1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
47
from bzrlib.branch import Branch
48
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
49
from bzrlib.conflicts import ConflictList
50
from bzrlib.revision import common_ancestor
51
from bzrlib.revisionspec import RevisionSpec
52
from bzrlib.workingtree import WorkingTree
55
from bzrlib.commands import Command, display_command
56
from bzrlib.option import Option, RegistryOption
57
from bzrlib.progress import DummyProgress, ProgressPhase
58
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
61
def tree_files(file_list, default_branch=u'.'):
63
return internal_tree_files(file_list, default_branch)
64
except errors.FileInWrongBranch, e:
65
raise errors.BzrCommandError("%s is not in the same branch as %s" %
66
(e.path, file_list[0]))
69
# XXX: Bad function name; should possibly also be a class method of
70
# WorkingTree rather than a function.
71
def internal_tree_files(file_list, default_branch=u'.'):
72
"""Convert command-line paths to a WorkingTree and relative paths.
74
This is typically used for command-line processors that take one or
75
more filenames, and infer the workingtree that contains them.
77
The filenames given are not required to exist.
79
:param file_list: Filenames to convert.
81
:param default_branch: Fallback tree path to use if file_list is empty or
84
:return: workingtree, [relative_paths]
86
if file_list is None or len(file_list) == 0:
87
return WorkingTree.open_containing(default_branch)[0], file_list
88
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
90
for filename in file_list:
92
new_list.append(tree.relpath(osutils.dereference_path(filename)))
93
except errors.PathNotChild:
94
raise errors.FileInWrongBranch(tree.branch, filename)
98
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
99
def get_format_type(typestring):
100
"""Parse and return a format specifier."""
101
# Have to use BzrDirMetaFormat1 directly, so that
102
# RepositoryFormat.set_default_format works
103
if typestring == "default":
104
return bzrdir.BzrDirMetaFormat1()
106
return bzrdir.format_registry.make_bzrdir(typestring)
108
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
109
raise errors.BzrCommandError(msg)
112
# TODO: Make sure no commands unconditionally use the working directory as a
113
# branch. If a filename argument is used, the first of them should be used to
114
# specify the branch. (Perhaps this can be factored out into some kind of
115
# Argument class, representing a file in a branch, where the first occurrence
118
class cmd_status(Command):
119
"""Display status summary.
121
This reports on versioned and unknown files, reporting them
122
grouped by state. Possible states are:
125
Versioned in the working copy but not in the previous revision.
128
Versioned in the previous revision but removed or deleted
132
Path of this file changed from the previous revision;
133
the text may also have changed. This includes files whose
134
parent directory was renamed.
137
Text has changed since the previous revision.
140
File kind has been changed (e.g. from file to directory).
143
Not versioned and not matching an ignore pattern.
145
To see ignored files use 'bzr ignored'. For details in the
146
changes to file texts, use 'bzr diff'.
148
--short gives a status flags for each item, similar to the SVN's status
151
Column 1: versioning / renames
157
P Entry for a pending merge (not a file)
166
* The execute bit was changed
168
If no arguments are specified, the status of the entire working
169
directory is shown. Otherwise, only the status of the specified
170
files or directories is reported. If a directory is given, status
171
is reported for everything inside that directory.
173
If a revision argument is given, the status is calculated against
174
that revision, or between two revisions if two are provided.
177
# TODO: --no-recurse, --recurse options
179
takes_args = ['file*']
180
takes_options = ['show-ids', 'revision', 'short']
181
aliases = ['st', 'stat']
183
encoding_type = 'replace'
186
def run(self, show_ids=False, file_list=None, revision=None, short=False):
187
from bzrlib.status import show_tree_status
189
tree, file_list = tree_files(file_list)
191
show_tree_status(tree, show_ids=show_ids,
192
specific_files=file_list, revision=revision,
197
class cmd_cat_revision(Command):
198
"""Write out metadata for a revision.
200
The revision to print can either be specified by a specific
201
revision identifier, or you can use --revision.
205
takes_args = ['revision_id?']
206
takes_options = ['revision']
207
# cat-revision is more for frontends so should be exact
211
def run(self, revision_id=None, revision=None):
213
if revision_id is not None and revision is not None:
214
raise errors.BzrCommandError('You can only supply one of'
215
' revision_id or --revision')
216
if revision_id is None and revision is None:
217
raise errors.BzrCommandError('You must supply either'
218
' --revision or a revision_id')
219
b = WorkingTree.open_containing(u'.')[0].branch
221
# TODO: jam 20060112 should cat-revision always output utf-8?
222
if revision_id is not None:
223
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
224
elif revision is not None:
227
raise errors.BzrCommandError('You cannot specify a NULL'
229
revno, rev_id = rev.in_history(b)
230
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
233
class cmd_remove_tree(Command):
234
"""Remove the working tree from a given branch/checkout.
236
Since a lightweight checkout is little more than a working tree
237
this will refuse to run against one.
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,
347
if file_ids_from is not None:
349
base_tree, base_path = WorkingTree.open_containing(
351
except errors.NoWorkingTree:
352
base_branch, base_path = Branch.open_containing(
354
base_tree = base_branch.basis_tree()
356
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
357
to_file=self.outf, should_print=(not is_quiet()))
359
action = bzrlib.add.AddAction(to_file=self.outf,
360
should_print=(not is_quiet()))
362
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
363
action=action, save=not dry_run)
366
for glob in sorted(ignored.keys()):
367
for path in ignored[glob]:
368
self.outf.write("ignored %s matching \"%s\"\n"
372
for glob, paths in ignored.items():
373
match_len += len(paths)
374
self.outf.write("ignored %d file(s).\n" % match_len)
375
self.outf.write("If you wish to add some of these files,"
376
" please add them by name.\n")
379
class cmd_mkdir(Command):
380
"""Create a new versioned directory.
382
This is equivalent to creating the directory and then adding it.
385
takes_args = ['dir+']
386
encoding_type = 'replace'
388
def run(self, dir_list):
391
wt, dd = WorkingTree.open_containing(d)
393
self.outf.write('added %s\n' % d)
396
class cmd_relpath(Command):
397
"""Show path of a file relative to root"""
399
takes_args = ['filename']
403
def run(self, filename):
404
# TODO: jam 20050106 Can relpath return a munged path if
405
# sys.stdout encoding cannot represent it?
406
tree, relpath = WorkingTree.open_containing(filename)
407
self.outf.write(relpath)
408
self.outf.write('\n')
411
class cmd_inventory(Command):
412
"""Show inventory of the current working copy or a revision.
414
It is possible to limit the output to a particular entry
415
type using the --kind option. For example: --kind file.
417
It is also possible to restrict the list of files to a specific
418
set. For example: bzr inventory --show-ids this/file
425
takes_options = ['revision', 'show-ids', 'kind']
427
takes_args = ['file*']
430
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
431
if kind and kind not in ['file', 'directory', 'symlink']:
432
raise errors.BzrCommandError('invalid kind specified')
434
work_tree, file_list = tree_files(file_list)
436
if revision is not None:
437
if len(revision) > 1:
438
raise errors.BzrCommandError('bzr inventory --revision takes'
439
' exactly one revision identifier')
440
revision_id = revision[0].in_history(work_tree.branch).rev_id
441
tree = work_tree.branch.repository.revision_tree(revision_id)
443
# We include work_tree as well as 'tree' here
444
# So that doing '-r 10 path/foo' will lookup whatever file
445
# exists now at 'path/foo' even if it has been renamed, as
446
# well as whatever files existed in revision 10 at path/foo
447
trees = [tree, work_tree]
452
if file_list is not None:
453
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
454
require_versioned=True)
455
# find_ids_across_trees may include some paths that don't
457
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
458
for file_id in file_ids if file_id in tree)
460
entries = tree.inventory.entries()
462
for path, entry in entries:
463
if kind and kind != entry.kind:
466
self.outf.write('%-50s %s\n' % (path, entry.file_id))
468
self.outf.write(path)
469
self.outf.write('\n')
472
class cmd_mv(Command):
473
"""Move or rename a file.
476
bzr mv OLDNAME NEWNAME
477
bzr mv SOURCE... DESTINATION
479
If the last argument is a versioned directory, all the other names
480
are moved into it. Otherwise, there must be exactly two arguments
481
and the file is changed to a new name.
483
If OLDNAME does not exist on the filesystem but is versioned and
484
NEWNAME does exist on the filesystem but is not versioned, mv
485
assumes that the file has been manually moved and only updates
486
its internal inventory to reflect that change.
487
The same is valid when moving many SOURCE files to a DESTINATION.
489
Files cannot be moved between branches.
492
takes_args = ['names*']
493
takes_options = [Option("after", help="move only the bzr identifier"
494
" of the file (file has already been moved). Use this flag if"
495
" bzr is not able to detect this itself.")]
496
aliases = ['move', 'rename']
497
encoding_type = 'replace'
499
def run(self, names_list, after=False):
500
if names_list is None:
503
if len(names_list) < 2:
504
raise errors.BzrCommandError("missing file argument")
505
tree, rel_names = tree_files(names_list)
507
if os.path.isdir(names_list[-1]):
508
# move into existing directory
509
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
510
self.outf.write("%s => %s\n" % pair)
512
if len(names_list) != 2:
513
raise errors.BzrCommandError('to mv multiple files the'
514
' destination must be a versioned'
516
tree.rename_one(rel_names[0], rel_names[1], after=after)
517
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
520
class cmd_pull(Command):
521
"""Turn this branch into a mirror of another branch.
523
This command only works on branches that have not diverged. Branches are
524
considered diverged if the destination branch's most recent commit is one
525
that has not been merged (directly or indirectly) into the parent.
527
If branches have diverged, you can use 'bzr merge' to integrate the changes
528
from one into the other. Once one branch has merged, the other should
529
be able to pull it again.
531
If you want to forget your local changes and just update your branch to
532
match the remote one, use pull --overwrite.
534
If there is no default location set, the first pull will set it. After
535
that, you can omit the location to use the default. To change the
536
default, use --remember. The value will only be saved if the remote
537
location can be accessed.
540
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
542
help='branch to pull into, '
543
'rather than the one containing the working directory',
548
takes_args = ['location?']
549
encoding_type = 'replace'
551
def run(self, location=None, remember=False, overwrite=False,
552
revision=None, verbose=False,
554
# FIXME: too much stuff is in the command class
555
if directory is None:
558
tree_to = WorkingTree.open_containing(directory)[0]
559
branch_to = tree_to.branch
560
except errors.NoWorkingTree:
562
branch_to = Branch.open_containing(directory)[0]
565
if location is not None:
567
reader = bundle.read_bundle_from_url(location)
568
except errors.NotABundle:
569
pass # Continue on considering this url a Branch
571
stored_loc = branch_to.get_parent()
573
if stored_loc is None:
574
raise errors.BzrCommandError("No pull location known or"
577
display_url = urlutils.unescape_for_display(stored_loc,
579
self.outf.write("Using saved location: %s\n" % display_url)
580
location = stored_loc
582
if reader is not None:
583
install_bundle(branch_to.repository, reader)
584
branch_from = branch_to
586
branch_from = Branch.open(location)
588
if branch_to.get_parent() is None or remember:
589
branch_to.set_parent(branch_from.base)
593
if reader is not None:
594
rev_id = reader.target
595
elif len(revision) == 1:
596
rev_id = revision[0].in_history(branch_from).rev_id
598
raise errors.BzrCommandError('bzr pull --revision takes one value.')
600
old_rh = branch_to.revision_history()
601
if tree_to is not None:
602
count = tree_to.pull(branch_from, overwrite, rev_id)
604
count = branch_to.pull(branch_from, overwrite, rev_id)
605
note('%d revision(s) pulled.' % (count,))
608
new_rh = branch_to.revision_history()
611
from bzrlib.log import show_changed_revisions
612
show_changed_revisions(branch_to, old_rh, new_rh,
616
class cmd_push(Command):
617
"""Update a mirror of this branch.
619
The target branch will not have its working tree populated because this
620
is both expensive, and is not supported on remote file systems.
622
Some smart servers or protocols *may* put the working tree in place in
625
This command only works on branches that have not diverged. Branches are
626
considered diverged if the destination branch's most recent commit is one
627
that has not been merged (directly or indirectly) by the source branch.
629
If branches have diverged, you can use 'bzr push --overwrite' to replace
630
the other branch completely, discarding its unmerged changes.
632
If you want to ensure you have the different changes in the other branch,
633
do a merge (see bzr help merge) from the other branch, and commit that.
634
After that you will be able to do a push without '--overwrite'.
636
If there is no default push location set, the first push will set it.
637
After that, you can omit the location to use the default. To change the
638
default, use --remember. The value will only be saved if the remote
639
location can be accessed.
642
takes_options = ['remember', 'overwrite', 'verbose',
643
Option('create-prefix',
644
help='Create the path leading up to the branch '
645
'if it does not already exist'),
647
help='branch to push from, '
648
'rather than the one containing the working directory',
652
Option('use-existing-dir',
653
help='By default push will fail if the target'
654
' directory exists, but does not already'
655
' have a control directory. This flag will'
656
' allow push to proceed.'),
658
takes_args = ['location?']
659
encoding_type = 'replace'
661
def run(self, location=None, remember=False, overwrite=False,
662
create_prefix=False, verbose=False,
663
use_existing_dir=False,
665
# FIXME: Way too big! Put this into a function called from the
667
if directory is None:
669
br_from = Branch.open_containing(directory)[0]
670
stored_loc = br_from.get_push_location()
672
if stored_loc is None:
673
raise errors.BzrCommandError("No push location known or specified.")
675
display_url = urlutils.unescape_for_display(stored_loc,
677
self.outf.write("Using saved location: %s\n" % display_url)
678
location = stored_loc
680
to_transport = transport.get_transport(location)
681
location_url = to_transport.base
686
br_to = repository_to = dir_to = None
688
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
689
except errors.NotBranchError:
690
pass # Didn't find anything
692
# If we can open a branch, use its direct repository, otherwise see
693
# if there is a repository without a branch.
695
br_to = dir_to.open_branch()
696
except errors.NotBranchError:
697
# Didn't find a branch, can we find a repository?
699
repository_to = dir_to.find_repository()
700
except errors.NoRepositoryPresent:
703
# Found a branch, so we must have found a repository
704
repository_to = br_to.repository
708
# XXX: Refactor the create_prefix/no_create_prefix code into a
709
# common helper function
711
to_transport.mkdir('.')
712
except errors.FileExists:
713
if not use_existing_dir:
714
raise errors.BzrCommandError("Target directory %s"
715
" already exists, but does not have a valid .bzr"
716
" directory. Supply --use-existing-dir to push"
717
" there anyway." % location)
718
except errors.NoSuchFile:
719
if not create_prefix:
720
raise errors.BzrCommandError("Parent directory of %s"
722
"\nYou may supply --create-prefix to create all"
723
" leading parent directories."
726
cur_transport = to_transport
727
needed = [cur_transport]
728
# Recurse upwards until we can create a directory successfully
730
new_transport = cur_transport.clone('..')
731
if new_transport.base == cur_transport.base:
732
raise errors.BzrCommandError("Failed to create path"
736
new_transport.mkdir('.')
737
except errors.NoSuchFile:
738
needed.append(new_transport)
739
cur_transport = new_transport
743
# Now we only need to create child directories
745
cur_transport = needed.pop()
746
cur_transport.mkdir('.')
748
# Now the target directory exists, but doesn't have a .bzr
749
# directory. So we need to create it, along with any work to create
750
# all of the dependent branches, etc.
751
dir_to = br_from.bzrdir.clone(location_url,
752
revision_id=br_from.last_revision())
753
br_to = dir_to.open_branch()
754
count = br_to.last_revision_info()[0]
755
# We successfully created the target, remember it
756
if br_from.get_push_location() is None or remember:
757
br_from.set_push_location(br_to.base)
758
elif repository_to is None:
759
# we have a bzrdir but no branch or repository
760
# XXX: Figure out what to do other than complain.
761
raise errors.BzrCommandError("At %s you have a valid .bzr control"
762
" directory, but not a branch or repository. This is an"
763
" unsupported configuration. Please move the target directory"
764
" out of the way and try again."
767
# We have a repository but no branch, copy the revisions, and then
769
last_revision_id = br_from.last_revision()
770
repository_to.fetch(br_from.repository,
771
revision_id=last_revision_id)
772
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
773
count = len(br_to.revision_history())
774
if br_from.get_push_location() is None or remember:
775
br_from.set_push_location(br_to.base)
776
else: # We have a valid to branch
777
# We were able to connect to the remote location, so remember it
778
# we don't need to successfully push because of possible divergence.
779
if br_from.get_push_location() is None or remember:
780
br_from.set_push_location(br_to.base)
781
old_rh = br_to.revision_history()
784
tree_to = dir_to.open_workingtree()
785
except errors.NotLocalUrl:
786
warning('This transport does not update the working '
787
'tree of: %s' % (br_to.base,))
788
count = br_from.push(br_to, overwrite)
789
except errors.NoWorkingTree:
790
count = br_from.push(br_to, overwrite)
794
count = br_from.push(tree_to.branch, overwrite)
798
except errors.DivergedBranches:
799
raise errors.BzrCommandError('These branches have diverged.'
800
' Try using "merge" and then "push".')
801
note('%d revision(s) pushed.' % (count,))
804
new_rh = br_to.revision_history()
807
from bzrlib.log import show_changed_revisions
808
show_changed_revisions(br_to, old_rh, new_rh,
812
class cmd_branch(Command):
813
"""Create a new copy of a branch.
815
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
816
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
818
To retrieve the branch as of a particular revision, supply the --revision
819
parameter, as in "branch foo/bar -r 5".
821
--basis is to speed up branching from remote branches. When specified, it
822
copies all the file-contents, inventory and revision data from the basis
823
branch before copying anything from the remote branch.
825
takes_args = ['from_location', 'to_location?']
826
takes_options = ['revision', 'basis']
827
aliases = ['get', 'clone']
829
def run(self, from_location, to_location=None, revision=None, basis=None):
832
elif len(revision) > 1:
833
raise errors.BzrCommandError(
834
'bzr branch --revision takes exactly 1 revision value')
836
br_from = Branch.open(from_location)
839
if basis is not None:
840
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
843
if len(revision) == 1 and revision[0] is not None:
844
revision_id = revision[0].in_history(br_from)[1]
846
# FIXME - wt.last_revision, fallback to branch, fall back to
847
# None or perhaps NULL_REVISION to mean copy nothing
849
revision_id = br_from.last_revision()
850
if to_location is None:
851
to_location = os.path.basename(from_location.rstrip("/\\"))
854
name = os.path.basename(to_location) + '\n'
856
to_transport = transport.get_transport(to_location)
858
to_transport.mkdir('.')
859
except errors.FileExists:
860
raise errors.BzrCommandError('Target directory "%s" already'
861
' exists.' % to_location)
862
except errors.NoSuchFile:
863
raise errors.BzrCommandError('Parent of "%s" does not exist.'
866
# preserve whatever source format we have.
867
dir = br_from.bzrdir.sprout(to_transport.base,
868
revision_id, basis_dir)
869
branch = dir.open_branch()
870
except errors.NoSuchRevision:
871
to_transport.delete_tree('.')
872
msg = "The branch %s has no revision %s." % (from_location, revision[0])
873
raise errors.BzrCommandError(msg)
874
except errors.UnlistableBranch:
875
osutils.rmtree(to_location)
876
msg = "The branch %s cannot be used as a --basis" % (basis,)
877
raise errors.BzrCommandError(msg)
879
branch.control_files.put_utf8('branch-name', name)
880
note('Branched %d revision(s).' % branch.revno())
885
class cmd_checkout(Command):
886
"""Create a new checkout of an existing branch.
888
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
889
the branch found in '.'. This is useful if you have removed the working tree
890
or if it was never created - i.e. if you pushed the branch to its current
893
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
894
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
896
To retrieve the branch as of a particular revision, supply the --revision
897
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
898
out of date [so you cannot commit] but it may be useful (i.e. to examine old
901
--basis is to speed up checking out from remote branches. When specified, it
902
uses the inventory and file contents from the basis branch in preference to the
903
branch being checked out.
905
See "help checkouts" for more information on checkouts.
907
takes_args = ['branch_location?', 'to_location?']
908
takes_options = ['revision', # , 'basis']
909
Option('lightweight',
910
help="perform a lightweight checkout. Lightweight "
911
"checkouts depend on access to the branch for "
912
"every operation. Normal checkouts can perform "
913
"common operations like diff and status without "
914
"such access, and also support local commits."
919
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
923
elif len(revision) > 1:
924
raise errors.BzrCommandError(
925
'bzr checkout --revision takes exactly 1 revision value')
926
if branch_location is None:
927
branch_location = osutils.getcwd()
928
to_location = branch_location
929
source = Branch.open(branch_location)
930
if len(revision) == 1 and revision[0] is not None:
931
revision_id = revision[0].in_history(source)[1]
934
if to_location is None:
935
to_location = os.path.basename(branch_location.rstrip("/\\"))
936
# if the source and to_location are the same,
937
# and there is no working tree,
938
# then reconstitute a branch
939
if (osutils.abspath(to_location) ==
940
osutils.abspath(branch_location)):
942
source.bzrdir.open_workingtree()
943
except errors.NoWorkingTree:
944
source.bzrdir.create_workingtree()
947
os.mkdir(to_location)
949
if e.errno == errno.EEXIST:
950
raise errors.BzrCommandError('Target directory "%s" already'
951
' exists.' % to_location)
952
if e.errno == errno.ENOENT:
953
raise errors.BzrCommandError('Parent of "%s" does not exist.'
957
source.create_checkout(to_location, revision_id, lightweight)
960
class cmd_renames(Command):
961
"""Show list of renamed files.
963
# TODO: Option to show renames between two historical versions.
965
# TODO: Only show renames under dir, rather than in the whole branch.
966
takes_args = ['dir?']
969
def run(self, dir=u'.'):
970
tree = WorkingTree.open_containing(dir)[0]
971
old_inv = tree.basis_tree().inventory
972
new_inv = tree.read_working_inventory()
973
renames = list(_mod_tree.find_renames(old_inv, new_inv))
975
for old_name, new_name in renames:
976
self.outf.write("%s => %s\n" % (old_name, new_name))
979
class cmd_update(Command):
980
"""Update a tree to have the latest code committed to its branch.
982
This will perform a merge into the working tree, and may generate
983
conflicts. If you have any local changes, you will still
984
need to commit them after the update for the update to be complete.
986
If you want to discard your local changes, you can just do a
987
'bzr revert' instead of 'bzr commit' after the update.
989
takes_args = ['dir?']
992
def run(self, dir='.'):
993
tree = WorkingTree.open_containing(dir)[0]
994
master = tree.branch.get_master_branch()
995
if master is not None:
998
tree.lock_tree_write()
1000
existing_pending_merges = tree.get_parent_ids()[1:]
1001
last_rev = tree.last_revision()
1002
if last_rev == tree.branch.last_revision():
1003
# may be up to date, check master too.
1004
master = tree.branch.get_master_branch()
1005
if master is None or last_rev == master.last_revision():
1006
revno = tree.branch.revision_id_to_revno(last_rev)
1007
note("Tree is up to date at revision %d." % (revno,))
1009
conflicts = tree.update()
1010
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1011
note('Updated to revision %d.' % (revno,))
1012
if tree.get_parent_ids()[1:] != existing_pending_merges:
1013
note('Your local commits will now show as pending merges with '
1014
"'bzr status', and can be committed with 'bzr commit'.")
1023
class cmd_info(Command):
1024
"""Show information about a working tree, branch or repository.
1026
This command will show all known locations and formats associated to the
1027
tree, branch or repository. Statistical information is included with
1030
Branches and working trees will also report any missing revisions.
1032
takes_args = ['location?']
1033
takes_options = ['verbose']
1036
def run(self, location=None, verbose=False):
1037
from bzrlib.info import show_bzrdir_info
1038
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1042
class cmd_remove(Command):
1043
"""Make a file unversioned.
1045
This makes bzr stop tracking changes to a versioned file. It does
1046
not delete the working copy.
1048
You can specify one or more files, and/or --new. If you specify --new,
1049
only 'added' files will be removed. If you specify both, then new files
1050
in the specified directories will be removed. If the directories are
1051
also new, they will also be removed.
1053
takes_args = ['file*']
1054
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1056
encoding_type = 'replace'
1058
def run(self, file_list, verbose=False, new=False):
1059
tree, file_list = tree_files(file_list)
1061
if file_list is None:
1062
raise errors.BzrCommandError('Specify one or more files to'
1063
' remove, or use --new.')
1065
added = tree.changes_from(tree.basis_tree(),
1066
specific_files=file_list).added
1067
file_list = sorted([f[0] for f in added], reverse=True)
1068
if len(file_list) == 0:
1069
raise errors.BzrCommandError('No matching files.')
1070
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1073
class cmd_file_id(Command):
1074
"""Print file_id of a particular file or directory.
1076
The file_id is assigned when the file is first added and remains the
1077
same through all revisions where the file exists, even when it is
1082
takes_args = ['filename']
1085
def run(self, filename):
1086
tree, relpath = WorkingTree.open_containing(filename)
1087
i = tree.inventory.path2id(relpath)
1089
raise errors.NotVersionedError(filename)
1091
self.outf.write(i + '\n')
1094
class cmd_file_path(Command):
1095
"""Print path of file_ids to a file or directory.
1097
This prints one line for each directory down to the target,
1098
starting at the branch root.
1102
takes_args = ['filename']
1105
def run(self, filename):
1106
tree, relpath = WorkingTree.open_containing(filename)
1107
inv = tree.inventory
1108
fid = inv.path2id(relpath)
1110
raise errors.NotVersionedError(filename)
1111
for fip in inv.get_idpath(fid):
1112
self.outf.write(fip + '\n')
1115
class cmd_reconcile(Command):
1116
"""Reconcile bzr metadata in a branch.
1118
This can correct data mismatches that may have been caused by
1119
previous ghost operations or bzr upgrades. You should only
1120
need to run this command if 'bzr check' or a bzr developer
1121
advises you to run it.
1123
If a second branch is provided, cross-branch reconciliation is
1124
also attempted, which will check that data like the tree root
1125
id which was not present in very early bzr versions is represented
1126
correctly in both branches.
1128
At the same time it is run it may recompress data resulting in
1129
a potential saving in disk space or performance gain.
1131
The branch *MUST* be on a listable system such as local disk or sftp.
1133
takes_args = ['branch?']
1135
def run(self, branch="."):
1136
from bzrlib.reconcile import reconcile
1137
dir = bzrdir.BzrDir.open(branch)
1141
class cmd_revision_history(Command):
1142
"""Display the list of revision ids on a branch."""
1143
takes_args = ['location?']
1148
def run(self, location="."):
1149
branch = Branch.open_containing(location)[0]
1150
for revid in branch.revision_history():
1151
self.outf.write(revid)
1152
self.outf.write('\n')
1155
class cmd_ancestry(Command):
1156
"""List all revisions merged into this branch."""
1157
takes_args = ['location?']
1162
def run(self, location="."):
1164
wt = WorkingTree.open_containing(location)[0]
1165
except errors.NoWorkingTree:
1166
b = Branch.open(location)
1167
last_revision = b.last_revision()
1170
last_revision = wt.last_revision()
1172
revision_ids = b.repository.get_ancestry(last_revision)
1173
assert revision_ids[0] is None
1175
for revision_id in revision_ids:
1176
self.outf.write(revision_id + '\n')
1179
class cmd_init(Command):
1180
"""Make a directory into a versioned branch.
1182
Use this to create an empty branch, or before importing an
1185
If there is a repository in a parent directory of the location, then
1186
the history of the branch will be stored in the repository. Otherwise
1187
init creates a standalone branch which carries its own history in
1190
If there is already a branch at the location but it has no working tree,
1191
the tree can be populated with 'bzr checkout'.
1193
Recipe for importing a tree of files:
1198
bzr commit -m 'imported project'
1200
takes_args = ['location?']
1202
RegistryOption('format',
1203
help='Specify a format for this branch. '
1204
'See "help formats".',
1205
registry=bzrdir.format_registry,
1206
converter=bzrdir.format_registry.make_bzrdir,
1207
value_switches=True,
1208
title="Branch Format",
1211
def run(self, location=None, format=None):
1213
format = bzrdir.format_registry.make_bzrdir('default')
1214
if location is None:
1217
to_transport = transport.get_transport(location)
1219
# The path has to exist to initialize a
1220
# branch inside of it.
1221
# Just using os.mkdir, since I don't
1222
# believe that we want to create a bunch of
1223
# locations if the user supplies an extended path
1224
# TODO: create-prefix
1226
to_transport.mkdir('.')
1227
except errors.FileExists:
1231
existing_bzrdir = bzrdir.BzrDir.open(location)
1232
except errors.NotBranchError:
1233
# really a NotBzrDir error...
1234
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1236
from bzrlib.transport.local import LocalTransport
1237
if existing_bzrdir.has_branch():
1238
if (isinstance(to_transport, LocalTransport)
1239
and not existing_bzrdir.has_workingtree()):
1240
raise errors.BranchExistsWithoutWorkingTree(location)
1241
raise errors.AlreadyBranchError(location)
1243
existing_bzrdir.create_branch()
1244
existing_bzrdir.create_workingtree()
1247
class cmd_init_repository(Command):
1248
"""Create a shared repository to hold branches.
1250
New branches created under the repository directory will store their revisions
1251
in the repository, not in the branch directory, if the branch format supports
1257
bzr checkout --lightweight repo/trunk trunk-checkout
1261
takes_args = ["location"]
1262
takes_options = [RegistryOption('format',
1263
help='Specify a format for this repository. See'
1264
' "bzr help formats" for details',
1265
registry=bzrdir.format_registry,
1266
converter=bzrdir.format_registry.make_bzrdir,
1267
value_switches=True, title='Repository format'),
1269
help='Allows branches in repository to have'
1271
aliases = ["init-repo"]
1272
def run(self, location, format=None, trees=False):
1274
format = bzrdir.format_registry.make_bzrdir('default')
1276
if location is None:
1279
to_transport = transport.get_transport(location)
1281
to_transport.mkdir('.')
1282
except errors.FileExists:
1285
newdir = format.initialize_on_transport(to_transport)
1286
repo = newdir.create_repository(shared=True)
1287
repo.set_make_working_trees(trees)
1290
class cmd_diff(Command):
1291
"""Show differences in the working tree or between revisions.
1293
If files are listed, only the changes in those files are listed.
1294
Otherwise, all changes for the tree are listed.
1296
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1297
produces patches suitable for "patch -p1".
1301
Shows the difference in the working tree versus the last commit
1303
Difference between the working tree and revision 1
1305
Difference between revision 2 and revision 1
1306
bzr diff --diff-prefix old/:new/
1307
Same as 'bzr diff' but prefix paths with old/ and new/
1308
bzr diff bzr.mine bzr.dev
1309
Show the differences between the two working trees
1311
Show just the differences for 'foo.c'
1313
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1314
# or a graphical diff.
1316
# TODO: Python difflib is not exactly the same as unidiff; should
1317
# either fix it up or prefer to use an external diff.
1319
# TODO: Selected-file diff is inefficient and doesn't show you
1322
# TODO: This probably handles non-Unix newlines poorly.
1324
takes_args = ['file*']
1325
takes_options = ['revision', 'diff-options',
1326
Option('prefix', type=str,
1328
help='Set prefixes to added to old and new filenames, as '
1329
'two values separated by a colon.'),
1331
aliases = ['di', 'dif']
1332
encoding_type = 'exact'
1335
def run(self, revision=None, file_list=None, diff_options=None,
1337
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1339
if (prefix is None) or (prefix == '0'):
1347
old_label, new_label = prefix.split(":")
1349
raise BzrCommandError(
1350
"--prefix expects two values separated by a colon")
1352
if revision and len(revision) > 2:
1353
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1354
' one or two revision specifiers')
1357
tree1, file_list = internal_tree_files(file_list)
1361
except errors.FileInWrongBranch:
1362
if len(file_list) != 2:
1363
raise errors.BzrCommandError("Files are in different branches")
1365
tree1, file1 = WorkingTree.open_containing(file_list[0])
1366
tree2, file2 = WorkingTree.open_containing(file_list[1])
1367
if file1 != "" or file2 != "":
1368
# FIXME diff those two files. rbc 20051123
1369
raise errors.BzrCommandError("Files are in different branches")
1371
except errors.NotBranchError:
1372
if (revision is not None and len(revision) == 2
1373
and not revision[0].needs_branch()
1374
and not revision[1].needs_branch()):
1375
# If both revision specs include a branch, we can
1376
# diff them without needing a local working tree
1377
tree1, tree2 = None, None
1381
if tree2 is not None:
1382
if revision is not None:
1383
# FIXME: but there should be a clean way to diff between
1384
# non-default versions of two trees, it's not hard to do
1386
raise errors.BzrCommandError(
1387
"Sorry, diffing arbitrary revisions across branches "
1388
"is not implemented yet")
1389
return show_diff_trees(tree1, tree2, sys.stdout,
1390
specific_files=file_list,
1391
external_diff_options=diff_options,
1392
old_label=old_label, new_label=new_label)
1394
return diff_cmd_helper(tree1, file_list, diff_options,
1395
revision_specs=revision,
1396
old_label=old_label, new_label=new_label)
1399
class cmd_deleted(Command):
1400
"""List files deleted in the working tree.
1402
# TODO: Show files deleted since a previous revision, or
1403
# between two revisions.
1404
# TODO: Much more efficient way to do this: read in new
1405
# directories with readdir, rather than stating each one. Same
1406
# level of effort but possibly much less IO. (Or possibly not,
1407
# if the directories are very large...)
1408
takes_options = ['show-ids']
1411
def run(self, show_ids=False):
1412
tree = WorkingTree.open_containing(u'.')[0]
1413
old = tree.basis_tree()
1414
for path, ie in old.inventory.iter_entries():
1415
if not tree.has_id(ie.file_id):
1416
self.outf.write(path)
1418
self.outf.write(' ')
1419
self.outf.write(ie.file_id)
1420
self.outf.write('\n')
1423
class cmd_modified(Command):
1424
"""List files modified in working tree.
1426
See also: "bzr status".
1433
tree = WorkingTree.open_containing(u'.')[0]
1434
td = tree.changes_from(tree.basis_tree())
1435
for path, id, kind, text_modified, meta_modified in td.modified:
1436
self.outf.write(path + '\n')
1439
class cmd_added(Command):
1440
"""List files added in working tree.
1442
See also: "bzr status".
1449
wt = WorkingTree.open_containing(u'.')[0]
1450
basis_inv = wt.basis_tree().inventory
1453
if file_id in basis_inv:
1455
if inv.is_root(file_id) and len(basis_inv) == 0:
1457
path = inv.id2path(file_id)
1458
if not os.access(osutils.abspath(path), os.F_OK):
1460
self.outf.write(path + '\n')
1463
class cmd_root(Command):
1464
"""Show the tree root directory.
1466
The root is the nearest enclosing directory with a .bzr control
1468
takes_args = ['filename?']
1470
def run(self, filename=None):
1471
"""Print the branch root."""
1472
tree = WorkingTree.open_containing(filename)[0]
1473
self.outf.write(tree.basedir + '\n')
1476
class cmd_log(Command):
1477
"""Show log of a branch, file, or directory.
1479
By default show the log of the branch containing the working directory.
1481
To request a range of logs, you can use the command -r begin..end
1482
-r revision requests a specific revision, -r ..end or -r begin.. are
1488
bzr log -r -10.. http://server/branch
1491
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1493
takes_args = ['location?']
1494
takes_options = [Option('forward',
1495
help='show from oldest to newest'),
1499
help='show files changed in each revision'),
1500
'show-ids', 'revision',
1504
help='show revisions whose message matches this regexp',
1507
encoding_type = 'replace'
1510
def run(self, location=None, timezone='original',
1517
from bzrlib.log import show_log
1518
assert message is None or isinstance(message, basestring), \
1519
"invalid message argument %r" % message
1520
direction = (forward and 'forward') or 'reverse'
1525
# find the file id to log:
1527
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1531
tree = b.basis_tree()
1532
inv = tree.inventory
1533
file_id = inv.path2id(fp)
1535
raise errors.BzrCommandError(
1536
"Path does not have any revision history: %s" %
1540
# FIXME ? log the current subdir only RBC 20060203
1541
if revision is not None \
1542
and len(revision) > 0 and revision[0].get_branch():
1543
location = revision[0].get_branch()
1546
dir, relpath = bzrdir.BzrDir.open_containing(location)
1547
b = dir.open_branch()
1549
if revision is None:
1552
elif len(revision) == 1:
1553
rev1 = rev2 = revision[0].in_history(b).revno
1554
elif len(revision) == 2:
1555
if revision[1].get_branch() != revision[0].get_branch():
1556
# b is taken from revision[0].get_branch(), and
1557
# show_log will use its revision_history. Having
1558
# different branches will lead to weird behaviors.
1559
raise errors.BzrCommandError(
1560
"Log doesn't accept two revisions in different branches.")
1561
if revision[0].spec is None:
1562
# missing begin-range means first revision
1565
rev1 = revision[0].in_history(b).revno
1567
if revision[1].spec is None:
1568
# missing end-range means last known revision
1571
rev2 = revision[1].in_history(b).revno
1573
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1575
# By this point, the revision numbers are converted to the +ve
1576
# form if they were supplied in the -ve form, so we can do
1577
# this comparison in relative safety
1579
(rev2, rev1) = (rev1, rev2)
1581
if log_format is None:
1582
log_format = log.log_formatter_registry.get_default(b)
1584
lf = log_format(show_ids=show_ids, to_file=self.outf,
1585
show_timezone=timezone)
1591
direction=direction,
1592
start_revision=rev1,
1597
def get_log_format(long=False, short=False, line=False, default='long'):
1598
log_format = default
1602
log_format = 'short'
1608
class cmd_touching_revisions(Command):
1609
"""Return revision-ids which affected a particular file.
1611
A more user-friendly interface is "bzr log FILE".
1615
takes_args = ["filename"]
1618
def run(self, filename):
1619
tree, relpath = WorkingTree.open_containing(filename)
1621
inv = tree.read_working_inventory()
1622
file_id = inv.path2id(relpath)
1623
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1624
self.outf.write("%6d %s\n" % (revno, what))
1627
class cmd_ls(Command):
1628
"""List files in a tree.
1631
takes_args = ['path?']
1632
# TODO: Take a revision or remote path and list that tree instead.
1633
takes_options = ['verbose', 'revision',
1634
Option('non-recursive',
1635
help='don\'t recurse into sub-directories'),
1637
help='Print all paths from the root of the branch.'),
1638
Option('unknown', help='Print unknown files'),
1639
Option('versioned', help='Print versioned files'),
1640
Option('ignored', help='Print ignored files'),
1642
Option('null', help='Null separate the files'),
1646
def run(self, revision=None, verbose=False,
1647
non_recursive=False, from_root=False,
1648
unknown=False, versioned=False, ignored=False,
1649
null=False, kind=None, show_ids=False, path=None):
1651
if kind and kind not in ('file', 'directory', 'symlink'):
1652
raise errors.BzrCommandError('invalid kind specified')
1654
if verbose and null:
1655
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1656
all = not (unknown or versioned or ignored)
1658
selection = {'I':ignored, '?':unknown, 'V':versioned}
1665
raise errors.BzrCommandError('cannot specify both --from-root'
1669
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1675
if revision is not None:
1676
tree = branch.repository.revision_tree(
1677
revision[0].in_history(branch).rev_id)
1679
tree = branch.basis_tree()
1681
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1682
if fp.startswith(relpath):
1683
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1684
if non_recursive and '/' in fp:
1686
if not all and not selection[fc]:
1688
if kind is not None and fkind != kind:
1691
kindch = entry.kind_character()
1692
outstring = '%-8s %s%s' % (fc, fp, kindch)
1693
if show_ids and fid is not None:
1694
outstring = "%-50s %s" % (outstring, fid)
1695
self.outf.write(outstring + '\n')
1697
self.outf.write(fp + '\0')
1700
self.outf.write(fid)
1701
self.outf.write('\0')
1709
self.outf.write('%-50s %s\n' % (fp, my_id))
1711
self.outf.write(fp + '\n')
1714
class cmd_unknowns(Command):
1715
"""List unknown files.
1717
See also: "bzr ls --unknown".
1724
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1725
self.outf.write(osutils.quotefn(f) + '\n')
1728
class cmd_ignore(Command):
1729
"""Ignore specified files or patterns.
1731
To remove patterns from the ignore list, edit the .bzrignore file.
1733
Trailing slashes on patterns are ignored.
1734
If the pattern contains a slash or is a regular expression, it is compared
1735
to the whole path from the branch root. Otherwise, it is compared to only
1736
the last component of the path. To match a file only in the root
1737
directory, prepend './'.
1739
Ignore patterns specifying absolute paths are not allowed.
1741
Ignore patterns may include globbing wildcards such as:
1742
? - Matches any single character except '/'
1743
* - Matches 0 or more characters except '/'
1744
/**/ - Matches 0 or more directories in a path
1745
[a-z] - Matches a single character from within a group of characters
1747
Ignore patterns may also be Python regular expressions.
1748
Regular expression ignore patterns are identified by a 'RE:' prefix
1749
followed by the regular expression. Regular expression ignore patterns
1750
may not include named or numbered groups.
1752
Note: ignore patterns containing shell wildcards must be quoted from
1756
bzr ignore ./Makefile
1757
bzr ignore '*.class'
1758
bzr ignore 'lib/**/*.o'
1759
bzr ignore 'RE:lib/.*\.o'
1761
takes_args = ['name_pattern*']
1763
Option('old-default-rules',
1764
help='Out the ignore rules bzr < 0.9 always used.')
1767
def run(self, name_pattern_list=None, old_default_rules=None):
1768
from bzrlib.atomicfile import AtomicFile
1769
if old_default_rules is not None:
1770
# dump the rules and exit
1771
for pattern in ignores.OLD_DEFAULTS:
1774
if not name_pattern_list:
1775
raise errors.BzrCommandError("ignore requires at least one "
1776
"NAME_PATTERN or --old-default-rules")
1777
for name_pattern in name_pattern_list:
1778
if name_pattern[0] == '/':
1779
raise errors.BzrCommandError(
1780
"NAME_PATTERN should not be an absolute path")
1781
tree, relpath = WorkingTree.open_containing(u'.')
1782
ifn = tree.abspath('.bzrignore')
1783
if os.path.exists(ifn):
1786
igns = f.read().decode('utf-8')
1792
# TODO: If the file already uses crlf-style termination, maybe
1793
# we should use that for the newly added lines?
1795
if igns and igns[-1] != '\n':
1797
for name_pattern in name_pattern_list:
1798
igns += name_pattern.rstrip('/') + '\n'
1800
f = AtomicFile(ifn, 'wb')
1802
f.write(igns.encode('utf-8'))
1807
inv = tree.inventory
1808
if inv.path2id('.bzrignore'):
1809
mutter('.bzrignore is already versioned')
1811
mutter('need to make new .bzrignore file versioned')
1812
tree.add(['.bzrignore'])
1815
class cmd_ignored(Command):
1816
"""List ignored files and the patterns that matched them.
1818
See also: bzr ignore"""
1821
tree = WorkingTree.open_containing(u'.')[0]
1822
for path, file_class, kind, file_id, entry in tree.list_files():
1823
if file_class != 'I':
1825
## XXX: Slightly inefficient since this was already calculated
1826
pat = tree.is_ignored(path)
1827
print '%-50s %s' % (path, pat)
1830
class cmd_lookup_revision(Command):
1831
"""Lookup the revision-id from a revision-number
1834
bzr lookup-revision 33
1837
takes_args = ['revno']
1840
def run(self, revno):
1844
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1846
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1849
class cmd_export(Command):
1850
"""Export past revision to destination directory.
1852
If no revision is specified this exports the last committed revision.
1854
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1855
given, try to find the format with the extension. If no extension
1856
is found exports to a directory (equivalent to --format=dir).
1858
Root may be the top directory for tar, tgz and tbz2 formats. If none
1859
is given, the top directory will be the root name of the file.
1861
If branch is omitted then the branch containing the CWD will be used.
1863
Note: export of tree with non-ascii filenames to zip is not supported.
1865
Supported formats Autodetected by extension
1866
----------------- -------------------------
1869
tbz2 .tar.bz2, .tbz2
1873
takes_args = ['dest', 'branch?']
1874
takes_options = ['revision', 'format', 'root']
1875
def run(self, dest, branch=None, revision=None, format=None, root=None):
1876
from bzrlib.export import export
1879
tree = WorkingTree.open_containing(u'.')[0]
1882
b = Branch.open(branch)
1884
if revision is None:
1885
# should be tree.last_revision FIXME
1886
rev_id = b.last_revision()
1888
if len(revision) != 1:
1889
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1890
rev_id = revision[0].in_history(b).rev_id
1891
t = b.repository.revision_tree(rev_id)
1893
export(t, dest, format, root)
1894
except errors.NoSuchExportFormat, e:
1895
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1898
class cmd_cat(Command):
1899
"""Write a file's text from a previous revision."""
1901
takes_options = ['revision', 'name-from-revision']
1902
takes_args = ['filename']
1903
encoding_type = 'exact'
1906
def run(self, filename, revision=None, name_from_revision=False):
1907
if revision is not None and len(revision) != 1:
1908
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1913
tree, relpath = WorkingTree.open_containing(filename)
1915
except (errors.NotBranchError, errors.NotLocalUrl):
1918
if revision is not None and revision[0].get_branch() is not None:
1919
b = Branch.open(revision[0].get_branch())
1921
b, relpath = Branch.open_containing(filename)
1922
tree = b.basis_tree()
1923
if revision is None:
1924
revision_id = b.last_revision()
1926
revision_id = revision[0].in_history(b).rev_id
1928
cur_file_id = tree.path2id(relpath)
1929
rev_tree = b.repository.revision_tree(revision_id)
1930
old_file_id = rev_tree.path2id(relpath)
1932
if name_from_revision:
1933
if old_file_id is None:
1934
raise errors.BzrCommandError("%r is not present in revision %s"
1935
% (filename, revision_id))
1937
rev_tree.print_file(old_file_id)
1938
elif cur_file_id is not None:
1939
rev_tree.print_file(cur_file_id)
1940
elif old_file_id is not None:
1941
rev_tree.print_file(old_file_id)
1943
raise errors.BzrCommandError("%r is not present in revision %s" %
1944
(filename, revision_id))
1947
class cmd_local_time_offset(Command):
1948
"""Show the offset in seconds from GMT to local time."""
1952
print osutils.local_time_offset()
1956
class cmd_commit(Command):
1957
"""Commit changes into a new revision.
1959
If no arguments are given, the entire tree is committed.
1961
If selected files are specified, only changes to those files are
1962
committed. If a directory is specified then the directory and everything
1963
within it is committed.
1965
A selected-file commit may fail in some cases where the committed
1966
tree would be invalid, such as trying to commit a file in a
1967
newly-added directory that is not itself committed.
1969
# TODO: Run hooks on tree to-be-committed, and after commit.
1971
# TODO: Strict commit that fails if there are deleted files.
1972
# (what does "deleted files" mean ??)
1974
# TODO: Give better message for -s, --summary, used by tla people
1976
# XXX: verbose currently does nothing
1978
takes_args = ['selected*']
1979
takes_options = ['message', 'verbose',
1981
help='commit even if nothing has changed'),
1982
Option('file', type=str,
1985
help='file containing commit message'),
1987
help="refuse to commit if there are unknown "
1988
"files in the working tree."),
1990
help="perform a local only commit in a bound "
1991
"branch. Such commits are not pushed to "
1992
"the master branch until a normal commit "
1996
aliases = ['ci', 'checkin']
1998
def run(self, message=None, file=None, verbose=True, selected_list=None,
1999
unchanged=False, strict=False, local=False):
2000
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2001
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2003
from bzrlib.msgeditor import edit_commit_message, \
2004
make_commit_message_template
2006
# TODO: Need a blackbox test for invoking the external editor; may be
2007
# slightly problematic to run this cross-platform.
2009
# TODO: do more checks that the commit will succeed before
2010
# spending the user's valuable time typing a commit message.
2011
tree, selected_list = tree_files(selected_list)
2012
if selected_list == ['']:
2013
# workaround - commit of root of tree should be exactly the same
2014
# as just default commit in that tree, and succeed even though
2015
# selected-file merge commit is not done yet
2018
if local and not tree.branch.get_bound_location():
2019
raise errors.LocalRequiresBoundBranch()
2021
def get_message(commit_obj):
2022
"""Callback to get commit message"""
2023
my_message = message
2024
if my_message is None and not file:
2025
template = make_commit_message_template(tree, selected_list)
2026
my_message = edit_commit_message(template)
2027
if my_message is None:
2028
raise errors.BzrCommandError("please specify a commit"
2029
" message with either --message or --file")
2030
elif my_message and file:
2031
raise errors.BzrCommandError(
2032
"please specify either --message or --file")
2034
my_message = codecs.open(file, 'rt',
2035
bzrlib.user_encoding).read()
2036
if my_message == "":
2037
raise errors.BzrCommandError("empty commit message specified")
2041
reporter = ReportCommitToLog()
2043
reporter = NullCommitReporter()
2046
tree.commit(message_callback=get_message,
2047
specific_files=selected_list,
2048
allow_pointless=unchanged, strict=strict, local=local,
2050
except PointlessCommit:
2051
# FIXME: This should really happen before the file is read in;
2052
# perhaps prepare the commit; get the message; then actually commit
2053
raise errors.BzrCommandError("no changes to commit."
2054
" use --unchanged to commit anyhow")
2055
except ConflictsInTree:
2056
raise errors.BzrCommandError('Conflicts detected in working '
2057
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2059
except StrictCommitFailed:
2060
raise errors.BzrCommandError("Commit refused because there are"
2061
" unknown files in the working tree.")
2062
except errors.BoundBranchOutOfDate, e:
2063
raise errors.BzrCommandError(str(e) + "\n"
2064
'To commit to master branch, run update and then commit.\n'
2065
'You can also pass --local to commit to continue working '
2069
class cmd_check(Command):
2070
"""Validate consistency of branch history.
2072
This command checks various invariants about the branch storage to
2073
detect data corruption or bzr bugs.
2075
takes_args = ['branch?']
2076
takes_options = ['verbose']
2078
def run(self, branch=None, verbose=False):
2079
from bzrlib.check import check
2081
tree = WorkingTree.open_containing()[0]
2082
branch = tree.branch
2084
branch = Branch.open(branch)
2085
check(branch, verbose)
2088
class cmd_upgrade(Command):
2089
"""Upgrade branch storage to current format.
2091
The check command or bzr developers may sometimes advise you to run
2092
this command. When the default format has changed you may also be warned
2093
during other operations to upgrade.
2095
takes_args = ['url?']
2097
RegistryOption('format',
2098
help='Upgrade to a specific format. See "bzr help'
2099
' formats" for details',
2100
registry=bzrdir.format_registry,
2101
converter=bzrdir.format_registry.make_bzrdir,
2102
value_switches=True, title='Branch format'),
2106
def run(self, url='.', format=None):
2107
from bzrlib.upgrade import upgrade
2109
format = bzrdir.format_registry.make_bzrdir('default')
2110
upgrade(url, format)
2113
class cmd_whoami(Command):
2114
"""Show or set bzr user id.
2118
bzr whoami 'Frank Chu <fchu@example.com>'
2120
takes_options = [ Option('email',
2121
help='display email address only'),
2123
help='set identity for the current branch instead of '
2126
takes_args = ['name?']
2127
encoding_type = 'replace'
2130
def run(self, email=False, branch=False, name=None):
2132
# use branch if we're inside one; otherwise global config
2134
c = Branch.open_containing('.')[0].get_config()
2135
except errors.NotBranchError:
2136
c = config.GlobalConfig()
2138
self.outf.write(c.user_email() + '\n')
2140
self.outf.write(c.username() + '\n')
2143
# display a warning if an email address isn't included in the given name.
2145
config.extract_email_address(name)
2146
except errors.NoEmailInUsername, e:
2147
warning('"%s" does not seem to contain an email address. '
2148
'This is allowed, but not recommended.', name)
2150
# use global config unless --branch given
2152
c = Branch.open_containing('.')[0].get_config()
2154
c = config.GlobalConfig()
2155
c.set_user_option('email', name)
2158
class cmd_nick(Command):
2159
"""Print or set the branch nickname.
2161
If unset, the tree root directory name is used as the nickname
2162
To print the current nickname, execute with no argument.
2164
takes_args = ['nickname?']
2165
def run(self, nickname=None):
2166
branch = Branch.open_containing(u'.')[0]
2167
if nickname is None:
2168
self.printme(branch)
2170
branch.nick = nickname
2173
def printme(self, branch):
2177
class cmd_selftest(Command):
2178
"""Run internal test suite.
2180
This creates temporary test directories in the working directory, but not
2181
existing data is affected. These directories are deleted if the tests
2182
pass, or left behind to help in debugging if they fail and --keep-output
2185
If arguments are given, they are regular expressions that say which tests
2186
should run. Tests matching any expression are run, and other tests are
2189
Alternatively if --first is given, matching tests are run first and then
2190
all other tests are run. This is useful if you have been working in a
2191
particular area, but want to make sure nothing else was broken.
2193
If the global option '--no-plugins' is given, plugins are not loaded
2194
before running the selftests. This has two effects: features provided or
2195
modified by plugins will not be tested, and tests provided by plugins will
2200
run only tests relating to 'ignore'
2201
bzr --no-plugins selftest -v
2202
disable plugins and list tests as they're run
2204
# TODO: --list should give a list of all available tests
2206
# NB: this is used from the class without creating an instance, which is
2207
# why it does not have a self parameter.
2208
def get_transport_type(typestring):
2209
"""Parse and return a transport specifier."""
2210
if typestring == "sftp":
2211
from bzrlib.transport.sftp import SFTPAbsoluteServer
2212
return SFTPAbsoluteServer
2213
if typestring == "memory":
2214
from bzrlib.transport.memory import MemoryServer
2216
if typestring == "fakenfs":
2217
from bzrlib.transport.fakenfs import FakeNFSServer
2218
return FakeNFSServer
2219
msg = "No known transport type %s. Supported types are: sftp\n" %\
2221
raise errors.BzrCommandError(msg)
2224
takes_args = ['testspecs*']
2225
takes_options = ['verbose',
2226
Option('one', help='stop when one test fails'),
2227
Option('keep-output',
2228
help='keep output directories when tests fail'),
2230
help='Use a different transport by default '
2231
'throughout the test suite.',
2232
type=get_transport_type),
2233
Option('benchmark', help='run the bzr bencharks.'),
2234
Option('lsprof-timed',
2235
help='generate lsprof output for benchmarked'
2236
' sections of code.'),
2237
Option('cache-dir', type=str,
2238
help='a directory to cache intermediate'
2239
' benchmark steps'),
2240
Option('clean-output',
2241
help='clean temporary tests directories'
2242
' without running tests'),
2244
help='run all tests, but run specified tests first',
2247
encoding_type = 'replace'
2249
def run(self, testspecs_list=None, verbose=None, one=False,
2250
keep_output=False, transport=None, benchmark=None,
2251
lsprof_timed=None, cache_dir=None, clean_output=False,
2254
from bzrlib.tests import selftest
2255
import bzrlib.benchmarks as benchmarks
2256
from bzrlib.benchmarks import tree_creator
2259
from bzrlib.tests import clean_selftest_output
2260
clean_selftest_output()
2263
if cache_dir is not None:
2264
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2265
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2266
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2268
if testspecs_list is not None:
2269
pattern = '|'.join(testspecs_list)
2273
test_suite_factory = benchmarks.test_suite
2276
# TODO: should possibly lock the history file...
2277
benchfile = open(".perf_history", "at", buffering=1)
2279
test_suite_factory = None
2284
result = selftest(verbose=verbose,
2286
stop_on_failure=one,
2287
keep_output=keep_output,
2288
transport=transport,
2289
test_suite_factory=test_suite_factory,
2290
lsprof_timed=lsprof_timed,
2291
bench_history=benchfile,
2292
matching_tests_first=first,
2295
if benchfile is not None:
2298
info('tests passed')
2300
info('tests failed')
2301
return int(not result)
2304
class cmd_version(Command):
2305
"""Show version of bzr."""
2309
from bzrlib.version import show_version
2313
class cmd_rocks(Command):
2314
"""Statement of optimism."""
2320
print "it sure does!"
2323
class cmd_find_merge_base(Command):
2324
"""Find and print a base revision for merging two branches."""
2325
# TODO: Options to specify revisions on either side, as if
2326
# merging only part of the history.
2327
takes_args = ['branch', 'other']
2331
def run(self, branch, other):
2332
from bzrlib.revision import MultipleRevisionSources
2334
branch1 = Branch.open_containing(branch)[0]
2335
branch2 = Branch.open_containing(other)[0]
2337
last1 = branch1.last_revision()
2338
last2 = branch2.last_revision()
2340
source = MultipleRevisionSources(branch1.repository,
2343
base_rev_id = common_ancestor(last1, last2, source)
2345
print 'merge base is revision %s' % base_rev_id
2348
class cmd_merge(Command):
2349
"""Perform a three-way merge.
2351
The branch is the branch you will merge from. By default, it will merge
2352
the latest revision. If you specify a revision, that revision will be
2353
merged. If you specify two revisions, the first will be used as a BASE,
2354
and the second one as OTHER. Revision numbers are always relative to the
2357
By default, bzr will try to merge in all new work from the other
2358
branch, automatically determining an appropriate base. If this
2359
fails, you may need to give an explicit base.
2361
Merge will do its best to combine the changes in two branches, but there
2362
are some kinds of problems only a human can fix. When it encounters those,
2363
it will mark a conflict. A conflict means that you need to fix something,
2364
before you should commit.
2366
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2368
If there is no default branch set, the first merge will set it. After
2369
that, you can omit the branch to use the default. To change the
2370
default, use --remember. The value will only be saved if the remote
2371
location can be accessed.
2373
The results of the merge are placed into the destination working
2374
directory, where they can be reviewed (with bzr diff), tested, and then
2375
committed to record the result of the merge.
2379
To merge the latest revision from bzr.dev
2380
bzr merge ../bzr.dev
2382
To merge changes up to and including revision 82 from bzr.dev
2383
bzr merge -r 82 ../bzr.dev
2385
To merge the changes introduced by 82, without previous changes:
2386
bzr merge -r 81..82 ../bzr.dev
2388
merge refuses to run if there are any uncommitted changes, unless
2391
The following merge types are available:
2393
takes_args = ['branch?']
2394
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2395
Option('show-base', help="Show base revision text in "
2397
Option('uncommitted', help='Apply uncommitted changes'
2398
' from a working copy, instead of branch changes'),
2399
Option('pull', help='If the destination is already'
2400
' completely merged into the source, pull from the'
2401
' source rather than merging. When this happens,'
2402
' you do not need to commit the result.'),
2404
help='branch to merge into, '
2405
'rather than the one containing the working directory',
2411
def run(self, branch=None, revision=None, force=False, merge_type=None,
2412
show_base=False, reprocess=False, remember=False,
2413
uncommitted=False, pull=False,
2416
if merge_type is None:
2417
merge_type = _mod_merge.Merge3Merger
2418
if directory is None: directory = u'.'
2419
tree = WorkingTree.open_containing(directory)[0]
2421
if branch is not None:
2423
reader = bundle.read_bundle_from_url(branch)
2424
except errors.NotABundle:
2425
pass # Continue on considering this url a Branch
2427
conflicts = merge_bundle(reader, tree, not force, merge_type,
2428
reprocess, show_base)
2434
if revision is None \
2435
or len(revision) < 1 or revision[0].needs_branch():
2436
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2438
if revision is None or len(revision) < 1:
2441
other = [branch, None]
2444
other = [branch, -1]
2445
other_branch, path = Branch.open_containing(branch)
2448
raise errors.BzrCommandError('Cannot use --uncommitted and'
2449
' --revision at the same time.')
2450
branch = revision[0].get_branch() or branch
2451
if len(revision) == 1:
2453
other_branch, path = Branch.open_containing(branch)
2454
revno = revision[0].in_history(other_branch).revno
2455
other = [branch, revno]
2457
assert len(revision) == 2
2458
if None in revision:
2459
raise errors.BzrCommandError(
2460
"Merge doesn't permit empty revision specifier.")
2461
base_branch, path = Branch.open_containing(branch)
2462
branch1 = revision[1].get_branch() or branch
2463
other_branch, path1 = Branch.open_containing(branch1)
2464
if revision[0].get_branch() is not None:
2465
# then path was obtained from it, and is None.
2468
base = [branch, revision[0].in_history(base_branch).revno]
2469
other = [branch1, revision[1].in_history(other_branch).revno]
2471
if tree.branch.get_parent() is None or remember:
2472
tree.branch.set_parent(other_branch.base)
2475
interesting_files = [path]
2477
interesting_files = None
2478
pb = ui.ui_factory.nested_progress_bar()
2481
conflict_count = _merge_helper(
2482
other, base, check_clean=(not force),
2483
merge_type=merge_type,
2484
reprocess=reprocess,
2485
show_base=show_base,
2488
pb=pb, file_list=interesting_files)
2491
if conflict_count != 0:
2495
except errors.AmbiguousBase, e:
2496
m = ("sorry, bzr can't determine the right merge base yet\n"
2497
"candidates are:\n "
2498
+ "\n ".join(e.bases)
2500
"please specify an explicit base with -r,\n"
2501
"and (if you want) report this to the bzr developers\n")
2504
# TODO: move up to common parent; this isn't merge-specific anymore.
2505
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2506
"""Use tree.branch's parent if none was supplied.
2508
Report if the remembered location was used.
2510
if supplied_location is not None:
2511
return supplied_location
2512
stored_location = tree.branch.get_parent()
2513
mutter("%s", stored_location)
2514
if stored_location is None:
2515
raise errors.BzrCommandError("No location specified or remembered")
2516
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2517
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2518
return stored_location
2521
class cmd_remerge(Command):
2524
Use this if you want to try a different merge technique while resolving
2525
conflicts. Some merge techniques are better than others, and remerge
2526
lets you try different ones on different files.
2528
The options for remerge have the same meaning and defaults as the ones for
2529
merge. The difference is that remerge can (only) be run when there is a
2530
pending merge, and it lets you specify particular files.
2533
$ bzr remerge --show-base
2534
Re-do the merge of all conflicted files, and show the base text in
2535
conflict regions, in addition to the usual THIS and OTHER texts.
2537
$ bzr remerge --merge-type weave --reprocess foobar
2538
Re-do the merge of "foobar", using the weave merge algorithm, with
2539
additional processing to reduce the size of conflict regions.
2541
The following merge types are available:"""
2542
takes_args = ['file*']
2543
takes_options = ['merge-type', 'reprocess',
2544
Option('show-base', help="Show base revision text in "
2547
def run(self, file_list=None, merge_type=None, show_base=False,
2549
if merge_type is None:
2550
merge_type = _mod_merge.Merge3Merger
2551
tree, file_list = tree_files(file_list)
2554
parents = tree.get_parent_ids()
2555
if len(parents) != 2:
2556
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2557
" merges. Not cherrypicking or"
2559
repository = tree.branch.repository
2560
base_revision = common_ancestor(parents[0],
2561
parents[1], repository)
2562
base_tree = repository.revision_tree(base_revision)
2563
other_tree = repository.revision_tree(parents[1])
2564
interesting_ids = None
2566
conflicts = tree.conflicts()
2567
if file_list is not None:
2568
interesting_ids = set()
2569
for filename in file_list:
2570
file_id = tree.path2id(filename)
2572
raise errors.NotVersionedError(filename)
2573
interesting_ids.add(file_id)
2574
if tree.kind(file_id) != "directory":
2577
for name, ie in tree.inventory.iter_entries(file_id):
2578
interesting_ids.add(ie.file_id)
2579
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2581
# Remerge only supports resolving contents conflicts
2582
allowed_conflicts = ('text conflict', 'contents conflict')
2583
restore_files = [c.path for c in conflicts
2584
if c.typestring in allowed_conflicts]
2585
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2586
tree.set_conflicts(ConflictList(new_conflicts))
2587
if file_list is not None:
2588
restore_files = file_list
2589
for filename in restore_files:
2591
restore(tree.abspath(filename))
2592
except errors.NotConflicted:
2594
conflicts = _mod_merge.merge_inner(
2595
tree.branch, other_tree, base_tree,
2597
interesting_ids=interesting_ids,
2598
other_rev_id=parents[1],
2599
merge_type=merge_type,
2600
show_base=show_base,
2601
reprocess=reprocess)
2610
class cmd_revert(Command):
2611
"""Revert files to a previous revision.
2613
Giving a list of files will revert only those files. Otherwise, all files
2614
will be reverted. If the revision is not specified with '--revision', the
2615
last committed revision is used.
2617
To remove only some changes, without reverting to a prior version, use
2618
merge instead. For example, "merge . --r-2..-3" will remove the changes
2619
introduced by -2, without affecting the changes introduced by -1. Or
2620
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2622
By default, any files that have been manually changed will be backed up
2623
first. (Files changed only by merge are not backed up.) Backup files have
2624
'.~#~' appended to their name, where # is a number.
2626
When you provide files, you can use their current pathname or the pathname
2627
from the target revision. So you can use revert to "undelete" a file by
2628
name. If you name a directory, all the contents of that directory will be
2631
takes_options = ['revision', 'no-backup']
2632
takes_args = ['file*']
2633
aliases = ['merge-revert']
2635
def run(self, revision=None, no_backup=False, file_list=None):
2636
if file_list is not None:
2637
if len(file_list) == 0:
2638
raise errors.BzrCommandError("No files specified")
2642
tree, file_list = tree_files(file_list)
2643
if revision is None:
2644
# FIXME should be tree.last_revision
2645
rev_id = tree.last_revision()
2646
elif len(revision) != 1:
2647
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2649
rev_id = revision[0].in_history(tree.branch).rev_id
2650
pb = ui.ui_factory.nested_progress_bar()
2652
tree.revert(file_list,
2653
tree.branch.repository.revision_tree(rev_id),
2654
not no_backup, pb, report_changes=True)
2659
class cmd_assert_fail(Command):
2660
"""Test reporting of assertion failures"""
2661
# intended just for use in testing
2666
raise AssertionError("always fails")
2669
class cmd_help(Command):
2670
"""Show help on a command or other topic.
2672
For a list of all available commands, say 'bzr help commands'.
2674
takes_options = [Option('long', 'show help on all commands')]
2675
takes_args = ['topic?']
2676
aliases = ['?', '--help', '-?', '-h']
2679
def run(self, topic=None, long=False):
2681
if topic is None and long:
2683
bzrlib.help.help(topic)
2686
class cmd_shell_complete(Command):
2687
"""Show appropriate completions for context.
2689
For a list of all available commands, say 'bzr shell-complete'.
2691
takes_args = ['context?']
2696
def run(self, context=None):
2697
import shellcomplete
2698
shellcomplete.shellcomplete(context)
2701
class cmd_fetch(Command):
2702
"""Copy in history from another branch but don't merge it.
2704
This is an internal method used for pull and merge.
2707
takes_args = ['from_branch', 'to_branch']
2708
def run(self, from_branch, to_branch):
2709
from bzrlib.fetch import Fetcher
2710
from_b = Branch.open(from_branch)
2711
to_b = Branch.open(to_branch)
2712
Fetcher(to_b, from_b)
2715
class cmd_missing(Command):
2716
"""Show unmerged/unpulled revisions between two branches.
2718
OTHER_BRANCH may be local or remote.
2720
takes_args = ['other_branch?']
2721
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2723
'Display changes in the local branch only'),
2724
Option('theirs-only',
2725
'Display changes in the remote branch only'),
2730
encoding_type = 'replace'
2733
def run(self, other_branch=None, reverse=False, mine_only=False,
2734
theirs_only=False, log_format=None, long=False, short=False, line=False,
2735
show_ids=False, verbose=False):
2736
from bzrlib.missing import find_unmerged, iter_log_data
2737
from bzrlib.log import log_formatter
2738
local_branch = Branch.open_containing(u".")[0]
2739
parent = local_branch.get_parent()
2740
if other_branch is None:
2741
other_branch = parent
2742
if other_branch is None:
2743
raise errors.BzrCommandError("No peer location known or specified.")
2744
display_url = urlutils.unescape_for_display(parent,
2746
print "Using last location: " + display_url
2748
remote_branch = Branch.open(other_branch)
2749
if remote_branch.base == local_branch.base:
2750
remote_branch = local_branch
2751
local_branch.lock_read()
2753
remote_branch.lock_read()
2755
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2756
if (log_format is None):
2757
log_format = log.log_formatter_registry.get_default(
2759
lf = log_format(to_file=self.outf,
2761
show_timezone='original')
2762
if reverse is False:
2763
local_extra.reverse()
2764
remote_extra.reverse()
2765
if local_extra and not theirs_only:
2766
print "You have %d extra revision(s):" % len(local_extra)
2767
for data in iter_log_data(local_extra, local_branch.repository,
2770
printed_local = True
2772
printed_local = False
2773
if remote_extra and not mine_only:
2774
if printed_local is True:
2776
print "You are missing %d revision(s):" % len(remote_extra)
2777
for data in iter_log_data(remote_extra, remote_branch.repository,
2780
if not remote_extra and not local_extra:
2782
print "Branches are up to date."
2786
remote_branch.unlock()
2788
local_branch.unlock()
2789
if not status_code and parent is None and other_branch is not None:
2790
local_branch.lock_write()
2792
# handle race conditions - a parent might be set while we run.
2793
if local_branch.get_parent() is None:
2794
local_branch.set_parent(remote_branch.base)
2796
local_branch.unlock()
2800
class cmd_plugins(Command):
2805
import bzrlib.plugin
2806
from inspect import getdoc
2807
for name, plugin in bzrlib.plugin.all_plugins().items():
2808
if getattr(plugin, '__path__', None) is not None:
2809
print plugin.__path__[0]
2810
elif getattr(plugin, '__file__', None) is not None:
2811
print plugin.__file__
2817
print '\t', d.split('\n')[0]
2820
class cmd_testament(Command):
2821
"""Show testament (signing-form) of a revision."""
2822
takes_options = ['revision',
2823
Option('long', help='Produce long-format testament'),
2824
Option('strict', help='Produce a strict-format'
2826
takes_args = ['branch?']
2828
def run(self, branch=u'.', revision=None, long=False, strict=False):
2829
from bzrlib.testament import Testament, StrictTestament
2831
testament_class = StrictTestament
2833
testament_class = Testament
2834
b = WorkingTree.open_containing(branch)[0].branch
2837
if revision is None:
2838
rev_id = b.last_revision()
2840
rev_id = revision[0].in_history(b).rev_id
2841
t = testament_class.from_revision(b.repository, rev_id)
2843
sys.stdout.writelines(t.as_text_lines())
2845
sys.stdout.write(t.as_short_text())
2850
class cmd_annotate(Command):
2851
"""Show the origin of each line in a file.
2853
This prints out the given file with an annotation on the left side
2854
indicating which revision, author and date introduced the change.
2856
If the origin is the same for a run of consecutive lines, it is
2857
shown only at the top, unless the --all option is given.
2859
# TODO: annotate directories; showing when each file was last changed
2860
# TODO: if the working copy is modified, show annotations on that
2861
# with new uncommitted lines marked
2862
aliases = ['ann', 'blame', 'praise']
2863
takes_args = ['filename']
2864
takes_options = [Option('all', help='show annotations on all lines'),
2865
Option('long', help='show date in annotations'),
2871
def run(self, filename, all=False, long=False, revision=None,
2873
from bzrlib.annotate import annotate_file
2874
tree, relpath = WorkingTree.open_containing(filename)
2875
branch = tree.branch
2878
if revision is None:
2879
revision_id = branch.last_revision()
2880
elif len(revision) != 1:
2881
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2883
revision_id = revision[0].in_history(branch).rev_id
2884
file_id = tree.inventory.path2id(relpath)
2885
tree = branch.repository.revision_tree(revision_id)
2886
file_version = tree.inventory[file_id].revision
2887
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2893
class cmd_re_sign(Command):
2894
"""Create a digital signature for an existing revision."""
2895
# TODO be able to replace existing ones.
2897
hidden = True # is this right ?
2898
takes_args = ['revision_id*']
2899
takes_options = ['revision']
2901
def run(self, revision_id_list=None, revision=None):
2902
import bzrlib.gpg as gpg
2903
if revision_id_list is not None and revision is not None:
2904
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2905
if revision_id_list is None and revision is None:
2906
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2907
b = WorkingTree.open_containing(u'.')[0].branch
2908
gpg_strategy = gpg.GPGStrategy(b.get_config())
2909
if revision_id_list is not None:
2910
for revision_id in revision_id_list:
2911
b.repository.sign_revision(revision_id, gpg_strategy)
2912
elif revision is not None:
2913
if len(revision) == 1:
2914
revno, rev_id = revision[0].in_history(b)
2915
b.repository.sign_revision(rev_id, gpg_strategy)
2916
elif len(revision) == 2:
2917
# are they both on rh- if so we can walk between them
2918
# might be nice to have a range helper for arbitrary
2919
# revision paths. hmm.
2920
from_revno, from_revid = revision[0].in_history(b)
2921
to_revno, to_revid = revision[1].in_history(b)
2922
if to_revid is None:
2923
to_revno = b.revno()
2924
if from_revno is None or to_revno is None:
2925
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2926
for revno in range(from_revno, to_revno + 1):
2927
b.repository.sign_revision(b.get_rev_id(revno),
2930
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2933
class cmd_bind(Command):
2934
"""Convert the current branch into a checkout of the supplied branch.
2936
Once converted into a checkout, commits must succeed on the master branch
2937
before they will be applied to the local branch.
2939
See "help checkouts" for more information on checkouts.
2942
takes_args = ['location']
2945
def run(self, location=None):
2946
b, relpath = Branch.open_containing(u'.')
2947
b_other = Branch.open(location)
2950
except errors.DivergedBranches:
2951
raise errors.BzrCommandError('These branches have diverged.'
2952
' Try merging, and then bind again.')
2955
class cmd_unbind(Command):
2956
"""Convert the current checkout into a regular branch.
2958
After unbinding, the local branch is considered independent and subsequent
2959
commits will be local only.
2961
See "help checkouts" for more information on checkouts.
2968
b, relpath = Branch.open_containing(u'.')
2970
raise errors.BzrCommandError('Local branch is not bound')
2973
class cmd_uncommit(Command):
2974
"""Remove the last committed revision.
2976
--verbose will print out what is being removed.
2977
--dry-run will go through all the motions, but not actually
2980
In the future, uncommit will create a revision bundle, which can then
2984
# TODO: jam 20060108 Add an option to allow uncommit to remove
2985
# unreferenced information in 'branch-as-repository' branches.
2986
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2987
# information in shared branches as well.
2988
takes_options = ['verbose', 'revision',
2989
Option('dry-run', help='Don\'t actually make changes'),
2990
Option('force', help='Say yes to all questions.')]
2991
takes_args = ['location?']
2994
def run(self, location=None,
2995
dry_run=False, verbose=False,
2996
revision=None, force=False):
2997
from bzrlib.log import log_formatter, show_log
2999
from bzrlib.uncommit import uncommit
3001
if location is None:
3003
control, relpath = bzrdir.BzrDir.open_containing(location)
3005
tree = control.open_workingtree()
3007
except (errors.NoWorkingTree, errors.NotLocalUrl):
3009
b = control.open_branch()
3012
if revision is None:
3015
# 'bzr uncommit -r 10' actually means uncommit
3016
# so that the final tree is at revno 10.
3017
# but bzrlib.uncommit.uncommit() actually uncommits
3018
# the revisions that are supplied.
3019
# So we need to offset it by one
3020
revno = revision[0].in_history(b).revno+1
3022
if revno <= b.revno():
3023
rev_id = b.get_rev_id(revno)
3025
self.outf.write('No revisions to uncommit.\n')
3028
lf = log_formatter('short',
3030
show_timezone='original')
3035
direction='forward',
3036
start_revision=revno,
3037
end_revision=b.revno())
3040
print 'Dry-run, pretending to remove the above revisions.'
3042
val = raw_input('Press <enter> to continue')
3044
print 'The above revision(s) will be removed.'
3046
val = raw_input('Are you sure [y/N]? ')
3047
if val.lower() not in ('y', 'yes'):
3051
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3055
class cmd_break_lock(Command):
3056
"""Break a dead lock on a repository, branch or working directory.
3058
CAUTION: Locks should only be broken when you are sure that the process
3059
holding the lock has been stopped.
3061
You can get information on what locks are open via the 'bzr info' command.
3066
takes_args = ['location?']
3068
def run(self, location=None, show=False):
3069
if location is None:
3071
control, relpath = bzrdir.BzrDir.open_containing(location)
3073
control.break_lock()
3074
except NotImplementedError:
3078
class cmd_wait_until_signalled(Command):
3079
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3081
This just prints a line to signal when it is ready, then blocks on stdin.
3087
sys.stdout.write("running\n")
3089
sys.stdin.readline()
3092
class cmd_serve(Command):
3093
"""Run the bzr server."""
3095
aliases = ['server']
3099
help='serve on stdin/out for use from inetd or sshd'),
3101
help='listen for connections on nominated port of the form '
3102
'[hostname:]portnumber. Passing 0 as the port number will '
3103
'result in a dynamically allocated port.',
3106
help='serve contents of directory',
3108
Option('allow-writes',
3109
help='By default the server is a readonly server. Supplying '
3110
'--allow-writes enables write access to the contents of '
3111
'the served directory and below. '
3115
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3116
from bzrlib.transport import smart
3117
from bzrlib.transport import get_transport
3118
if directory is None:
3119
directory = os.getcwd()
3120
url = urlutils.local_path_to_url(directory)
3121
if not allow_writes:
3122
url = 'readonly+' + url
3123
t = get_transport(url)
3125
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3126
elif port is not None:
3128
host, port = port.split(':')
3131
server = smart.SmartTCPServer(t, host=host, port=int(port))
3132
print 'listening on port: ', server.port
3135
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3139
# command-line interpretation helper for merge-related commands
3140
def _merge_helper(other_revision, base_revision,
3141
check_clean=True, ignore_zero=False,
3142
this_dir=None, backup_files=False,
3144
file_list=None, show_base=False, reprocess=False,
3146
pb=DummyProgress()):
3147
"""Merge changes into a tree.
3150
list(path, revno) Base for three-way merge.
3151
If [None, None] then a base will be automatically determined.
3153
list(path, revno) Other revision for three-way merge.
3155
Directory to merge changes into; '.' by default.
3157
If true, this_dir must have no uncommitted changes before the
3159
ignore_zero - If true, suppress the "zero conflicts" message when
3160
there are no conflicts; should be set when doing something we expect
3161
to complete perfectly.
3162
file_list - If supplied, merge only changes to selected files.
3164
All available ancestors of other_revision and base_revision are
3165
automatically pulled into the branch.
3167
The revno may be -1 to indicate the last revision on the branch, which is
3170
This function is intended for use from the command line; programmatic
3171
clients might prefer to call merge.merge_inner(), which has less magic
3174
# Loading it late, so that we don't always have to import bzrlib.merge
3175
if merge_type is None:
3176
merge_type = _mod_merge.Merge3Merger
3177
if this_dir is None:
3179
this_tree = WorkingTree.open_containing(this_dir)[0]
3180
if show_base and not merge_type is _mod_merge.Merge3Merger:
3181
raise errors.BzrCommandError("Show-base is not supported for this merge"
3182
" type. %s" % merge_type)
3183
if reprocess and not merge_type.supports_reprocess:
3184
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3185
" type %s." % merge_type)
3186
if reprocess and show_base:
3187
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3189
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3191
merger.pp = ProgressPhase("Merge phase", 5, pb)
3192
merger.pp.next_phase()
3193
merger.check_basis(check_clean)
3194
merger.set_other(other_revision)
3195
merger.pp.next_phase()
3196
merger.set_base(base_revision)
3197
if merger.base_rev_id == merger.other_rev_id:
3198
note('Nothing to do.')
3200
if file_list is None:
3201
if pull and merger.base_rev_id == merger.this_rev_id:
3202
count = merger.this_tree.pull(merger.this_branch,
3203
False, merger.other_rev_id)
3204
note('%d revision(s) pulled.' % (count,))
3206
merger.backup_files = backup_files
3207
merger.merge_type = merge_type
3208
merger.set_interesting_files(file_list)
3209
merger.show_base = show_base
3210
merger.reprocess = reprocess
3211
conflicts = merger.do_merge()
3212
if file_list is None:
3213
merger.set_pending()
3220
merge = _merge_helper
3223
# these get imported and then picked up by the scan for cmd_*
3224
# TODO: Some more consistent way to split command definitions across files;
3225
# we do need to load at least some information about them to know of
3226
# aliases. ideally we would avoid loading the implementation until the
3227
# details were needed.
3228
from bzrlib.cmd_version_info import cmd_version_info
3229
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3230
from bzrlib.bundle.commands import cmd_bundle_revisions
3231
from bzrlib.sign_my_commits import cmd_sign_my_commits
3232
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3233
cmd_weave_plan_merge, cmd_weave_merge_text