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,
603
delta.ChangeReporter(tree_to.inventory))
605
count = branch_to.pull(branch_from, overwrite, rev_id)
606
note('%d revision(s) pulled.' % (count,))
609
new_rh = branch_to.revision_history()
612
from bzrlib.log import show_changed_revisions
613
show_changed_revisions(branch_to, old_rh, new_rh,
617
class cmd_push(Command):
618
"""Update a mirror of this branch.
620
The target branch will not have its working tree populated because this
621
is both expensive, and is not supported on remote file systems.
623
Some smart servers or protocols *may* put the working tree in place in
626
This command only works on branches that have not diverged. Branches are
627
considered diverged if the destination branch's most recent commit is one
628
that has not been merged (directly or indirectly) by the source branch.
630
If branches have diverged, you can use 'bzr push --overwrite' to replace
631
the other branch completely, discarding its unmerged changes.
633
If you want to ensure you have the different changes in the other branch,
634
do a merge (see bzr help merge) from the other branch, and commit that.
635
After that you will be able to do a push without '--overwrite'.
637
If there is no default push location set, the first push will set it.
638
After that, you can omit the location to use the default. To change the
639
default, use --remember. The value will only be saved if the remote
640
location can be accessed.
643
takes_options = ['remember', 'overwrite', 'verbose',
644
Option('create-prefix',
645
help='Create the path leading up to the branch '
646
'if it does not already exist'),
648
help='branch to push from, '
649
'rather than the one containing the working directory',
653
Option('use-existing-dir',
654
help='By default push will fail if the target'
655
' directory exists, but does not already'
656
' have a control directory. This flag will'
657
' allow push to proceed.'),
659
takes_args = ['location?']
660
encoding_type = 'replace'
662
def run(self, location=None, remember=False, overwrite=False,
663
create_prefix=False, verbose=False,
664
use_existing_dir=False,
666
# FIXME: Way too big! Put this into a function called from the
668
if directory is None:
670
br_from = Branch.open_containing(directory)[0]
671
stored_loc = br_from.get_push_location()
673
if stored_loc is None:
674
raise errors.BzrCommandError("No push location known or specified.")
676
display_url = urlutils.unescape_for_display(stored_loc,
678
self.outf.write("Using saved location: %s\n" % display_url)
679
location = stored_loc
681
to_transport = transport.get_transport(location)
682
location_url = to_transport.base
687
br_to = repository_to = dir_to = None
689
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
690
except errors.NotBranchError:
691
pass # Didn't find anything
693
# If we can open a branch, use its direct repository, otherwise see
694
# if there is a repository without a branch.
696
br_to = dir_to.open_branch()
697
except errors.NotBranchError:
698
# Didn't find a branch, can we find a repository?
700
repository_to = dir_to.find_repository()
701
except errors.NoRepositoryPresent:
704
# Found a branch, so we must have found a repository
705
repository_to = br_to.repository
709
# XXX: Refactor the create_prefix/no_create_prefix code into a
710
# common helper function
712
to_transport.mkdir('.')
713
except errors.FileExists:
714
if not use_existing_dir:
715
raise errors.BzrCommandError("Target directory %s"
716
" already exists, but does not have a valid .bzr"
717
" directory. Supply --use-existing-dir to push"
718
" there anyway." % location)
719
except errors.NoSuchFile:
720
if not create_prefix:
721
raise errors.BzrCommandError("Parent directory of %s"
723
"\nYou may supply --create-prefix to create all"
724
" leading parent directories."
727
cur_transport = to_transport
728
needed = [cur_transport]
729
# Recurse upwards until we can create a directory successfully
731
new_transport = cur_transport.clone('..')
732
if new_transport.base == cur_transport.base:
733
raise errors.BzrCommandError("Failed to create path"
737
new_transport.mkdir('.')
738
except errors.NoSuchFile:
739
needed.append(new_transport)
740
cur_transport = new_transport
744
# Now we only need to create child directories
746
cur_transport = needed.pop()
747
cur_transport.mkdir('.')
749
# Now the target directory exists, but doesn't have a .bzr
750
# directory. So we need to create it, along with any work to create
751
# all of the dependent branches, etc.
752
dir_to = br_from.bzrdir.clone(location_url,
753
revision_id=br_from.last_revision())
754
br_to = dir_to.open_branch()
755
count = br_to.last_revision_info()[0]
756
# We successfully created the target, remember it
757
if br_from.get_push_location() is None or remember:
758
br_from.set_push_location(br_to.base)
759
elif repository_to is None:
760
# we have a bzrdir but no branch or repository
761
# XXX: Figure out what to do other than complain.
762
raise errors.BzrCommandError("At %s you have a valid .bzr control"
763
" directory, but not a branch or repository. This is an"
764
" unsupported configuration. Please move the target directory"
765
" out of the way and try again."
768
# We have a repository but no branch, copy the revisions, and then
770
last_revision_id = br_from.last_revision()
771
repository_to.fetch(br_from.repository,
772
revision_id=last_revision_id)
773
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
774
count = len(br_to.revision_history())
775
if br_from.get_push_location() is None or remember:
776
br_from.set_push_location(br_to.base)
777
else: # We have a valid to branch
778
# We were able to connect to the remote location, so remember it
779
# we don't need to successfully push because of possible divergence.
780
if br_from.get_push_location() is None or remember:
781
br_from.set_push_location(br_to.base)
782
old_rh = br_to.revision_history()
785
tree_to = dir_to.open_workingtree()
786
except errors.NotLocalUrl:
787
warning('This transport does not update the working '
788
'tree of: %s' % (br_to.base,))
789
count = br_from.push(br_to, overwrite)
790
except errors.NoWorkingTree:
791
count = br_from.push(br_to, overwrite)
795
count = br_from.push(tree_to.branch, overwrite)
799
except errors.DivergedBranches:
800
raise errors.BzrCommandError('These branches have diverged.'
801
' Try using "merge" and then "push".')
802
note('%d revision(s) pushed.' % (count,))
805
new_rh = br_to.revision_history()
808
from bzrlib.log import show_changed_revisions
809
show_changed_revisions(br_to, old_rh, new_rh,
813
class cmd_branch(Command):
814
"""Create a new copy of a branch.
816
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
817
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
819
To retrieve the branch as of a particular revision, supply the --revision
820
parameter, as in "branch foo/bar -r 5".
822
--basis is to speed up branching from remote branches. When specified, it
823
copies all the file-contents, inventory and revision data from the basis
824
branch before copying anything from the remote branch.
826
takes_args = ['from_location', 'to_location?']
827
takes_options = ['revision', 'basis']
828
aliases = ['get', 'clone']
830
def run(self, from_location, to_location=None, revision=None, basis=None):
833
elif len(revision) > 1:
834
raise errors.BzrCommandError(
835
'bzr branch --revision takes exactly 1 revision value')
837
br_from = Branch.open(from_location)
840
if basis is not None:
841
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
844
if len(revision) == 1 and revision[0] is not None:
845
revision_id = revision[0].in_history(br_from)[1]
847
# FIXME - wt.last_revision, fallback to branch, fall back to
848
# None or perhaps NULL_REVISION to mean copy nothing
850
revision_id = br_from.last_revision()
851
if to_location is None:
852
to_location = os.path.basename(from_location.rstrip("/\\"))
855
name = os.path.basename(to_location) + '\n'
857
to_transport = transport.get_transport(to_location)
859
to_transport.mkdir('.')
860
except errors.FileExists:
861
raise errors.BzrCommandError('Target directory "%s" already'
862
' exists.' % to_location)
863
except errors.NoSuchFile:
864
raise errors.BzrCommandError('Parent of "%s" does not exist.'
867
# preserve whatever source format we have.
868
dir = br_from.bzrdir.sprout(to_transport.base,
869
revision_id, basis_dir)
870
branch = dir.open_branch()
871
except errors.NoSuchRevision:
872
to_transport.delete_tree('.')
873
msg = "The branch %s has no revision %s." % (from_location, revision[0])
874
raise errors.BzrCommandError(msg)
875
except errors.UnlistableBranch:
876
osutils.rmtree(to_location)
877
msg = "The branch %s cannot be used as a --basis" % (basis,)
878
raise errors.BzrCommandError(msg)
880
branch.control_files.put_utf8('branch-name', name)
881
note('Branched %d revision(s).' % branch.revno())
886
class cmd_checkout(Command):
887
"""Create a new checkout of an existing branch.
889
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
890
the branch found in '.'. This is useful if you have removed the working tree
891
or if it was never created - i.e. if you pushed the branch to its current
894
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
895
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
897
To retrieve the branch as of a particular revision, supply the --revision
898
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
899
out of date [so you cannot commit] but it may be useful (i.e. to examine old
902
--basis is to speed up checking out from remote branches. When specified, it
903
uses the inventory and file contents from the basis branch in preference to the
904
branch being checked out.
906
See "help checkouts" for more information on checkouts.
908
takes_args = ['branch_location?', 'to_location?']
909
takes_options = ['revision', # , 'basis']
910
Option('lightweight',
911
help="perform a lightweight checkout. Lightweight "
912
"checkouts depend on access to the branch for "
913
"every operation. Normal checkouts can perform "
914
"common operations like diff and status without "
915
"such access, and also support local commits."
920
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
924
elif len(revision) > 1:
925
raise errors.BzrCommandError(
926
'bzr checkout --revision takes exactly 1 revision value')
927
if branch_location is None:
928
branch_location = osutils.getcwd()
929
to_location = branch_location
930
source = Branch.open(branch_location)
931
if len(revision) == 1 and revision[0] is not None:
932
revision_id = revision[0].in_history(source)[1]
935
if to_location is None:
936
to_location = os.path.basename(branch_location.rstrip("/\\"))
937
# if the source and to_location are the same,
938
# and there is no working tree,
939
# then reconstitute a branch
940
if (osutils.abspath(to_location) ==
941
osutils.abspath(branch_location)):
943
source.bzrdir.open_workingtree()
944
except errors.NoWorkingTree:
945
source.bzrdir.create_workingtree()
948
os.mkdir(to_location)
950
if e.errno == errno.EEXIST:
951
raise errors.BzrCommandError('Target directory "%s" already'
952
' exists.' % to_location)
953
if e.errno == errno.ENOENT:
954
raise errors.BzrCommandError('Parent of "%s" does not exist.'
958
source.create_checkout(to_location, revision_id, lightweight)
961
class cmd_renames(Command):
962
"""Show list of renamed files.
964
# TODO: Option to show renames between two historical versions.
966
# TODO: Only show renames under dir, rather than in the whole branch.
967
takes_args = ['dir?']
970
def run(self, dir=u'.'):
971
tree = WorkingTree.open_containing(dir)[0]
972
old_inv = tree.basis_tree().inventory
973
new_inv = tree.read_working_inventory()
974
renames = list(_mod_tree.find_renames(old_inv, new_inv))
976
for old_name, new_name in renames:
977
self.outf.write("%s => %s\n" % (old_name, new_name))
980
class cmd_update(Command):
981
"""Update a tree to have the latest code committed to its branch.
983
This will perform a merge into the working tree, and may generate
984
conflicts. If you have any local changes, you will still
985
need to commit them after the update for the update to be complete.
987
If you want to discard your local changes, you can just do a
988
'bzr revert' instead of 'bzr commit' after the update.
990
takes_args = ['dir?']
993
def run(self, dir='.'):
994
tree = WorkingTree.open_containing(dir)[0]
995
master = tree.branch.get_master_branch()
996
if master is not None:
999
tree.lock_tree_write()
1001
existing_pending_merges = tree.get_parent_ids()[1:]
1002
last_rev = tree.last_revision()
1003
if last_rev == tree.branch.last_revision():
1004
# may be up to date, check master too.
1005
master = tree.branch.get_master_branch()
1006
if master is None or last_rev == master.last_revision():
1007
revno = tree.branch.revision_id_to_revno(last_rev)
1008
note("Tree is up to date at revision %d." % (revno,))
1010
conflicts = tree.update()
1011
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1012
note('Updated to revision %d.' % (revno,))
1013
if tree.get_parent_ids()[1:] != existing_pending_merges:
1014
note('Your local commits will now show as pending merges with '
1015
"'bzr status', and can be committed with 'bzr commit'.")
1024
class cmd_info(Command):
1025
"""Show information about a working tree, branch or repository.
1027
This command will show all known locations and formats associated to the
1028
tree, branch or repository. Statistical information is included with
1031
Branches and working trees will also report any missing revisions.
1033
takes_args = ['location?']
1034
takes_options = ['verbose']
1037
def run(self, location=None, verbose=False):
1038
from bzrlib.info import show_bzrdir_info
1039
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1043
class cmd_remove(Command):
1044
"""Make a file unversioned.
1046
This makes bzr stop tracking changes to a versioned file. It does
1047
not delete the working copy.
1049
You can specify one or more files, and/or --new. If you specify --new,
1050
only 'added' files will be removed. If you specify both, then new files
1051
in the specified directories will be removed. If the directories are
1052
also new, they will also be removed.
1054
takes_args = ['file*']
1055
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1057
encoding_type = 'replace'
1059
def run(self, file_list, verbose=False, new=False):
1060
tree, file_list = tree_files(file_list)
1062
if file_list is None:
1063
raise errors.BzrCommandError('Specify one or more files to'
1064
' remove, or use --new.')
1066
added = tree.changes_from(tree.basis_tree(),
1067
specific_files=file_list).added
1068
file_list = sorted([f[0] for f in added], reverse=True)
1069
if len(file_list) == 0:
1070
raise errors.BzrCommandError('No matching files.')
1071
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1074
class cmd_file_id(Command):
1075
"""Print file_id of a particular file or directory.
1077
The file_id is assigned when the file is first added and remains the
1078
same through all revisions where the file exists, even when it is
1083
takes_args = ['filename']
1086
def run(self, filename):
1087
tree, relpath = WorkingTree.open_containing(filename)
1088
i = tree.inventory.path2id(relpath)
1090
raise errors.NotVersionedError(filename)
1092
self.outf.write(i + '\n')
1095
class cmd_file_path(Command):
1096
"""Print path of file_ids to a file or directory.
1098
This prints one line for each directory down to the target,
1099
starting at the branch root.
1103
takes_args = ['filename']
1106
def run(self, filename):
1107
tree, relpath = WorkingTree.open_containing(filename)
1108
inv = tree.inventory
1109
fid = inv.path2id(relpath)
1111
raise errors.NotVersionedError(filename)
1112
for fip in inv.get_idpath(fid):
1113
self.outf.write(fip + '\n')
1116
class cmd_reconcile(Command):
1117
"""Reconcile bzr metadata in a branch.
1119
This can correct data mismatches that may have been caused by
1120
previous ghost operations or bzr upgrades. You should only
1121
need to run this command if 'bzr check' or a bzr developer
1122
advises you to run it.
1124
If a second branch is provided, cross-branch reconciliation is
1125
also attempted, which will check that data like the tree root
1126
id which was not present in very early bzr versions is represented
1127
correctly in both branches.
1129
At the same time it is run it may recompress data resulting in
1130
a potential saving in disk space or performance gain.
1132
The branch *MUST* be on a listable system such as local disk or sftp.
1134
takes_args = ['branch?']
1136
def run(self, branch="."):
1137
from bzrlib.reconcile import reconcile
1138
dir = bzrdir.BzrDir.open(branch)
1142
class cmd_revision_history(Command):
1143
"""Display the list of revision ids on a branch."""
1144
takes_args = ['location?']
1149
def run(self, location="."):
1150
branch = Branch.open_containing(location)[0]
1151
for revid in branch.revision_history():
1152
self.outf.write(revid)
1153
self.outf.write('\n')
1156
class cmd_ancestry(Command):
1157
"""List all revisions merged into this branch."""
1158
takes_args = ['location?']
1163
def run(self, location="."):
1165
wt = WorkingTree.open_containing(location)[0]
1166
except errors.NoWorkingTree:
1167
b = Branch.open(location)
1168
last_revision = b.last_revision()
1171
last_revision = wt.last_revision()
1173
revision_ids = b.repository.get_ancestry(last_revision)
1174
assert revision_ids[0] is None
1176
for revision_id in revision_ids:
1177
self.outf.write(revision_id + '\n')
1180
class cmd_init(Command):
1181
"""Make a directory into a versioned branch.
1183
Use this to create an empty branch, or before importing an
1186
If there is a repository in a parent directory of the location, then
1187
the history of the branch will be stored in the repository. Otherwise
1188
init creates a standalone branch which carries its own history in
1191
If there is already a branch at the location but it has no working tree,
1192
the tree can be populated with 'bzr checkout'.
1194
Recipe for importing a tree of files:
1199
bzr commit -m 'imported project'
1201
takes_args = ['location?']
1203
RegistryOption('format',
1204
help='Specify a format for this branch. '
1205
'See "help formats".',
1206
registry=bzrdir.format_registry,
1207
converter=bzrdir.format_registry.make_bzrdir,
1208
value_switches=True,
1209
title="Branch Format",
1212
def run(self, location=None, format=None):
1214
format = bzrdir.format_registry.make_bzrdir('default')
1215
if location is None:
1218
to_transport = transport.get_transport(location)
1220
# The path has to exist to initialize a
1221
# branch inside of it.
1222
# Just using os.mkdir, since I don't
1223
# believe that we want to create a bunch of
1224
# locations if the user supplies an extended path
1225
# TODO: create-prefix
1227
to_transport.mkdir('.')
1228
except errors.FileExists:
1232
existing_bzrdir = bzrdir.BzrDir.open(location)
1233
except errors.NotBranchError:
1234
# really a NotBzrDir error...
1235
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1237
from bzrlib.transport.local import LocalTransport
1238
if existing_bzrdir.has_branch():
1239
if (isinstance(to_transport, LocalTransport)
1240
and not existing_bzrdir.has_workingtree()):
1241
raise errors.BranchExistsWithoutWorkingTree(location)
1242
raise errors.AlreadyBranchError(location)
1244
existing_bzrdir.create_branch()
1245
existing_bzrdir.create_workingtree()
1248
class cmd_init_repository(Command):
1249
"""Create a shared repository to hold branches.
1251
New branches created under the repository directory will store their revisions
1252
in the repository, not in the branch directory, if the branch format supports
1258
bzr checkout --lightweight repo/trunk trunk-checkout
1262
takes_args = ["location"]
1263
takes_options = [RegistryOption('format',
1264
help='Specify a format for this repository. See'
1265
' "bzr help formats" for details',
1266
registry=bzrdir.format_registry,
1267
converter=bzrdir.format_registry.make_bzrdir,
1268
value_switches=True, title='Repository format'),
1270
help='Allows branches in repository to have'
1272
aliases = ["init-repo"]
1273
def run(self, location, format=None, trees=False):
1275
format = bzrdir.format_registry.make_bzrdir('default')
1277
if location is None:
1280
to_transport = transport.get_transport(location)
1282
to_transport.mkdir('.')
1283
except errors.FileExists:
1286
newdir = format.initialize_on_transport(to_transport)
1287
repo = newdir.create_repository(shared=True)
1288
repo.set_make_working_trees(trees)
1291
class cmd_diff(Command):
1292
"""Show differences in the working tree or between revisions.
1294
If files are listed, only the changes in those files are listed.
1295
Otherwise, all changes for the tree are listed.
1297
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1298
produces patches suitable for "patch -p1".
1302
Shows the difference in the working tree versus the last commit
1304
Difference between the working tree and revision 1
1306
Difference between revision 2 and revision 1
1307
bzr diff --diff-prefix old/:new/
1308
Same as 'bzr diff' but prefix paths with old/ and new/
1309
bzr diff bzr.mine bzr.dev
1310
Show the differences between the two working trees
1312
Show just the differences for 'foo.c'
1314
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1315
# or a graphical diff.
1317
# TODO: Python difflib is not exactly the same as unidiff; should
1318
# either fix it up or prefer to use an external diff.
1320
# TODO: Selected-file diff is inefficient and doesn't show you
1323
# TODO: This probably handles non-Unix newlines poorly.
1325
takes_args = ['file*']
1326
takes_options = ['revision', 'diff-options',
1327
Option('prefix', type=str,
1329
help='Set prefixes to added to old and new filenames, as '
1330
'two values separated by a colon.'),
1332
aliases = ['di', 'dif']
1333
encoding_type = 'exact'
1336
def run(self, revision=None, file_list=None, diff_options=None,
1338
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1340
if (prefix is None) or (prefix == '0'):
1348
old_label, new_label = prefix.split(":")
1350
raise BzrCommandError(
1351
"--prefix expects two values separated by a colon")
1353
if revision and len(revision) > 2:
1354
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1355
' one or two revision specifiers')
1358
tree1, file_list = internal_tree_files(file_list)
1362
except errors.FileInWrongBranch:
1363
if len(file_list) != 2:
1364
raise errors.BzrCommandError("Files are in different branches")
1366
tree1, file1 = WorkingTree.open_containing(file_list[0])
1367
tree2, file2 = WorkingTree.open_containing(file_list[1])
1368
if file1 != "" or file2 != "":
1369
# FIXME diff those two files. rbc 20051123
1370
raise errors.BzrCommandError("Files are in different branches")
1372
except errors.NotBranchError:
1373
if (revision is not None and len(revision) == 2
1374
and not revision[0].needs_branch()
1375
and not revision[1].needs_branch()):
1376
# If both revision specs include a branch, we can
1377
# diff them without needing a local working tree
1378
tree1, tree2 = None, None
1382
if tree2 is not None:
1383
if revision is not None:
1384
# FIXME: but there should be a clean way to diff between
1385
# non-default versions of two trees, it's not hard to do
1387
raise errors.BzrCommandError(
1388
"Sorry, diffing arbitrary revisions across branches "
1389
"is not implemented yet")
1390
return show_diff_trees(tree1, tree2, sys.stdout,
1391
specific_files=file_list,
1392
external_diff_options=diff_options,
1393
old_label=old_label, new_label=new_label)
1395
return diff_cmd_helper(tree1, file_list, diff_options,
1396
revision_specs=revision,
1397
old_label=old_label, new_label=new_label)
1400
class cmd_deleted(Command):
1401
"""List files deleted in the working tree.
1403
# TODO: Show files deleted since a previous revision, or
1404
# between two revisions.
1405
# TODO: Much more efficient way to do this: read in new
1406
# directories with readdir, rather than stating each one. Same
1407
# level of effort but possibly much less IO. (Or possibly not,
1408
# if the directories are very large...)
1409
takes_options = ['show-ids']
1412
def run(self, show_ids=False):
1413
tree = WorkingTree.open_containing(u'.')[0]
1414
old = tree.basis_tree()
1415
for path, ie in old.inventory.iter_entries():
1416
if not tree.has_id(ie.file_id):
1417
self.outf.write(path)
1419
self.outf.write(' ')
1420
self.outf.write(ie.file_id)
1421
self.outf.write('\n')
1424
class cmd_modified(Command):
1425
"""List files modified in working tree.
1427
See also: "bzr status".
1434
tree = WorkingTree.open_containing(u'.')[0]
1435
td = tree.changes_from(tree.basis_tree())
1436
for path, id, kind, text_modified, meta_modified in td.modified:
1437
self.outf.write(path + '\n')
1440
class cmd_added(Command):
1441
"""List files added in working tree.
1443
See also: "bzr status".
1450
wt = WorkingTree.open_containing(u'.')[0]
1451
basis_inv = wt.basis_tree().inventory
1454
if file_id in basis_inv:
1456
if inv.is_root(file_id) and len(basis_inv) == 0:
1458
path = inv.id2path(file_id)
1459
if not os.access(osutils.abspath(path), os.F_OK):
1461
self.outf.write(path + '\n')
1464
class cmd_root(Command):
1465
"""Show the tree root directory.
1467
The root is the nearest enclosing directory with a .bzr control
1469
takes_args = ['filename?']
1471
def run(self, filename=None):
1472
"""Print the branch root."""
1473
tree = WorkingTree.open_containing(filename)[0]
1474
self.outf.write(tree.basedir + '\n')
1477
class cmd_log(Command):
1478
"""Show log of a branch, file, or directory.
1480
By default show the log of the branch containing the working directory.
1482
To request a range of logs, you can use the command -r begin..end
1483
-r revision requests a specific revision, -r ..end or -r begin.. are
1489
bzr log -r -10.. http://server/branch
1492
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1494
takes_args = ['location?']
1495
takes_options = [Option('forward',
1496
help='show from oldest to newest'),
1500
help='show files changed in each revision'),
1501
'show-ids', 'revision',
1505
help='show revisions whose message matches this regexp',
1508
encoding_type = 'replace'
1511
def run(self, location=None, timezone='original',
1518
from bzrlib.log import show_log
1519
assert message is None or isinstance(message, basestring), \
1520
"invalid message argument %r" % message
1521
direction = (forward and 'forward') or 'reverse'
1526
# find the file id to log:
1528
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1532
tree = b.basis_tree()
1533
inv = tree.inventory
1534
file_id = inv.path2id(fp)
1536
raise errors.BzrCommandError(
1537
"Path does not have any revision history: %s" %
1541
# FIXME ? log the current subdir only RBC 20060203
1542
if revision is not None \
1543
and len(revision) > 0 and revision[0].get_branch():
1544
location = revision[0].get_branch()
1547
dir, relpath = bzrdir.BzrDir.open_containing(location)
1548
b = dir.open_branch()
1550
if revision is None:
1553
elif len(revision) == 1:
1554
rev1 = rev2 = revision[0].in_history(b).revno
1555
elif len(revision) == 2:
1556
if revision[1].get_branch() != revision[0].get_branch():
1557
# b is taken from revision[0].get_branch(), and
1558
# show_log will use its revision_history. Having
1559
# different branches will lead to weird behaviors.
1560
raise errors.BzrCommandError(
1561
"Log doesn't accept two revisions in different branches.")
1562
if revision[0].spec is None:
1563
# missing begin-range means first revision
1566
rev1 = revision[0].in_history(b).revno
1568
if revision[1].spec is None:
1569
# missing end-range means last known revision
1572
rev2 = revision[1].in_history(b).revno
1574
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1576
# By this point, the revision numbers are converted to the +ve
1577
# form if they were supplied in the -ve form, so we can do
1578
# this comparison in relative safety
1580
(rev2, rev1) = (rev1, rev2)
1582
if log_format is None:
1583
log_format = log.log_formatter_registry.get_default(b)
1585
lf = log_format(show_ids=show_ids, to_file=self.outf,
1586
show_timezone=timezone)
1592
direction=direction,
1593
start_revision=rev1,
1598
def get_log_format(long=False, short=False, line=False, default='long'):
1599
log_format = default
1603
log_format = 'short'
1609
class cmd_touching_revisions(Command):
1610
"""Return revision-ids which affected a particular file.
1612
A more user-friendly interface is "bzr log FILE".
1616
takes_args = ["filename"]
1619
def run(self, filename):
1620
tree, relpath = WorkingTree.open_containing(filename)
1622
inv = tree.read_working_inventory()
1623
file_id = inv.path2id(relpath)
1624
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1625
self.outf.write("%6d %s\n" % (revno, what))
1628
class cmd_ls(Command):
1629
"""List files in a tree.
1632
takes_args = ['path?']
1633
# TODO: Take a revision or remote path and list that tree instead.
1634
takes_options = ['verbose', 'revision',
1635
Option('non-recursive',
1636
help='don\'t recurse into sub-directories'),
1638
help='Print all paths from the root of the branch.'),
1639
Option('unknown', help='Print unknown files'),
1640
Option('versioned', help='Print versioned files'),
1641
Option('ignored', help='Print ignored files'),
1643
Option('null', help='Null separate the files'),
1647
def run(self, revision=None, verbose=False,
1648
non_recursive=False, from_root=False,
1649
unknown=False, versioned=False, ignored=False,
1650
null=False, kind=None, show_ids=False, path=None):
1652
if kind and kind not in ('file', 'directory', 'symlink'):
1653
raise errors.BzrCommandError('invalid kind specified')
1655
if verbose and null:
1656
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1657
all = not (unknown or versioned or ignored)
1659
selection = {'I':ignored, '?':unknown, 'V':versioned}
1666
raise errors.BzrCommandError('cannot specify both --from-root'
1670
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1676
if revision is not None:
1677
tree = branch.repository.revision_tree(
1678
revision[0].in_history(branch).rev_id)
1680
tree = branch.basis_tree()
1682
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1683
if fp.startswith(relpath):
1684
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1685
if non_recursive and '/' in fp:
1687
if not all and not selection[fc]:
1689
if kind is not None and fkind != kind:
1692
kindch = entry.kind_character()
1693
outstring = '%-8s %s%s' % (fc, fp, kindch)
1694
if show_ids and fid is not None:
1695
outstring = "%-50s %s" % (outstring, fid)
1696
self.outf.write(outstring + '\n')
1698
self.outf.write(fp + '\0')
1701
self.outf.write(fid)
1702
self.outf.write('\0')
1710
self.outf.write('%-50s %s\n' % (fp, my_id))
1712
self.outf.write(fp + '\n')
1715
class cmd_unknowns(Command):
1716
"""List unknown files.
1718
See also: "bzr ls --unknown".
1725
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1726
self.outf.write(osutils.quotefn(f) + '\n')
1729
class cmd_ignore(Command):
1730
"""Ignore specified files or patterns.
1732
To remove patterns from the ignore list, edit the .bzrignore file.
1734
Trailing slashes on patterns are ignored.
1735
If the pattern contains a slash or is a regular expression, it is compared
1736
to the whole path from the branch root. Otherwise, it is compared to only
1737
the last component of the path. To match a file only in the root
1738
directory, prepend './'.
1740
Ignore patterns specifying absolute paths are not allowed.
1742
Ignore patterns may include globbing wildcards such as:
1743
? - Matches any single character except '/'
1744
* - Matches 0 or more characters except '/'
1745
/**/ - Matches 0 or more directories in a path
1746
[a-z] - Matches a single character from within a group of characters
1748
Ignore patterns may also be Python regular expressions.
1749
Regular expression ignore patterns are identified by a 'RE:' prefix
1750
followed by the regular expression. Regular expression ignore patterns
1751
may not include named or numbered groups.
1753
Note: ignore patterns containing shell wildcards must be quoted from
1757
bzr ignore ./Makefile
1758
bzr ignore '*.class'
1759
bzr ignore 'lib/**/*.o'
1760
bzr ignore 'RE:lib/.*\.o'
1762
takes_args = ['name_pattern*']
1764
Option('old-default-rules',
1765
help='Out the ignore rules bzr < 0.9 always used.')
1768
def run(self, name_pattern_list=None, old_default_rules=None):
1769
from bzrlib.atomicfile import AtomicFile
1770
if old_default_rules is not None:
1771
# dump the rules and exit
1772
for pattern in ignores.OLD_DEFAULTS:
1775
if not name_pattern_list:
1776
raise errors.BzrCommandError("ignore requires at least one "
1777
"NAME_PATTERN or --old-default-rules")
1778
for name_pattern in name_pattern_list:
1779
if name_pattern[0] == '/':
1780
raise errors.BzrCommandError(
1781
"NAME_PATTERN should not be an absolute path")
1782
tree, relpath = WorkingTree.open_containing(u'.')
1783
ifn = tree.abspath('.bzrignore')
1784
if os.path.exists(ifn):
1787
igns = f.read().decode('utf-8')
1793
# TODO: If the file already uses crlf-style termination, maybe
1794
# we should use that for the newly added lines?
1796
if igns and igns[-1] != '\n':
1798
for name_pattern in name_pattern_list:
1799
igns += name_pattern.rstrip('/') + '\n'
1801
f = AtomicFile(ifn, 'wb')
1803
f.write(igns.encode('utf-8'))
1808
inv = tree.inventory
1809
if inv.path2id('.bzrignore'):
1810
mutter('.bzrignore is already versioned')
1812
mutter('need to make new .bzrignore file versioned')
1813
tree.add(['.bzrignore'])
1816
class cmd_ignored(Command):
1817
"""List ignored files and the patterns that matched them.
1819
See also: bzr ignore"""
1822
tree = WorkingTree.open_containing(u'.')[0]
1823
for path, file_class, kind, file_id, entry in tree.list_files():
1824
if file_class != 'I':
1826
## XXX: Slightly inefficient since this was already calculated
1827
pat = tree.is_ignored(path)
1828
print '%-50s %s' % (path, pat)
1831
class cmd_lookup_revision(Command):
1832
"""Lookup the revision-id from a revision-number
1835
bzr lookup-revision 33
1838
takes_args = ['revno']
1841
def run(self, revno):
1845
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1847
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1850
class cmd_export(Command):
1851
"""Export past revision to destination directory.
1853
If no revision is specified this exports the last committed revision.
1855
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1856
given, try to find the format with the extension. If no extension
1857
is found exports to a directory (equivalent to --format=dir).
1859
Root may be the top directory for tar, tgz and tbz2 formats. If none
1860
is given, the top directory will be the root name of the file.
1862
If branch is omitted then the branch containing the CWD will be used.
1864
Note: export of tree with non-ascii filenames to zip is not supported.
1866
Supported formats Autodetected by extension
1867
----------------- -------------------------
1870
tbz2 .tar.bz2, .tbz2
1874
takes_args = ['dest', 'branch?']
1875
takes_options = ['revision', 'format', 'root']
1876
def run(self, dest, branch=None, revision=None, format=None, root=None):
1877
from bzrlib.export import export
1880
tree = WorkingTree.open_containing(u'.')[0]
1883
b = Branch.open(branch)
1885
if revision is None:
1886
# should be tree.last_revision FIXME
1887
rev_id = b.last_revision()
1889
if len(revision) != 1:
1890
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1891
rev_id = revision[0].in_history(b).rev_id
1892
t = b.repository.revision_tree(rev_id)
1894
export(t, dest, format, root)
1895
except errors.NoSuchExportFormat, e:
1896
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1899
class cmd_cat(Command):
1900
"""Write a file's text from a previous revision."""
1902
takes_options = ['revision', 'name-from-revision']
1903
takes_args = ['filename']
1904
encoding_type = 'exact'
1907
def run(self, filename, revision=None, name_from_revision=False):
1908
if revision is not None and len(revision) != 1:
1909
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1914
tree, relpath = WorkingTree.open_containing(filename)
1916
except (errors.NotBranchError, errors.NotLocalUrl):
1919
if revision is not None and revision[0].get_branch() is not None:
1920
b = Branch.open(revision[0].get_branch())
1922
b, relpath = Branch.open_containing(filename)
1923
tree = b.basis_tree()
1924
if revision is None:
1925
revision_id = b.last_revision()
1927
revision_id = revision[0].in_history(b).rev_id
1929
cur_file_id = tree.path2id(relpath)
1930
rev_tree = b.repository.revision_tree(revision_id)
1931
old_file_id = rev_tree.path2id(relpath)
1933
if name_from_revision:
1934
if old_file_id is None:
1935
raise errors.BzrCommandError("%r is not present in revision %s"
1936
% (filename, revision_id))
1938
rev_tree.print_file(old_file_id)
1939
elif cur_file_id is not None:
1940
rev_tree.print_file(cur_file_id)
1941
elif old_file_id is not None:
1942
rev_tree.print_file(old_file_id)
1944
raise errors.BzrCommandError("%r is not present in revision %s" %
1945
(filename, revision_id))
1948
class cmd_local_time_offset(Command):
1949
"""Show the offset in seconds from GMT to local time."""
1953
print osutils.local_time_offset()
1957
class cmd_commit(Command):
1958
"""Commit changes into a new revision.
1960
If no arguments are given, the entire tree is committed.
1962
If selected files are specified, only changes to those files are
1963
committed. If a directory is specified then the directory and everything
1964
within it is committed.
1966
A selected-file commit may fail in some cases where the committed
1967
tree would be invalid, such as trying to commit a file in a
1968
newly-added directory that is not itself committed.
1970
# TODO: Run hooks on tree to-be-committed, and after commit.
1972
# TODO: Strict commit that fails if there are deleted files.
1973
# (what does "deleted files" mean ??)
1975
# TODO: Give better message for -s, --summary, used by tla people
1977
# XXX: verbose currently does nothing
1979
takes_args = ['selected*']
1980
takes_options = ['message', 'verbose',
1982
help='commit even if nothing has changed'),
1983
Option('file', type=str,
1986
help='file containing commit message'),
1988
help="refuse to commit if there are unknown "
1989
"files in the working tree."),
1991
help="perform a local only commit in a bound "
1992
"branch. Such commits are not pushed to "
1993
"the master branch until a normal commit "
1997
aliases = ['ci', 'checkin']
1999
def run(self, message=None, file=None, verbose=True, selected_list=None,
2000
unchanged=False, strict=False, local=False):
2001
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2002
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2004
from bzrlib.msgeditor import edit_commit_message, \
2005
make_commit_message_template
2007
# TODO: Need a blackbox test for invoking the external editor; may be
2008
# slightly problematic to run this cross-platform.
2010
# TODO: do more checks that the commit will succeed before
2011
# spending the user's valuable time typing a commit message.
2012
tree, selected_list = tree_files(selected_list)
2013
if selected_list == ['']:
2014
# workaround - commit of root of tree should be exactly the same
2015
# as just default commit in that tree, and succeed even though
2016
# selected-file merge commit is not done yet
2019
if local and not tree.branch.get_bound_location():
2020
raise errors.LocalRequiresBoundBranch()
2022
def get_message(commit_obj):
2023
"""Callback to get commit message"""
2024
my_message = message
2025
if my_message is None and not file:
2026
template = make_commit_message_template(tree, selected_list)
2027
my_message = edit_commit_message(template)
2028
if my_message is None:
2029
raise errors.BzrCommandError("please specify a commit"
2030
" message with either --message or --file")
2031
elif my_message and file:
2032
raise errors.BzrCommandError(
2033
"please specify either --message or --file")
2035
my_message = codecs.open(file, 'rt',
2036
bzrlib.user_encoding).read()
2037
if my_message == "":
2038
raise errors.BzrCommandError("empty commit message specified")
2042
reporter = ReportCommitToLog()
2044
reporter = NullCommitReporter()
2047
tree.commit(message_callback=get_message,
2048
specific_files=selected_list,
2049
allow_pointless=unchanged, strict=strict, local=local,
2051
except PointlessCommit:
2052
# FIXME: This should really happen before the file is read in;
2053
# perhaps prepare the commit; get the message; then actually commit
2054
raise errors.BzrCommandError("no changes to commit."
2055
" use --unchanged to commit anyhow")
2056
except ConflictsInTree:
2057
raise errors.BzrCommandError('Conflicts detected in working '
2058
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2060
except StrictCommitFailed:
2061
raise errors.BzrCommandError("Commit refused because there are"
2062
" unknown files in the working tree.")
2063
except errors.BoundBranchOutOfDate, e:
2064
raise errors.BzrCommandError(str(e) + "\n"
2065
'To commit to master branch, run update and then commit.\n'
2066
'You can also pass --local to commit to continue working '
2070
class cmd_check(Command):
2071
"""Validate consistency of branch history.
2073
This command checks various invariants about the branch storage to
2074
detect data corruption or bzr bugs.
2076
takes_args = ['branch?']
2077
takes_options = ['verbose']
2079
def run(self, branch=None, verbose=False):
2080
from bzrlib.check import check
2082
tree = WorkingTree.open_containing()[0]
2083
branch = tree.branch
2085
branch = Branch.open(branch)
2086
check(branch, verbose)
2089
class cmd_upgrade(Command):
2090
"""Upgrade branch storage to current format.
2092
The check command or bzr developers may sometimes advise you to run
2093
this command. When the default format has changed you may also be warned
2094
during other operations to upgrade.
2096
takes_args = ['url?']
2098
RegistryOption('format',
2099
help='Upgrade to a specific format. See "bzr help'
2100
' formats" for details',
2101
registry=bzrdir.format_registry,
2102
converter=bzrdir.format_registry.make_bzrdir,
2103
value_switches=True, title='Branch format'),
2107
def run(self, url='.', format=None):
2108
from bzrlib.upgrade import upgrade
2110
format = bzrdir.format_registry.make_bzrdir('default')
2111
upgrade(url, format)
2114
class cmd_whoami(Command):
2115
"""Show or set bzr user id.
2119
bzr whoami 'Frank Chu <fchu@example.com>'
2121
takes_options = [ Option('email',
2122
help='display email address only'),
2124
help='set identity for the current branch instead of '
2127
takes_args = ['name?']
2128
encoding_type = 'replace'
2131
def run(self, email=False, branch=False, name=None):
2133
# use branch if we're inside one; otherwise global config
2135
c = Branch.open_containing('.')[0].get_config()
2136
except errors.NotBranchError:
2137
c = config.GlobalConfig()
2139
self.outf.write(c.user_email() + '\n')
2141
self.outf.write(c.username() + '\n')
2144
# display a warning if an email address isn't included in the given name.
2146
config.extract_email_address(name)
2147
except errors.NoEmailInUsername, e:
2148
warning('"%s" does not seem to contain an email address. '
2149
'This is allowed, but not recommended.', name)
2151
# use global config unless --branch given
2153
c = Branch.open_containing('.')[0].get_config()
2155
c = config.GlobalConfig()
2156
c.set_user_option('email', name)
2159
class cmd_nick(Command):
2160
"""Print or set the branch nickname.
2162
If unset, the tree root directory name is used as the nickname
2163
To print the current nickname, execute with no argument.
2165
takes_args = ['nickname?']
2166
def run(self, nickname=None):
2167
branch = Branch.open_containing(u'.')[0]
2168
if nickname is None:
2169
self.printme(branch)
2171
branch.nick = nickname
2174
def printme(self, branch):
2178
class cmd_selftest(Command):
2179
"""Run internal test suite.
2181
This creates temporary test directories in the working directory, but not
2182
existing data is affected. These directories are deleted if the tests
2183
pass, or left behind to help in debugging if they fail and --keep-output
2186
If arguments are given, they are regular expressions that say which tests
2187
should run. Tests matching any expression are run, and other tests are
2190
Alternatively if --first is given, matching tests are run first and then
2191
all other tests are run. This is useful if you have been working in a
2192
particular area, but want to make sure nothing else was broken.
2194
If the global option '--no-plugins' is given, plugins are not loaded
2195
before running the selftests. This has two effects: features provided or
2196
modified by plugins will not be tested, and tests provided by plugins will
2201
run only tests relating to 'ignore'
2202
bzr --no-plugins selftest -v
2203
disable plugins and list tests as they're run
2205
# TODO: --list should give a list of all available tests
2207
# NB: this is used from the class without creating an instance, which is
2208
# why it does not have a self parameter.
2209
def get_transport_type(typestring):
2210
"""Parse and return a transport specifier."""
2211
if typestring == "sftp":
2212
from bzrlib.transport.sftp import SFTPAbsoluteServer
2213
return SFTPAbsoluteServer
2214
if typestring == "memory":
2215
from bzrlib.transport.memory import MemoryServer
2217
if typestring == "fakenfs":
2218
from bzrlib.transport.fakenfs import FakeNFSServer
2219
return FakeNFSServer
2220
msg = "No known transport type %s. Supported types are: sftp\n" %\
2222
raise errors.BzrCommandError(msg)
2225
takes_args = ['testspecs*']
2226
takes_options = ['verbose',
2227
Option('one', help='stop when one test fails'),
2228
Option('keep-output',
2229
help='keep output directories when tests fail'),
2231
help='Use a different transport by default '
2232
'throughout the test suite.',
2233
type=get_transport_type),
2234
Option('benchmark', help='run the bzr bencharks.'),
2235
Option('lsprof-timed',
2236
help='generate lsprof output for benchmarked'
2237
' sections of code.'),
2238
Option('cache-dir', type=str,
2239
help='a directory to cache intermediate'
2240
' benchmark steps'),
2241
Option('clean-output',
2242
help='clean temporary tests directories'
2243
' without running tests'),
2245
help='run all tests, but run specified tests first',
2248
encoding_type = 'replace'
2250
def run(self, testspecs_list=None, verbose=None, one=False,
2251
keep_output=False, transport=None, benchmark=None,
2252
lsprof_timed=None, cache_dir=None, clean_output=False,
2255
from bzrlib.tests import selftest
2256
import bzrlib.benchmarks as benchmarks
2257
from bzrlib.benchmarks import tree_creator
2260
from bzrlib.tests import clean_selftest_output
2261
clean_selftest_output()
2264
if cache_dir is not None:
2265
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2266
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2267
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2269
if testspecs_list is not None:
2270
pattern = '|'.join(testspecs_list)
2274
test_suite_factory = benchmarks.test_suite
2277
# TODO: should possibly lock the history file...
2278
benchfile = open(".perf_history", "at", buffering=1)
2280
test_suite_factory = None
2285
result = selftest(verbose=verbose,
2287
stop_on_failure=one,
2288
keep_output=keep_output,
2289
transport=transport,
2290
test_suite_factory=test_suite_factory,
2291
lsprof_timed=lsprof_timed,
2292
bench_history=benchfile,
2293
matching_tests_first=first,
2296
if benchfile is not None:
2299
info('tests passed')
2301
info('tests failed')
2302
return int(not result)
2305
class cmd_version(Command):
2306
"""Show version of bzr."""
2310
from bzrlib.version import show_version
2314
class cmd_rocks(Command):
2315
"""Statement of optimism."""
2321
print "it sure does!"
2324
class cmd_find_merge_base(Command):
2325
"""Find and print a base revision for merging two branches."""
2326
# TODO: Options to specify revisions on either side, as if
2327
# merging only part of the history.
2328
takes_args = ['branch', 'other']
2332
def run(self, branch, other):
2333
from bzrlib.revision import MultipleRevisionSources
2335
branch1 = Branch.open_containing(branch)[0]
2336
branch2 = Branch.open_containing(other)[0]
2338
last1 = branch1.last_revision()
2339
last2 = branch2.last_revision()
2341
source = MultipleRevisionSources(branch1.repository,
2344
base_rev_id = common_ancestor(last1, last2, source)
2346
print 'merge base is revision %s' % base_rev_id
2349
class cmd_merge(Command):
2350
"""Perform a three-way merge.
2352
The branch is the branch you will merge from. By default, it will merge
2353
the latest revision. If you specify a revision, that revision will be
2354
merged. If you specify two revisions, the first will be used as a BASE,
2355
and the second one as OTHER. Revision numbers are always relative to the
2358
By default, bzr will try to merge in all new work from the other
2359
branch, automatically determining an appropriate base. If this
2360
fails, you may need to give an explicit base.
2362
Merge will do its best to combine the changes in two branches, but there
2363
are some kinds of problems only a human can fix. When it encounters those,
2364
it will mark a conflict. A conflict means that you need to fix something,
2365
before you should commit.
2367
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2369
If there is no default branch set, the first merge will set it. After
2370
that, you can omit the branch to use the default. To change the
2371
default, use --remember. The value will only be saved if the remote
2372
location can be accessed.
2374
The results of the merge are placed into the destination working
2375
directory, where they can be reviewed (with bzr diff), tested, and then
2376
committed to record the result of the merge.
2380
To merge the latest revision from bzr.dev
2381
bzr merge ../bzr.dev
2383
To merge changes up to and including revision 82 from bzr.dev
2384
bzr merge -r 82 ../bzr.dev
2386
To merge the changes introduced by 82, without previous changes:
2387
bzr merge -r 81..82 ../bzr.dev
2389
merge refuses to run if there are any uncommitted changes, unless
2392
The following merge types are available:
2394
takes_args = ['branch?']
2395
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2396
Option('show-base', help="Show base revision text in "
2398
Option('uncommitted', help='Apply uncommitted changes'
2399
' from a working copy, instead of branch changes'),
2400
Option('pull', help='If the destination is already'
2401
' completely merged into the source, pull from the'
2402
' source rather than merging. When this happens,'
2403
' you do not need to commit the result.'),
2405
help='branch to merge into, '
2406
'rather than the one containing the working directory',
2412
def run(self, branch=None, revision=None, force=False, merge_type=None,
2413
show_base=False, reprocess=False, remember=False,
2414
uncommitted=False, pull=False,
2417
if merge_type is None:
2418
merge_type = _mod_merge.Merge3Merger
2420
if directory is None: directory = u'.'
2421
tree = WorkingTree.open_containing(directory)[0]
2422
change_reporter = delta.ChangeReporter(tree.inventory)
2424
if branch is not None:
2426
reader = bundle.read_bundle_from_url(branch)
2427
except errors.NotABundle:
2428
pass # Continue on considering this url a Branch
2430
conflicts = merge_bundle(reader, tree, not force, merge_type,
2431
reprocess, show_base, change_reporter)
2437
if revision is None \
2438
or len(revision) < 1 or revision[0].needs_branch():
2439
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2441
if revision is None or len(revision) < 1:
2444
other = [branch, None]
2447
other = [branch, -1]
2448
other_branch, path = Branch.open_containing(branch)
2451
raise errors.BzrCommandError('Cannot use --uncommitted and'
2452
' --revision at the same time.')
2453
branch = revision[0].get_branch() or branch
2454
if len(revision) == 1:
2456
other_branch, path = Branch.open_containing(branch)
2457
revno = revision[0].in_history(other_branch).revno
2458
other = [branch, revno]
2460
assert len(revision) == 2
2461
if None in revision:
2462
raise errors.BzrCommandError(
2463
"Merge doesn't permit empty revision specifier.")
2464
base_branch, path = Branch.open_containing(branch)
2465
branch1 = revision[1].get_branch() or branch
2466
other_branch, path1 = Branch.open_containing(branch1)
2467
if revision[0].get_branch() is not None:
2468
# then path was obtained from it, and is None.
2471
base = [branch, revision[0].in_history(base_branch).revno]
2472
other = [branch1, revision[1].in_history(other_branch).revno]
2474
if tree.branch.get_parent() is None or remember:
2475
tree.branch.set_parent(other_branch.base)
2478
interesting_files = [path]
2480
interesting_files = None
2481
pb = ui.ui_factory.nested_progress_bar()
2484
conflict_count = _merge_helper(
2485
other, base, check_clean=(not force),
2486
merge_type=merge_type,
2487
reprocess=reprocess,
2488
show_base=show_base,
2491
pb=pb, file_list=interesting_files,
2492
change_reporter=change_reporter)
2495
if conflict_count != 0:
2499
except errors.AmbiguousBase, e:
2500
m = ("sorry, bzr can't determine the right merge base yet\n"
2501
"candidates are:\n "
2502
+ "\n ".join(e.bases)
2504
"please specify an explicit base with -r,\n"
2505
"and (if you want) report this to the bzr developers\n")
2508
# TODO: move up to common parent; this isn't merge-specific anymore.
2509
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2510
"""Use tree.branch's parent if none was supplied.
2512
Report if the remembered location was used.
2514
if supplied_location is not None:
2515
return supplied_location
2516
stored_location = tree.branch.get_parent()
2517
mutter("%s", stored_location)
2518
if stored_location is None:
2519
raise errors.BzrCommandError("No location specified or remembered")
2520
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2521
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2522
return stored_location
2525
class cmd_remerge(Command):
2528
Use this if you want to try a different merge technique while resolving
2529
conflicts. Some merge techniques are better than others, and remerge
2530
lets you try different ones on different files.
2532
The options for remerge have the same meaning and defaults as the ones for
2533
merge. The difference is that remerge can (only) be run when there is a
2534
pending merge, and it lets you specify particular files.
2537
$ bzr remerge --show-base
2538
Re-do the merge of all conflicted files, and show the base text in
2539
conflict regions, in addition to the usual THIS and OTHER texts.
2541
$ bzr remerge --merge-type weave --reprocess foobar
2542
Re-do the merge of "foobar", using the weave merge algorithm, with
2543
additional processing to reduce the size of conflict regions.
2545
The following merge types are available:"""
2546
takes_args = ['file*']
2547
takes_options = ['merge-type', 'reprocess',
2548
Option('show-base', help="Show base revision text in "
2551
def run(self, file_list=None, merge_type=None, show_base=False,
2553
if merge_type is None:
2554
merge_type = _mod_merge.Merge3Merger
2555
tree, file_list = tree_files(file_list)
2558
parents = tree.get_parent_ids()
2559
if len(parents) != 2:
2560
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2561
" merges. Not cherrypicking or"
2563
repository = tree.branch.repository
2564
base_revision = common_ancestor(parents[0],
2565
parents[1], repository)
2566
base_tree = repository.revision_tree(base_revision)
2567
other_tree = repository.revision_tree(parents[1])
2568
interesting_ids = None
2570
conflicts = tree.conflicts()
2571
if file_list is not None:
2572
interesting_ids = set()
2573
for filename in file_list:
2574
file_id = tree.path2id(filename)
2576
raise errors.NotVersionedError(filename)
2577
interesting_ids.add(file_id)
2578
if tree.kind(file_id) != "directory":
2581
for name, ie in tree.inventory.iter_entries(file_id):
2582
interesting_ids.add(ie.file_id)
2583
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2585
# Remerge only supports resolving contents conflicts
2586
allowed_conflicts = ('text conflict', 'contents conflict')
2587
restore_files = [c.path for c in conflicts
2588
if c.typestring in allowed_conflicts]
2589
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2590
tree.set_conflicts(ConflictList(new_conflicts))
2591
if file_list is not None:
2592
restore_files = file_list
2593
for filename in restore_files:
2595
restore(tree.abspath(filename))
2596
except errors.NotConflicted:
2598
conflicts = _mod_merge.merge_inner(
2599
tree.branch, other_tree, base_tree,
2601
interesting_ids=interesting_ids,
2602
other_rev_id=parents[1],
2603
merge_type=merge_type,
2604
show_base=show_base,
2605
reprocess=reprocess)
2614
class cmd_revert(Command):
2615
"""Revert files to a previous revision.
2617
Giving a list of files will revert only those files. Otherwise, all files
2618
will be reverted. If the revision is not specified with '--revision', the
2619
last committed revision is used.
2621
To remove only some changes, without reverting to a prior version, use
2622
merge instead. For example, "merge . --r-2..-3" will remove the changes
2623
introduced by -2, without affecting the changes introduced by -1. Or
2624
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2626
By default, any files that have been manually changed will be backed up
2627
first. (Files changed only by merge are not backed up.) Backup files have
2628
'.~#~' appended to their name, where # is a number.
2630
When you provide files, you can use their current pathname or the pathname
2631
from the target revision. So you can use revert to "undelete" a file by
2632
name. If you name a directory, all the contents of that directory will be
2635
takes_options = ['revision', 'no-backup']
2636
takes_args = ['file*']
2637
aliases = ['merge-revert']
2639
def run(self, revision=None, no_backup=False, file_list=None):
2640
if file_list is not None:
2641
if len(file_list) == 0:
2642
raise errors.BzrCommandError("No files specified")
2646
tree, file_list = tree_files(file_list)
2647
if revision is None:
2648
# FIXME should be tree.last_revision
2649
rev_id = tree.last_revision()
2650
elif len(revision) != 1:
2651
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2653
rev_id = revision[0].in_history(tree.branch).rev_id
2654
pb = ui.ui_factory.nested_progress_bar()
2656
tree.revert(file_list,
2657
tree.branch.repository.revision_tree(rev_id),
2658
not no_backup, pb, report_changes=True)
2663
class cmd_assert_fail(Command):
2664
"""Test reporting of assertion failures"""
2665
# intended just for use in testing
2670
raise AssertionError("always fails")
2673
class cmd_help(Command):
2674
"""Show help on a command or other topic.
2676
For a list of all available commands, say 'bzr help commands'.
2678
takes_options = [Option('long', 'show help on all commands')]
2679
takes_args = ['topic?']
2680
aliases = ['?', '--help', '-?', '-h']
2683
def run(self, topic=None, long=False):
2685
if topic is None and long:
2687
bzrlib.help.help(topic)
2690
class cmd_shell_complete(Command):
2691
"""Show appropriate completions for context.
2693
For a list of all available commands, say 'bzr shell-complete'.
2695
takes_args = ['context?']
2700
def run(self, context=None):
2701
import shellcomplete
2702
shellcomplete.shellcomplete(context)
2705
class cmd_fetch(Command):
2706
"""Copy in history from another branch but don't merge it.
2708
This is an internal method used for pull and merge.
2711
takes_args = ['from_branch', 'to_branch']
2712
def run(self, from_branch, to_branch):
2713
from bzrlib.fetch import Fetcher
2714
from_b = Branch.open(from_branch)
2715
to_b = Branch.open(to_branch)
2716
Fetcher(to_b, from_b)
2719
class cmd_missing(Command):
2720
"""Show unmerged/unpulled revisions between two branches.
2722
OTHER_BRANCH may be local or remote.
2724
takes_args = ['other_branch?']
2725
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2727
'Display changes in the local branch only'),
2728
Option('theirs-only',
2729
'Display changes in the remote branch only'),
2734
encoding_type = 'replace'
2737
def run(self, other_branch=None, reverse=False, mine_only=False,
2738
theirs_only=False, log_format=None, long=False, short=False, line=False,
2739
show_ids=False, verbose=False):
2740
from bzrlib.missing import find_unmerged, iter_log_data
2741
from bzrlib.log import log_formatter
2742
local_branch = Branch.open_containing(u".")[0]
2743
parent = local_branch.get_parent()
2744
if other_branch is None:
2745
other_branch = parent
2746
if other_branch is None:
2747
raise errors.BzrCommandError("No peer location known or specified.")
2748
display_url = urlutils.unescape_for_display(parent,
2750
print "Using last location: " + display_url
2752
remote_branch = Branch.open(other_branch)
2753
if remote_branch.base == local_branch.base:
2754
remote_branch = local_branch
2755
local_branch.lock_read()
2757
remote_branch.lock_read()
2759
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2760
if (log_format is None):
2761
log_format = log.log_formatter_registry.get_default(
2763
lf = log_format(to_file=self.outf,
2765
show_timezone='original')
2766
if reverse is False:
2767
local_extra.reverse()
2768
remote_extra.reverse()
2769
if local_extra and not theirs_only:
2770
print "You have %d extra revision(s):" % len(local_extra)
2771
for data in iter_log_data(local_extra, local_branch.repository,
2774
printed_local = True
2776
printed_local = False
2777
if remote_extra and not mine_only:
2778
if printed_local is True:
2780
print "You are missing %d revision(s):" % len(remote_extra)
2781
for data in iter_log_data(remote_extra, remote_branch.repository,
2784
if not remote_extra and not local_extra:
2786
print "Branches are up to date."
2790
remote_branch.unlock()
2792
local_branch.unlock()
2793
if not status_code and parent is None and other_branch is not None:
2794
local_branch.lock_write()
2796
# handle race conditions - a parent might be set while we run.
2797
if local_branch.get_parent() is None:
2798
local_branch.set_parent(remote_branch.base)
2800
local_branch.unlock()
2804
class cmd_plugins(Command):
2809
import bzrlib.plugin
2810
from inspect import getdoc
2811
for name, plugin in bzrlib.plugin.all_plugins().items():
2812
if getattr(plugin, '__path__', None) is not None:
2813
print plugin.__path__[0]
2814
elif getattr(plugin, '__file__', None) is not None:
2815
print plugin.__file__
2821
print '\t', d.split('\n')[0]
2824
class cmd_testament(Command):
2825
"""Show testament (signing-form) of a revision."""
2826
takes_options = ['revision',
2827
Option('long', help='Produce long-format testament'),
2828
Option('strict', help='Produce a strict-format'
2830
takes_args = ['branch?']
2832
def run(self, branch=u'.', revision=None, long=False, strict=False):
2833
from bzrlib.testament import Testament, StrictTestament
2835
testament_class = StrictTestament
2837
testament_class = Testament
2838
b = WorkingTree.open_containing(branch)[0].branch
2841
if revision is None:
2842
rev_id = b.last_revision()
2844
rev_id = revision[0].in_history(b).rev_id
2845
t = testament_class.from_revision(b.repository, rev_id)
2847
sys.stdout.writelines(t.as_text_lines())
2849
sys.stdout.write(t.as_short_text())
2854
class cmd_annotate(Command):
2855
"""Show the origin of each line in a file.
2857
This prints out the given file with an annotation on the left side
2858
indicating which revision, author and date introduced the change.
2860
If the origin is the same for a run of consecutive lines, it is
2861
shown only at the top, unless the --all option is given.
2863
# TODO: annotate directories; showing when each file was last changed
2864
# TODO: if the working copy is modified, show annotations on that
2865
# with new uncommitted lines marked
2866
aliases = ['ann', 'blame', 'praise']
2867
takes_args = ['filename']
2868
takes_options = [Option('all', help='show annotations on all lines'),
2869
Option('long', help='show date in annotations'),
2875
def run(self, filename, all=False, long=False, revision=None,
2877
from bzrlib.annotate import annotate_file
2878
tree, relpath = WorkingTree.open_containing(filename)
2879
branch = tree.branch
2882
if revision is None:
2883
revision_id = branch.last_revision()
2884
elif len(revision) != 1:
2885
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2887
revision_id = revision[0].in_history(branch).rev_id
2888
file_id = tree.inventory.path2id(relpath)
2889
tree = branch.repository.revision_tree(revision_id)
2890
file_version = tree.inventory[file_id].revision
2891
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2897
class cmd_re_sign(Command):
2898
"""Create a digital signature for an existing revision."""
2899
# TODO be able to replace existing ones.
2901
hidden = True # is this right ?
2902
takes_args = ['revision_id*']
2903
takes_options = ['revision']
2905
def run(self, revision_id_list=None, revision=None):
2906
import bzrlib.gpg as gpg
2907
if revision_id_list is not None and revision is not None:
2908
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2909
if revision_id_list is None and revision is None:
2910
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2911
b = WorkingTree.open_containing(u'.')[0].branch
2912
gpg_strategy = gpg.GPGStrategy(b.get_config())
2913
if revision_id_list is not None:
2914
for revision_id in revision_id_list:
2915
b.repository.sign_revision(revision_id, gpg_strategy)
2916
elif revision is not None:
2917
if len(revision) == 1:
2918
revno, rev_id = revision[0].in_history(b)
2919
b.repository.sign_revision(rev_id, gpg_strategy)
2920
elif len(revision) == 2:
2921
# are they both on rh- if so we can walk between them
2922
# might be nice to have a range helper for arbitrary
2923
# revision paths. hmm.
2924
from_revno, from_revid = revision[0].in_history(b)
2925
to_revno, to_revid = revision[1].in_history(b)
2926
if to_revid is None:
2927
to_revno = b.revno()
2928
if from_revno is None or to_revno is None:
2929
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2930
for revno in range(from_revno, to_revno + 1):
2931
b.repository.sign_revision(b.get_rev_id(revno),
2934
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2937
class cmd_bind(Command):
2938
"""Convert the current branch into a checkout of the supplied branch.
2940
Once converted into a checkout, commits must succeed on the master branch
2941
before they will be applied to the local branch.
2943
See "help checkouts" for more information on checkouts.
2946
takes_args = ['location']
2949
def run(self, location=None):
2950
b, relpath = Branch.open_containing(u'.')
2951
b_other = Branch.open(location)
2954
except errors.DivergedBranches:
2955
raise errors.BzrCommandError('These branches have diverged.'
2956
' Try merging, and then bind again.')
2959
class cmd_unbind(Command):
2960
"""Convert the current checkout into a regular branch.
2962
After unbinding, the local branch is considered independent and subsequent
2963
commits will be local only.
2965
See "help checkouts" for more information on checkouts.
2972
b, relpath = Branch.open_containing(u'.')
2974
raise errors.BzrCommandError('Local branch is not bound')
2977
class cmd_uncommit(Command):
2978
"""Remove the last committed revision.
2980
--verbose will print out what is being removed.
2981
--dry-run will go through all the motions, but not actually
2984
In the future, uncommit will create a revision bundle, which can then
2988
# TODO: jam 20060108 Add an option to allow uncommit to remove
2989
# unreferenced information in 'branch-as-repository' branches.
2990
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2991
# information in shared branches as well.
2992
takes_options = ['verbose', 'revision',
2993
Option('dry-run', help='Don\'t actually make changes'),
2994
Option('force', help='Say yes to all questions.')]
2995
takes_args = ['location?']
2998
def run(self, location=None,
2999
dry_run=False, verbose=False,
3000
revision=None, force=False):
3001
from bzrlib.log import log_formatter, show_log
3003
from bzrlib.uncommit import uncommit
3005
if location is None:
3007
control, relpath = bzrdir.BzrDir.open_containing(location)
3009
tree = control.open_workingtree()
3011
except (errors.NoWorkingTree, errors.NotLocalUrl):
3013
b = control.open_branch()
3016
if revision is None:
3019
# 'bzr uncommit -r 10' actually means uncommit
3020
# so that the final tree is at revno 10.
3021
# but bzrlib.uncommit.uncommit() actually uncommits
3022
# the revisions that are supplied.
3023
# So we need to offset it by one
3024
revno = revision[0].in_history(b).revno+1
3026
if revno <= b.revno():
3027
rev_id = b.get_rev_id(revno)
3029
self.outf.write('No revisions to uncommit.\n')
3032
lf = log_formatter('short',
3034
show_timezone='original')
3039
direction='forward',
3040
start_revision=revno,
3041
end_revision=b.revno())
3044
print 'Dry-run, pretending to remove the above revisions.'
3046
val = raw_input('Press <enter> to continue')
3048
print 'The above revision(s) will be removed.'
3050
val = raw_input('Are you sure [y/N]? ')
3051
if val.lower() not in ('y', 'yes'):
3055
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3059
class cmd_break_lock(Command):
3060
"""Break a dead lock on a repository, branch or working directory.
3062
CAUTION: Locks should only be broken when you are sure that the process
3063
holding the lock has been stopped.
3065
You can get information on what locks are open via the 'bzr info' command.
3070
takes_args = ['location?']
3072
def run(self, location=None, show=False):
3073
if location is None:
3075
control, relpath = bzrdir.BzrDir.open_containing(location)
3077
control.break_lock()
3078
except NotImplementedError:
3082
class cmd_wait_until_signalled(Command):
3083
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3085
This just prints a line to signal when it is ready, then blocks on stdin.
3091
sys.stdout.write("running\n")
3093
sys.stdin.readline()
3096
class cmd_serve(Command):
3097
"""Run the bzr server."""
3099
aliases = ['server']
3103
help='serve on stdin/out for use from inetd or sshd'),
3105
help='listen for connections on nominated port of the form '
3106
'[hostname:]portnumber. Passing 0 as the port number will '
3107
'result in a dynamically allocated port.',
3110
help='serve contents of directory',
3112
Option('allow-writes',
3113
help='By default the server is a readonly server. Supplying '
3114
'--allow-writes enables write access to the contents of '
3115
'the served directory and below. '
3119
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3120
from bzrlib.transport import smart
3121
from bzrlib.transport import get_transport
3122
if directory is None:
3123
directory = os.getcwd()
3124
url = urlutils.local_path_to_url(directory)
3125
if not allow_writes:
3126
url = 'readonly+' + url
3127
t = get_transport(url)
3129
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3130
elif port is not None:
3132
host, port = port.split(':')
3135
server = smart.SmartTCPServer(t, host=host, port=int(port))
3136
print 'listening on port: ', server.port
3139
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3143
# command-line interpretation helper for merge-related commands
3144
def _merge_helper(other_revision, base_revision,
3145
check_clean=True, ignore_zero=False,
3146
this_dir=None, backup_files=False,
3148
file_list=None, show_base=False, reprocess=False,
3151
change_reporter=None):
3152
"""Merge changes into a tree.
3155
list(path, revno) Base for three-way merge.
3156
If [None, None] then a base will be automatically determined.
3158
list(path, revno) Other revision for three-way merge.
3160
Directory to merge changes into; '.' by default.
3162
If true, this_dir must have no uncommitted changes before the
3164
ignore_zero - If true, suppress the "zero conflicts" message when
3165
there are no conflicts; should be set when doing something we expect
3166
to complete perfectly.
3167
file_list - If supplied, merge only changes to selected files.
3169
All available ancestors of other_revision and base_revision are
3170
automatically pulled into the branch.
3172
The revno may be -1 to indicate the last revision on the branch, which is
3175
This function is intended for use from the command line; programmatic
3176
clients might prefer to call merge.merge_inner(), which has less magic
3179
# Loading it late, so that we don't always have to import bzrlib.merge
3180
if merge_type is None:
3181
merge_type = _mod_merge.Merge3Merger
3182
if this_dir is None:
3184
this_tree = WorkingTree.open_containing(this_dir)[0]
3185
if show_base and not merge_type is _mod_merge.Merge3Merger:
3186
raise errors.BzrCommandError("Show-base is not supported for this merge"
3187
" type. %s" % merge_type)
3188
if reprocess and not merge_type.supports_reprocess:
3189
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3190
" type %s." % merge_type)
3191
if reprocess and show_base:
3192
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3194
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3195
pb=pb, change_reporter=change_reporter)
3196
merger.pp = ProgressPhase("Merge phase", 5, pb)
3197
merger.pp.next_phase()
3198
merger.check_basis(check_clean)
3199
merger.set_other(other_revision)
3200
merger.pp.next_phase()
3201
merger.set_base(base_revision)
3202
if merger.base_rev_id == merger.other_rev_id:
3203
note('Nothing to do.')
3205
if file_list is None:
3206
if pull and merger.base_rev_id == merger.this_rev_id:
3207
count = merger.this_tree.pull(merger.this_branch,
3208
False, merger.other_rev_id)
3209
note('%d revision(s) pulled.' % (count,))
3211
merger.backup_files = backup_files
3212
merger.merge_type = merge_type
3213
merger.set_interesting_files(file_list)
3214
merger.show_base = show_base
3215
merger.reprocess = reprocess
3216
conflicts = merger.do_merge()
3217
if file_list is None:
3218
merger.set_pending()
3225
merge = _merge_helper
3228
# these get imported and then picked up by the scan for cmd_*
3229
# TODO: Some more consistent way to split command definitions across files;
3230
# we do need to load at least some information about them to know of
3231
# aliases. ideally we would avoid loading the implementation until the
3232
# details were needed.
3233
from bzrlib.cmd_version_info import cmd_version_info
3234
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3235
from bzrlib.bundle.commands import cmd_bundle_revisions
3236
from bzrlib.sign_my_commits import cmd_sign_my_commits
3237
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3238
cmd_weave_plan_merge, cmd_weave_merge_text