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,
347
if file_ids_from is not None:
349
base_tree, base_path = WorkingTree.open_containing(
351
except errors.NoWorkingTree:
352
base_branch, base_path = Branch.open_containing(
354
base_tree = base_branch.basis_tree()
356
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
357
to_file=self.outf, should_print=(not is_quiet()))
359
action = bzrlib.add.AddAction(to_file=self.outf,
360
should_print=(not is_quiet()))
363
base_tree.lock_read()
365
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
366
action=action, save=not dry_run)
368
if base_tree is not None:
372
for glob in sorted(ignored.keys()):
373
for path in ignored[glob]:
374
self.outf.write("ignored %s matching \"%s\"\n"
378
for glob, paths in ignored.items():
379
match_len += len(paths)
380
self.outf.write("ignored %d file(s).\n" % match_len)
381
self.outf.write("If you wish to add some of these files,"
382
" please add them by name.\n")
385
class cmd_mkdir(Command):
386
"""Create a new versioned directory.
388
This is equivalent to creating the directory and then adding it.
391
takes_args = ['dir+']
392
encoding_type = 'replace'
394
def run(self, dir_list):
397
wt, dd = WorkingTree.open_containing(d)
399
self.outf.write('added %s\n' % d)
402
class cmd_relpath(Command):
403
"""Show path of a file relative to root"""
405
takes_args = ['filename']
409
def run(self, filename):
410
# TODO: jam 20050106 Can relpath return a munged path if
411
# sys.stdout encoding cannot represent it?
412
tree, relpath = WorkingTree.open_containing(filename)
413
self.outf.write(relpath)
414
self.outf.write('\n')
417
class cmd_inventory(Command):
418
"""Show inventory of the current working copy or a revision.
420
It is possible to limit the output to a particular entry
421
type using the --kind option. For example: --kind file.
423
It is also possible to restrict the list of files to a specific
424
set. For example: bzr inventory --show-ids this/file
431
takes_options = ['revision', 'show-ids', 'kind']
433
takes_args = ['file*']
436
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
437
if kind and kind not in ['file', 'directory', 'symlink']:
438
raise errors.BzrCommandError('invalid kind specified')
440
work_tree, file_list = tree_files(file_list)
441
work_tree.lock_read()
443
if revision is not None:
444
if len(revision) > 1:
445
raise errors.BzrCommandError(
446
'bzr inventory --revision takes exactly one revision'
448
revision_id = revision[0].in_history(work_tree.branch).rev_id
449
tree = work_tree.branch.repository.revision_tree(revision_id)
451
extra_trees = [work_tree]
457
if file_list is not None:
458
file_ids = tree.paths2ids(file_list, trees=extra_trees,
459
require_versioned=True)
460
# find_ids_across_trees may include some paths that don't
462
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
463
for file_id in file_ids if file_id in tree)
465
entries = tree.inventory.entries()
468
if tree is not work_tree:
471
for path, entry in entries:
472
if kind and kind != entry.kind:
475
self.outf.write('%-50s %s\n' % (path, entry.file_id))
477
self.outf.write(path)
478
self.outf.write('\n')
481
class cmd_mv(Command):
482
"""Move or rename a file.
485
bzr mv OLDNAME NEWNAME
486
bzr mv SOURCE... DESTINATION
488
If the last argument is a versioned directory, all the other names
489
are moved into it. Otherwise, there must be exactly two arguments
490
and the file is changed to a new name.
492
If OLDNAME does not exist on the filesystem but is versioned and
493
NEWNAME does exist on the filesystem but is not versioned, mv
494
assumes that the file has been manually moved and only updates
495
its internal inventory to reflect that change.
496
The same is valid when moving many SOURCE files to a DESTINATION.
498
Files cannot be moved between branches.
501
takes_args = ['names*']
502
takes_options = [Option("after", help="move only the bzr identifier"
503
" of the file (file has already been moved). Use this flag if"
504
" bzr is not able to detect this itself.")]
505
aliases = ['move', 'rename']
506
encoding_type = 'replace'
508
def run(self, names_list, after=False):
509
if names_list is None:
512
if len(names_list) < 2:
513
raise errors.BzrCommandError("missing file argument")
514
tree, rel_names = tree_files(names_list)
516
if os.path.isdir(names_list[-1]):
517
# move into existing directory
518
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
519
self.outf.write("%s => %s\n" % pair)
521
if len(names_list) != 2:
522
raise errors.BzrCommandError('to mv multiple files the'
523
' destination must be a versioned'
525
tree.rename_one(rel_names[0], rel_names[1], after=after)
526
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
529
class cmd_pull(Command):
530
"""Turn this branch into a mirror of another branch.
532
This command only works on branches that have not diverged. Branches are
533
considered diverged if the destination branch's most recent commit is one
534
that has not been merged (directly or indirectly) into the parent.
536
If branches have diverged, you can use 'bzr merge' to integrate the changes
537
from one into the other. Once one branch has merged, the other should
538
be able to pull it again.
540
If you want to forget your local changes and just update your branch to
541
match the remote one, use pull --overwrite.
543
If there is no default location set, the first pull will set it. After
544
that, you can omit the location to use the default. To change the
545
default, use --remember. The value will only be saved if the remote
546
location can be accessed.
549
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
551
help='branch to pull into, '
552
'rather than the one containing the working directory',
557
takes_args = ['location?']
558
encoding_type = 'replace'
560
def run(self, location=None, remember=False, overwrite=False,
561
revision=None, verbose=False,
563
from bzrlib.tag import _merge_tags_if_possible
564
# FIXME: too much stuff is in the command class
565
if directory is None:
568
tree_to = WorkingTree.open_containing(directory)[0]
569
branch_to = tree_to.branch
570
except errors.NoWorkingTree:
572
branch_to = Branch.open_containing(directory)[0]
575
if location is not None:
577
reader = bundle.read_bundle_from_url(location)
578
except errors.NotABundle:
579
pass # Continue on considering this url a Branch
581
stored_loc = branch_to.get_parent()
583
if stored_loc is None:
584
raise errors.BzrCommandError("No pull location known or"
587
display_url = urlutils.unescape_for_display(stored_loc,
589
self.outf.write("Using saved location: %s\n" % display_url)
590
location = stored_loc
592
if reader is not None:
593
install_bundle(branch_to.repository, reader)
594
branch_from = branch_to
596
branch_from = Branch.open(location)
598
if branch_to.get_parent() is None or remember:
599
branch_to.set_parent(branch_from.base)
603
if reader is not None:
604
rev_id = reader.target
605
elif len(revision) == 1:
606
rev_id = revision[0].in_history(branch_from).rev_id
608
raise errors.BzrCommandError('bzr pull --revision takes one value.')
610
old_rh = branch_to.revision_history()
611
if tree_to is not None:
612
result = tree_to.pull(branch_from, overwrite, rev_id,
613
delta.ChangeReporter(unversioned_filter=tree_to.is_ignored))
615
result = branch_to.pull(branch_from, overwrite, rev_id)
617
result.report(self.outf)
619
from bzrlib.log import show_changed_revisions
620
new_rh = branch_to.revision_history()
621
show_changed_revisions(branch_to, old_rh, new_rh, to_file=self.outf)
624
class cmd_push(Command):
625
"""Update a mirror of this branch.
627
The target branch will not have its working tree populated because this
628
is both expensive, and is not supported on remote file systems.
630
Some smart servers or protocols *may* put the working tree in place in
633
This command only works on branches that have not diverged. Branches are
634
considered diverged if the destination branch's most recent commit is one
635
that has not been merged (directly or indirectly) by the source branch.
637
If branches have diverged, you can use 'bzr push --overwrite' to replace
638
the other branch completely, discarding its unmerged changes.
640
If you want to ensure you have the different changes in the other branch,
641
do a merge (see bzr help merge) from the other branch, and commit that.
642
After that you will be able to do a push without '--overwrite'.
644
If there is no default push location set, the first push will set it.
645
After that, you can omit the location to use the default. To change the
646
default, use --remember. The value will only be saved if the remote
647
location can be accessed.
650
takes_options = ['remember', 'overwrite', 'verbose',
651
Option('create-prefix',
652
help='Create the path leading up to the branch '
653
'if it does not already exist'),
655
help='branch to push from, '
656
'rather than the one containing the working directory',
660
Option('use-existing-dir',
661
help='By default push will fail if the target'
662
' directory exists, but does not already'
663
' have a control directory. This flag will'
664
' allow push to proceed.'),
666
takes_args = ['location?']
667
encoding_type = 'replace'
669
def run(self, location=None, remember=False, overwrite=False,
670
create_prefix=False, verbose=False,
671
use_existing_dir=False,
673
# FIXME: Way too big! Put this into a function called from the
675
if directory is None:
677
br_from = Branch.open_containing(directory)[0]
678
stored_loc = br_from.get_push_location()
680
if stored_loc is None:
681
raise errors.BzrCommandError("No push location known or specified.")
683
display_url = urlutils.unescape_for_display(stored_loc,
685
self.outf.write("Using saved location: %s\n" % display_url)
686
location = stored_loc
688
to_transport = transport.get_transport(location)
689
location_url = to_transport.base
691
br_to = repository_to = dir_to = None
693
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
694
except errors.NotBranchError:
695
pass # Didn't find anything
697
# If we can open a branch, use its direct repository, otherwise see
698
# if there is a repository without a branch.
700
br_to = dir_to.open_branch()
701
except errors.NotBranchError:
702
# Didn't find a branch, can we find a repository?
704
repository_to = dir_to.find_repository()
705
except errors.NoRepositoryPresent:
708
# Found a branch, so we must have found a repository
709
repository_to = br_to.repository
713
# The destination doesn't exist; create it.
714
# XXX: Refactor the create_prefix/no_create_prefix code into a
715
# common helper function
717
to_transport.mkdir('.')
718
except errors.FileExists:
719
if not use_existing_dir:
720
raise errors.BzrCommandError("Target directory %s"
721
" already exists, but does not have a valid .bzr"
722
" directory. Supply --use-existing-dir to push"
723
" there anyway." % location)
724
except errors.NoSuchFile:
725
if not create_prefix:
726
raise errors.BzrCommandError("Parent directory of %s"
728
"\nYou may supply --create-prefix to create all"
729
" leading parent directories."
732
cur_transport = to_transport
733
needed = [cur_transport]
734
# Recurse upwards until we can create a directory successfully
736
new_transport = cur_transport.clone('..')
737
if new_transport.base == cur_transport.base:
738
raise errors.BzrCommandError("Failed to create path"
742
new_transport.mkdir('.')
743
except errors.NoSuchFile:
744
needed.append(new_transport)
745
cur_transport = new_transport
749
# Now we only need to create child directories
751
cur_transport = needed.pop()
752
cur_transport.mkdir('.')
754
# Now the target directory exists, but doesn't have a .bzr
755
# directory. So we need to create it, along with any work to create
756
# all of the dependent branches, etc.
757
dir_to = br_from.bzrdir.clone(location_url,
758
revision_id=br_from.last_revision())
759
br_to = dir_to.open_branch()
760
# TODO: Some more useful message about what was copied
761
note('Created new branch.')
762
# We successfully created the target, remember it
763
if br_from.get_push_location() is None or remember:
764
br_from.set_push_location(br_to.base)
765
elif repository_to is None:
766
# we have a bzrdir but no branch or repository
767
# XXX: Figure out what to do other than complain.
768
raise errors.BzrCommandError("At %s you have a valid .bzr control"
769
" directory, but not a branch or repository. This is an"
770
" unsupported configuration. Please move the target directory"
771
" out of the way and try again."
774
# We have a repository but no branch, copy the revisions, and then
776
last_revision_id = br_from.last_revision()
777
repository_to.fetch(br_from.repository,
778
revision_id=last_revision_id)
779
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
780
note('Created new branch.')
781
if br_from.get_push_location() is None or remember:
782
br_from.set_push_location(br_to.base)
783
else: # We have a valid to branch
784
# We were able to connect to the remote location, so remember it
785
# we don't need to successfully push because of possible divergence.
786
if br_from.get_push_location() is None or remember:
787
br_from.set_push_location(br_to.base)
788
old_rh = br_to.revision_history()
791
tree_to = dir_to.open_workingtree()
792
except errors.NotLocalUrl:
793
warning('This transport does not update the working '
794
'tree of: %s' % (br_to.base,))
795
push_result = br_from.push(br_to, overwrite)
796
except errors.NoWorkingTree:
797
push_result = br_from.push(br_to, overwrite)
801
push_result = br_from.push(tree_to.branch, overwrite)
805
except errors.DivergedBranches:
806
raise errors.BzrCommandError('These branches have diverged.'
807
' Try using "merge" and then "push".')
808
if push_result is not None:
809
push_result.report(self.outf)
811
new_rh = br_to.revision_history()
814
from bzrlib.log import show_changed_revisions
815
show_changed_revisions(br_to, old_rh, new_rh,
818
# we probably did a clone rather than a push, so a message was
823
class cmd_branch(Command):
824
"""Create a new copy of a branch.
826
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
827
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
829
To retrieve the branch as of a particular revision, supply the --revision
830
parameter, as in "branch foo/bar -r 5".
832
--basis is to speed up branching from remote branches. When specified, it
833
copies all the file-contents, inventory and revision data from the basis
834
branch before copying anything from the remote branch.
836
takes_args = ['from_location', 'to_location?']
837
takes_options = ['revision', 'basis']
838
aliases = ['get', 'clone']
840
def run(self, from_location, to_location=None, revision=None, basis=None):
841
from bzrlib.tag import _merge_tags_if_possible
844
elif len(revision) > 1:
845
raise errors.BzrCommandError(
846
'bzr branch --revision takes exactly 1 revision value')
848
br_from = Branch.open(from_location)
851
if basis is not None:
852
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
855
if len(revision) == 1 and revision[0] is not None:
856
revision_id = revision[0].in_history(br_from)[1]
858
# FIXME - wt.last_revision, fallback to branch, fall back to
859
# None or perhaps NULL_REVISION to mean copy nothing
861
revision_id = br_from.last_revision()
862
if to_location is None:
863
to_location = os.path.basename(from_location.rstrip("/\\"))
866
name = os.path.basename(to_location) + '\n'
868
to_transport = transport.get_transport(to_location)
870
to_transport.mkdir('.')
871
except errors.FileExists:
872
raise errors.BzrCommandError('Target directory "%s" already'
873
' exists.' % to_location)
874
except errors.NoSuchFile:
875
raise errors.BzrCommandError('Parent of "%s" does not exist.'
878
# preserve whatever source format we have.
879
dir = br_from.bzrdir.sprout(to_transport.base,
880
revision_id, basis_dir)
881
branch = dir.open_branch()
882
except errors.NoSuchRevision:
883
to_transport.delete_tree('.')
884
msg = "The branch %s has no revision %s." % (from_location, revision[0])
885
raise errors.BzrCommandError(msg)
886
except errors.UnlistableBranch:
887
osutils.rmtree(to_location)
888
msg = "The branch %s cannot be used as a --basis" % (basis,)
889
raise errors.BzrCommandError(msg)
891
branch.control_files.put_utf8('branch-name', name)
892
_merge_tags_if_possible(br_from, branch)
893
note('Branched %d revision(s).' % branch.revno())
898
class cmd_checkout(Command):
899
"""Create a new checkout of an existing branch.
901
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
902
the branch found in '.'. This is useful if you have removed the working tree
903
or if it was never created - i.e. if you pushed the branch to its current
906
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
907
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
909
To retrieve the branch as of a particular revision, supply the --revision
910
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
911
out of date [so you cannot commit] but it may be useful (i.e. to examine old
914
--basis is to speed up checking out from remote branches. When specified, it
915
uses the inventory and file contents from the basis branch in preference to the
916
branch being checked out.
918
See "help checkouts" for more information on checkouts.
920
takes_args = ['branch_location?', 'to_location?']
921
takes_options = ['revision', # , 'basis']
922
Option('lightweight',
923
help="perform a lightweight checkout. Lightweight "
924
"checkouts depend on access to the branch for "
925
"every operation. Normal checkouts can perform "
926
"common operations like diff and status without "
927
"such access, and also support local commits."
932
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
936
elif len(revision) > 1:
937
raise errors.BzrCommandError(
938
'bzr checkout --revision takes exactly 1 revision value')
939
if branch_location is None:
940
branch_location = osutils.getcwd()
941
to_location = branch_location
942
source = Branch.open(branch_location)
943
if len(revision) == 1 and revision[0] is not None:
944
revision_id = revision[0].in_history(source)[1]
947
if to_location is None:
948
to_location = os.path.basename(branch_location.rstrip("/\\"))
949
# if the source and to_location are the same,
950
# and there is no working tree,
951
# then reconstitute a branch
952
if (osutils.abspath(to_location) ==
953
osutils.abspath(branch_location)):
955
source.bzrdir.open_workingtree()
956
except errors.NoWorkingTree:
957
source.bzrdir.create_workingtree()
960
os.mkdir(to_location)
962
if e.errno == errno.EEXIST:
963
raise errors.BzrCommandError('Target directory "%s" already'
964
' exists.' % to_location)
965
if e.errno == errno.ENOENT:
966
raise errors.BzrCommandError('Parent of "%s" does not exist.'
970
source.create_checkout(to_location, revision_id, lightweight)
973
class cmd_renames(Command):
974
"""Show list of renamed files.
976
# TODO: Option to show renames between two historical versions.
978
# TODO: Only show renames under dir, rather than in the whole branch.
979
takes_args = ['dir?']
982
def run(self, dir=u'.'):
983
tree = WorkingTree.open_containing(dir)[0]
986
new_inv = tree.inventory
987
old_tree = tree.basis_tree()
990
old_inv = old_tree.inventory
991
renames = list(_mod_tree.find_renames(old_inv, new_inv))
993
for old_name, new_name in renames:
994
self.outf.write("%s => %s\n" % (old_name, new_name))
1001
class cmd_update(Command):
1002
"""Update a tree to have the latest code committed to its branch.
1004
This will perform a merge into the working tree, and may generate
1005
conflicts. If you have any local changes, you will still
1006
need to commit them after the update for the update to be complete.
1008
If you want to discard your local changes, you can just do a
1009
'bzr revert' instead of 'bzr commit' after the update.
1011
takes_args = ['dir?']
1014
def run(self, dir='.'):
1015
tree = WorkingTree.open_containing(dir)[0]
1016
master = tree.branch.get_master_branch()
1017
if master is not None:
1020
tree.lock_tree_write()
1022
existing_pending_merges = tree.get_parent_ids()[1:]
1023
last_rev = tree.last_revision()
1024
if last_rev == tree.branch.last_revision():
1025
# may be up to date, check master too.
1026
master = tree.branch.get_master_branch()
1027
if master is None or last_rev == master.last_revision():
1028
revno = tree.branch.revision_id_to_revno(last_rev)
1029
note("Tree is up to date at revision %d." % (revno,))
1031
conflicts = tree.update()
1032
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1033
note('Updated to revision %d.' % (revno,))
1034
if tree.get_parent_ids()[1:] != existing_pending_merges:
1035
note('Your local commits will now show as pending merges with '
1036
"'bzr status', and can be committed with 'bzr commit'.")
1045
class cmd_info(Command):
1046
"""Show information about a working tree, branch or repository.
1048
This command will show all known locations and formats associated to the
1049
tree, branch or repository. Statistical information is included with
1052
Branches and working trees will also report any missing revisions.
1054
takes_args = ['location?']
1055
takes_options = ['verbose']
1058
def run(self, location=None, verbose=False):
1059
from bzrlib.info import show_bzrdir_info
1060
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1064
class cmd_remove(Command):
1065
"""Make a file unversioned.
1067
This makes bzr stop tracking changes to a versioned file. It does
1068
not delete the working copy.
1070
You can specify one or more files, and/or --new. If you specify --new,
1071
only 'added' files will be removed. If you specify both, then new files
1072
in the specified directories will be removed. If the directories are
1073
also new, they will also be removed.
1075
takes_args = ['file*']
1076
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1078
encoding_type = 'replace'
1080
def run(self, file_list, verbose=False, new=False):
1081
tree, file_list = tree_files(file_list)
1083
if file_list is None:
1084
raise errors.BzrCommandError('Specify one or more files to'
1085
' remove, or use --new.')
1087
added = tree.changes_from(tree.basis_tree(),
1088
specific_files=file_list).added
1089
file_list = sorted([f[0] for f in added], reverse=True)
1090
if len(file_list) == 0:
1091
raise errors.BzrCommandError('No matching files.')
1092
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1095
class cmd_file_id(Command):
1096
"""Print file_id of a particular file or directory.
1098
The file_id is assigned when the file is first added and remains the
1099
same through all revisions where the file exists, even when it is
1104
takes_args = ['filename']
1107
def run(self, filename):
1108
tree, relpath = WorkingTree.open_containing(filename)
1109
i = tree.path2id(relpath)
1111
raise errors.NotVersionedError(filename)
1113
self.outf.write(i + '\n')
1116
class cmd_file_path(Command):
1117
"""Print path of file_ids to a file or directory.
1119
This prints one line for each directory down to the target,
1120
starting at the branch root.
1124
takes_args = ['filename']
1127
def run(self, filename):
1128
tree, relpath = WorkingTree.open_containing(filename)
1129
fid = tree.path2id(relpath)
1131
raise errors.NotVersionedError(filename)
1132
segments = osutils.splitpath(relpath)
1133
for pos in range(1, len(segments) + 1):
1134
path = osutils.joinpath(segments[:pos])
1135
self.outf.write("%s\n" % tree.path2id(path))
1138
class cmd_reconcile(Command):
1139
"""Reconcile bzr metadata in a branch.
1141
This can correct data mismatches that may have been caused by
1142
previous ghost operations or bzr upgrades. You should only
1143
need to run this command if 'bzr check' or a bzr developer
1144
advises you to run it.
1146
If a second branch is provided, cross-branch reconciliation is
1147
also attempted, which will check that data like the tree root
1148
id which was not present in very early bzr versions is represented
1149
correctly in both branches.
1151
At the same time it is run it may recompress data resulting in
1152
a potential saving in disk space or performance gain.
1154
The branch *MUST* be on a listable system such as local disk or sftp.
1156
takes_args = ['branch?']
1158
def run(self, branch="."):
1159
from bzrlib.reconcile import reconcile
1160
dir = bzrdir.BzrDir.open(branch)
1164
class cmd_revision_history(Command):
1165
"""Display the list of revision ids on a branch."""
1166
takes_args = ['location?']
1171
def run(self, location="."):
1172
branch = Branch.open_containing(location)[0]
1173
for revid in branch.revision_history():
1174
self.outf.write(revid)
1175
self.outf.write('\n')
1178
class cmd_ancestry(Command):
1179
"""List all revisions merged into this branch."""
1180
takes_args = ['location?']
1185
def run(self, location="."):
1187
wt = WorkingTree.open_containing(location)[0]
1188
except errors.NoWorkingTree:
1189
b = Branch.open(location)
1190
last_revision = b.last_revision()
1193
last_revision = wt.last_revision()
1195
revision_ids = b.repository.get_ancestry(last_revision)
1196
assert revision_ids[0] is None
1198
for revision_id in revision_ids:
1199
self.outf.write(revision_id + '\n')
1202
class cmd_init(Command):
1203
"""Make a directory into a versioned branch.
1205
Use this to create an empty branch, or before importing an
1208
If there is a repository in a parent directory of the location, then
1209
the history of the branch will be stored in the repository. Otherwise
1210
init creates a standalone branch which carries its own history in
1213
If there is already a branch at the location but it has no working tree,
1214
the tree can be populated with 'bzr checkout'.
1216
Recipe for importing a tree of files:
1221
bzr commit -m 'imported project'
1223
takes_args = ['location?']
1225
RegistryOption('format',
1226
help='Specify a format for this branch. '
1227
'See "help formats".',
1228
registry=bzrdir.format_registry,
1229
converter=bzrdir.format_registry.make_bzrdir,
1230
value_switches=True,
1231
title="Branch Format",
1233
Option('append-revisions-only',
1234
help='Never change revnos or the existing log.'
1235
' Append revisions to it only.')
1237
def run(self, location=None, format=None, append_revisions_only=False):
1239
format = bzrdir.format_registry.make_bzrdir('default')
1240
if location is None:
1243
to_transport = transport.get_transport(location)
1245
# The path has to exist to initialize a
1246
# branch inside of it.
1247
# Just using os.mkdir, since I don't
1248
# believe that we want to create a bunch of
1249
# locations if the user supplies an extended path
1250
# TODO: create-prefix
1252
to_transport.mkdir('.')
1253
except errors.FileExists:
1257
existing_bzrdir = bzrdir.BzrDir.open(location)
1258
except errors.NotBranchError:
1259
# really a NotBzrDir error...
1260
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1263
from bzrlib.transport.local import LocalTransport
1264
if existing_bzrdir.has_branch():
1265
if (isinstance(to_transport, LocalTransport)
1266
and not existing_bzrdir.has_workingtree()):
1267
raise errors.BranchExistsWithoutWorkingTree(location)
1268
raise errors.AlreadyBranchError(location)
1270
branch = existing_bzrdir.create_branch()
1271
existing_bzrdir.create_workingtree()
1272
if append_revisions_only:
1274
branch.set_append_revisions_only(True)
1275
except errors.UpgradeRequired:
1276
raise errors.BzrCommandError('This branch format cannot be set'
1277
' to append-revisions-only. Try --experimental-branch6')
1280
class cmd_init_repository(Command):
1281
"""Create a shared repository to hold branches.
1283
New branches created under the repository directory will store their revisions
1284
in the repository, not in the branch directory, if the branch format supports
1290
bzr checkout --lightweight repo/trunk trunk-checkout
1294
takes_args = ["location"]
1295
takes_options = [RegistryOption('format',
1296
help='Specify a format for this repository. See'
1297
' "bzr help formats" for details',
1298
registry=bzrdir.format_registry,
1299
converter=bzrdir.format_registry.make_bzrdir,
1300
value_switches=True, title='Repository format'),
1302
help='Allows branches in repository to have'
1304
aliases = ["init-repo"]
1305
def run(self, location, format=None, trees=False):
1307
format = bzrdir.format_registry.make_bzrdir('default')
1309
if location is None:
1312
to_transport = transport.get_transport(location)
1314
to_transport.mkdir('.')
1315
except errors.FileExists:
1318
newdir = format.initialize_on_transport(to_transport)
1319
repo = newdir.create_repository(shared=True)
1320
repo.set_make_working_trees(trees)
1323
class cmd_diff(Command):
1324
"""Show differences in the working tree or between revisions.
1326
If files are listed, only the changes in those files are listed.
1327
Otherwise, all changes for the tree are listed.
1329
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1330
produces patches suitable for "patch -p1".
1334
Shows the difference in the working tree versus the last commit
1336
Difference between the working tree and revision 1
1338
Difference between revision 2 and revision 1
1339
bzr diff --diff-prefix old/:new/
1340
Same as 'bzr diff' but prefix paths with old/ and new/
1341
bzr diff bzr.mine bzr.dev
1342
Show the differences between the two working trees
1344
Show just the differences for 'foo.c'
1346
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1347
# or a graphical diff.
1349
# TODO: Python difflib is not exactly the same as unidiff; should
1350
# either fix it up or prefer to use an external diff.
1352
# TODO: Selected-file diff is inefficient and doesn't show you
1355
# TODO: This probably handles non-Unix newlines poorly.
1357
takes_args = ['file*']
1358
takes_options = ['revision', 'diff-options',
1359
Option('prefix', type=str,
1361
help='Set prefixes to added to old and new filenames, as '
1362
'two values separated by a colon.'),
1364
aliases = ['di', 'dif']
1365
encoding_type = 'exact'
1368
def run(self, revision=None, file_list=None, diff_options=None,
1370
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1372
if (prefix is None) or (prefix == '0'):
1380
old_label, new_label = prefix.split(":")
1382
raise BzrCommandError(
1383
"--prefix expects two values separated by a colon")
1385
if revision and len(revision) > 2:
1386
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1387
' one or two revision specifiers')
1390
tree1, file_list = internal_tree_files(file_list)
1394
except errors.FileInWrongBranch:
1395
if len(file_list) != 2:
1396
raise errors.BzrCommandError("Files are in different branches")
1398
tree1, file1 = WorkingTree.open_containing(file_list[0])
1399
tree2, file2 = WorkingTree.open_containing(file_list[1])
1400
if file1 != "" or file2 != "":
1401
# FIXME diff those two files. rbc 20051123
1402
raise errors.BzrCommandError("Files are in different branches")
1404
except errors.NotBranchError:
1405
if (revision is not None and len(revision) == 2
1406
and not revision[0].needs_branch()
1407
and not revision[1].needs_branch()):
1408
# If both revision specs include a branch, we can
1409
# diff them without needing a local working tree
1410
tree1, tree2 = None, None
1414
if tree2 is not None:
1415
if revision is not None:
1416
# FIXME: but there should be a clean way to diff between
1417
# non-default versions of two trees, it's not hard to do
1419
raise errors.BzrCommandError(
1420
"Sorry, diffing arbitrary revisions across branches "
1421
"is not implemented yet")
1422
return show_diff_trees(tree1, tree2, sys.stdout,
1423
specific_files=file_list,
1424
external_diff_options=diff_options,
1425
old_label=old_label, new_label=new_label)
1427
return diff_cmd_helper(tree1, file_list, diff_options,
1428
revision_specs=revision,
1429
old_label=old_label, new_label=new_label)
1432
class cmd_deleted(Command):
1433
"""List files deleted in the working tree.
1435
# TODO: Show files deleted since a previous revision, or
1436
# between two revisions.
1437
# TODO: Much more efficient way to do this: read in new
1438
# directories with readdir, rather than stating each one. Same
1439
# level of effort but possibly much less IO. (Or possibly not,
1440
# if the directories are very large...)
1441
takes_options = ['show-ids']
1444
def run(self, show_ids=False):
1445
tree = WorkingTree.open_containing(u'.')[0]
1448
old = tree.basis_tree()
1451
for path, ie in old.inventory.iter_entries():
1452
if not tree.has_id(ie.file_id):
1453
self.outf.write(path)
1455
self.outf.write(' ')
1456
self.outf.write(ie.file_id)
1457
self.outf.write('\n')
1464
class cmd_modified(Command):
1465
"""List files modified in working tree.
1467
See also: "bzr status".
1474
tree = WorkingTree.open_containing(u'.')[0]
1475
td = tree.changes_from(tree.basis_tree())
1476
for path, id, kind, text_modified, meta_modified in td.modified:
1477
self.outf.write(path + '\n')
1480
class cmd_added(Command):
1481
"""List files added in working tree.
1483
See also: "bzr status".
1490
wt = WorkingTree.open_containing(u'.')[0]
1493
basis = wt.basis_tree()
1496
basis_inv = basis.inventory
1499
if file_id in basis_inv:
1501
if inv.is_root(file_id) and len(basis_inv) == 0:
1503
path = inv.id2path(file_id)
1504
if not os.access(osutils.abspath(path), os.F_OK):
1506
self.outf.write(path + '\n')
1513
class cmd_root(Command):
1514
"""Show the tree root directory.
1516
The root is the nearest enclosing directory with a .bzr control
1518
takes_args = ['filename?']
1520
def run(self, filename=None):
1521
"""Print the branch root."""
1522
tree = WorkingTree.open_containing(filename)[0]
1523
self.outf.write(tree.basedir + '\n')
1526
class cmd_log(Command):
1527
"""Show log of a branch, file, or directory.
1529
By default show the log of the branch containing the working directory.
1531
To request a range of logs, you can use the command -r begin..end
1532
-r revision requests a specific revision, -r ..end or -r begin.. are
1538
bzr log -r -10.. http://server/branch
1541
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1543
takes_args = ['location?']
1544
takes_options = [Option('forward',
1545
help='show from oldest to newest'),
1549
help='show files changed in each revision'),
1550
'show-ids', 'revision',
1554
help='show revisions whose message matches this regexp',
1557
encoding_type = 'replace'
1560
def run(self, location=None, timezone='original',
1567
from bzrlib.log import show_log
1568
assert message is None or isinstance(message, basestring), \
1569
"invalid message argument %r" % message
1570
direction = (forward and 'forward') or 'reverse'
1575
# find the file id to log:
1577
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1581
tree = b.basis_tree()
1582
file_id = tree.path2id(fp)
1584
raise errors.BzrCommandError(
1585
"Path does not have any revision history: %s" %
1589
# FIXME ? log the current subdir only RBC 20060203
1590
if revision is not None \
1591
and len(revision) > 0 and revision[0].get_branch():
1592
location = revision[0].get_branch()
1595
dir, relpath = bzrdir.BzrDir.open_containing(location)
1596
b = dir.open_branch()
1600
if revision is None:
1603
elif len(revision) == 1:
1604
rev1 = rev2 = revision[0].in_history(b).revno
1605
elif len(revision) == 2:
1606
if revision[1].get_branch() != revision[0].get_branch():
1607
# b is taken from revision[0].get_branch(), and
1608
# show_log will use its revision_history. Having
1609
# different branches will lead to weird behaviors.
1610
raise errors.BzrCommandError(
1611
"Log doesn't accept two revisions in different"
1613
if revision[0].spec is None:
1614
# missing begin-range means first revision
1617
rev1 = revision[0].in_history(b).revno
1619
if revision[1].spec is None:
1620
# missing end-range means last known revision
1623
rev2 = revision[1].in_history(b).revno
1625
raise errors.BzrCommandError(
1626
'bzr log --revision takes one or two values.')
1628
# By this point, the revision numbers are converted to the +ve
1629
# form if they were supplied in the -ve form, so we can do
1630
# this comparison in relative safety
1632
(rev2, rev1) = (rev1, rev2)
1634
if log_format is None:
1635
log_format = log.log_formatter_registry.get_default(b)
1637
lf = log_format(show_ids=show_ids, to_file=self.outf,
1638
show_timezone=timezone)
1644
direction=direction,
1645
start_revision=rev1,
1652
def get_log_format(long=False, short=False, line=False, default='long'):
1653
log_format = default
1657
log_format = 'short'
1663
class cmd_touching_revisions(Command):
1664
"""Return revision-ids which affected a particular file.
1666
A more user-friendly interface is "bzr log FILE".
1670
takes_args = ["filename"]
1673
def run(self, filename):
1674
tree, relpath = WorkingTree.open_containing(filename)
1676
file_id = tree.path2id(relpath)
1677
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1678
self.outf.write("%6d %s\n" % (revno, what))
1681
class cmd_ls(Command):
1682
"""List files in a tree.
1685
takes_args = ['path?']
1686
# TODO: Take a revision or remote path and list that tree instead.
1687
takes_options = ['verbose', 'revision',
1688
Option('non-recursive',
1689
help='don\'t recurse into sub-directories'),
1691
help='Print all paths from the root of the branch.'),
1692
Option('unknown', help='Print unknown files'),
1693
Option('versioned', help='Print versioned files'),
1694
Option('ignored', help='Print ignored files'),
1696
Option('null', help='Null separate the files'),
1700
def run(self, revision=None, verbose=False,
1701
non_recursive=False, from_root=False,
1702
unknown=False, versioned=False, ignored=False,
1703
null=False, kind=None, show_ids=False, path=None):
1705
if kind and kind not in ('file', 'directory', 'symlink'):
1706
raise errors.BzrCommandError('invalid kind specified')
1708
if verbose and null:
1709
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1710
all = not (unknown or versioned or ignored)
1712
selection = {'I':ignored, '?':unknown, 'V':versioned}
1719
raise errors.BzrCommandError('cannot specify both --from-root'
1723
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1729
if revision is not None:
1730
tree = branch.repository.revision_tree(
1731
revision[0].in_history(branch).rev_id)
1733
tree = branch.basis_tree()
1737
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1738
if fp.startswith(relpath):
1739
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1740
if non_recursive and '/' in fp:
1742
if not all and not selection[fc]:
1744
if kind is not None and fkind != kind:
1747
kindch = entry.kind_character()
1748
outstring = '%-8s %s%s' % (fc, fp, kindch)
1749
if show_ids and fid is not None:
1750
outstring = "%-50s %s" % (outstring, fid)
1751
self.outf.write(outstring + '\n')
1753
self.outf.write(fp + '\0')
1756
self.outf.write(fid)
1757
self.outf.write('\0')
1765
self.outf.write('%-50s %s\n' % (fp, my_id))
1767
self.outf.write(fp + '\n')
1772
class cmd_unknowns(Command):
1773
"""List unknown files.
1775
See also: "bzr ls --unknown".
1782
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1783
self.outf.write(osutils.quotefn(f) + '\n')
1786
class cmd_ignore(Command):
1787
"""Ignore specified files or patterns.
1789
To remove patterns from the ignore list, edit the .bzrignore file.
1791
Trailing slashes on patterns are ignored.
1792
If the pattern contains a slash or is a regular expression, it is compared
1793
to the whole path from the branch root. Otherwise, it is compared to only
1794
the last component of the path. To match a file only in the root
1795
directory, prepend './'.
1797
Ignore patterns specifying absolute paths are not allowed.
1799
Ignore patterns may include globbing wildcards such as:
1800
? - Matches any single character except '/'
1801
* - Matches 0 or more characters except '/'
1802
/**/ - Matches 0 or more directories in a path
1803
[a-z] - Matches a single character from within a group of characters
1805
Ignore patterns may also be Python regular expressions.
1806
Regular expression ignore patterns are identified by a 'RE:' prefix
1807
followed by the regular expression. Regular expression ignore patterns
1808
may not include named or numbered groups.
1810
Note: ignore patterns containing shell wildcards must be quoted from
1814
bzr ignore ./Makefile
1815
bzr ignore '*.class'
1816
bzr ignore 'lib/**/*.o'
1817
bzr ignore 'RE:lib/.*\.o'
1819
takes_args = ['name_pattern*']
1821
Option('old-default-rules',
1822
help='Out the ignore rules bzr < 0.9 always used.')
1825
def run(self, name_pattern_list=None, old_default_rules=None):
1826
from bzrlib.atomicfile import AtomicFile
1827
if old_default_rules is not None:
1828
# dump the rules and exit
1829
for pattern in ignores.OLD_DEFAULTS:
1832
if not name_pattern_list:
1833
raise errors.BzrCommandError("ignore requires at least one "
1834
"NAME_PATTERN or --old-default-rules")
1835
name_pattern_list = [globbing.normalize_pattern(p)
1836
for p in name_pattern_list]
1837
for name_pattern in name_pattern_list:
1838
if (name_pattern[0] == '/' or
1839
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1840
raise errors.BzrCommandError(
1841
"NAME_PATTERN should not be an absolute path")
1842
tree, relpath = WorkingTree.open_containing(u'.')
1843
ifn = tree.abspath('.bzrignore')
1844
if os.path.exists(ifn):
1847
igns = f.read().decode('utf-8')
1853
# TODO: If the file already uses crlf-style termination, maybe
1854
# we should use that for the newly added lines?
1856
if igns and igns[-1] != '\n':
1858
for name_pattern in name_pattern_list:
1859
igns += name_pattern + '\n'
1861
f = AtomicFile(ifn, 'wb')
1863
f.write(igns.encode('utf-8'))
1868
if not tree.path2id('.bzrignore'):
1869
tree.add(['.bzrignore'])
1872
class cmd_ignored(Command):
1873
"""List ignored files and the patterns that matched them.
1875
See also: bzr ignore"""
1878
tree = WorkingTree.open_containing(u'.')[0]
1881
for path, file_class, kind, file_id, entry in tree.list_files():
1882
if file_class != 'I':
1884
## XXX: Slightly inefficient since this was already calculated
1885
pat = tree.is_ignored(path)
1886
print '%-50s %s' % (path, pat)
1891
class cmd_lookup_revision(Command):
1892
"""Lookup the revision-id from a revision-number
1895
bzr lookup-revision 33
1898
takes_args = ['revno']
1901
def run(self, revno):
1905
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1907
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1910
class cmd_export(Command):
1911
"""Export past revision to destination directory.
1913
If no revision is specified this exports the last committed revision.
1915
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1916
given, try to find the format with the extension. If no extension
1917
is found exports to a directory (equivalent to --format=dir).
1919
Root may be the top directory for tar, tgz and tbz2 formats. If none
1920
is given, the top directory will be the root name of the file.
1922
If branch is omitted then the branch containing the CWD will be used.
1924
Note: export of tree with non-ascii filenames to zip is not supported.
1926
Supported formats Autodetected by extension
1927
----------------- -------------------------
1930
tbz2 .tar.bz2, .tbz2
1934
takes_args = ['dest', 'branch?']
1935
takes_options = ['revision', 'format', 'root']
1936
def run(self, dest, branch=None, revision=None, format=None, root=None):
1937
from bzrlib.export import export
1940
tree = WorkingTree.open_containing(u'.')[0]
1943
b = Branch.open(branch)
1945
if revision is None:
1946
# should be tree.last_revision FIXME
1947
rev_id = b.last_revision()
1949
if len(revision) != 1:
1950
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1951
rev_id = revision[0].in_history(b).rev_id
1952
t = b.repository.revision_tree(rev_id)
1954
export(t, dest, format, root)
1955
except errors.NoSuchExportFormat, e:
1956
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1959
class cmd_cat(Command):
1960
"""Write a file's text from a previous revision."""
1962
takes_options = ['revision', 'name-from-revision']
1963
takes_args = ['filename']
1964
encoding_type = 'exact'
1967
def run(self, filename, revision=None, name_from_revision=False):
1968
if revision is not None and len(revision) != 1:
1969
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1974
tree, b, relpath = \
1975
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
1976
except errors.NotBranchError:
1979
if revision is not None and revision[0].get_branch() is not None:
1980
b = Branch.open(revision[0].get_branch())
1982
tree = b.basis_tree()
1983
if revision is None:
1984
revision_id = b.last_revision()
1986
revision_id = revision[0].in_history(b).rev_id
1988
cur_file_id = tree.path2id(relpath)
1989
rev_tree = b.repository.revision_tree(revision_id)
1990
old_file_id = rev_tree.path2id(relpath)
1992
if name_from_revision:
1993
if old_file_id is None:
1994
raise errors.BzrCommandError("%r is not present in revision %s"
1995
% (filename, revision_id))
1997
rev_tree.print_file(old_file_id)
1998
elif cur_file_id is not None:
1999
rev_tree.print_file(cur_file_id)
2000
elif old_file_id is not None:
2001
rev_tree.print_file(old_file_id)
2003
raise errors.BzrCommandError("%r is not present in revision %s" %
2004
(filename, revision_id))
2007
class cmd_local_time_offset(Command):
2008
"""Show the offset in seconds from GMT to local time."""
2012
print osutils.local_time_offset()
2016
class cmd_commit(Command):
2017
"""Commit changes into a new revision.
2019
If no arguments are given, the entire tree is committed.
2021
If selected files are specified, only changes to those files are
2022
committed. If a directory is specified then the directory and everything
2023
within it is committed.
2025
A selected-file commit may fail in some cases where the committed
2026
tree would be invalid, such as trying to commit a file in a
2027
newly-added directory that is not itself committed.
2029
# TODO: Run hooks on tree to-be-committed, and after commit.
2031
# TODO: Strict commit that fails if there are deleted files.
2032
# (what does "deleted files" mean ??)
2034
# TODO: Give better message for -s, --summary, used by tla people
2036
# XXX: verbose currently does nothing
2038
takes_args = ['selected*']
2039
takes_options = ['message', 'verbose',
2041
help='commit even if nothing has changed'),
2042
Option('file', type=str,
2045
help='file containing commit message'),
2047
help="refuse to commit if there are unknown "
2048
"files in the working tree."),
2050
help="perform a local only commit in a bound "
2051
"branch. Such commits are not pushed to "
2052
"the master branch until a normal commit "
2056
aliases = ['ci', 'checkin']
2058
def run(self, message=None, file=None, verbose=True, selected_list=None,
2059
unchanged=False, strict=False, local=False):
2060
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2061
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2063
from bzrlib.msgeditor import edit_commit_message, \
2064
make_commit_message_template
2066
# TODO: Need a blackbox test for invoking the external editor; may be
2067
# slightly problematic to run this cross-platform.
2069
# TODO: do more checks that the commit will succeed before
2070
# spending the user's valuable time typing a commit message.
2071
tree, selected_list = tree_files(selected_list)
2072
if selected_list == ['']:
2073
# workaround - commit of root of tree should be exactly the same
2074
# as just default commit in that tree, and succeed even though
2075
# selected-file merge commit is not done yet
2078
if local and not tree.branch.get_bound_location():
2079
raise errors.LocalRequiresBoundBranch()
2081
def get_message(commit_obj):
2082
"""Callback to get commit message"""
2083
my_message = message
2084
if my_message is None and not file:
2085
template = make_commit_message_template(tree, selected_list)
2086
my_message = edit_commit_message(template)
2087
if my_message is None:
2088
raise errors.BzrCommandError("please specify a commit"
2089
" message with either --message or --file")
2090
elif my_message and file:
2091
raise errors.BzrCommandError(
2092
"please specify either --message or --file")
2094
my_message = codecs.open(file, 'rt',
2095
bzrlib.user_encoding).read()
2096
if my_message == "":
2097
raise errors.BzrCommandError("empty commit message specified")
2101
reporter = ReportCommitToLog()
2103
reporter = NullCommitReporter()
2106
tree.commit(message_callback=get_message,
2107
specific_files=selected_list,
2108
allow_pointless=unchanged, strict=strict, local=local,
2110
except PointlessCommit:
2111
# FIXME: This should really happen before the file is read in;
2112
# perhaps prepare the commit; get the message; then actually commit
2113
raise errors.BzrCommandError("no changes to commit."
2114
" use --unchanged to commit anyhow")
2115
except ConflictsInTree:
2116
raise errors.BzrCommandError('Conflicts detected in working '
2117
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2119
except StrictCommitFailed:
2120
raise errors.BzrCommandError("Commit refused because there are"
2121
" unknown files in the working tree.")
2122
except errors.BoundBranchOutOfDate, e:
2123
raise errors.BzrCommandError(str(e) + "\n"
2124
'To commit to master branch, run update and then commit.\n'
2125
'You can also pass --local to commit to continue working '
2129
class cmd_check(Command):
2130
"""Validate consistency of branch history.
2132
This command checks various invariants about the branch storage to
2133
detect data corruption or bzr bugs.
2135
takes_args = ['branch?']
2136
takes_options = ['verbose']
2138
def run(self, branch=None, verbose=False):
2139
from bzrlib.check import check
2141
tree = WorkingTree.open_containing()[0]
2142
branch = tree.branch
2144
branch = Branch.open(branch)
2145
check(branch, verbose)
2148
class cmd_upgrade(Command):
2149
"""Upgrade branch storage to current format.
2151
The check command or bzr developers may sometimes advise you to run
2152
this command. When the default format has changed you may also be warned
2153
during other operations to upgrade.
2155
takes_args = ['url?']
2157
RegistryOption('format',
2158
help='Upgrade to a specific format. See "bzr help'
2159
' formats" for details',
2160
registry=bzrdir.format_registry,
2161
converter=bzrdir.format_registry.make_bzrdir,
2162
value_switches=True, title='Branch format'),
2165
def run(self, url='.', format=None):
2166
from bzrlib.upgrade import upgrade
2168
format = bzrdir.format_registry.make_bzrdir('default')
2169
upgrade(url, format)
2172
class cmd_whoami(Command):
2173
"""Show or set bzr user id.
2177
bzr whoami 'Frank Chu <fchu@example.com>'
2179
takes_options = [ Option('email',
2180
help='display email address only'),
2182
help='set identity for the current branch instead of '
2185
takes_args = ['name?']
2186
encoding_type = 'replace'
2189
def run(self, email=False, branch=False, name=None):
2191
# use branch if we're inside one; otherwise global config
2193
c = Branch.open_containing('.')[0].get_config()
2194
except errors.NotBranchError:
2195
c = config.GlobalConfig()
2197
self.outf.write(c.user_email() + '\n')
2199
self.outf.write(c.username() + '\n')
2202
# display a warning if an email address isn't included in the given name.
2204
config.extract_email_address(name)
2205
except errors.NoEmailInUsername, e:
2206
warning('"%s" does not seem to contain an email address. '
2207
'This is allowed, but not recommended.', name)
2209
# use global config unless --branch given
2211
c = Branch.open_containing('.')[0].get_config()
2213
c = config.GlobalConfig()
2214
c.set_user_option('email', name)
2217
class cmd_nick(Command):
2218
"""Print or set the branch nickname.
2220
If unset, the tree root directory name is used as the nickname
2221
To print the current nickname, execute with no argument.
2223
takes_args = ['nickname?']
2224
def run(self, nickname=None):
2225
branch = Branch.open_containing(u'.')[0]
2226
if nickname is None:
2227
self.printme(branch)
2229
branch.nick = nickname
2232
def printme(self, branch):
2236
class cmd_selftest(Command):
2237
"""Run internal test suite.
2239
This creates temporary test directories in the working directory, but not
2240
existing data is affected. These directories are deleted if the tests
2241
pass, or left behind to help in debugging if they fail and --keep-output
2244
If arguments are given, they are regular expressions that say which tests
2245
should run. Tests matching any expression are run, and other tests are
2248
Alternatively if --first is given, matching tests are run first and then
2249
all other tests are run. This is useful if you have been working in a
2250
particular area, but want to make sure nothing else was broken.
2252
If the global option '--no-plugins' is given, plugins are not loaded
2253
before running the selftests. This has two effects: features provided or
2254
modified by plugins will not be tested, and tests provided by plugins will
2259
run only tests relating to 'ignore'
2260
bzr --no-plugins selftest -v
2261
disable plugins and list tests as they're run
2263
For each test, that needs actual disk access, bzr create their own
2264
subdirectory in the temporary testing directory (testXXXX.tmp).
2265
By default the name of such subdirectory is based on the name of the test.
2266
If option '--numbered-dirs' is given, bzr will use sequent numbers
2267
of running tests to create such subdirectories. This is default behavior
2268
on Windows because of path length limitation.
2270
# TODO: --list should give a list of all available tests
2272
# NB: this is used from the class without creating an instance, which is
2273
# why it does not have a self parameter.
2274
def get_transport_type(typestring):
2275
"""Parse and return a transport specifier."""
2276
if typestring == "sftp":
2277
from bzrlib.transport.sftp import SFTPAbsoluteServer
2278
return SFTPAbsoluteServer
2279
if typestring == "memory":
2280
from bzrlib.transport.memory import MemoryServer
2282
if typestring == "fakenfs":
2283
from bzrlib.transport.fakenfs import FakeNFSServer
2284
return FakeNFSServer
2285
msg = "No known transport type %s. Supported types are: sftp\n" %\
2287
raise errors.BzrCommandError(msg)
2290
takes_args = ['testspecs*']
2291
takes_options = ['verbose',
2292
Option('one', help='stop when one test fails'),
2293
Option('keep-output',
2294
help='keep output directories when tests fail'),
2296
help='Use a different transport by default '
2297
'throughout the test suite.',
2298
type=get_transport_type),
2299
Option('benchmark', help='run the bzr bencharks.'),
2300
Option('lsprof-timed',
2301
help='generate lsprof output for benchmarked'
2302
' sections of code.'),
2303
Option('cache-dir', type=str,
2304
help='a directory to cache intermediate'
2305
' benchmark steps'),
2306
Option('clean-output',
2307
help='clean temporary tests directories'
2308
' without running tests'),
2310
help='run all tests, but run specified tests first',
2312
Option('numbered-dirs',
2313
help='use numbered dirs for TestCaseInTempDir'),
2315
encoding_type = 'replace'
2317
def run(self, testspecs_list=None, verbose=None, one=False,
2318
keep_output=False, transport=None, benchmark=None,
2319
lsprof_timed=None, cache_dir=None, clean_output=False,
2320
first=False, numbered_dirs=None):
2322
from bzrlib.tests import selftest
2323
import bzrlib.benchmarks as benchmarks
2324
from bzrlib.benchmarks import tree_creator
2327
from bzrlib.tests import clean_selftest_output
2328
clean_selftest_output()
2331
if numbered_dirs is None and sys.platform == 'win32':
2332
numbered_dirs = True
2334
if cache_dir is not None:
2335
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2336
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2337
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2339
if testspecs_list is not None:
2340
pattern = '|'.join(testspecs_list)
2344
test_suite_factory = benchmarks.test_suite
2347
# TODO: should possibly lock the history file...
2348
benchfile = open(".perf_history", "at", buffering=1)
2350
test_suite_factory = None
2355
result = selftest(verbose=verbose,
2357
stop_on_failure=one,
2358
keep_output=keep_output,
2359
transport=transport,
2360
test_suite_factory=test_suite_factory,
2361
lsprof_timed=lsprof_timed,
2362
bench_history=benchfile,
2363
matching_tests_first=first,
2364
numbered_dirs=numbered_dirs,
2367
if benchfile is not None:
2370
info('tests passed')
2372
info('tests failed')
2373
return int(not result)
2376
class cmd_version(Command):
2377
"""Show version of bzr."""
2381
from bzrlib.version import show_version
2385
class cmd_rocks(Command):
2386
"""Statement of optimism."""
2392
print "It sure does!"
2395
class cmd_find_merge_base(Command):
2396
"""Find and print a base revision for merging two branches."""
2397
# TODO: Options to specify revisions on either side, as if
2398
# merging only part of the history.
2399
takes_args = ['branch', 'other']
2403
def run(self, branch, other):
2404
from bzrlib.revision import MultipleRevisionSources
2406
branch1 = Branch.open_containing(branch)[0]
2407
branch2 = Branch.open_containing(other)[0]
2409
last1 = branch1.last_revision()
2410
last2 = branch2.last_revision()
2412
source = MultipleRevisionSources(branch1.repository,
2415
base_rev_id = common_ancestor(last1, last2, source)
2417
print 'merge base is revision %s' % base_rev_id
2420
class cmd_merge(Command):
2421
"""Perform a three-way merge.
2423
The branch is the branch you will merge from. By default, it will merge
2424
the latest revision. If you specify a revision, that revision will be
2425
merged. If you specify two revisions, the first will be used as a BASE,
2426
and the second one as OTHER. Revision numbers are always relative to the
2429
By default, bzr will try to merge in all new work from the other
2430
branch, automatically determining an appropriate base. If this
2431
fails, you may need to give an explicit base.
2433
Merge will do its best to combine the changes in two branches, but there
2434
are some kinds of problems only a human can fix. When it encounters those,
2435
it will mark a conflict. A conflict means that you need to fix something,
2436
before you should commit.
2438
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2440
If there is no default branch set, the first merge will set it. After
2441
that, you can omit the branch to use the default. To change the
2442
default, use --remember. The value will only be saved if the remote
2443
location can be accessed.
2445
The results of the merge are placed into the destination working
2446
directory, where they can be reviewed (with bzr diff), tested, and then
2447
committed to record the result of the merge.
2451
To merge the latest revision from bzr.dev
2452
bzr merge ../bzr.dev
2454
To merge changes up to and including revision 82 from bzr.dev
2455
bzr merge -r 82 ../bzr.dev
2457
To merge the changes introduced by 82, without previous changes:
2458
bzr merge -r 81..82 ../bzr.dev
2460
merge refuses to run if there are any uncommitted changes, unless
2463
The following merge types are available:
2465
takes_args = ['branch?']
2466
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2467
Option('show-base', help="Show base revision text in "
2469
Option('uncommitted', help='Apply uncommitted changes'
2470
' from a working copy, instead of branch changes'),
2471
Option('pull', help='If the destination is already'
2472
' completely merged into the source, pull from the'
2473
' source rather than merging. When this happens,'
2474
' you do not need to commit the result.'),
2476
help='Branch to merge into, '
2477
'rather than the one containing the working directory',
2483
def run(self, branch=None, revision=None, force=False, merge_type=None,
2484
show_base=False, reprocess=False, remember=False,
2485
uncommitted=False, pull=False,
2488
from bzrlib.tag import _merge_tags_if_possible
2489
if merge_type is None:
2490
merge_type = _mod_merge.Merge3Merger
2492
if directory is None: directory = u'.'
2493
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2494
# inventory. Because merge is a mutating operation, it really
2495
# should be a lock_write() for the whole cmd_merge operation.
2496
# However, cmd_merge open's its own tree in _merge_helper, which
2497
# means if we lock here, the later lock_write() will always block.
2498
# Either the merge helper code should be updated to take a tree,
2499
# (What about tree.merge_from_branch?)
2500
tree = WorkingTree.open_containing(directory)[0]
2501
change_reporter = delta.ChangeReporter(
2502
unversioned_filter=tree.is_ignored)
2504
if branch is not None:
2506
reader = bundle.read_bundle_from_url(branch)
2507
except errors.NotABundle:
2508
pass # Continue on considering this url a Branch
2510
conflicts = merge_bundle(reader, tree, not force, merge_type,
2511
reprocess, show_base, change_reporter)
2517
if revision is None \
2518
or len(revision) < 1 or revision[0].needs_branch():
2519
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2521
if revision is None or len(revision) < 1:
2524
other = [branch, None]
2527
other = [branch, -1]
2528
other_branch, path = Branch.open_containing(branch)
2531
raise errors.BzrCommandError('Cannot use --uncommitted and'
2532
' --revision at the same time.')
2533
branch = revision[0].get_branch() or branch
2534
if len(revision) == 1:
2536
other_branch, path = Branch.open_containing(branch)
2537
revno = revision[0].in_history(other_branch).revno
2538
other = [branch, revno]
2540
assert len(revision) == 2
2541
if None in revision:
2542
raise errors.BzrCommandError(
2543
"Merge doesn't permit empty revision specifier.")
2544
base_branch, path = Branch.open_containing(branch)
2545
branch1 = revision[1].get_branch() or branch
2546
other_branch, path1 = Branch.open_containing(branch1)
2547
if revision[0].get_branch() is not None:
2548
# then path was obtained from it, and is None.
2551
base = [branch, revision[0].in_history(base_branch).revno]
2552
other = [branch1, revision[1].in_history(other_branch).revno]
2554
if tree.branch.get_parent() is None or remember:
2555
tree.branch.set_parent(other_branch.base)
2557
# pull tags now... it's a bit inconsistent to do it ahead of copying
2558
# the history but that's done inside the merge code
2559
_merge_tags_if_possible(other_branch, tree.branch)
2562
interesting_files = [path]
2564
interesting_files = None
2565
pb = ui.ui_factory.nested_progress_bar()
2568
conflict_count = _merge_helper(
2569
other, base, check_clean=(not force),
2570
merge_type=merge_type,
2571
reprocess=reprocess,
2572
show_base=show_base,
2575
pb=pb, file_list=interesting_files,
2576
change_reporter=change_reporter)
2579
if conflict_count != 0:
2583
except errors.AmbiguousBase, e:
2584
m = ("sorry, bzr can't determine the right merge base yet\n"
2585
"candidates are:\n "
2586
+ "\n ".join(e.bases)
2588
"please specify an explicit base with -r,\n"
2589
"and (if you want) report this to the bzr developers\n")
2592
# TODO: move up to common parent; this isn't merge-specific anymore.
2593
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2594
"""Use tree.branch's parent if none was supplied.
2596
Report if the remembered location was used.
2598
if supplied_location is not None:
2599
return supplied_location
2600
stored_location = tree.branch.get_parent()
2601
mutter("%s", stored_location)
2602
if stored_location is None:
2603
raise errors.BzrCommandError("No location specified or remembered")
2604
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2605
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2606
return stored_location
2609
class cmd_remerge(Command):
2612
Use this if you want to try a different merge technique while resolving
2613
conflicts. Some merge techniques are better than others, and remerge
2614
lets you try different ones on different files.
2616
The options for remerge have the same meaning and defaults as the ones for
2617
merge. The difference is that remerge can (only) be run when there is a
2618
pending merge, and it lets you specify particular files.
2621
$ bzr remerge --show-base
2622
Re-do the merge of all conflicted files, and show the base text in
2623
conflict regions, in addition to the usual THIS and OTHER texts.
2625
$ bzr remerge --merge-type weave --reprocess foobar
2626
Re-do the merge of "foobar", using the weave merge algorithm, with
2627
additional processing to reduce the size of conflict regions.
2629
The following merge types are available:"""
2630
takes_args = ['file*']
2631
takes_options = ['merge-type', 'reprocess',
2632
Option('show-base', help="Show base revision text in "
2635
def run(self, file_list=None, merge_type=None, show_base=False,
2637
if merge_type is None:
2638
merge_type = _mod_merge.Merge3Merger
2639
tree, file_list = tree_files(file_list)
2642
parents = tree.get_parent_ids()
2643
if len(parents) != 2:
2644
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2645
" merges. Not cherrypicking or"
2647
repository = tree.branch.repository
2648
base_revision = common_ancestor(parents[0],
2649
parents[1], repository)
2650
base_tree = repository.revision_tree(base_revision)
2651
other_tree = repository.revision_tree(parents[1])
2652
interesting_ids = None
2654
conflicts = tree.conflicts()
2655
if file_list is not None:
2656
interesting_ids = set()
2657
for filename in file_list:
2658
file_id = tree.path2id(filename)
2660
raise errors.NotVersionedError(filename)
2661
interesting_ids.add(file_id)
2662
if tree.kind(file_id) != "directory":
2665
for name, ie in tree.inventory.iter_entries(file_id):
2666
interesting_ids.add(ie.file_id)
2667
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2669
# Remerge only supports resolving contents conflicts
2670
allowed_conflicts = ('text conflict', 'contents conflict')
2671
restore_files = [c.path for c in conflicts
2672
if c.typestring in allowed_conflicts]
2673
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2674
tree.set_conflicts(ConflictList(new_conflicts))
2675
if file_list is not None:
2676
restore_files = file_list
2677
for filename in restore_files:
2679
restore(tree.abspath(filename))
2680
except errors.NotConflicted:
2682
conflicts = _mod_merge.merge_inner(
2683
tree.branch, other_tree, base_tree,
2685
interesting_ids=interesting_ids,
2686
other_rev_id=parents[1],
2687
merge_type=merge_type,
2688
show_base=show_base,
2689
reprocess=reprocess)
2698
class cmd_revert(Command):
2699
"""Revert files to a previous revision.
2701
Giving a list of files will revert only those files. Otherwise, all files
2702
will be reverted. If the revision is not specified with '--revision', the
2703
last committed revision is used.
2705
To remove only some changes, without reverting to a prior version, use
2706
merge instead. For example, "merge . --r-2..-3" will remove the changes
2707
introduced by -2, without affecting the changes introduced by -1. Or
2708
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2710
By default, any files that have been manually changed will be backed up
2711
first. (Files changed only by merge are not backed up.) Backup files have
2712
'.~#~' appended to their name, where # is a number.
2714
When you provide files, you can use their current pathname or the pathname
2715
from the target revision. So you can use revert to "undelete" a file by
2716
name. If you name a directory, all the contents of that directory will be
2719
takes_options = ['revision', 'no-backup']
2720
takes_args = ['file*']
2721
aliases = ['merge-revert']
2723
def run(self, revision=None, no_backup=False, file_list=None):
2724
if file_list is not None:
2725
if len(file_list) == 0:
2726
raise errors.BzrCommandError("No files specified")
2730
tree, file_list = tree_files(file_list)
2731
if revision is None:
2732
# FIXME should be tree.last_revision
2733
rev_id = tree.last_revision()
2734
elif len(revision) != 1:
2735
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2737
rev_id = revision[0].in_history(tree.branch).rev_id
2738
pb = ui.ui_factory.nested_progress_bar()
2740
tree.revert(file_list,
2741
tree.branch.repository.revision_tree(rev_id),
2742
not no_backup, pb, report_changes=True)
2747
class cmd_assert_fail(Command):
2748
"""Test reporting of assertion failures"""
2749
# intended just for use in testing
2754
raise AssertionError("always fails")
2757
class cmd_help(Command):
2758
"""Show help on a command or other topic.
2760
For a list of all available commands, say 'bzr help commands'.
2762
takes_options = [Option('long', 'show help on all commands')]
2763
takes_args = ['topic?']
2764
aliases = ['?', '--help', '-?', '-h']
2767
def run(self, topic=None, long=False):
2769
if topic is None and long:
2771
bzrlib.help.help(topic)
2774
class cmd_shell_complete(Command):
2775
"""Show appropriate completions for context.
2777
For a list of all available commands, say 'bzr shell-complete'.
2779
takes_args = ['context?']
2784
def run(self, context=None):
2785
import shellcomplete
2786
shellcomplete.shellcomplete(context)
2789
class cmd_fetch(Command):
2790
"""Copy in history from another branch but don't merge it.
2792
This is an internal method used for pull and merge.
2795
takes_args = ['from_branch', 'to_branch']
2796
def run(self, from_branch, to_branch):
2797
from bzrlib.fetch import Fetcher
2798
from_b = Branch.open(from_branch)
2799
to_b = Branch.open(to_branch)
2800
Fetcher(to_b, from_b)
2803
class cmd_missing(Command):
2804
"""Show unmerged/unpulled revisions between two branches.
2806
OTHER_BRANCH may be local or remote.
2808
takes_args = ['other_branch?']
2809
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2811
'Display changes in the local branch only'),
2812
Option('theirs-only',
2813
'Display changes in the remote branch only'),
2818
encoding_type = 'replace'
2821
def run(self, other_branch=None, reverse=False, mine_only=False,
2822
theirs_only=False, log_format=None, long=False, short=False, line=False,
2823
show_ids=False, verbose=False):
2824
from bzrlib.missing import find_unmerged, iter_log_data
2825
from bzrlib.log import log_formatter
2826
local_branch = Branch.open_containing(u".")[0]
2827
parent = local_branch.get_parent()
2828
if other_branch is None:
2829
other_branch = parent
2830
if other_branch is None:
2831
raise errors.BzrCommandError("No peer location known or specified.")
2832
display_url = urlutils.unescape_for_display(parent,
2834
print "Using last location: " + display_url
2836
remote_branch = Branch.open(other_branch)
2837
if remote_branch.base == local_branch.base:
2838
remote_branch = local_branch
2839
local_branch.lock_read()
2841
remote_branch.lock_read()
2843
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2844
if (log_format is None):
2845
log_format = log.log_formatter_registry.get_default(
2847
lf = log_format(to_file=self.outf,
2849
show_timezone='original')
2850
if reverse is False:
2851
local_extra.reverse()
2852
remote_extra.reverse()
2853
if local_extra and not theirs_only:
2854
print "You have %d extra revision(s):" % len(local_extra)
2855
for data in iter_log_data(local_extra, local_branch.repository,
2858
printed_local = True
2860
printed_local = False
2861
if remote_extra and not mine_only:
2862
if printed_local is True:
2864
print "You are missing %d revision(s):" % len(remote_extra)
2865
for data in iter_log_data(remote_extra, remote_branch.repository,
2868
if not remote_extra and not local_extra:
2870
print "Branches are up to date."
2874
remote_branch.unlock()
2876
local_branch.unlock()
2877
if not status_code and parent is None and other_branch is not None:
2878
local_branch.lock_write()
2880
# handle race conditions - a parent might be set while we run.
2881
if local_branch.get_parent() is None:
2882
local_branch.set_parent(remote_branch.base)
2884
local_branch.unlock()
2888
class cmd_plugins(Command):
2893
import bzrlib.plugin
2894
from inspect import getdoc
2895
for name, plugin in bzrlib.plugin.all_plugins().items():
2896
if getattr(plugin, '__path__', None) is not None:
2897
print plugin.__path__[0]
2898
elif getattr(plugin, '__file__', None) is not None:
2899
print plugin.__file__
2905
print '\t', d.split('\n')[0]
2908
class cmd_testament(Command):
2909
"""Show testament (signing-form) of a revision."""
2910
takes_options = ['revision',
2911
Option('long', help='Produce long-format testament'),
2912
Option('strict', help='Produce a strict-format'
2914
takes_args = ['branch?']
2916
def run(self, branch=u'.', revision=None, long=False, strict=False):
2917
from bzrlib.testament import Testament, StrictTestament
2919
testament_class = StrictTestament
2921
testament_class = Testament
2922
b = WorkingTree.open_containing(branch)[0].branch
2925
if revision is None:
2926
rev_id = b.last_revision()
2928
rev_id = revision[0].in_history(b).rev_id
2929
t = testament_class.from_revision(b.repository, rev_id)
2931
sys.stdout.writelines(t.as_text_lines())
2933
sys.stdout.write(t.as_short_text())
2938
class cmd_annotate(Command):
2939
"""Show the origin of each line in a file.
2941
This prints out the given file with an annotation on the left side
2942
indicating which revision, author and date introduced the change.
2944
If the origin is the same for a run of consecutive lines, it is
2945
shown only at the top, unless the --all option is given.
2947
# TODO: annotate directories; showing when each file was last changed
2948
# TODO: if the working copy is modified, show annotations on that
2949
# with new uncommitted lines marked
2950
aliases = ['ann', 'blame', 'praise']
2951
takes_args = ['filename']
2952
takes_options = [Option('all', help='show annotations on all lines'),
2953
Option('long', help='show date in annotations'),
2959
def run(self, filename, all=False, long=False, revision=None,
2961
from bzrlib.annotate import annotate_file
2962
tree, relpath = WorkingTree.open_containing(filename)
2963
branch = tree.branch
2966
if revision is None:
2967
revision_id = branch.last_revision()
2968
elif len(revision) != 1:
2969
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2971
revision_id = revision[0].in_history(branch).rev_id
2972
file_id = tree.path2id(relpath)
2973
tree = branch.repository.revision_tree(revision_id)
2974
file_version = tree.inventory[file_id].revision
2975
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2981
class cmd_re_sign(Command):
2982
"""Create a digital signature for an existing revision."""
2983
# TODO be able to replace existing ones.
2985
hidden = True # is this right ?
2986
takes_args = ['revision_id*']
2987
takes_options = ['revision']
2989
def run(self, revision_id_list=None, revision=None):
2990
import bzrlib.gpg as gpg
2991
if revision_id_list is not None and revision is not None:
2992
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2993
if revision_id_list is None and revision is None:
2994
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2995
b = WorkingTree.open_containing(u'.')[0].branch
2996
gpg_strategy = gpg.GPGStrategy(b.get_config())
2997
if revision_id_list is not None:
2998
for revision_id in revision_id_list:
2999
b.repository.sign_revision(revision_id, gpg_strategy)
3000
elif revision is not None:
3001
if len(revision) == 1:
3002
revno, rev_id = revision[0].in_history(b)
3003
b.repository.sign_revision(rev_id, gpg_strategy)
3004
elif len(revision) == 2:
3005
# are they both on rh- if so we can walk between them
3006
# might be nice to have a range helper for arbitrary
3007
# revision paths. hmm.
3008
from_revno, from_revid = revision[0].in_history(b)
3009
to_revno, to_revid = revision[1].in_history(b)
3010
if to_revid is None:
3011
to_revno = b.revno()
3012
if from_revno is None or to_revno is None:
3013
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3014
for revno in range(from_revno, to_revno + 1):
3015
b.repository.sign_revision(b.get_rev_id(revno),
3018
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3021
class cmd_bind(Command):
3022
"""Convert the current branch into a checkout of the supplied branch.
3024
Once converted into a checkout, commits must succeed on the master branch
3025
before they will be applied to the local branch.
3027
See "help checkouts" for more information on checkouts.
3030
takes_args = ['location?']
3033
def run(self, location=None):
3034
b, relpath = Branch.open_containing(u'.')
3035
if location is None:
3037
location = b.get_old_bound_location()
3038
except errors.UpgradeRequired:
3039
raise errors.BzrCommandError('No location supplied. '
3040
'This format does not remember old locations.')
3042
if location is None:
3043
raise errors.BzrCommandError('No location supplied and no '
3044
'previous location known')
3045
b_other = Branch.open(location)
3048
except errors.DivergedBranches:
3049
raise errors.BzrCommandError('These branches have diverged.'
3050
' Try merging, and then bind again.')
3053
class cmd_unbind(Command):
3054
"""Convert the current checkout into a regular branch.
3056
After unbinding, the local branch is considered independent and subsequent
3057
commits will be local only.
3059
See "help checkouts" for more information on checkouts.
3066
b, relpath = Branch.open_containing(u'.')
3068
raise errors.BzrCommandError('Local branch is not bound')
3071
class cmd_uncommit(Command):
3072
"""Remove the last committed revision.
3074
--verbose will print out what is being removed.
3075
--dry-run will go through all the motions, but not actually
3078
In the future, uncommit will create a revision bundle, which can then
3082
# TODO: jam 20060108 Add an option to allow uncommit to remove
3083
# unreferenced information in 'branch-as-repository' branches.
3084
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3085
# information in shared branches as well.
3086
takes_options = ['verbose', 'revision',
3087
Option('dry-run', help='Don\'t actually make changes'),
3088
Option('force', help='Say yes to all questions.')]
3089
takes_args = ['location?']
3092
def run(self, location=None,
3093
dry_run=False, verbose=False,
3094
revision=None, force=False):
3095
from bzrlib.log import log_formatter, show_log
3097
from bzrlib.uncommit import uncommit
3099
if location is None:
3101
control, relpath = bzrdir.BzrDir.open_containing(location)
3103
tree = control.open_workingtree()
3105
except (errors.NoWorkingTree, errors.NotLocalUrl):
3107
b = control.open_branch()
3110
if revision is None:
3113
# 'bzr uncommit -r 10' actually means uncommit
3114
# so that the final tree is at revno 10.
3115
# but bzrlib.uncommit.uncommit() actually uncommits
3116
# the revisions that are supplied.
3117
# So we need to offset it by one
3118
revno = revision[0].in_history(b).revno+1
3120
if revno <= b.revno():
3121
rev_id = b.get_rev_id(revno)
3123
self.outf.write('No revisions to uncommit.\n')
3126
lf = log_formatter('short',
3128
show_timezone='original')
3133
direction='forward',
3134
start_revision=revno,
3135
end_revision=b.revno())
3138
print 'Dry-run, pretending to remove the above revisions.'
3140
val = raw_input('Press <enter> to continue')
3142
print 'The above revision(s) will be removed.'
3144
val = raw_input('Are you sure [y/N]? ')
3145
if val.lower() not in ('y', 'yes'):
3149
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3153
class cmd_break_lock(Command):
3154
"""Break a dead lock on a repository, branch or working directory.
3156
CAUTION: Locks should only be broken when you are sure that the process
3157
holding the lock has been stopped.
3159
You can get information on what locks are open via the 'bzr info' command.
3164
takes_args = ['location?']
3166
def run(self, location=None, show=False):
3167
if location is None:
3169
control, relpath = bzrdir.BzrDir.open_containing(location)
3171
control.break_lock()
3172
except NotImplementedError:
3176
class cmd_wait_until_signalled(Command):
3177
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3179
This just prints a line to signal when it is ready, then blocks on stdin.
3185
sys.stdout.write("running\n")
3187
sys.stdin.readline()
3190
class cmd_serve(Command):
3191
"""Run the bzr server."""
3193
aliases = ['server']
3197
help='serve on stdin/out for use from inetd or sshd'),
3199
help='listen for connections on nominated port of the form '
3200
'[hostname:]portnumber. Passing 0 as the port number will '
3201
'result in a dynamically allocated port. Default port is '
3205
help='serve contents of directory',
3207
Option('allow-writes',
3208
help='By default the server is a readonly server. Supplying '
3209
'--allow-writes enables write access to the contents of '
3210
'the served directory and below. '
3214
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3215
from bzrlib.transport import smart
3216
from bzrlib.transport import get_transport
3217
if directory is None:
3218
directory = os.getcwd()
3219
url = urlutils.local_path_to_url(directory)
3220
if not allow_writes:
3221
url = 'readonly+' + url
3222
t = get_transport(url)
3224
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3227
port = smart.BZR_DEFAULT_PORT
3231
host, port = port.split(':')
3235
server = smart.SmartTCPServer(t, host=host, port=port)
3236
print 'listening on port: ', server.port
3240
class cmd_join(Command):
3241
"""Combine a subtree into its containing tree.
3243
This is marked as a merge of the subtree into the containing tree, and all
3244
history is preserved.
3247
takes_args = ['tree']
3248
takes_options = [Option('reference', 'join by reference')]
3250
def run(self, tree, reference=False):
3251
sub_tree = WorkingTree.open(tree)
3252
parent_dir = osutils.dirname(sub_tree.basedir)
3253
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3254
repo = containing_tree.branch.repository
3255
if not repo.supports_rich_root():
3256
raise errors.BzrCommandError(
3257
"Can't join trees because %s doesn't support rich root data.\n"
3258
"You can use bzr upgrade on the repository."
3262
containing_tree.add_reference(sub_tree)
3263
except errors.BadReferenceTarget, e:
3264
# XXX: Would be better to just raise a nicely printable
3265
# exception from the real origin. Also below. mbp 20070306
3266
raise errors.BzrCommandError("Cannot join %s. %s" %
3270
containing_tree.subsume(sub_tree)
3271
except errors.BadSubsumeSource, e:
3272
raise errors.BzrCommandError("Cannot join %s. %s" %
3276
class cmd_split(Command):
3277
"""Split a tree into two trees.
3280
takes_args = ['tree']
3282
def run(self, tree):
3283
containing_tree, subdir = WorkingTree.open_containing(tree)
3284
sub_id = containing_tree.path2id(subdir)
3286
raise errors.NotVersionedError(subdir)
3288
containing_tree.extract(sub_id)
3289
except errors.RootNotRich:
3290
raise errors.UpgradeRequired(containing_tree.branch.base)
3294
class cmd_tag(Command):
3295
"""Create a tag naming a revision.
3297
Tags give human-meaningful names to revisions. Commands that take a -r
3298
(--revision) option can be given -rtag:X, where X is any previously
3301
Tags are stored in the branch. Tags are copied from one branch to another
3302
along when you branch, push, pull or merge.
3304
It is an error to give a tag name that already exists unless you pass
3305
--force, in which case the tag is moved to point to the new revision.
3308
takes_args = ['tag_name']
3311
help='Delete this tag rather than placing it.',
3314
help='Branch in which to place the tag.',
3319
help='Replace existing tags',
3324
def run(self, tag_name,
3330
branch, relpath = Branch.open_containing(directory)
3334
branch.tags.delete_tag(tag_name)
3335
self.outf.write('Deleted tag %s.\n' % tag_name)
3338
if len(revision) != 1:
3339
raise errors.BzrCommandError(
3340
"Tags can only be placed on a single revision, "
3342
revision_id = revision[0].in_history(branch).rev_id
3344
revision_id = branch.last_revision()
3345
if (not force) and branch.tags.has_tag(tag_name):
3346
raise errors.TagAlreadyExists(tag_name)
3347
branch.tags.set_tag(tag_name, revision_id)
3348
self.outf.write('Created tag %s.\n' % tag_name)
3353
class cmd_tags(Command):
3356
This tag shows a table of tag names and the revisions they reference.
3361
help='Branch whose tags should be displayed',
3371
branch, relpath = Branch.open_containing(directory)
3372
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3373
self.outf.write('%-20s %s\n' % (tag_name, target))
3376
# command-line interpretation helper for merge-related commands
3377
def _merge_helper(other_revision, base_revision,
3378
check_clean=True, ignore_zero=False,
3379
this_dir=None, backup_files=False,
3381
file_list=None, show_base=False, reprocess=False,
3384
change_reporter=None):
3385
"""Merge changes into a tree.
3388
list(path, revno) Base for three-way merge.
3389
If [None, None] then a base will be automatically determined.
3391
list(path, revno) Other revision for three-way merge.
3393
Directory to merge changes into; '.' by default.
3395
If true, this_dir must have no uncommitted changes before the
3397
ignore_zero - If true, suppress the "zero conflicts" message when
3398
there are no conflicts; should be set when doing something we expect
3399
to complete perfectly.
3400
file_list - If supplied, merge only changes to selected files.
3402
All available ancestors of other_revision and base_revision are
3403
automatically pulled into the branch.
3405
The revno may be -1 to indicate the last revision on the branch, which is
3408
This function is intended for use from the command line; programmatic
3409
clients might prefer to call merge.merge_inner(), which has less magic
3412
# Loading it late, so that we don't always have to import bzrlib.merge
3413
if merge_type is None:
3414
merge_type = _mod_merge.Merge3Merger
3415
if this_dir is None:
3417
this_tree = WorkingTree.open_containing(this_dir)[0]
3418
if show_base and not merge_type is _mod_merge.Merge3Merger:
3419
raise errors.BzrCommandError("Show-base is not supported for this merge"
3420
" type. %s" % merge_type)
3421
if reprocess and not merge_type.supports_reprocess:
3422
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3423
" type %s." % merge_type)
3424
if reprocess and show_base:
3425
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3426
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3427
# only want to take out a lock_tree_write() if we don't have to pull
3428
# any ancestry. But merge might fetch ancestry in the middle, in
3429
# which case we would need a lock_write().
3430
# Because we cannot upgrade locks, for now we live with the fact that
3431
# the tree will be locked multiple times during a merge. (Maybe
3432
# read-only some of the time, but it means things will get read
3435
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3436
pb=pb, change_reporter=change_reporter)
3437
merger.pp = ProgressPhase("Merge phase", 5, pb)
3438
merger.pp.next_phase()
3439
merger.check_basis(check_clean)
3440
merger.set_other(other_revision)
3441
merger.pp.next_phase()
3442
merger.set_base(base_revision)
3443
if merger.base_rev_id == merger.other_rev_id:
3444
note('Nothing to do.')
3446
if file_list is None:
3447
if pull and merger.base_rev_id == merger.this_rev_id:
3448
# FIXME: deduplicate with pull
3449
result = merger.this_tree.pull(merger.this_branch,
3450
False, merger.other_rev_id)
3451
if result.old_revid == result.new_revid:
3452
note('No revisions to pull.')
3454
note('Now on revision %d.' % result.new_revno)
3456
merger.backup_files = backup_files
3457
merger.merge_type = merge_type
3458
merger.set_interesting_files(file_list)
3459
merger.show_base = show_base
3460
merger.reprocess = reprocess
3461
conflicts = merger.do_merge()
3462
if file_list is None:
3463
merger.set_pending()
3470
merge = _merge_helper
3473
# these get imported and then picked up by the scan for cmd_*
3474
# TODO: Some more consistent way to split command definitions across files;
3475
# we do need to load at least some information about them to know of
3476
# aliases. ideally we would avoid loading the implementation until the
3477
# details were needed.
3478
from bzrlib.cmd_version_info import cmd_version_info
3479
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3480
from bzrlib.bundle.commands import cmd_bundle_revisions
3481
from bzrlib.sign_my_commits import cmd_sign_my_commits
3482
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3483
cmd_weave_plan_merge, cmd_weave_merge_text