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
Option('versioned', help='Only show versioned files')]
183
aliases = ['st', 'stat']
185
encoding_type = 'replace'
188
def run(self, show_ids=False, file_list=None, revision=None, short=False,
190
from bzrlib.status import show_tree_status
192
tree, file_list = tree_files(file_list)
194
show_tree_status(tree, show_ids=show_ids,
195
specific_files=file_list, revision=revision,
196
to_file=self.outf, short=short, versioned=versioned)
199
class cmd_cat_revision(Command):
200
"""Write out metadata for a revision.
202
The revision to print can either be specified by a specific
203
revision identifier, or you can use --revision.
207
takes_args = ['revision_id?']
208
takes_options = ['revision']
209
# cat-revision is more for frontends so should be exact
213
def run(self, revision_id=None, revision=None):
215
if revision_id is not None and revision is not None:
216
raise errors.BzrCommandError('You can only supply one of'
217
' revision_id or --revision')
218
if revision_id is None and revision is None:
219
raise errors.BzrCommandError('You must supply either'
220
' --revision or a revision_id')
221
b = WorkingTree.open_containing(u'.')[0].branch
223
# TODO: jam 20060112 should cat-revision always output utf-8?
224
if revision_id is not None:
225
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
226
elif revision is not None:
229
raise errors.BzrCommandError('You cannot specify a NULL'
231
revno, rev_id = rev.in_history(b)
232
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
235
class cmd_remove_tree(Command):
236
"""Remove the working tree from a given branch/checkout.
238
Since a lightweight checkout is little more than a working tree
239
this will refuse to run against one.
242
takes_args = ['location?']
244
def run(self, location='.'):
245
d = bzrdir.BzrDir.open(location)
248
working = d.open_workingtree()
249
except errors.NoWorkingTree:
250
raise errors.BzrCommandError("No working tree to remove")
251
except errors.NotLocalUrl:
252
raise errors.BzrCommandError("You cannot remove the working tree of a "
255
working_path = working.bzrdir.root_transport.base
256
branch_path = working.branch.bzrdir.root_transport.base
257
if working_path != branch_path:
258
raise errors.BzrCommandError("You cannot remove the working tree from "
259
"a lightweight checkout")
261
d.destroy_workingtree()
264
class cmd_revno(Command):
265
"""Show current revision number.
267
This is equal to the number of revisions on this branch.
270
takes_args = ['location?']
273
def run(self, location=u'.'):
274
self.outf.write(str(Branch.open_containing(location)[0].revno()))
275
self.outf.write('\n')
278
class cmd_revision_info(Command):
279
"""Show revision number and revision id for a given revision identifier.
282
takes_args = ['revision_info*']
283
takes_options = ['revision']
286
def run(self, revision=None, revision_info_list=[]):
289
if revision is not None:
290
revs.extend(revision)
291
if revision_info_list is not None:
292
for rev in revision_info_list:
293
revs.append(RevisionSpec.from_string(rev))
295
raise errors.BzrCommandError('You must supply a revision identifier')
297
b = WorkingTree.open_containing(u'.')[0].branch
300
revinfo = rev.in_history(b)
301
if revinfo.revno is None:
302
print ' %s' % revinfo.rev_id
304
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
307
class cmd_add(Command):
308
"""Add specified files or directories.
310
In non-recursive mode, all the named items are added, regardless
311
of whether they were previously ignored. A warning is given if
312
any of the named files are already versioned.
314
In recursive mode (the default), files are treated the same way
315
but the behaviour for directories is different. Directories that
316
are already versioned do not give a warning. All directories,
317
whether already versioned or not, are searched for files or
318
subdirectories that are neither versioned or ignored, and these
319
are added. This search proceeds recursively into versioned
320
directories. If no names are given '.' is assumed.
322
Therefore simply saying 'bzr add' will version all files that
323
are currently unknown.
325
Adding a file whose parent directory is not versioned will
326
implicitly add the parent, and so on up to the root. This means
327
you should never need to explicitly add a directory, they'll just
328
get added when you add a file in the directory.
330
--dry-run will show which files would be added, but not actually
333
--file-ids-from will try to use the file ids from the supplied path.
334
It looks up ids trying to find a matching parent directory with the
335
same filename, and then by pure path.
337
takes_args = ['file*']
338
takes_options = ['no-recurse', 'dry-run', 'verbose',
339
Option('file-ids-from', type=unicode,
340
help='Lookup file ids from here')]
341
encoding_type = 'replace'
343
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
348
if file_ids_from is not None:
350
base_tree, base_path = WorkingTree.open_containing(
352
except errors.NoWorkingTree:
353
base_branch, base_path = Branch.open_containing(
355
base_tree = base_branch.basis_tree()
357
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
358
to_file=self.outf, should_print=(not is_quiet()))
360
action = bzrlib.add.AddAction(to_file=self.outf,
361
should_print=(not is_quiet()))
364
base_tree.lock_read()
366
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
367
action=action, save=not dry_run)
369
if base_tree is not None:
373
for glob in sorted(ignored.keys()):
374
for path in ignored[glob]:
375
self.outf.write("ignored %s matching \"%s\"\n"
379
for glob, paths in ignored.items():
380
match_len += len(paths)
381
self.outf.write("ignored %d file(s).\n" % match_len)
382
self.outf.write("If you wish to add some of these files,"
383
" please add them by name.\n")
386
class cmd_mkdir(Command):
387
"""Create a new versioned directory.
389
This is equivalent to creating the directory and then adding it.
392
takes_args = ['dir+']
393
encoding_type = 'replace'
395
def run(self, dir_list):
398
wt, dd = WorkingTree.open_containing(d)
400
self.outf.write('added %s\n' % d)
403
class cmd_relpath(Command):
404
"""Show path of a file relative to root"""
406
takes_args = ['filename']
410
def run(self, filename):
411
# TODO: jam 20050106 Can relpath return a munged path if
412
# sys.stdout encoding cannot represent it?
413
tree, relpath = WorkingTree.open_containing(filename)
414
self.outf.write(relpath)
415
self.outf.write('\n')
418
class cmd_inventory(Command):
419
"""Show inventory of the current working copy or a revision.
421
It is possible to limit the output to a particular entry
422
type using the --kind option. For example: --kind file.
424
It is also possible to restrict the list of files to a specific
425
set. For example: bzr inventory --show-ids this/file
432
takes_options = ['revision', 'show-ids', 'kind']
434
takes_args = ['file*']
437
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
438
if kind and kind not in ['file', 'directory', 'symlink']:
439
raise errors.BzrCommandError('invalid kind specified')
441
work_tree, file_list = tree_files(file_list)
442
work_tree.lock_read()
444
if revision is not None:
445
if len(revision) > 1:
446
raise errors.BzrCommandError(
447
'bzr inventory --revision takes exactly one revision'
449
revision_id = revision[0].in_history(work_tree.branch).rev_id
450
tree = work_tree.branch.repository.revision_tree(revision_id)
452
extra_trees = [work_tree]
458
if file_list is not None:
459
file_ids = tree.paths2ids(file_list, trees=extra_trees,
460
require_versioned=True)
461
# find_ids_across_trees may include some paths that don't
463
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
464
for file_id in file_ids if file_id in tree)
466
entries = tree.inventory.entries()
469
if tree is not work_tree:
472
for path, entry in entries:
473
if kind and kind != entry.kind:
476
self.outf.write('%-50s %s\n' % (path, entry.file_id))
478
self.outf.write(path)
479
self.outf.write('\n')
482
class cmd_mv(Command):
483
"""Move or rename a file.
486
bzr mv OLDNAME NEWNAME
487
bzr mv SOURCE... DESTINATION
489
If the last argument is a versioned directory, all the other names
490
are moved into it. Otherwise, there must be exactly two arguments
491
and the file is changed to a new name.
493
If OLDNAME does not exist on the filesystem but is versioned and
494
NEWNAME does exist on the filesystem but is not versioned, mv
495
assumes that the file has been manually moved and only updates
496
its internal inventory to reflect that change.
497
The same is valid when moving many SOURCE files to a DESTINATION.
499
Files cannot be moved between branches.
502
takes_args = ['names*']
503
takes_options = [Option("after", help="move only the bzr identifier"
504
" of the file (file has already been moved). Use this flag if"
505
" bzr is not able to detect this itself.")]
506
aliases = ['move', 'rename']
507
encoding_type = 'replace'
509
def run(self, names_list, after=False):
510
if names_list is None:
513
if len(names_list) < 2:
514
raise errors.BzrCommandError("missing file argument")
515
tree, rel_names = tree_files(names_list)
517
if os.path.isdir(names_list[-1]):
518
# move into existing directory
519
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
520
self.outf.write("%s => %s\n" % pair)
522
if len(names_list) != 2:
523
raise errors.BzrCommandError('to mv multiple files the'
524
' destination must be a versioned'
526
tree.rename_one(rel_names[0], rel_names[1], after=after)
527
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
530
class cmd_pull(Command):
531
"""Turn this branch into a mirror of another branch.
533
This command only works on branches that have not diverged. Branches are
534
considered diverged if the destination branch's most recent commit is one
535
that has not been merged (directly or indirectly) into the parent.
537
If branches have diverged, you can use 'bzr merge' to integrate the changes
538
from one into the other. Once one branch has merged, the other should
539
be able to pull it again.
541
If you want to forget your local changes and just update your branch to
542
match the remote one, use pull --overwrite.
544
If there is no default location set, the first pull will set it. After
545
that, you can omit the location to use the default. To change the
546
default, use --remember. The value will only be saved if the remote
547
location can be accessed.
550
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
552
help='branch to pull into, '
553
'rather than the one containing the working directory',
558
takes_args = ['location?']
559
encoding_type = 'replace'
561
def run(self, location=None, remember=False, overwrite=False,
562
revision=None, verbose=False,
564
from bzrlib.tag import _merge_tags_if_possible
565
# FIXME: too much stuff is in the command class
566
if directory is None:
569
tree_to = WorkingTree.open_containing(directory)[0]
570
branch_to = tree_to.branch
571
except errors.NoWorkingTree:
573
branch_to = Branch.open_containing(directory)[0]
576
if location is not None:
578
reader = bundle.read_bundle_from_url(location)
579
except errors.NotABundle:
580
pass # Continue on considering this url a Branch
582
stored_loc = branch_to.get_parent()
584
if stored_loc is None:
585
raise errors.BzrCommandError("No pull location known or"
588
display_url = urlutils.unescape_for_display(stored_loc,
590
self.outf.write("Using saved location: %s\n" % display_url)
591
location = stored_loc
593
if reader is not None:
594
install_bundle(branch_to.repository, reader)
595
branch_from = branch_to
597
branch_from = Branch.open(location)
599
if branch_to.get_parent() is None or remember:
600
branch_to.set_parent(branch_from.base)
604
if reader is not None:
605
rev_id = reader.target
606
elif len(revision) == 1:
607
rev_id = revision[0].in_history(branch_from).rev_id
609
raise errors.BzrCommandError('bzr pull --revision takes one value.')
611
old_rh = branch_to.revision_history()
612
if tree_to is not None:
613
result = tree_to.pull(branch_from, overwrite, rev_id,
614
delta.ChangeReporter(unversioned_filter=tree_to.is_ignored))
616
result = branch_to.pull(branch_from, overwrite, rev_id)
618
result.report(self.outf)
620
from bzrlib.log import show_changed_revisions
621
new_rh = branch_to.revision_history()
622
show_changed_revisions(branch_to, old_rh, new_rh, to_file=self.outf)
625
class cmd_push(Command):
626
"""Update a mirror of this branch.
628
The target branch will not have its working tree populated because this
629
is both expensive, and is not supported on remote file systems.
631
Some smart servers or protocols *may* put the working tree in place in
634
This command only works on branches that have not diverged. Branches are
635
considered diverged if the destination branch's most recent commit is one
636
that has not been merged (directly or indirectly) by the source branch.
638
If branches have diverged, you can use 'bzr push --overwrite' to replace
639
the other branch completely, discarding its unmerged changes.
641
If you want to ensure you have the different changes in the other branch,
642
do a merge (see bzr help merge) from the other branch, and commit that.
643
After that you will be able to do a push without '--overwrite'.
645
If there is no default push location set, the first push will set it.
646
After that, you can omit the location to use the default. To change the
647
default, use --remember. The value will only be saved if the remote
648
location can be accessed.
651
takes_options = ['remember', 'overwrite', 'verbose',
652
Option('create-prefix',
653
help='Create the path leading up to the branch '
654
'if it does not already exist'),
656
help='branch to push from, '
657
'rather than the one containing the working directory',
661
Option('use-existing-dir',
662
help='By default push will fail if the target'
663
' directory exists, but does not already'
664
' have a control directory. This flag will'
665
' allow push to proceed.'),
667
takes_args = ['location?']
668
encoding_type = 'replace'
670
def run(self, location=None, remember=False, overwrite=False,
671
create_prefix=False, verbose=False,
672
use_existing_dir=False,
674
# FIXME: Way too big! Put this into a function called from the
676
if directory is None:
678
br_from = Branch.open_containing(directory)[0]
679
stored_loc = br_from.get_push_location()
681
if stored_loc is None:
682
raise errors.BzrCommandError("No push location known or specified.")
684
display_url = urlutils.unescape_for_display(stored_loc,
686
self.outf.write("Using saved location: %s\n" % display_url)
687
location = stored_loc
689
to_transport = transport.get_transport(location)
690
location_url = to_transport.base
692
br_to = repository_to = dir_to = None
694
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
695
except errors.NotBranchError:
696
pass # Didn't find anything
698
# If we can open a branch, use its direct repository, otherwise see
699
# if there is a repository without a branch.
701
br_to = dir_to.open_branch()
702
except errors.NotBranchError:
703
# Didn't find a branch, can we find a repository?
705
repository_to = dir_to.find_repository()
706
except errors.NoRepositoryPresent:
709
# Found a branch, so we must have found a repository
710
repository_to = br_to.repository
714
# The destination doesn't exist; create it.
715
# XXX: Refactor the create_prefix/no_create_prefix code into a
716
# common helper function
718
to_transport.mkdir('.')
719
except errors.FileExists:
720
if not use_existing_dir:
721
raise errors.BzrCommandError("Target directory %s"
722
" already exists, but does not have a valid .bzr"
723
" directory. Supply --use-existing-dir to push"
724
" there anyway." % location)
725
except errors.NoSuchFile:
726
if not create_prefix:
727
raise errors.BzrCommandError("Parent directory of %s"
729
"\nYou may supply --create-prefix to create all"
730
" leading parent directories."
733
cur_transport = to_transport
734
needed = [cur_transport]
735
# Recurse upwards until we can create a directory successfully
737
new_transport = cur_transport.clone('..')
738
if new_transport.base == cur_transport.base:
739
raise errors.BzrCommandError("Failed to create path"
743
new_transport.mkdir('.')
744
except errors.NoSuchFile:
745
needed.append(new_transport)
746
cur_transport = new_transport
750
# Now we only need to create child directories
752
cur_transport = needed.pop()
753
cur_transport.mkdir('.')
755
# Now the target directory exists, but doesn't have a .bzr
756
# directory. So we need to create it, along with any work to create
757
# all of the dependent branches, etc.
758
dir_to = br_from.bzrdir.clone(location_url,
759
revision_id=br_from.last_revision())
760
br_to = dir_to.open_branch()
761
# TODO: Some more useful message about what was copied
762
note('Created new branch.')
763
# We successfully created the target, remember it
764
if br_from.get_push_location() is None or remember:
765
br_from.set_push_location(br_to.base)
766
elif repository_to is None:
767
# we have a bzrdir but no branch or repository
768
# XXX: Figure out what to do other than complain.
769
raise errors.BzrCommandError("At %s you have a valid .bzr control"
770
" directory, but not a branch or repository. This is an"
771
" unsupported configuration. Please move the target directory"
772
" out of the way and try again."
775
# We have a repository but no branch, copy the revisions, and then
777
last_revision_id = br_from.last_revision()
778
repository_to.fetch(br_from.repository,
779
revision_id=last_revision_id)
780
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
781
note('Created new branch.')
782
if br_from.get_push_location() is None or remember:
783
br_from.set_push_location(br_to.base)
784
else: # We have a valid to branch
785
# We were able to connect to the remote location, so remember it
786
# we don't need to successfully push because of possible divergence.
787
if br_from.get_push_location() is None or remember:
788
br_from.set_push_location(br_to.base)
789
old_rh = br_to.revision_history()
792
tree_to = dir_to.open_workingtree()
793
except errors.NotLocalUrl:
794
warning('This transport does not update the working '
795
'tree of: %s' % (br_to.base,))
796
push_result = br_from.push(br_to, overwrite)
797
except errors.NoWorkingTree:
798
push_result = br_from.push(br_to, overwrite)
802
push_result = br_from.push(tree_to.branch, overwrite)
806
except errors.DivergedBranches:
807
raise errors.BzrCommandError('These branches have diverged.'
808
' Try using "merge" and then "push".')
809
if push_result is not None:
810
push_result.report(self.outf)
812
new_rh = br_to.revision_history()
815
from bzrlib.log import show_changed_revisions
816
show_changed_revisions(br_to, old_rh, new_rh,
819
# we probably did a clone rather than a push, so a message was
824
class cmd_branch(Command):
825
"""Create a new copy of a branch.
827
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
828
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
830
To retrieve the branch as of a particular revision, supply the --revision
831
parameter, as in "branch foo/bar -r 5".
833
--basis is to speed up branching from remote branches. When specified, it
834
copies all the file-contents, inventory and revision data from the basis
835
branch before copying anything from the remote branch.
837
takes_args = ['from_location', 'to_location?']
838
takes_options = ['revision', 'basis']
839
aliases = ['get', 'clone']
841
def run(self, from_location, to_location=None, revision=None, basis=None):
842
from bzrlib.tag import _merge_tags_if_possible
845
elif len(revision) > 1:
846
raise errors.BzrCommandError(
847
'bzr branch --revision takes exactly 1 revision value')
849
br_from = Branch.open(from_location)
852
if basis is not None:
853
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
856
if len(revision) == 1 and revision[0] is not None:
857
revision_id = revision[0].in_history(br_from)[1]
859
# FIXME - wt.last_revision, fallback to branch, fall back to
860
# None or perhaps NULL_REVISION to mean copy nothing
862
revision_id = br_from.last_revision()
863
if to_location is None:
864
to_location = os.path.basename(from_location.rstrip("/\\"))
867
name = os.path.basename(to_location) + '\n'
869
to_transport = transport.get_transport(to_location)
871
to_transport.mkdir('.')
872
except errors.FileExists:
873
raise errors.BzrCommandError('Target directory "%s" already'
874
' exists.' % to_location)
875
except errors.NoSuchFile:
876
raise errors.BzrCommandError('Parent of "%s" does not exist.'
879
# preserve whatever source format we have.
880
dir = br_from.bzrdir.sprout(to_transport.base,
881
revision_id, basis_dir)
882
branch = dir.open_branch()
883
except errors.NoSuchRevision:
884
to_transport.delete_tree('.')
885
msg = "The branch %s has no revision %s." % (from_location, revision[0])
886
raise errors.BzrCommandError(msg)
887
except errors.UnlistableBranch:
888
osutils.rmtree(to_location)
889
msg = "The branch %s cannot be used as a --basis" % (basis,)
890
raise errors.BzrCommandError(msg)
892
branch.control_files.put_utf8('branch-name', name)
893
_merge_tags_if_possible(br_from, branch)
894
note('Branched %d revision(s).' % branch.revno())
899
class cmd_checkout(Command):
900
"""Create a new checkout of an existing branch.
902
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
903
the branch found in '.'. This is useful if you have removed the working tree
904
or if it was never created - i.e. if you pushed the branch to its current
907
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
908
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
910
To retrieve the branch as of a particular revision, supply the --revision
911
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
912
out of date [so you cannot commit] but it may be useful (i.e. to examine old
915
--basis is to speed up checking out from remote branches. When specified, it
916
uses the inventory and file contents from the basis branch in preference to the
917
branch being checked out.
919
See "help checkouts" for more information on checkouts.
921
takes_args = ['branch_location?', 'to_location?']
922
takes_options = ['revision', # , 'basis']
923
Option('lightweight',
924
help="perform a lightweight checkout. Lightweight "
925
"checkouts depend on access to the branch for "
926
"every operation. Normal checkouts can perform "
927
"common operations like diff and status without "
928
"such access, and also support local commits."
933
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
937
elif len(revision) > 1:
938
raise errors.BzrCommandError(
939
'bzr checkout --revision takes exactly 1 revision value')
940
if branch_location is None:
941
branch_location = osutils.getcwd()
942
to_location = branch_location
943
source = Branch.open(branch_location)
944
if len(revision) == 1 and revision[0] is not None:
945
revision_id = revision[0].in_history(source)[1]
948
if to_location is None:
949
to_location = os.path.basename(branch_location.rstrip("/\\"))
950
# if the source and to_location are the same,
951
# and there is no working tree,
952
# then reconstitute a branch
953
if (osutils.abspath(to_location) ==
954
osutils.abspath(branch_location)):
956
source.bzrdir.open_workingtree()
957
except errors.NoWorkingTree:
958
source.bzrdir.create_workingtree()
961
os.mkdir(to_location)
963
if e.errno == errno.EEXIST:
964
raise errors.BzrCommandError('Target directory "%s" already'
965
' exists.' % to_location)
966
if e.errno == errno.ENOENT:
967
raise errors.BzrCommandError('Parent of "%s" does not exist.'
971
source.create_checkout(to_location, revision_id, lightweight)
974
class cmd_renames(Command):
975
"""Show list of renamed files.
977
# TODO: Option to show renames between two historical versions.
979
# TODO: Only show renames under dir, rather than in the whole branch.
980
takes_args = ['dir?']
983
def run(self, dir=u'.'):
984
tree = WorkingTree.open_containing(dir)[0]
987
new_inv = tree.inventory
988
old_tree = tree.basis_tree()
991
old_inv = old_tree.inventory
992
renames = list(_mod_tree.find_renames(old_inv, new_inv))
994
for old_name, new_name in renames:
995
self.outf.write("%s => %s\n" % (old_name, new_name))
1002
class cmd_update(Command):
1003
"""Update a tree to have the latest code committed to its branch.
1005
This will perform a merge into the working tree, and may generate
1006
conflicts. If you have any local changes, you will still
1007
need to commit them after the update for the update to be complete.
1009
If you want to discard your local changes, you can just do a
1010
'bzr revert' instead of 'bzr commit' after the update.
1012
takes_args = ['dir?']
1015
def run(self, dir='.'):
1016
tree = WorkingTree.open_containing(dir)[0]
1017
master = tree.branch.get_master_branch()
1018
if master is not None:
1021
tree.lock_tree_write()
1023
existing_pending_merges = tree.get_parent_ids()[1:]
1024
last_rev = tree.last_revision()
1025
if last_rev == tree.branch.last_revision():
1026
# may be up to date, check master too.
1027
master = tree.branch.get_master_branch()
1028
if master is None or last_rev == master.last_revision():
1029
revno = tree.branch.revision_id_to_revno(last_rev)
1030
note("Tree is up to date at revision %d." % (revno,))
1032
conflicts = tree.update()
1033
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1034
note('Updated to revision %d.' % (revno,))
1035
if tree.get_parent_ids()[1:] != existing_pending_merges:
1036
note('Your local commits will now show as pending merges with '
1037
"'bzr status', and can be committed with 'bzr commit'.")
1046
class cmd_info(Command):
1047
"""Show information about a working tree, branch or repository.
1049
This command will show all known locations and formats associated to the
1050
tree, branch or repository. Statistical information is included with
1053
Branches and working trees will also report any missing revisions.
1055
takes_args = ['location?']
1056
takes_options = ['verbose']
1059
def run(self, location=None, verbose=False):
1060
from bzrlib.info import show_bzrdir_info
1061
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1065
class cmd_remove(Command):
1066
"""Make a file unversioned.
1068
This makes bzr stop tracking changes to a versioned file. It does
1069
not delete the working copy.
1071
You can specify one or more files, and/or --new. If you specify --new,
1072
only 'added' files will be removed. If you specify both, then new files
1073
in the specified directories will be removed. If the directories are
1074
also new, they will also be removed.
1076
takes_args = ['file*']
1077
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1079
encoding_type = 'replace'
1081
def run(self, file_list, verbose=False, new=False):
1082
tree, file_list = tree_files(file_list)
1084
if file_list is None:
1085
raise errors.BzrCommandError('Specify one or more files to'
1086
' remove, or use --new.')
1088
added = tree.changes_from(tree.basis_tree(),
1089
specific_files=file_list).added
1090
file_list = sorted([f[0] for f in added], reverse=True)
1091
if len(file_list) == 0:
1092
raise errors.BzrCommandError('No matching files.')
1093
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1096
class cmd_file_id(Command):
1097
"""Print file_id of a particular file or directory.
1099
The file_id is assigned when the file is first added and remains the
1100
same through all revisions where the file exists, even when it is
1105
takes_args = ['filename']
1108
def run(self, filename):
1109
tree, relpath = WorkingTree.open_containing(filename)
1110
i = tree.path2id(relpath)
1112
raise errors.NotVersionedError(filename)
1114
self.outf.write(i + '\n')
1117
class cmd_file_path(Command):
1118
"""Print path of file_ids to a file or directory.
1120
This prints one line for each directory down to the target,
1121
starting at the branch root.
1125
takes_args = ['filename']
1128
def run(self, filename):
1129
tree, relpath = WorkingTree.open_containing(filename)
1130
fid = tree.path2id(relpath)
1132
raise errors.NotVersionedError(filename)
1133
segments = osutils.splitpath(relpath)
1134
for pos in range(1, len(segments) + 1):
1135
path = osutils.joinpath(segments[:pos])
1136
self.outf.write("%s\n" % tree.path2id(path))
1139
class cmd_reconcile(Command):
1140
"""Reconcile bzr metadata in a branch.
1142
This can correct data mismatches that may have been caused by
1143
previous ghost operations or bzr upgrades. You should only
1144
need to run this command if 'bzr check' or a bzr developer
1145
advises you to run it.
1147
If a second branch is provided, cross-branch reconciliation is
1148
also attempted, which will check that data like the tree root
1149
id which was not present in very early bzr versions is represented
1150
correctly in both branches.
1152
At the same time it is run it may recompress data resulting in
1153
a potential saving in disk space or performance gain.
1155
The branch *MUST* be on a listable system such as local disk or sftp.
1157
takes_args = ['branch?']
1159
def run(self, branch="."):
1160
from bzrlib.reconcile import reconcile
1161
dir = bzrdir.BzrDir.open(branch)
1165
class cmd_revision_history(Command):
1166
"""Display the list of revision ids on a branch."""
1167
takes_args = ['location?']
1172
def run(self, location="."):
1173
branch = Branch.open_containing(location)[0]
1174
for revid in branch.revision_history():
1175
self.outf.write(revid)
1176
self.outf.write('\n')
1179
class cmd_ancestry(Command):
1180
"""List all revisions merged into this branch."""
1181
takes_args = ['location?']
1186
def run(self, location="."):
1188
wt = WorkingTree.open_containing(location)[0]
1189
except errors.NoWorkingTree:
1190
b = Branch.open(location)
1191
last_revision = b.last_revision()
1194
last_revision = wt.last_revision()
1196
revision_ids = b.repository.get_ancestry(last_revision)
1197
assert revision_ids[0] is None
1199
for revision_id in revision_ids:
1200
self.outf.write(revision_id + '\n')
1203
class cmd_init(Command):
1204
"""Make a directory into a versioned branch.
1206
Use this to create an empty branch, or before importing an
1209
If there is a repository in a parent directory of the location, then
1210
the history of the branch will be stored in the repository. Otherwise
1211
init creates a standalone branch which carries its own history in
1214
If there is already a branch at the location but it has no working tree,
1215
the tree can be populated with 'bzr checkout'.
1217
Recipe for importing a tree of files:
1222
bzr commit -m 'imported project'
1224
takes_args = ['location?']
1226
RegistryOption('format',
1227
help='Specify a format for this branch. '
1228
'See "help formats".',
1229
registry=bzrdir.format_registry,
1230
converter=bzrdir.format_registry.make_bzrdir,
1231
value_switches=True,
1232
title="Branch Format",
1234
Option('append-revisions-only',
1235
help='Never change revnos or the existing log.'
1236
' Append revisions to it only.')
1238
def run(self, location=None, format=None, append_revisions_only=False):
1240
format = bzrdir.format_registry.make_bzrdir('default')
1241
if location is None:
1244
to_transport = transport.get_transport(location)
1246
# The path has to exist to initialize a
1247
# branch inside of it.
1248
# Just using os.mkdir, since I don't
1249
# believe that we want to create a bunch of
1250
# locations if the user supplies an extended path
1251
# TODO: create-prefix
1253
to_transport.mkdir('.')
1254
except errors.FileExists:
1258
existing_bzrdir = bzrdir.BzrDir.open(location)
1259
except errors.NotBranchError:
1260
# really a NotBzrDir error...
1261
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1264
from bzrlib.transport.local import LocalTransport
1265
if existing_bzrdir.has_branch():
1266
if (isinstance(to_transport, LocalTransport)
1267
and not existing_bzrdir.has_workingtree()):
1268
raise errors.BranchExistsWithoutWorkingTree(location)
1269
raise errors.AlreadyBranchError(location)
1271
branch = existing_bzrdir.create_branch()
1272
existing_bzrdir.create_workingtree()
1273
if append_revisions_only:
1275
branch.set_append_revisions_only(True)
1276
except errors.UpgradeRequired:
1277
raise errors.BzrCommandError('This branch format cannot be set'
1278
' to append-revisions-only. Try --experimental-branch6')
1281
class cmd_init_repository(Command):
1282
"""Create a shared repository to hold branches.
1284
New branches created under the repository directory will store their revisions
1285
in the repository, not in the branch directory, if the branch format supports
1291
bzr checkout --lightweight repo/trunk trunk-checkout
1295
takes_args = ["location"]
1296
takes_options = [RegistryOption('format',
1297
help='Specify a format for this repository. See'
1298
' "bzr help formats" for details',
1299
registry=bzrdir.format_registry,
1300
converter=bzrdir.format_registry.make_bzrdir,
1301
value_switches=True, title='Repository format'),
1303
help='Allows branches in repository to have'
1305
aliases = ["init-repo"]
1306
def run(self, location, format=None, trees=False):
1308
format = bzrdir.format_registry.make_bzrdir('default')
1310
if location is None:
1313
to_transport = transport.get_transport(location)
1315
to_transport.mkdir('.')
1316
except errors.FileExists:
1319
newdir = format.initialize_on_transport(to_transport)
1320
repo = newdir.create_repository(shared=True)
1321
repo.set_make_working_trees(trees)
1324
class cmd_diff(Command):
1325
"""Show differences in the working tree or between revisions.
1327
If files are listed, only the changes in those files are listed.
1328
Otherwise, all changes for the tree are listed.
1330
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1331
produces patches suitable for "patch -p1".
1335
Shows the difference in the working tree versus the last commit
1337
Difference between the working tree and revision 1
1339
Difference between revision 2 and revision 1
1340
bzr diff --diff-prefix old/:new/
1341
Same as 'bzr diff' but prefix paths with old/ and new/
1342
bzr diff bzr.mine bzr.dev
1343
Show the differences between the two working trees
1345
Show just the differences for 'foo.c'
1347
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1348
# or a graphical diff.
1350
# TODO: Python difflib is not exactly the same as unidiff; should
1351
# either fix it up or prefer to use an external diff.
1353
# TODO: Selected-file diff is inefficient and doesn't show you
1356
# TODO: This probably handles non-Unix newlines poorly.
1358
takes_args = ['file*']
1359
takes_options = ['revision', 'diff-options',
1360
Option('prefix', type=str,
1362
help='Set prefixes to added to old and new filenames, as '
1363
'two values separated by a colon.'),
1365
aliases = ['di', 'dif']
1366
encoding_type = 'exact'
1369
def run(self, revision=None, file_list=None, diff_options=None,
1371
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1373
if (prefix is None) or (prefix == '0'):
1381
old_label, new_label = prefix.split(":")
1383
raise BzrCommandError(
1384
"--prefix expects two values separated by a colon")
1386
if revision and len(revision) > 2:
1387
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1388
' one or two revision specifiers')
1391
tree1, file_list = internal_tree_files(file_list)
1395
except errors.FileInWrongBranch:
1396
if len(file_list) != 2:
1397
raise errors.BzrCommandError("Files are in different branches")
1399
tree1, file1 = WorkingTree.open_containing(file_list[0])
1400
tree2, file2 = WorkingTree.open_containing(file_list[1])
1401
if file1 != "" or file2 != "":
1402
# FIXME diff those two files. rbc 20051123
1403
raise errors.BzrCommandError("Files are in different branches")
1405
except errors.NotBranchError:
1406
if (revision is not None and len(revision) == 2
1407
and not revision[0].needs_branch()
1408
and not revision[1].needs_branch()):
1409
# If both revision specs include a branch, we can
1410
# diff them without needing a local working tree
1411
tree1, tree2 = None, None
1415
if tree2 is not None:
1416
if revision is not None:
1417
# FIXME: but there should be a clean way to diff between
1418
# non-default versions of two trees, it's not hard to do
1420
raise errors.BzrCommandError(
1421
"Sorry, diffing arbitrary revisions across branches "
1422
"is not implemented yet")
1423
return show_diff_trees(tree1, tree2, sys.stdout,
1424
specific_files=file_list,
1425
external_diff_options=diff_options,
1426
old_label=old_label, new_label=new_label)
1428
return diff_cmd_helper(tree1, file_list, diff_options,
1429
revision_specs=revision,
1430
old_label=old_label, new_label=new_label)
1433
class cmd_deleted(Command):
1434
"""List files deleted in the working tree.
1436
# TODO: Show files deleted since a previous revision, or
1437
# between two revisions.
1438
# TODO: Much more efficient way to do this: read in new
1439
# directories with readdir, rather than stating each one. Same
1440
# level of effort but possibly much less IO. (Or possibly not,
1441
# if the directories are very large...)
1442
takes_options = ['show-ids']
1445
def run(self, show_ids=False):
1446
tree = WorkingTree.open_containing(u'.')[0]
1449
old = tree.basis_tree()
1452
for path, ie in old.inventory.iter_entries():
1453
if not tree.has_id(ie.file_id):
1454
self.outf.write(path)
1456
self.outf.write(' ')
1457
self.outf.write(ie.file_id)
1458
self.outf.write('\n')
1465
class cmd_modified(Command):
1466
"""List files modified in working tree.
1468
See also: "bzr status".
1475
tree = WorkingTree.open_containing(u'.')[0]
1476
td = tree.changes_from(tree.basis_tree())
1477
for path, id, kind, text_modified, meta_modified in td.modified:
1478
self.outf.write(path + '\n')
1481
class cmd_added(Command):
1482
"""List files added in working tree.
1484
See also: "bzr status".
1491
wt = WorkingTree.open_containing(u'.')[0]
1494
basis = wt.basis_tree()
1497
basis_inv = basis.inventory
1500
if file_id in basis_inv:
1502
if inv.is_root(file_id) and len(basis_inv) == 0:
1504
path = inv.id2path(file_id)
1505
if not os.access(osutils.abspath(path), os.F_OK):
1507
self.outf.write(path + '\n')
1514
class cmd_root(Command):
1515
"""Show the tree root directory.
1517
The root is the nearest enclosing directory with a .bzr control
1519
takes_args = ['filename?']
1521
def run(self, filename=None):
1522
"""Print the branch root."""
1523
tree = WorkingTree.open_containing(filename)[0]
1524
self.outf.write(tree.basedir + '\n')
1527
class cmd_log(Command):
1528
"""Show log of a branch, file, or directory.
1530
By default show the log of the branch containing the working directory.
1532
To request a range of logs, you can use the command -r begin..end
1533
-r revision requests a specific revision, -r ..end or -r begin.. are
1539
bzr log -r -10.. http://server/branch
1542
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1544
takes_args = ['location?']
1545
takes_options = [Option('forward',
1546
help='show from oldest to newest'),
1550
help='show files changed in each revision'),
1551
'show-ids', 'revision',
1555
help='show revisions whose message matches this regexp',
1558
encoding_type = 'replace'
1561
def run(self, location=None, timezone='original',
1568
from bzrlib.log import show_log
1569
assert message is None or isinstance(message, basestring), \
1570
"invalid message argument %r" % message
1571
direction = (forward and 'forward') or 'reverse'
1576
# find the file id to log:
1578
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1582
tree = b.basis_tree()
1583
file_id = tree.path2id(fp)
1585
raise errors.BzrCommandError(
1586
"Path does not have any revision history: %s" %
1590
# FIXME ? log the current subdir only RBC 20060203
1591
if revision is not None \
1592
and len(revision) > 0 and revision[0].get_branch():
1593
location = revision[0].get_branch()
1596
dir, relpath = bzrdir.BzrDir.open_containing(location)
1597
b = dir.open_branch()
1601
if revision is None:
1604
elif len(revision) == 1:
1605
rev1 = rev2 = revision[0].in_history(b).revno
1606
elif len(revision) == 2:
1607
if revision[1].get_branch() != revision[0].get_branch():
1608
# b is taken from revision[0].get_branch(), and
1609
# show_log will use its revision_history. Having
1610
# different branches will lead to weird behaviors.
1611
raise errors.BzrCommandError(
1612
"Log doesn't accept two revisions in different"
1614
if revision[0].spec is None:
1615
# missing begin-range means first revision
1618
rev1 = revision[0].in_history(b).revno
1620
if revision[1].spec is None:
1621
# missing end-range means last known revision
1624
rev2 = revision[1].in_history(b).revno
1626
raise errors.BzrCommandError(
1627
'bzr log --revision takes one or two values.')
1629
# By this point, the revision numbers are converted to the +ve
1630
# form if they were supplied in the -ve form, so we can do
1631
# this comparison in relative safety
1633
(rev2, rev1) = (rev1, rev2)
1635
if log_format is None:
1636
log_format = log.log_formatter_registry.get_default(b)
1638
lf = log_format(show_ids=show_ids, to_file=self.outf,
1639
show_timezone=timezone)
1645
direction=direction,
1646
start_revision=rev1,
1653
def get_log_format(long=False, short=False, line=False, default='long'):
1654
log_format = default
1658
log_format = 'short'
1664
class cmd_touching_revisions(Command):
1665
"""Return revision-ids which affected a particular file.
1667
A more user-friendly interface is "bzr log FILE".
1671
takes_args = ["filename"]
1674
def run(self, filename):
1675
tree, relpath = WorkingTree.open_containing(filename)
1677
file_id = tree.path2id(relpath)
1678
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1679
self.outf.write("%6d %s\n" % (revno, what))
1682
class cmd_ls(Command):
1683
"""List files in a tree.
1686
takes_args = ['path?']
1687
# TODO: Take a revision or remote path and list that tree instead.
1688
takes_options = ['verbose', 'revision',
1689
Option('non-recursive',
1690
help='don\'t recurse into sub-directories'),
1692
help='Print all paths from the root of the branch.'),
1693
Option('unknown', help='Print unknown files'),
1694
Option('versioned', help='Print versioned files'),
1695
Option('ignored', help='Print ignored files'),
1697
Option('null', help='Null separate the files'),
1701
def run(self, revision=None, verbose=False,
1702
non_recursive=False, from_root=False,
1703
unknown=False, versioned=False, ignored=False,
1704
null=False, kind=None, show_ids=False, path=None):
1706
if kind and kind not in ('file', 'directory', 'symlink'):
1707
raise errors.BzrCommandError('invalid kind specified')
1709
if verbose and null:
1710
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1711
all = not (unknown or versioned or ignored)
1713
selection = {'I':ignored, '?':unknown, 'V':versioned}
1720
raise errors.BzrCommandError('cannot specify both --from-root'
1724
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1730
if revision is not None:
1731
tree = branch.repository.revision_tree(
1732
revision[0].in_history(branch).rev_id)
1734
tree = branch.basis_tree()
1738
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1739
if fp.startswith(relpath):
1740
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1741
if non_recursive and '/' in fp:
1743
if not all and not selection[fc]:
1745
if kind is not None and fkind != kind:
1748
kindch = entry.kind_character()
1749
outstring = '%-8s %s%s' % (fc, fp, kindch)
1750
if show_ids and fid is not None:
1751
outstring = "%-50s %s" % (outstring, fid)
1752
self.outf.write(outstring + '\n')
1754
self.outf.write(fp + '\0')
1757
self.outf.write(fid)
1758
self.outf.write('\0')
1766
self.outf.write('%-50s %s\n' % (fp, my_id))
1768
self.outf.write(fp + '\n')
1773
class cmd_unknowns(Command):
1774
"""List unknown files.
1776
See also: "bzr ls --unknown".
1783
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1784
self.outf.write(osutils.quotefn(f) + '\n')
1787
class cmd_ignore(Command):
1788
"""Ignore specified files or patterns.
1790
To remove patterns from the ignore list, edit the .bzrignore file.
1792
Trailing slashes on patterns are ignored.
1793
If the pattern contains a slash or is a regular expression, it is compared
1794
to the whole path from the branch root. Otherwise, it is compared to only
1795
the last component of the path. To match a file only in the root
1796
directory, prepend './'.
1798
Ignore patterns specifying absolute paths are not allowed.
1800
Ignore patterns may include globbing wildcards such as:
1801
? - Matches any single character except '/'
1802
* - Matches 0 or more characters except '/'
1803
/**/ - Matches 0 or more directories in a path
1804
[a-z] - Matches a single character from within a group of characters
1806
Ignore patterns may also be Python regular expressions.
1807
Regular expression ignore patterns are identified by a 'RE:' prefix
1808
followed by the regular expression. Regular expression ignore patterns
1809
may not include named or numbered groups.
1811
Note: ignore patterns containing shell wildcards must be quoted from
1815
bzr ignore ./Makefile
1816
bzr ignore '*.class'
1817
bzr ignore 'lib/**/*.o'
1818
bzr ignore 'RE:lib/.*\.o'
1820
takes_args = ['name_pattern*']
1822
Option('old-default-rules',
1823
help='Out the ignore rules bzr < 0.9 always used.')
1826
def run(self, name_pattern_list=None, old_default_rules=None):
1827
from bzrlib.atomicfile import AtomicFile
1828
if old_default_rules is not None:
1829
# dump the rules and exit
1830
for pattern in ignores.OLD_DEFAULTS:
1833
if not name_pattern_list:
1834
raise errors.BzrCommandError("ignore requires at least one "
1835
"NAME_PATTERN or --old-default-rules")
1836
name_pattern_list = [globbing.normalize_pattern(p)
1837
for p in name_pattern_list]
1838
for name_pattern in name_pattern_list:
1839
if (name_pattern[0] == '/' or
1840
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1841
raise errors.BzrCommandError(
1842
"NAME_PATTERN should not be an absolute path")
1843
tree, relpath = WorkingTree.open_containing(u'.')
1844
ifn = tree.abspath('.bzrignore')
1845
if os.path.exists(ifn):
1848
igns = f.read().decode('utf-8')
1854
# TODO: If the file already uses crlf-style termination, maybe
1855
# we should use that for the newly added lines?
1857
if igns and igns[-1] != '\n':
1859
for name_pattern in name_pattern_list:
1860
igns += name_pattern + '\n'
1862
f = AtomicFile(ifn, 'wb')
1864
f.write(igns.encode('utf-8'))
1869
if not tree.path2id('.bzrignore'):
1870
tree.add(['.bzrignore'])
1873
class cmd_ignored(Command):
1874
"""List ignored files and the patterns that matched them.
1876
See also: bzr ignore"""
1879
tree = WorkingTree.open_containing(u'.')[0]
1882
for path, file_class, kind, file_id, entry in tree.list_files():
1883
if file_class != 'I':
1885
## XXX: Slightly inefficient since this was already calculated
1886
pat = tree.is_ignored(path)
1887
print '%-50s %s' % (path, pat)
1892
class cmd_lookup_revision(Command):
1893
"""Lookup the revision-id from a revision-number
1896
bzr lookup-revision 33
1899
takes_args = ['revno']
1902
def run(self, revno):
1906
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1908
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1911
class cmd_export(Command):
1912
"""Export past revision to destination directory.
1914
If no revision is specified this exports the last committed revision.
1916
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1917
given, try to find the format with the extension. If no extension
1918
is found exports to a directory (equivalent to --format=dir).
1920
Root may be the top directory for tar, tgz and tbz2 formats. If none
1921
is given, the top directory will be the root name of the file.
1923
If branch is omitted then the branch containing the CWD will be used.
1925
Note: export of tree with non-ascii filenames to zip is not supported.
1927
Supported formats Autodetected by extension
1928
----------------- -------------------------
1931
tbz2 .tar.bz2, .tbz2
1935
takes_args = ['dest', 'branch?']
1936
takes_options = ['revision', 'format', 'root']
1937
def run(self, dest, branch=None, revision=None, format=None, root=None):
1938
from bzrlib.export import export
1941
tree = WorkingTree.open_containing(u'.')[0]
1944
b = Branch.open(branch)
1946
if revision is None:
1947
# should be tree.last_revision FIXME
1948
rev_id = b.last_revision()
1950
if len(revision) != 1:
1951
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1952
rev_id = revision[0].in_history(b).rev_id
1953
t = b.repository.revision_tree(rev_id)
1955
export(t, dest, format, root)
1956
except errors.NoSuchExportFormat, e:
1957
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1960
class cmd_cat(Command):
1961
"""Write a file's text from a previous revision."""
1963
takes_options = ['revision', 'name-from-revision']
1964
takes_args = ['filename']
1965
encoding_type = 'exact'
1968
def run(self, filename, revision=None, name_from_revision=False):
1969
if revision is not None and len(revision) != 1:
1970
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1975
tree, b, relpath = \
1976
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
1977
except errors.NotBranchError:
1980
if revision is not None and revision[0].get_branch() is not None:
1981
b = Branch.open(revision[0].get_branch())
1983
tree = b.basis_tree()
1984
if revision is None:
1985
revision_id = b.last_revision()
1987
revision_id = revision[0].in_history(b).rev_id
1989
cur_file_id = tree.path2id(relpath)
1990
rev_tree = b.repository.revision_tree(revision_id)
1991
old_file_id = rev_tree.path2id(relpath)
1993
if name_from_revision:
1994
if old_file_id is None:
1995
raise errors.BzrCommandError("%r is not present in revision %s"
1996
% (filename, revision_id))
1998
rev_tree.print_file(old_file_id)
1999
elif cur_file_id is not None:
2000
rev_tree.print_file(cur_file_id)
2001
elif old_file_id is not None:
2002
rev_tree.print_file(old_file_id)
2004
raise errors.BzrCommandError("%r is not present in revision %s" %
2005
(filename, revision_id))
2008
class cmd_local_time_offset(Command):
2009
"""Show the offset in seconds from GMT to local time."""
2013
print osutils.local_time_offset()
2017
class cmd_commit(Command):
2018
"""Commit changes into a new revision.
2020
If no arguments are given, the entire tree is committed.
2022
If selected files are specified, only changes to those files are
2023
committed. If a directory is specified then the directory and everything
2024
within it is committed.
2026
A selected-file commit may fail in some cases where the committed
2027
tree would be invalid, such as trying to commit a file in a
2028
newly-added directory that is not itself committed.
2030
# TODO: Run hooks on tree to-be-committed, and after commit.
2032
# TODO: Strict commit that fails if there are deleted files.
2033
# (what does "deleted files" mean ??)
2035
# TODO: Give better message for -s, --summary, used by tla people
2037
# XXX: verbose currently does nothing
2039
takes_args = ['selected*']
2040
takes_options = ['message', 'verbose',
2042
help='commit even if nothing has changed'),
2043
Option('file', type=str,
2046
help='file containing commit message'),
2048
help="refuse to commit if there are unknown "
2049
"files in the working tree."),
2051
help="perform a local only commit in a bound "
2052
"branch. Such commits are not pushed to "
2053
"the master branch until a normal commit "
2057
aliases = ['ci', 'checkin']
2059
def run(self, message=None, file=None, verbose=True, selected_list=None,
2060
unchanged=False, strict=False, local=False):
2061
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2062
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2064
from bzrlib.msgeditor import edit_commit_message, \
2065
make_commit_message_template
2067
# TODO: Need a blackbox test for invoking the external editor; may be
2068
# slightly problematic to run this cross-platform.
2070
# TODO: do more checks that the commit will succeed before
2071
# spending the user's valuable time typing a commit message.
2072
tree, selected_list = tree_files(selected_list)
2073
if selected_list == ['']:
2074
# workaround - commit of root of tree should be exactly the same
2075
# as just default commit in that tree, and succeed even though
2076
# selected-file merge commit is not done yet
2079
if local and not tree.branch.get_bound_location():
2080
raise errors.LocalRequiresBoundBranch()
2082
def get_message(commit_obj):
2083
"""Callback to get commit message"""
2084
my_message = message
2085
if my_message is None and not file:
2086
template = make_commit_message_template(tree, selected_list)
2087
my_message = edit_commit_message(template)
2088
if my_message is None:
2089
raise errors.BzrCommandError("please specify a commit"
2090
" message with either --message or --file")
2091
elif my_message and file:
2092
raise errors.BzrCommandError(
2093
"please specify either --message or --file")
2095
my_message = codecs.open(file, 'rt',
2096
bzrlib.user_encoding).read()
2097
if my_message == "":
2098
raise errors.BzrCommandError("empty commit message specified")
2102
reporter = ReportCommitToLog()
2104
reporter = NullCommitReporter()
2107
tree.commit(message_callback=get_message,
2108
specific_files=selected_list,
2109
allow_pointless=unchanged, strict=strict, local=local,
2111
except PointlessCommit:
2112
# FIXME: This should really happen before the file is read in;
2113
# perhaps prepare the commit; get the message; then actually commit
2114
raise errors.BzrCommandError("no changes to commit."
2115
" use --unchanged to commit anyhow")
2116
except ConflictsInTree:
2117
raise errors.BzrCommandError('Conflicts detected in working '
2118
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2120
except StrictCommitFailed:
2121
raise errors.BzrCommandError("Commit refused because there are"
2122
" unknown files in the working tree.")
2123
except errors.BoundBranchOutOfDate, e:
2124
raise errors.BzrCommandError(str(e) + "\n"
2125
'To commit to master branch, run update and then commit.\n'
2126
'You can also pass --local to commit to continue working '
2130
class cmd_check(Command):
2131
"""Validate consistency of branch history.
2133
This command checks various invariants about the branch storage to
2134
detect data corruption or bzr bugs.
2136
takes_args = ['branch?']
2137
takes_options = ['verbose']
2139
def run(self, branch=None, verbose=False):
2140
from bzrlib.check import check
2142
tree = WorkingTree.open_containing()[0]
2143
branch = tree.branch
2145
branch = Branch.open(branch)
2146
check(branch, verbose)
2149
class cmd_upgrade(Command):
2150
"""Upgrade branch storage to current format.
2152
The check command or bzr developers may sometimes advise you to run
2153
this command. When the default format has changed you may also be warned
2154
during other operations to upgrade.
2156
takes_args = ['url?']
2158
RegistryOption('format',
2159
help='Upgrade to a specific format. See "bzr help'
2160
' formats" for details',
2161
registry=bzrdir.format_registry,
2162
converter=bzrdir.format_registry.make_bzrdir,
2163
value_switches=True, title='Branch format'),
2166
def run(self, url='.', format=None):
2167
from bzrlib.upgrade import upgrade
2169
format = bzrdir.format_registry.make_bzrdir('default')
2170
upgrade(url, format)
2173
class cmd_whoami(Command):
2174
"""Show or set bzr user id.
2178
bzr whoami 'Frank Chu <fchu@example.com>'
2180
takes_options = [ Option('email',
2181
help='display email address only'),
2183
help='set identity for the current branch instead of '
2186
takes_args = ['name?']
2187
encoding_type = 'replace'
2190
def run(self, email=False, branch=False, name=None):
2192
# use branch if we're inside one; otherwise global config
2194
c = Branch.open_containing('.')[0].get_config()
2195
except errors.NotBranchError:
2196
c = config.GlobalConfig()
2198
self.outf.write(c.user_email() + '\n')
2200
self.outf.write(c.username() + '\n')
2203
# display a warning if an email address isn't included in the given name.
2205
config.extract_email_address(name)
2206
except errors.NoEmailInUsername, e:
2207
warning('"%s" does not seem to contain an email address. '
2208
'This is allowed, but not recommended.', name)
2210
# use global config unless --branch given
2212
c = Branch.open_containing('.')[0].get_config()
2214
c = config.GlobalConfig()
2215
c.set_user_option('email', name)
2218
class cmd_nick(Command):
2219
"""Print or set the branch nickname.
2221
If unset, the tree root directory name is used as the nickname
2222
To print the current nickname, execute with no argument.
2224
takes_args = ['nickname?']
2225
def run(self, nickname=None):
2226
branch = Branch.open_containing(u'.')[0]
2227
if nickname is None:
2228
self.printme(branch)
2230
branch.nick = nickname
2233
def printme(self, branch):
2237
class cmd_selftest(Command):
2238
"""Run internal test suite.
2240
This creates temporary test directories in the working directory, but not
2241
existing data is affected. These directories are deleted if the tests
2242
pass, or left behind to help in debugging if they fail and --keep-output
2245
If arguments are given, they are regular expressions that say which tests
2246
should run. Tests matching any expression are run, and other tests are
2249
Alternatively if --first is given, matching tests are run first and then
2250
all other tests are run. This is useful if you have been working in a
2251
particular area, but want to make sure nothing else was broken.
2253
If the global option '--no-plugins' is given, plugins are not loaded
2254
before running the selftests. This has two effects: features provided or
2255
modified by plugins will not be tested, and tests provided by plugins will
2260
run only tests relating to 'ignore'
2261
bzr --no-plugins selftest -v
2262
disable plugins and list tests as they're run
2264
For each test, that needs actual disk access, bzr create their own
2265
subdirectory in the temporary testing directory (testXXXX.tmp).
2266
By default the name of such subdirectory is based on the name of the test.
2267
If option '--numbered-dirs' is given, bzr will use sequent numbers
2268
of running tests to create such subdirectories. This is default behavior
2269
on Windows because of path length limitation.
2271
# TODO: --list should give a list of all available tests
2273
# NB: this is used from the class without creating an instance, which is
2274
# why it does not have a self parameter.
2275
def get_transport_type(typestring):
2276
"""Parse and return a transport specifier."""
2277
if typestring == "sftp":
2278
from bzrlib.transport.sftp import SFTPAbsoluteServer
2279
return SFTPAbsoluteServer
2280
if typestring == "memory":
2281
from bzrlib.transport.memory import MemoryServer
2283
if typestring == "fakenfs":
2284
from bzrlib.transport.fakenfs import FakeNFSServer
2285
return FakeNFSServer
2286
msg = "No known transport type %s. Supported types are: sftp\n" %\
2288
raise errors.BzrCommandError(msg)
2291
takes_args = ['testspecs*']
2292
takes_options = ['verbose',
2293
Option('one', help='stop when one test fails'),
2294
Option('keep-output',
2295
help='keep output directories when tests fail'),
2297
help='Use a different transport by default '
2298
'throughout the test suite.',
2299
type=get_transport_type),
2300
Option('benchmark', help='run the bzr bencharks.'),
2301
Option('lsprof-timed',
2302
help='generate lsprof output for benchmarked'
2303
' sections of code.'),
2304
Option('cache-dir', type=str,
2305
help='a directory to cache intermediate'
2306
' benchmark steps'),
2307
Option('clean-output',
2308
help='clean temporary tests directories'
2309
' without running tests'),
2311
help='run all tests, but run specified tests first',
2313
Option('numbered-dirs',
2314
help='use numbered dirs for TestCaseInTempDir'),
2316
encoding_type = 'replace'
2318
def run(self, testspecs_list=None, verbose=None, one=False,
2319
keep_output=False, transport=None, benchmark=None,
2320
lsprof_timed=None, cache_dir=None, clean_output=False,
2321
first=False, numbered_dirs=None):
2323
from bzrlib.tests import selftest
2324
import bzrlib.benchmarks as benchmarks
2325
from bzrlib.benchmarks import tree_creator
2328
from bzrlib.tests import clean_selftest_output
2329
clean_selftest_output()
2332
if numbered_dirs is None and sys.platform == 'win32':
2333
numbered_dirs = True
2335
if cache_dir is not None:
2336
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2337
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2338
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2340
if testspecs_list is not None:
2341
pattern = '|'.join(testspecs_list)
2345
test_suite_factory = benchmarks.test_suite
2348
# TODO: should possibly lock the history file...
2349
benchfile = open(".perf_history", "at", buffering=1)
2351
test_suite_factory = None
2356
result = selftest(verbose=verbose,
2358
stop_on_failure=one,
2359
keep_output=keep_output,
2360
transport=transport,
2361
test_suite_factory=test_suite_factory,
2362
lsprof_timed=lsprof_timed,
2363
bench_history=benchfile,
2364
matching_tests_first=first,
2365
numbered_dirs=numbered_dirs,
2368
if benchfile is not None:
2371
info('tests passed')
2373
info('tests failed')
2374
return int(not result)
2377
class cmd_version(Command):
2378
"""Show version of bzr."""
2382
from bzrlib.version import show_version
2386
class cmd_rocks(Command):
2387
"""Statement of optimism."""
2393
print "It sure does!"
2396
class cmd_find_merge_base(Command):
2397
"""Find and print a base revision for merging two branches."""
2398
# TODO: Options to specify revisions on either side, as if
2399
# merging only part of the history.
2400
takes_args = ['branch', 'other']
2404
def run(self, branch, other):
2405
from bzrlib.revision import MultipleRevisionSources
2407
branch1 = Branch.open_containing(branch)[0]
2408
branch2 = Branch.open_containing(other)[0]
2410
last1 = branch1.last_revision()
2411
last2 = branch2.last_revision()
2413
source = MultipleRevisionSources(branch1.repository,
2416
base_rev_id = common_ancestor(last1, last2, source)
2418
print 'merge base is revision %s' % base_rev_id
2421
class cmd_merge(Command):
2422
"""Perform a three-way merge.
2424
The branch is the branch you will merge from. By default, it will merge
2425
the latest revision. If you specify a revision, that revision will be
2426
merged. If you specify two revisions, the first will be used as a BASE,
2427
and the second one as OTHER. Revision numbers are always relative to the
2430
By default, bzr will try to merge in all new work from the other
2431
branch, automatically determining an appropriate base. If this
2432
fails, you may need to give an explicit base.
2434
Merge will do its best to combine the changes in two branches, but there
2435
are some kinds of problems only a human can fix. When it encounters those,
2436
it will mark a conflict. A conflict means that you need to fix something,
2437
before you should commit.
2439
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2441
If there is no default branch set, the first merge will set it. After
2442
that, you can omit the branch to use the default. To change the
2443
default, use --remember. The value will only be saved if the remote
2444
location can be accessed.
2446
The results of the merge are placed into the destination working
2447
directory, where they can be reviewed (with bzr diff), tested, and then
2448
committed to record the result of the merge.
2452
To merge the latest revision from bzr.dev
2453
bzr merge ../bzr.dev
2455
To merge changes up to and including revision 82 from bzr.dev
2456
bzr merge -r 82 ../bzr.dev
2458
To merge the changes introduced by 82, without previous changes:
2459
bzr merge -r 81..82 ../bzr.dev
2461
merge refuses to run if there are any uncommitted changes, unless
2464
The following merge types are available:
2466
takes_args = ['branch?']
2467
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2468
Option('show-base', help="Show base revision text in "
2470
Option('uncommitted', help='Apply uncommitted changes'
2471
' from a working copy, instead of branch changes'),
2472
Option('pull', help='If the destination is already'
2473
' completely merged into the source, pull from the'
2474
' source rather than merging. When this happens,'
2475
' you do not need to commit the result.'),
2477
help='Branch to merge into, '
2478
'rather than the one containing the working directory',
2484
def run(self, branch=None, revision=None, force=False, merge_type=None,
2485
show_base=False, reprocess=False, remember=False,
2486
uncommitted=False, pull=False,
2489
from bzrlib.tag import _merge_tags_if_possible
2490
if merge_type is None:
2491
merge_type = _mod_merge.Merge3Merger
2493
if directory is None: directory = u'.'
2494
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2495
# inventory. Because merge is a mutating operation, it really
2496
# should be a lock_write() for the whole cmd_merge operation.
2497
# However, cmd_merge open's its own tree in _merge_helper, which
2498
# means if we lock here, the later lock_write() will always block.
2499
# Either the merge helper code should be updated to take a tree,
2500
# (What about tree.merge_from_branch?)
2501
tree = WorkingTree.open_containing(directory)[0]
2502
change_reporter = delta.ChangeReporter(
2503
unversioned_filter=tree.is_ignored)
2505
if branch is not None:
2507
reader = bundle.read_bundle_from_url(branch)
2508
except errors.NotABundle:
2509
pass # Continue on considering this url a Branch
2511
conflicts = merge_bundle(reader, tree, not force, merge_type,
2512
reprocess, show_base, change_reporter)
2518
if revision is None \
2519
or len(revision) < 1 or revision[0].needs_branch():
2520
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2522
if revision is None or len(revision) < 1:
2525
other = [branch, None]
2528
other = [branch, -1]
2529
other_branch, path = Branch.open_containing(branch)
2532
raise errors.BzrCommandError('Cannot use --uncommitted and'
2533
' --revision at the same time.')
2534
branch = revision[0].get_branch() or branch
2535
if len(revision) == 1:
2537
other_branch, path = Branch.open_containing(branch)
2538
revno = revision[0].in_history(other_branch).revno
2539
other = [branch, revno]
2541
assert len(revision) == 2
2542
if None in revision:
2543
raise errors.BzrCommandError(
2544
"Merge doesn't permit empty revision specifier.")
2545
base_branch, path = Branch.open_containing(branch)
2546
branch1 = revision[1].get_branch() or branch
2547
other_branch, path1 = Branch.open_containing(branch1)
2548
if revision[0].get_branch() is not None:
2549
# then path was obtained from it, and is None.
2552
base = [branch, revision[0].in_history(base_branch).revno]
2553
other = [branch1, revision[1].in_history(other_branch).revno]
2555
if tree.branch.get_parent() is None or remember:
2556
tree.branch.set_parent(other_branch.base)
2558
# pull tags now... it's a bit inconsistent to do it ahead of copying
2559
# the history but that's done inside the merge code
2560
_merge_tags_if_possible(other_branch, tree.branch)
2563
interesting_files = [path]
2565
interesting_files = None
2566
pb = ui.ui_factory.nested_progress_bar()
2569
conflict_count = _merge_helper(
2570
other, base, check_clean=(not force),
2571
merge_type=merge_type,
2572
reprocess=reprocess,
2573
show_base=show_base,
2576
pb=pb, file_list=interesting_files,
2577
change_reporter=change_reporter)
2580
if conflict_count != 0:
2584
except errors.AmbiguousBase, e:
2585
m = ("sorry, bzr can't determine the right merge base yet\n"
2586
"candidates are:\n "
2587
+ "\n ".join(e.bases)
2589
"please specify an explicit base with -r,\n"
2590
"and (if you want) report this to the bzr developers\n")
2593
# TODO: move up to common parent; this isn't merge-specific anymore.
2594
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2595
"""Use tree.branch's parent if none was supplied.
2597
Report if the remembered location was used.
2599
if supplied_location is not None:
2600
return supplied_location
2601
stored_location = tree.branch.get_parent()
2602
mutter("%s", stored_location)
2603
if stored_location is None:
2604
raise errors.BzrCommandError("No location specified or remembered")
2605
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2606
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2607
return stored_location
2610
class cmd_remerge(Command):
2613
Use this if you want to try a different merge technique while resolving
2614
conflicts. Some merge techniques are better than others, and remerge
2615
lets you try different ones on different files.
2617
The options for remerge have the same meaning and defaults as the ones for
2618
merge. The difference is that remerge can (only) be run when there is a
2619
pending merge, and it lets you specify particular files.
2622
$ bzr remerge --show-base
2623
Re-do the merge of all conflicted files, and show the base text in
2624
conflict regions, in addition to the usual THIS and OTHER texts.
2626
$ bzr remerge --merge-type weave --reprocess foobar
2627
Re-do the merge of "foobar", using the weave merge algorithm, with
2628
additional processing to reduce the size of conflict regions.
2630
The following merge types are available:"""
2631
takes_args = ['file*']
2632
takes_options = ['merge-type', 'reprocess',
2633
Option('show-base', help="Show base revision text in "
2636
def run(self, file_list=None, merge_type=None, show_base=False,
2638
if merge_type is None:
2639
merge_type = _mod_merge.Merge3Merger
2640
tree, file_list = tree_files(file_list)
2643
parents = tree.get_parent_ids()
2644
if len(parents) != 2:
2645
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2646
" merges. Not cherrypicking or"
2648
repository = tree.branch.repository
2649
base_revision = common_ancestor(parents[0],
2650
parents[1], repository)
2651
base_tree = repository.revision_tree(base_revision)
2652
other_tree = repository.revision_tree(parents[1])
2653
interesting_ids = None
2655
conflicts = tree.conflicts()
2656
if file_list is not None:
2657
interesting_ids = set()
2658
for filename in file_list:
2659
file_id = tree.path2id(filename)
2661
raise errors.NotVersionedError(filename)
2662
interesting_ids.add(file_id)
2663
if tree.kind(file_id) != "directory":
2666
for name, ie in tree.inventory.iter_entries(file_id):
2667
interesting_ids.add(ie.file_id)
2668
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2670
# Remerge only supports resolving contents conflicts
2671
allowed_conflicts = ('text conflict', 'contents conflict')
2672
restore_files = [c.path for c in conflicts
2673
if c.typestring in allowed_conflicts]
2674
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2675
tree.set_conflicts(ConflictList(new_conflicts))
2676
if file_list is not None:
2677
restore_files = file_list
2678
for filename in restore_files:
2680
restore(tree.abspath(filename))
2681
except errors.NotConflicted:
2683
conflicts = _mod_merge.merge_inner(
2684
tree.branch, other_tree, base_tree,
2686
interesting_ids=interesting_ids,
2687
other_rev_id=parents[1],
2688
merge_type=merge_type,
2689
show_base=show_base,
2690
reprocess=reprocess)
2699
class cmd_revert(Command):
2700
"""Revert files to a previous revision.
2702
Giving a list of files will revert only those files. Otherwise, all files
2703
will be reverted. If the revision is not specified with '--revision', the
2704
last committed revision is used.
2706
To remove only some changes, without reverting to a prior version, use
2707
merge instead. For example, "merge . --r-2..-3" will remove the changes
2708
introduced by -2, without affecting the changes introduced by -1. Or
2709
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2711
By default, any files that have been manually changed will be backed up
2712
first. (Files changed only by merge are not backed up.) Backup files have
2713
'.~#~' appended to their name, where # is a number.
2715
When you provide files, you can use their current pathname or the pathname
2716
from the target revision. So you can use revert to "undelete" a file by
2717
name. If you name a directory, all the contents of that directory will be
2720
takes_options = ['revision', 'no-backup']
2721
takes_args = ['file*']
2722
aliases = ['merge-revert']
2724
def run(self, revision=None, no_backup=False, file_list=None):
2725
if file_list is not None:
2726
if len(file_list) == 0:
2727
raise errors.BzrCommandError("No files specified")
2731
tree, file_list = tree_files(file_list)
2732
if revision is None:
2733
# FIXME should be tree.last_revision
2734
rev_id = tree.last_revision()
2735
elif len(revision) != 1:
2736
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2738
rev_id = revision[0].in_history(tree.branch).rev_id
2739
pb = ui.ui_factory.nested_progress_bar()
2741
tree.revert(file_list,
2742
tree.branch.repository.revision_tree(rev_id),
2743
not no_backup, pb, report_changes=True)
2748
class cmd_assert_fail(Command):
2749
"""Test reporting of assertion failures"""
2750
# intended just for use in testing
2755
raise AssertionError("always fails")
2758
class cmd_help(Command):
2759
"""Show help on a command or other topic.
2761
For a list of all available commands, say 'bzr help commands'.
2763
takes_options = [Option('long', 'show help on all commands')]
2764
takes_args = ['topic?']
2765
aliases = ['?', '--help', '-?', '-h']
2768
def run(self, topic=None, long=False):
2770
if topic is None and long:
2772
bzrlib.help.help(topic)
2775
class cmd_shell_complete(Command):
2776
"""Show appropriate completions for context.
2778
For a list of all available commands, say 'bzr shell-complete'.
2780
takes_args = ['context?']
2785
def run(self, context=None):
2786
import shellcomplete
2787
shellcomplete.shellcomplete(context)
2790
class cmd_fetch(Command):
2791
"""Copy in history from another branch but don't merge it.
2793
This is an internal method used for pull and merge.
2796
takes_args = ['from_branch', 'to_branch']
2797
def run(self, from_branch, to_branch):
2798
from bzrlib.fetch import Fetcher
2799
from_b = Branch.open(from_branch)
2800
to_b = Branch.open(to_branch)
2801
Fetcher(to_b, from_b)
2804
class cmd_missing(Command):
2805
"""Show unmerged/unpulled revisions between two branches.
2807
OTHER_BRANCH may be local or remote.
2809
takes_args = ['other_branch?']
2810
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2812
'Display changes in the local branch only'),
2813
Option('theirs-only',
2814
'Display changes in the remote branch only'),
2819
encoding_type = 'replace'
2822
def run(self, other_branch=None, reverse=False, mine_only=False,
2823
theirs_only=False, log_format=None, long=False, short=False, line=False,
2824
show_ids=False, verbose=False):
2825
from bzrlib.missing import find_unmerged, iter_log_data
2826
from bzrlib.log import log_formatter
2827
local_branch = Branch.open_containing(u".")[0]
2828
parent = local_branch.get_parent()
2829
if other_branch is None:
2830
other_branch = parent
2831
if other_branch is None:
2832
raise errors.BzrCommandError("No peer location known or specified.")
2833
display_url = urlutils.unescape_for_display(parent,
2835
print "Using last location: " + display_url
2837
remote_branch = Branch.open(other_branch)
2838
if remote_branch.base == local_branch.base:
2839
remote_branch = local_branch
2840
local_branch.lock_read()
2842
remote_branch.lock_read()
2844
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2845
if (log_format is None):
2846
log_format = log.log_formatter_registry.get_default(
2848
lf = log_format(to_file=self.outf,
2850
show_timezone='original')
2851
if reverse is False:
2852
local_extra.reverse()
2853
remote_extra.reverse()
2854
if local_extra and not theirs_only:
2855
print "You have %d extra revision(s):" % len(local_extra)
2856
for data in iter_log_data(local_extra, local_branch.repository,
2859
printed_local = True
2861
printed_local = False
2862
if remote_extra and not mine_only:
2863
if printed_local is True:
2865
print "You are missing %d revision(s):" % len(remote_extra)
2866
for data in iter_log_data(remote_extra, remote_branch.repository,
2869
if not remote_extra and not local_extra:
2871
print "Branches are up to date."
2875
remote_branch.unlock()
2877
local_branch.unlock()
2878
if not status_code and parent is None and other_branch is not None:
2879
local_branch.lock_write()
2881
# handle race conditions - a parent might be set while we run.
2882
if local_branch.get_parent() is None:
2883
local_branch.set_parent(remote_branch.base)
2885
local_branch.unlock()
2889
class cmd_plugins(Command):
2894
import bzrlib.plugin
2895
from inspect import getdoc
2896
for name, plugin in bzrlib.plugin.all_plugins().items():
2897
if getattr(plugin, '__path__', None) is not None:
2898
print plugin.__path__[0]
2899
elif getattr(plugin, '__file__', None) is not None:
2900
print plugin.__file__
2906
print '\t', d.split('\n')[0]
2909
class cmd_testament(Command):
2910
"""Show testament (signing-form) of a revision."""
2911
takes_options = ['revision',
2912
Option('long', help='Produce long-format testament'),
2913
Option('strict', help='Produce a strict-format'
2915
takes_args = ['branch?']
2917
def run(self, branch=u'.', revision=None, long=False, strict=False):
2918
from bzrlib.testament import Testament, StrictTestament
2920
testament_class = StrictTestament
2922
testament_class = Testament
2923
b = WorkingTree.open_containing(branch)[0].branch
2926
if revision is None:
2927
rev_id = b.last_revision()
2929
rev_id = revision[0].in_history(b).rev_id
2930
t = testament_class.from_revision(b.repository, rev_id)
2932
sys.stdout.writelines(t.as_text_lines())
2934
sys.stdout.write(t.as_short_text())
2939
class cmd_annotate(Command):
2940
"""Show the origin of each line in a file.
2942
This prints out the given file with an annotation on the left side
2943
indicating which revision, author and date introduced the change.
2945
If the origin is the same for a run of consecutive lines, it is
2946
shown only at the top, unless the --all option is given.
2948
# TODO: annotate directories; showing when each file was last changed
2949
# TODO: if the working copy is modified, show annotations on that
2950
# with new uncommitted lines marked
2951
aliases = ['ann', 'blame', 'praise']
2952
takes_args = ['filename']
2953
takes_options = [Option('all', help='show annotations on all lines'),
2954
Option('long', help='show date in annotations'),
2960
def run(self, filename, all=False, long=False, revision=None,
2962
from bzrlib.annotate import annotate_file
2963
tree, relpath = WorkingTree.open_containing(filename)
2964
branch = tree.branch
2967
if revision is None:
2968
revision_id = branch.last_revision()
2969
elif len(revision) != 1:
2970
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2972
revision_id = revision[0].in_history(branch).rev_id
2973
file_id = tree.path2id(relpath)
2974
tree = branch.repository.revision_tree(revision_id)
2975
file_version = tree.inventory[file_id].revision
2976
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2982
class cmd_re_sign(Command):
2983
"""Create a digital signature for an existing revision."""
2984
# TODO be able to replace existing ones.
2986
hidden = True # is this right ?
2987
takes_args = ['revision_id*']
2988
takes_options = ['revision']
2990
def run(self, revision_id_list=None, revision=None):
2991
import bzrlib.gpg as gpg
2992
if revision_id_list is not None and revision is not None:
2993
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2994
if revision_id_list is None and revision is None:
2995
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2996
b = WorkingTree.open_containing(u'.')[0].branch
2997
gpg_strategy = gpg.GPGStrategy(b.get_config())
2998
if revision_id_list is not None:
2999
for revision_id in revision_id_list:
3000
b.repository.sign_revision(revision_id, gpg_strategy)
3001
elif revision is not None:
3002
if len(revision) == 1:
3003
revno, rev_id = revision[0].in_history(b)
3004
b.repository.sign_revision(rev_id, gpg_strategy)
3005
elif len(revision) == 2:
3006
# are they both on rh- if so we can walk between them
3007
# might be nice to have a range helper for arbitrary
3008
# revision paths. hmm.
3009
from_revno, from_revid = revision[0].in_history(b)
3010
to_revno, to_revid = revision[1].in_history(b)
3011
if to_revid is None:
3012
to_revno = b.revno()
3013
if from_revno is None or to_revno is None:
3014
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3015
for revno in range(from_revno, to_revno + 1):
3016
b.repository.sign_revision(b.get_rev_id(revno),
3019
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3022
class cmd_bind(Command):
3023
"""Convert the current branch into a checkout of the supplied branch.
3025
Once converted into a checkout, commits must succeed on the master branch
3026
before they will be applied to the local branch.
3028
See "help checkouts" for more information on checkouts.
3031
takes_args = ['location?']
3034
def run(self, location=None):
3035
b, relpath = Branch.open_containing(u'.')
3036
if location is None:
3038
location = b.get_old_bound_location()
3039
except errors.UpgradeRequired:
3040
raise errors.BzrCommandError('No location supplied. '
3041
'This format does not remember old locations.')
3043
if location is None:
3044
raise errors.BzrCommandError('No location supplied and no '
3045
'previous location known')
3046
b_other = Branch.open(location)
3049
except errors.DivergedBranches:
3050
raise errors.BzrCommandError('These branches have diverged.'
3051
' Try merging, and then bind again.')
3054
class cmd_unbind(Command):
3055
"""Convert the current checkout into a regular branch.
3057
After unbinding, the local branch is considered independent and subsequent
3058
commits will be local only.
3060
See "help checkouts" for more information on checkouts.
3067
b, relpath = Branch.open_containing(u'.')
3069
raise errors.BzrCommandError('Local branch is not bound')
3072
class cmd_uncommit(Command):
3073
"""Remove the last committed revision.
3075
--verbose will print out what is being removed.
3076
--dry-run will go through all the motions, but not actually
3079
In the future, uncommit will create a revision bundle, which can then
3083
# TODO: jam 20060108 Add an option to allow uncommit to remove
3084
# unreferenced information in 'branch-as-repository' branches.
3085
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3086
# information in shared branches as well.
3087
takes_options = ['verbose', 'revision',
3088
Option('dry-run', help='Don\'t actually make changes'),
3089
Option('force', help='Say yes to all questions.')]
3090
takes_args = ['location?']
3093
def run(self, location=None,
3094
dry_run=False, verbose=False,
3095
revision=None, force=False):
3096
from bzrlib.log import log_formatter, show_log
3098
from bzrlib.uncommit import uncommit
3100
if location is None:
3102
control, relpath = bzrdir.BzrDir.open_containing(location)
3104
tree = control.open_workingtree()
3106
except (errors.NoWorkingTree, errors.NotLocalUrl):
3108
b = control.open_branch()
3111
if revision is None:
3114
# 'bzr uncommit -r 10' actually means uncommit
3115
# so that the final tree is at revno 10.
3116
# but bzrlib.uncommit.uncommit() actually uncommits
3117
# the revisions that are supplied.
3118
# So we need to offset it by one
3119
revno = revision[0].in_history(b).revno+1
3121
if revno <= b.revno():
3122
rev_id = b.get_rev_id(revno)
3124
self.outf.write('No revisions to uncommit.\n')
3127
lf = log_formatter('short',
3129
show_timezone='original')
3134
direction='forward',
3135
start_revision=revno,
3136
end_revision=b.revno())
3139
print 'Dry-run, pretending to remove the above revisions.'
3141
val = raw_input('Press <enter> to continue')
3143
print 'The above revision(s) will be removed.'
3145
val = raw_input('Are you sure [y/N]? ')
3146
if val.lower() not in ('y', 'yes'):
3150
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3154
class cmd_break_lock(Command):
3155
"""Break a dead lock on a repository, branch or working directory.
3157
CAUTION: Locks should only be broken when you are sure that the process
3158
holding the lock has been stopped.
3160
You can get information on what locks are open via the 'bzr info' command.
3165
takes_args = ['location?']
3167
def run(self, location=None, show=False):
3168
if location is None:
3170
control, relpath = bzrdir.BzrDir.open_containing(location)
3172
control.break_lock()
3173
except NotImplementedError:
3177
class cmd_wait_until_signalled(Command):
3178
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3180
This just prints a line to signal when it is ready, then blocks on stdin.
3186
sys.stdout.write("running\n")
3188
sys.stdin.readline()
3191
class cmd_serve(Command):
3192
"""Run the bzr server."""
3194
aliases = ['server']
3198
help='serve on stdin/out for use from inetd or sshd'),
3200
help='listen for connections on nominated port of the form '
3201
'[hostname:]portnumber. Passing 0 as the port number will '
3202
'result in a dynamically allocated port. Default port is '
3206
help='serve contents of directory',
3208
Option('allow-writes',
3209
help='By default the server is a readonly server. Supplying '
3210
'--allow-writes enables write access to the contents of '
3211
'the served directory and below. '
3215
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3216
from bzrlib.transport import smart
3217
from bzrlib.transport import get_transport
3218
if directory is None:
3219
directory = os.getcwd()
3220
url = urlutils.local_path_to_url(directory)
3221
if not allow_writes:
3222
url = 'readonly+' + url
3223
t = get_transport(url)
3225
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3228
port = smart.BZR_DEFAULT_PORT
3232
host, port = port.split(':')
3236
server = smart.SmartTCPServer(t, host=host, port=port)
3237
print 'listening on port: ', server.port
3241
class cmd_join(Command):
3242
"""Combine a subtree into its containing tree.
3244
This is marked as a merge of the subtree into the containing tree, and all
3245
history is preserved.
3248
takes_args = ['tree']
3249
takes_options = [Option('reference', 'join by reference')]
3251
def run(self, tree, reference=False):
3252
sub_tree = WorkingTree.open(tree)
3253
parent_dir = osutils.dirname(sub_tree.basedir)
3254
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3255
repo = containing_tree.branch.repository
3256
if not repo.supports_rich_root():
3257
raise errors.BzrCommandError(
3258
"Can't join trees because %s doesn't support rich root data.\n"
3259
"You can use bzr upgrade on the repository."
3263
containing_tree.add_reference(sub_tree)
3264
except errors.BadReferenceTarget, e:
3265
# XXX: Would be better to just raise a nicely printable
3266
# exception from the real origin. Also below. mbp 20070306
3267
raise errors.BzrCommandError("Cannot join %s. %s" %
3271
containing_tree.subsume(sub_tree)
3272
except errors.BadSubsumeSource, e:
3273
raise errors.BzrCommandError("Cannot join %s. %s" %
3277
class cmd_split(Command):
3278
"""Split a tree into two trees.
3281
takes_args = ['tree']
3283
def run(self, tree):
3284
containing_tree, subdir = WorkingTree.open_containing(tree)
3285
sub_id = containing_tree.path2id(subdir)
3287
raise errors.NotVersionedError(subdir)
3289
containing_tree.extract(sub_id)
3290
except errors.RootNotRich:
3291
raise errors.UpgradeRequired(containing_tree.branch.base)
3295
class cmd_tag(Command):
3296
"""Create a tag naming a revision.
3298
Tags give human-meaningful names to revisions. Commands that take a -r
3299
(--revision) option can be given -rtag:X, where X is any previously
3302
Tags are stored in the branch. Tags are copied from one branch to another
3303
along when you branch, push, pull or merge.
3305
It is an error to give a tag name that already exists unless you pass
3306
--force, in which case the tag is moved to point to the new revision.
3309
takes_args = ['tag_name']
3312
help='Delete this tag rather than placing it.',
3315
help='Branch in which to place the tag.',
3320
help='Replace existing tags',
3325
def run(self, tag_name,
3331
branch, relpath = Branch.open_containing(directory)
3335
branch.tags.delete_tag(tag_name)
3336
self.outf.write('Deleted tag %s.\n' % tag_name)
3339
if len(revision) != 1:
3340
raise errors.BzrCommandError(
3341
"Tags can only be placed on a single revision, "
3343
revision_id = revision[0].in_history(branch).rev_id
3345
revision_id = branch.last_revision()
3346
if (not force) and branch.tags.has_tag(tag_name):
3347
raise errors.TagAlreadyExists(tag_name)
3348
branch.tags.set_tag(tag_name, revision_id)
3349
self.outf.write('Created tag %s.\n' % tag_name)
3354
class cmd_tags(Command):
3357
This tag shows a table of tag names and the revisions they reference.
3362
help='Branch whose tags should be displayed',
3372
branch, relpath = Branch.open_containing(directory)
3373
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3374
self.outf.write('%-20s %s\n' % (tag_name, target))
3377
# command-line interpretation helper for merge-related commands
3378
def _merge_helper(other_revision, base_revision,
3379
check_clean=True, ignore_zero=False,
3380
this_dir=None, backup_files=False,
3382
file_list=None, show_base=False, reprocess=False,
3385
change_reporter=None):
3386
"""Merge changes into a tree.
3389
list(path, revno) Base for three-way merge.
3390
If [None, None] then a base will be automatically determined.
3392
list(path, revno) Other revision for three-way merge.
3394
Directory to merge changes into; '.' by default.
3396
If true, this_dir must have no uncommitted changes before the
3398
ignore_zero - If true, suppress the "zero conflicts" message when
3399
there are no conflicts; should be set when doing something we expect
3400
to complete perfectly.
3401
file_list - If supplied, merge only changes to selected files.
3403
All available ancestors of other_revision and base_revision are
3404
automatically pulled into the branch.
3406
The revno may be -1 to indicate the last revision on the branch, which is
3409
This function is intended for use from the command line; programmatic
3410
clients might prefer to call merge.merge_inner(), which has less magic
3413
# Loading it late, so that we don't always have to import bzrlib.merge
3414
if merge_type is None:
3415
merge_type = _mod_merge.Merge3Merger
3416
if this_dir is None:
3418
this_tree = WorkingTree.open_containing(this_dir)[0]
3419
if show_base and not merge_type is _mod_merge.Merge3Merger:
3420
raise errors.BzrCommandError("Show-base is not supported for this merge"
3421
" type. %s" % merge_type)
3422
if reprocess and not merge_type.supports_reprocess:
3423
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3424
" type %s." % merge_type)
3425
if reprocess and show_base:
3426
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3427
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3428
# only want to take out a lock_tree_write() if we don't have to pull
3429
# any ancestry. But merge might fetch ancestry in the middle, in
3430
# which case we would need a lock_write().
3431
# Because we cannot upgrade locks, for now we live with the fact that
3432
# the tree will be locked multiple times during a merge. (Maybe
3433
# read-only some of the time, but it means things will get read
3436
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3437
pb=pb, change_reporter=change_reporter)
3438
merger.pp = ProgressPhase("Merge phase", 5, pb)
3439
merger.pp.next_phase()
3440
merger.check_basis(check_clean)
3441
merger.set_other(other_revision)
3442
merger.pp.next_phase()
3443
merger.set_base(base_revision)
3444
if merger.base_rev_id == merger.other_rev_id:
3445
note('Nothing to do.')
3447
if file_list is None:
3448
if pull and merger.base_rev_id == merger.this_rev_id:
3449
# FIXME: deduplicate with pull
3450
result = merger.this_tree.pull(merger.this_branch,
3451
False, merger.other_rev_id)
3452
if result.old_revid == result.new_revid:
3453
note('No revisions to pull.')
3455
note('Now on revision %d.' % result.new_revno)
3457
merger.backup_files = backup_files
3458
merger.merge_type = merge_type
3459
merger.set_interesting_files(file_list)
3460
merger.show_base = show_base
3461
merger.reprocess = reprocess
3462
conflicts = merger.do_merge()
3463
if file_list is None:
3464
merger.set_pending()
3471
merge = _merge_helper
3474
# these get imported and then picked up by the scan for cmd_*
3475
# TODO: Some more consistent way to split command definitions across files;
3476
# we do need to load at least some information about them to know of
3477
# aliases. ideally we would avoid loading the implementation until the
3478
# details were needed.
3479
from bzrlib.cmd_version_info import cmd_version_info
3480
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3481
from bzrlib.bundle.commands import cmd_bundle_revisions
3482
from bzrlib.sign_my_commits import cmd_sign_my_commits
3483
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3484
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
