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.
240
takes_args = ['location?']
242
def run(self, location='.'):
243
d = bzrdir.BzrDir.open(location)
246
working = d.open_workingtree()
247
except errors.NoWorkingTree:
248
raise errors.BzrCommandError("No working tree to remove")
249
except errors.NotLocalUrl:
250
raise errors.BzrCommandError("You cannot remove the working tree of a "
253
working_path = working.bzrdir.root_transport.base
254
branch_path = working.branch.bzrdir.root_transport.base
255
if working_path != branch_path:
256
raise errors.BzrCommandError("You cannot remove the working tree from "
257
"a lightweight checkout")
259
d.destroy_workingtree()
262
class cmd_revno(Command):
263
"""Show current revision number.
265
This is equal to the number of revisions on this branch.
268
takes_args = ['location?']
271
def run(self, location=u'.'):
272
self.outf.write(str(Branch.open_containing(location)[0].revno()))
273
self.outf.write('\n')
276
class cmd_revision_info(Command):
277
"""Show revision number and revision id for a given revision identifier.
280
takes_args = ['revision_info*']
281
takes_options = ['revision']
284
def run(self, revision=None, revision_info_list=[]):
287
if revision is not None:
288
revs.extend(revision)
289
if revision_info_list is not None:
290
for rev in revision_info_list:
291
revs.append(RevisionSpec.from_string(rev))
293
raise errors.BzrCommandError('You must supply a revision identifier')
295
b = WorkingTree.open_containing(u'.')[0].branch
298
revinfo = rev.in_history(b)
299
if revinfo.revno is None:
300
print ' %s' % revinfo.rev_id
302
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
305
class cmd_add(Command):
306
"""Add specified files or directories.
308
In non-recursive mode, all the named items are added, regardless
309
of whether they were previously ignored. A warning is given if
310
any of the named files are already versioned.
312
In recursive mode (the default), files are treated the same way
313
but the behaviour for directories is different. Directories that
314
are already versioned do not give a warning. All directories,
315
whether already versioned or not, are searched for files or
316
subdirectories that are neither versioned or ignored, and these
317
are added. This search proceeds recursively into versioned
318
directories. If no names are given '.' is assumed.
320
Therefore simply saying 'bzr add' will version all files that
321
are currently unknown.
323
Adding a file whose parent directory is not versioned will
324
implicitly add the parent, and so on up to the root. This means
325
you should never need to explicitly add a directory, they'll just
326
get added when you add a file in the directory.
328
--dry-run will show which files would be added, but not actually
331
--file-ids-from will try to use the file ids from the supplied path.
332
It looks up ids trying to find a matching parent directory with the
333
same filename, and then by pure path.
335
takes_args = ['file*']
336
takes_options = ['no-recurse', 'dry-run', 'verbose',
337
Option('file-ids-from', type=unicode,
338
help='Lookup file ids from here')]
339
encoding_type = 'replace'
341
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
345
if file_ids_from is not None:
347
base_tree, base_path = WorkingTree.open_containing(
349
except errors.NoWorkingTree:
350
base_branch, base_path = Branch.open_containing(
352
base_tree = base_branch.basis_tree()
354
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
355
to_file=self.outf, should_print=(not is_quiet()))
357
action = bzrlib.add.AddAction(to_file=self.outf,
358
should_print=(not is_quiet()))
360
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
361
action=action, save=not dry_run)
364
for glob in sorted(ignored.keys()):
365
for path in ignored[glob]:
366
self.outf.write("ignored %s matching \"%s\"\n"
370
for glob, paths in ignored.items():
371
match_len += len(paths)
372
self.outf.write("ignored %d file(s).\n" % match_len)
373
self.outf.write("If you wish to add some of these files,"
374
" please add them by name.\n")
377
class cmd_mkdir(Command):
378
"""Create a new versioned directory.
380
This is equivalent to creating the directory and then adding it.
383
takes_args = ['dir+']
384
encoding_type = 'replace'
386
def run(self, dir_list):
389
wt, dd = WorkingTree.open_containing(d)
391
self.outf.write('added %s\n' % d)
394
class cmd_relpath(Command):
395
"""Show path of a file relative to root"""
397
takes_args = ['filename']
401
def run(self, filename):
402
# TODO: jam 20050106 Can relpath return a munged path if
403
# sys.stdout encoding cannot represent it?
404
tree, relpath = WorkingTree.open_containing(filename)
405
self.outf.write(relpath)
406
self.outf.write('\n')
409
class cmd_inventory(Command):
410
"""Show inventory of the current working copy or a revision.
412
It is possible to limit the output to a particular entry
413
type using the --kind option. For example: --kind file.
415
It is also possible to restrict the list of files to a specific
416
set. For example: bzr inventory --show-ids this/file
423
takes_options = ['revision', 'show-ids', 'kind']
425
takes_args = ['file*']
428
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
429
if kind and kind not in ['file', 'directory', 'symlink']:
430
raise errors.BzrCommandError('invalid kind specified')
432
work_tree, file_list = tree_files(file_list)
434
if revision is not None:
435
if len(revision) > 1:
436
raise errors.BzrCommandError('bzr inventory --revision takes'
437
' exactly one revision identifier')
438
revision_id = revision[0].in_history(work_tree.branch).rev_id
439
tree = work_tree.branch.repository.revision_tree(revision_id)
441
# We include work_tree as well as 'tree' here
442
# So that doing '-r 10 path/foo' will lookup whatever file
443
# exists now at 'path/foo' even if it has been renamed, as
444
# well as whatever files existed in revision 10 at path/foo
445
trees = [tree, work_tree]
450
if file_list is not None:
451
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
452
require_versioned=True)
453
# find_ids_across_trees may include some paths that don't
455
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
456
for file_id in file_ids if file_id in tree)
458
entries = tree.inventory.entries()
460
for path, entry in entries:
461
if kind and kind != entry.kind:
464
self.outf.write('%-50s %s\n' % (path, entry.file_id))
466
self.outf.write(path)
467
self.outf.write('\n')
470
class cmd_mv(Command):
471
"""Move or rename a file.
474
bzr mv OLDNAME NEWNAME
475
bzr mv SOURCE... DESTINATION
477
If the last argument is a versioned directory, all the other names
478
are moved into it. Otherwise, there must be exactly two arguments
479
and the file is changed to a new name.
481
If OLDNAME does not exist on the filesystem but is versioned and
482
NEWNAME does exist on the filesystem but is not versioned, mv
483
assumes that the file has been manually moved and only updates
484
its internal inventory to reflect that change.
485
The same is valid when moving many SOURCE files to a DESTINATION.
487
Files cannot be moved between branches.
490
takes_args = ['names*']
491
takes_options = [Option("after", help="move only the bzr identifier"
492
" of the file (file has already been moved). Use this flag if"
493
" bzr is not able to detect this itself.")]
494
aliases = ['move', 'rename']
495
encoding_type = 'replace'
497
def run(self, names_list, after=False):
498
if names_list is None:
501
if len(names_list) < 2:
502
raise errors.BzrCommandError("missing file argument")
503
tree, rel_names = tree_files(names_list)
505
if os.path.isdir(names_list[-1]):
506
# move into existing directory
507
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
508
self.outf.write("%s => %s\n" % pair)
510
if len(names_list) != 2:
511
raise errors.BzrCommandError('to mv multiple files the'
512
' destination must be a versioned'
514
tree.rename_one(rel_names[0], rel_names[1], after=after)
515
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
518
class cmd_pull(Command):
519
"""Turn this branch into a mirror of another branch.
521
This command only works on branches that have not diverged. Branches are
522
considered diverged if the destination branch's most recent commit is one
523
that has not been merged (directly or indirectly) into the parent.
525
If branches have diverged, you can use 'bzr merge' to integrate the changes
526
from one into the other. Once one branch has merged, the other should
527
be able to pull it again.
529
If you want to forget your local changes and just update your branch to
530
match the remote one, use pull --overwrite.
532
If there is no default location set, the first pull will set it. After
533
that, you can omit the location to use the default. To change the
534
default, use --remember. The value will only be saved if the remote
535
location can be accessed.
538
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
540
help='branch to pull into, '
541
'rather than the one containing the working directory',
546
takes_args = ['location?']
547
encoding_type = 'replace'
549
def run(self, location=None, remember=False, overwrite=False,
550
revision=None, verbose=False,
552
# FIXME: too much stuff is in the command class
553
if directory is None:
556
tree_to = WorkingTree.open_containing(directory)[0]
557
branch_to = tree_to.branch
558
except errors.NoWorkingTree:
560
branch_to = Branch.open_containing(directory)[0]
563
if location is not None:
565
reader = bundle.read_bundle_from_url(location)
566
except errors.NotABundle:
567
pass # Continue on considering this url a Branch
569
stored_loc = branch_to.get_parent()
571
if stored_loc is None:
572
raise errors.BzrCommandError("No pull location known or"
575
display_url = urlutils.unescape_for_display(stored_loc,
577
self.outf.write("Using saved location: %s\n" % display_url)
578
location = stored_loc
580
if reader is not None:
581
install_bundle(branch_to.repository, reader)
582
branch_from = branch_to
584
branch_from = Branch.open(location)
586
if branch_to.get_parent() is None or remember:
587
branch_to.set_parent(branch_from.base)
591
if reader is not None:
592
rev_id = reader.target
593
elif len(revision) == 1:
594
rev_id = revision[0].in_history(branch_from).rev_id
596
raise errors.BzrCommandError('bzr pull --revision takes one value.')
598
old_rh = branch_to.revision_history()
599
if tree_to is not None:
600
count = tree_to.pull(branch_from, overwrite, rev_id,
601
delta.ChangeReporter(tree_to.inventory))
603
count = branch_to.pull(branch_from, overwrite, rev_id)
604
note('%d revision(s) pulled.' % (count,))
607
new_rh = branch_to.revision_history()
610
from bzrlib.log import show_changed_revisions
611
show_changed_revisions(branch_to, old_rh, new_rh,
615
class cmd_push(Command):
616
"""Update a mirror of this branch.
618
The target branch will not have its working tree populated because this
619
is both expensive, and is not supported on remote file systems.
621
Some smart servers or protocols *may* put the working tree in place in
624
This command only works on branches that have not diverged. Branches are
625
considered diverged if the destination branch's most recent commit is one
626
that has not been merged (directly or indirectly) by the source branch.
628
If branches have diverged, you can use 'bzr push --overwrite' to replace
629
the other branch completely, discarding its unmerged changes.
631
If you want to ensure you have the different changes in the other branch,
632
do a merge (see bzr help merge) from the other branch, and commit that.
633
After that you will be able to do a push without '--overwrite'.
635
If there is no default push location set, the first push will set it.
636
After that, you can omit the location to use the default. To change the
637
default, use --remember. The value will only be saved if the remote
638
location can be accessed.
641
takes_options = ['remember', 'overwrite', 'verbose',
642
Option('create-prefix',
643
help='Create the path leading up to the branch '
644
'if it does not already exist'),
646
help='branch to push from, '
647
'rather than the one containing the working directory',
651
Option('use-existing-dir',
652
help='By default push will fail if the target'
653
' directory exists, but does not already'
654
' have a control directory. This flag will'
655
' allow push to proceed.'),
657
takes_args = ['location?']
658
encoding_type = 'replace'
660
def run(self, location=None, remember=False, overwrite=False,
661
create_prefix=False, verbose=False,
662
use_existing_dir=False,
664
# FIXME: Way too big! Put this into a function called from the
666
if directory is None:
668
br_from = Branch.open_containing(directory)[0]
669
stored_loc = br_from.get_push_location()
671
if stored_loc is None:
672
raise errors.BzrCommandError("No push location known or specified.")
674
display_url = urlutils.unescape_for_display(stored_loc,
676
self.outf.write("Using saved location: %s\n" % display_url)
677
location = stored_loc
679
to_transport = transport.get_transport(location)
680
location_url = to_transport.base
685
br_to = repository_to = dir_to = None
687
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
688
except errors.NotBranchError:
689
pass # Didn't find anything
691
# If we can open a branch, use its direct repository, otherwise see
692
# if there is a repository without a branch.
694
br_to = dir_to.open_branch()
695
except errors.NotBranchError:
696
# Didn't find a branch, can we find a repository?
698
repository_to = dir_to.find_repository()
699
except errors.NoRepositoryPresent:
702
# Found a branch, so we must have found a repository
703
repository_to = br_to.repository
707
# XXX: Refactor the create_prefix/no_create_prefix code into a
708
# common helper function
710
to_transport.mkdir('.')
711
except errors.FileExists:
712
if not use_existing_dir:
713
raise errors.BzrCommandError("Target directory %s"
714
" already exists, but does not have a valid .bzr"
715
" directory. Supply --use-existing-dir to push"
716
" there anyway." % location)
717
except errors.NoSuchFile:
718
if not create_prefix:
719
raise errors.BzrCommandError("Parent directory of %s"
721
"\nYou may supply --create-prefix to create all"
722
" leading parent directories."
725
cur_transport = to_transport
726
needed = [cur_transport]
727
# Recurse upwards until we can create a directory successfully
729
new_transport = cur_transport.clone('..')
730
if new_transport.base == cur_transport.base:
731
raise errors.BzrCommandError("Failed to create path"
735
new_transport.mkdir('.')
736
except errors.NoSuchFile:
737
needed.append(new_transport)
738
cur_transport = new_transport
742
# Now we only need to create child directories
744
cur_transport = needed.pop()
745
cur_transport.mkdir('.')
747
# Now the target directory exists, but doesn't have a .bzr
748
# directory. So we need to create it, along with any work to create
749
# all of the dependent branches, etc.
750
dir_to = br_from.bzrdir.clone(location_url,
751
revision_id=br_from.last_revision())
752
br_to = dir_to.open_branch()
753
count = br_to.last_revision_info()[0]
754
# We successfully created the target, remember it
755
if br_from.get_push_location() is None or remember:
756
br_from.set_push_location(br_to.base)
757
elif repository_to is None:
758
# we have a bzrdir but no branch or repository
759
# XXX: Figure out what to do other than complain.
760
raise errors.BzrCommandError("At %s you have a valid .bzr control"
761
" directory, but not a branch or repository. This is an"
762
" unsupported configuration. Please move the target directory"
763
" out of the way and try again."
766
# We have a repository but no branch, copy the revisions, and then
768
last_revision_id = br_from.last_revision()
769
repository_to.fetch(br_from.repository,
770
revision_id=last_revision_id)
771
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
772
count = len(br_to.revision_history())
773
if br_from.get_push_location() is None or remember:
774
br_from.set_push_location(br_to.base)
775
else: # We have a valid to branch
776
# We were able to connect to the remote location, so remember it
777
# we don't need to successfully push because of possible divergence.
778
if br_from.get_push_location() is None or remember:
779
br_from.set_push_location(br_to.base)
780
old_rh = br_to.revision_history()
783
tree_to = dir_to.open_workingtree()
784
except errors.NotLocalUrl:
785
warning('This transport does not update the working '
786
'tree of: %s' % (br_to.base,))
787
count = br_from.push(br_to, overwrite)
788
except errors.NoWorkingTree:
789
count = br_from.push(br_to, overwrite)
793
count = br_from.push(tree_to.branch, overwrite)
797
except errors.DivergedBranches:
798
raise errors.BzrCommandError('These branches have diverged.'
799
' Try using "merge" and then "push".')
800
note('%d revision(s) pushed.' % (count,))
803
new_rh = br_to.revision_history()
806
from bzrlib.log import show_changed_revisions
807
show_changed_revisions(br_to, old_rh, new_rh,
811
class cmd_branch(Command):
812
"""Create a new copy of a branch.
814
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
815
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
817
To retrieve the branch as of a particular revision, supply the --revision
818
parameter, as in "branch foo/bar -r 5".
820
--basis is to speed up branching from remote branches. When specified, it
821
copies all the file-contents, inventory and revision data from the basis
822
branch before copying anything from the remote branch.
824
takes_args = ['from_location', 'to_location?']
825
takes_options = ['revision', 'basis']
826
aliases = ['get', 'clone']
828
def run(self, from_location, to_location=None, revision=None, basis=None):
831
elif len(revision) > 1:
832
raise errors.BzrCommandError(
833
'bzr branch --revision takes exactly 1 revision value')
835
br_from = Branch.open(from_location)
838
if basis is not None:
839
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
842
if len(revision) == 1 and revision[0] is not None:
843
revision_id = revision[0].in_history(br_from)[1]
845
# FIXME - wt.last_revision, fallback to branch, fall back to
846
# None or perhaps NULL_REVISION to mean copy nothing
848
revision_id = br_from.last_revision()
849
if to_location is None:
850
to_location = os.path.basename(from_location.rstrip("/\\"))
853
name = os.path.basename(to_location) + '\n'
855
to_transport = transport.get_transport(to_location)
857
to_transport.mkdir('.')
858
except errors.FileExists:
859
raise errors.BzrCommandError('Target directory "%s" already'
860
' exists.' % to_location)
861
except errors.NoSuchFile:
862
raise errors.BzrCommandError('Parent of "%s" does not exist.'
865
# preserve whatever source format we have.
866
dir = br_from.bzrdir.sprout(to_transport.base,
867
revision_id, basis_dir)
868
branch = dir.open_branch()
869
except errors.NoSuchRevision:
870
to_transport.delete_tree('.')
871
msg = "The branch %s has no revision %s." % (from_location, revision[0])
872
raise errors.BzrCommandError(msg)
873
except errors.UnlistableBranch:
874
osutils.rmtree(to_location)
875
msg = "The branch %s cannot be used as a --basis" % (basis,)
876
raise errors.BzrCommandError(msg)
878
branch.control_files.put_utf8('branch-name', name)
879
note('Branched %d revision(s).' % branch.revno())
884
class cmd_checkout(Command):
885
"""Create a new checkout of an existing branch.
887
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
888
the branch found in '.'. This is useful if you have removed the working tree
889
or if it was never created - i.e. if you pushed the branch to its current
892
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
893
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
895
To retrieve the branch as of a particular revision, supply the --revision
896
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
897
out of date [so you cannot commit] but it may be useful (i.e. to examine old
900
--basis is to speed up checking out from remote branches. When specified, it
901
uses the inventory and file contents from the basis branch in preference to the
902
branch being checked out.
904
See "help checkouts" for more information on checkouts.
906
takes_args = ['branch_location?', 'to_location?']
907
takes_options = ['revision', # , 'basis']
908
Option('lightweight',
909
help="perform a lightweight checkout. Lightweight "
910
"checkouts depend on access to the branch for "
911
"every operation. Normal checkouts can perform "
912
"common operations like diff and status without "
913
"such access, and also support local commits."
918
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
922
elif len(revision) > 1:
923
raise errors.BzrCommandError(
924
'bzr checkout --revision takes exactly 1 revision value')
925
if branch_location is None:
926
branch_location = osutils.getcwd()
927
to_location = branch_location
928
source = Branch.open(branch_location)
929
if len(revision) == 1 and revision[0] is not None:
930
revision_id = revision[0].in_history(source)[1]
933
if to_location is None:
934
to_location = os.path.basename(branch_location.rstrip("/\\"))
935
# if the source and to_location are the same,
936
# and there is no working tree,
937
# then reconstitute a branch
938
if (osutils.abspath(to_location) ==
939
osutils.abspath(branch_location)):
941
source.bzrdir.open_workingtree()
942
except errors.NoWorkingTree:
943
source.bzrdir.create_workingtree()
946
os.mkdir(to_location)
948
if e.errno == errno.EEXIST:
949
raise errors.BzrCommandError('Target directory "%s" already'
950
' exists.' % to_location)
951
if e.errno == errno.ENOENT:
952
raise errors.BzrCommandError('Parent of "%s" does not exist.'
956
source.create_checkout(to_location, revision_id, lightweight)
959
class cmd_renames(Command):
960
"""Show list of renamed files.
962
# TODO: Option to show renames between two historical versions.
964
# TODO: Only show renames under dir, rather than in the whole branch.
965
takes_args = ['dir?']
968
def run(self, dir=u'.'):
969
tree = WorkingTree.open_containing(dir)[0]
970
old_inv = tree.basis_tree().inventory
971
new_inv = tree.read_working_inventory()
972
renames = list(_mod_tree.find_renames(old_inv, new_inv))
974
for old_name, new_name in renames:
975
self.outf.write("%s => %s\n" % (old_name, new_name))
978
class cmd_update(Command):
979
"""Update a tree to have the latest code committed to its branch.
981
This will perform a merge into the working tree, and may generate
982
conflicts. If you have any local changes, you will still
983
need to commit them after the update for the update to be complete.
985
If you want to discard your local changes, you can just do a
986
'bzr revert' instead of 'bzr commit' after the update.
988
takes_args = ['dir?']
991
def run(self, dir='.'):
992
tree = WorkingTree.open_containing(dir)[0]
993
master = tree.branch.get_master_branch()
994
if master is not None:
997
tree.lock_tree_write()
999
existing_pending_merges = tree.get_parent_ids()[1:]
1000
last_rev = tree.last_revision()
1001
if last_rev == tree.branch.last_revision():
1002
# may be up to date, check master too.
1003
master = tree.branch.get_master_branch()
1004
if master is None or last_rev == master.last_revision():
1005
revno = tree.branch.revision_id_to_revno(last_rev)
1006
note("Tree is up to date at revision %d." % (revno,))
1008
conflicts = tree.update()
1009
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1010
note('Updated to revision %d.' % (revno,))
1011
if tree.get_parent_ids()[1:] != existing_pending_merges:
1012
note('Your local commits will now show as pending merges with '
1013
"'bzr status', and can be committed with 'bzr commit'.")
1022
class cmd_info(Command):
1023
"""Show information about a working tree, branch or repository.
1025
This command will show all known locations and formats associated to the
1026
tree, branch or repository. Statistical information is included with
1029
Branches and working trees will also report any missing revisions.
1031
takes_args = ['location?']
1032
takes_options = ['verbose']
1035
def run(self, location=None, verbose=False):
1036
from bzrlib.info import show_bzrdir_info
1037
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1041
class cmd_remove(Command):
1042
"""Make a file unversioned.
1044
This makes bzr stop tracking changes to a versioned file. It does
1045
not delete the working copy.
1047
You can specify one or more files, and/or --new. If you specify --new,
1048
only 'added' files will be removed. If you specify both, then new files
1049
in the specified directories will be removed. If the directories are
1050
also new, they will also be removed.
1052
takes_args = ['file*']
1053
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1055
encoding_type = 'replace'
1057
def run(self, file_list, verbose=False, new=False):
1058
tree, file_list = tree_files(file_list)
1060
if file_list is None:
1061
raise errors.BzrCommandError('Specify one or more files to'
1062
' remove, or use --new.')
1064
added = tree.changes_from(tree.basis_tree(),
1065
specific_files=file_list).added
1066
file_list = sorted([f[0] for f in added], reverse=True)
1067
if len(file_list) == 0:
1068
raise errors.BzrCommandError('No matching files.')
1069
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1072
class cmd_file_id(Command):
1073
"""Print file_id of a particular file or directory.
1075
The file_id is assigned when the file is first added and remains the
1076
same through all revisions where the file exists, even when it is
1081
takes_args = ['filename']
1084
def run(self, filename):
1085
tree, relpath = WorkingTree.open_containing(filename)
1086
i = tree.inventory.path2id(relpath)
1088
raise errors.NotVersionedError(filename)
1090
self.outf.write(i + '\n')
1093
class cmd_file_path(Command):
1094
"""Print path of file_ids to a file or directory.
1096
This prints one line for each directory down to the target,
1097
starting at the branch root.
1101
takes_args = ['filename']
1104
def run(self, filename):
1105
tree, relpath = WorkingTree.open_containing(filename)
1106
inv = tree.inventory
1107
fid = inv.path2id(relpath)
1109
raise errors.NotVersionedError(filename)
1110
for fip in inv.get_idpath(fid):
1111
self.outf.write(fip + '\n')
1114
class cmd_reconcile(Command):
1115
"""Reconcile bzr metadata in a branch.
1117
This can correct data mismatches that may have been caused by
1118
previous ghost operations or bzr upgrades. You should only
1119
need to run this command if 'bzr check' or a bzr developer
1120
advises you to run it.
1122
If a second branch is provided, cross-branch reconciliation is
1123
also attempted, which will check that data like the tree root
1124
id which was not present in very early bzr versions is represented
1125
correctly in both branches.
1127
At the same time it is run it may recompress data resulting in
1128
a potential saving in disk space or performance gain.
1130
The branch *MUST* be on a listable system such as local disk or sftp.
1132
takes_args = ['branch?']
1134
def run(self, branch="."):
1135
from bzrlib.reconcile import reconcile
1136
dir = bzrdir.BzrDir.open(branch)
1140
class cmd_revision_history(Command):
1141
"""Display the list of revision ids on a branch."""
1142
takes_args = ['location?']
1147
def run(self, location="."):
1148
branch = Branch.open_containing(location)[0]
1149
for revid in branch.revision_history():
1150
self.outf.write(revid)
1151
self.outf.write('\n')
1154
class cmd_ancestry(Command):
1155
"""List all revisions merged into this branch."""
1156
takes_args = ['location?']
1161
def run(self, location="."):
1163
wt = WorkingTree.open_containing(location)[0]
1164
except errors.NoWorkingTree:
1165
b = Branch.open(location)
1166
last_revision = b.last_revision()
1169
last_revision = wt.last_revision()
1171
revision_ids = b.repository.get_ancestry(last_revision)
1172
assert revision_ids[0] is None
1174
for revision_id in revision_ids:
1175
self.outf.write(revision_id + '\n')
1178
class cmd_init(Command):
1179
"""Make a directory into a versioned branch.
1181
Use this to create an empty branch, or before importing an
1184
If there is a repository in a parent directory of the location, then
1185
the history of the branch will be stored in the repository. Otherwise
1186
init creates a standalone branch which carries its own history in
1189
If there is already a branch at the location but it has no working tree,
1190
the tree can be populated with 'bzr checkout'.
1192
Recipe for importing a tree of files:
1197
bzr commit -m 'imported project'
1199
takes_args = ['location?']
1201
RegistryOption('format',
1202
help='Specify a format for this branch. '
1203
'See "help formats".',
1204
registry=bzrdir.format_registry,
1205
converter=bzrdir.format_registry.make_bzrdir,
1206
value_switches=True,
1207
title="Branch Format",
1209
Option('append-revisions-only',
1210
help='Never change revnos or the existing log.'
1211
' Append revisions to it only.')
1213
def run(self, location=None, format=None, append_revisions_only=False):
1215
format = bzrdir.format_registry.make_bzrdir('default')
1216
if location is None:
1219
to_transport = transport.get_transport(location)
1221
# The path has to exist to initialize a
1222
# branch inside of it.
1223
# Just using os.mkdir, since I don't
1224
# believe that we want to create a bunch of
1225
# locations if the user supplies an extended path
1226
# TODO: create-prefix
1228
to_transport.mkdir('.')
1229
except errors.FileExists:
1233
existing_bzrdir = bzrdir.BzrDir.open(location)
1234
except errors.NotBranchError:
1235
# really a NotBzrDir error...
1236
branch = bzrdir.BzrDir.create_branch_convenience(location,
1239
from bzrlib.transport.local import LocalTransport
1240
if existing_bzrdir.has_branch():
1241
if (isinstance(to_transport, LocalTransport)
1242
and not existing_bzrdir.has_workingtree()):
1243
raise errors.BranchExistsWithoutWorkingTree(location)
1244
raise errors.AlreadyBranchError(location)
1246
branch = existing_bzrdir.create_branch()
1247
existing_bzrdir.create_workingtree()
1248
if append_revisions_only:
1250
branch.set_append_revisions_only(True)
1251
except errors.UpgradeRequired:
1252
raise errors.BzrCommandError('This branch format cannot be set'
1253
' to append-revisions-only. Try --experimental-branch6')
1256
class cmd_init_repository(Command):
1257
"""Create a shared repository to hold branches.
1259
New branches created under the repository directory will store their revisions
1260
in the repository, not in the branch directory, if the branch format supports
1266
bzr checkout --lightweight repo/trunk trunk-checkout
1270
takes_args = ["location"]
1271
takes_options = [RegistryOption('format',
1272
help='Specify a format for this repository. See'
1273
' "bzr help formats" for details',
1274
registry=bzrdir.format_registry,
1275
converter=bzrdir.format_registry.make_bzrdir,
1276
value_switches=True, title='Repository format'),
1278
help='Allows branches in repository to have'
1280
aliases = ["init-repo"]
1281
def run(self, location, format=None, trees=False):
1283
format = bzrdir.format_registry.make_bzrdir('default')
1285
if location is None:
1288
to_transport = transport.get_transport(location)
1290
to_transport.mkdir('.')
1291
except errors.FileExists:
1294
newdir = format.initialize_on_transport(to_transport)
1295
repo = newdir.create_repository(shared=True)
1296
repo.set_make_working_trees(trees)
1299
class cmd_diff(Command):
1300
"""Show differences in the working tree or between revisions.
1302
If files are listed, only the changes in those files are listed.
1303
Otherwise, all changes for the tree are listed.
1305
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1306
produces patches suitable for "patch -p1".
1310
Shows the difference in the working tree versus the last commit
1312
Difference between the working tree and revision 1
1314
Difference between revision 2 and revision 1
1315
bzr diff --diff-prefix old/:new/
1316
Same as 'bzr diff' but prefix paths with old/ and new/
1317
bzr diff bzr.mine bzr.dev
1318
Show the differences between the two working trees
1320
Show just the differences for 'foo.c'
1322
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1323
# or a graphical diff.
1325
# TODO: Python difflib is not exactly the same as unidiff; should
1326
# either fix it up or prefer to use an external diff.
1328
# TODO: Selected-file diff is inefficient and doesn't show you
1331
# TODO: This probably handles non-Unix newlines poorly.
1333
takes_args = ['file*']
1334
takes_options = ['revision', 'diff-options',
1335
Option('prefix', type=str,
1337
help='Set prefixes to added to old and new filenames, as '
1338
'two values separated by a colon.'),
1340
aliases = ['di', 'dif']
1341
encoding_type = 'exact'
1344
def run(self, revision=None, file_list=None, diff_options=None,
1346
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1348
if (prefix is None) or (prefix == '0'):
1356
old_label, new_label = prefix.split(":")
1358
raise BzrCommandError(
1359
"--prefix expects two values separated by a colon")
1361
if revision and len(revision) > 2:
1362
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1363
' one or two revision specifiers')
1366
tree1, file_list = internal_tree_files(file_list)
1370
except errors.FileInWrongBranch:
1371
if len(file_list) != 2:
1372
raise errors.BzrCommandError("Files are in different branches")
1374
tree1, file1 = WorkingTree.open_containing(file_list[0])
1375
tree2, file2 = WorkingTree.open_containing(file_list[1])
1376
if file1 != "" or file2 != "":
1377
# FIXME diff those two files. rbc 20051123
1378
raise errors.BzrCommandError("Files are in different branches")
1380
except errors.NotBranchError:
1381
if (revision is not None and len(revision) == 2
1382
and not revision[0].needs_branch()
1383
and not revision[1].needs_branch()):
1384
# If both revision specs include a branch, we can
1385
# diff them without needing a local working tree
1386
tree1, tree2 = None, None
1390
if tree2 is not None:
1391
if revision is not None:
1392
# FIXME: but there should be a clean way to diff between
1393
# non-default versions of two trees, it's not hard to do
1395
raise errors.BzrCommandError(
1396
"Sorry, diffing arbitrary revisions across branches "
1397
"is not implemented yet")
1398
return show_diff_trees(tree1, tree2, sys.stdout,
1399
specific_files=file_list,
1400
external_diff_options=diff_options,
1401
old_label=old_label, new_label=new_label)
1403
return diff_cmd_helper(tree1, file_list, diff_options,
1404
revision_specs=revision,
1405
old_label=old_label, new_label=new_label)
1408
class cmd_deleted(Command):
1409
"""List files deleted in the working tree.
1411
# TODO: Show files deleted since a previous revision, or
1412
# between two revisions.
1413
# TODO: Much more efficient way to do this: read in new
1414
# directories with readdir, rather than stating each one. Same
1415
# level of effort but possibly much less IO. (Or possibly not,
1416
# if the directories are very large...)
1417
takes_options = ['show-ids']
1420
def run(self, show_ids=False):
1421
tree = WorkingTree.open_containing(u'.')[0]
1422
old = tree.basis_tree()
1423
for path, ie in old.inventory.iter_entries():
1424
if not tree.has_id(ie.file_id):
1425
self.outf.write(path)
1427
self.outf.write(' ')
1428
self.outf.write(ie.file_id)
1429
self.outf.write('\n')
1432
class cmd_modified(Command):
1433
"""List files modified in working tree.
1435
See also: "bzr status".
1442
tree = WorkingTree.open_containing(u'.')[0]
1443
td = tree.changes_from(tree.basis_tree())
1444
for path, id, kind, text_modified, meta_modified in td.modified:
1445
self.outf.write(path + '\n')
1448
class cmd_added(Command):
1449
"""List files added in working tree.
1451
See also: "bzr status".
1458
wt = WorkingTree.open_containing(u'.')[0]
1459
basis_inv = wt.basis_tree().inventory
1462
if file_id in basis_inv:
1464
if inv.is_root(file_id) and len(basis_inv) == 0:
1466
path = inv.id2path(file_id)
1467
if not os.access(osutils.abspath(path), os.F_OK):
1469
self.outf.write(path + '\n')
1472
class cmd_root(Command):
1473
"""Show the tree root directory.
1475
The root is the nearest enclosing directory with a .bzr control
1477
takes_args = ['filename?']
1479
def run(self, filename=None):
1480
"""Print the branch root."""
1481
tree = WorkingTree.open_containing(filename)[0]
1482
self.outf.write(tree.basedir + '\n')
1485
class cmd_log(Command):
1486
"""Show log of a branch, file, or directory.
1488
By default show the log of the branch containing the working directory.
1490
To request a range of logs, you can use the command -r begin..end
1491
-r revision requests a specific revision, -r ..end or -r begin.. are
1497
bzr log -r -10.. http://server/branch
1500
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1502
takes_args = ['location?']
1503
takes_options = [Option('forward',
1504
help='show from oldest to newest'),
1508
help='show files changed in each revision'),
1509
'show-ids', 'revision',
1513
help='show revisions whose message matches this regexp',
1516
encoding_type = 'replace'
1519
def run(self, location=None, timezone='original',
1526
from bzrlib.log import show_log
1527
assert message is None or isinstance(message, basestring), \
1528
"invalid message argument %r" % message
1529
direction = (forward and 'forward') or 'reverse'
1534
# find the file id to log:
1536
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1540
tree = b.basis_tree()
1541
inv = tree.inventory
1542
file_id = inv.path2id(fp)
1544
raise errors.BzrCommandError(
1545
"Path does not have any revision history: %s" %
1549
# FIXME ? log the current subdir only RBC 20060203
1550
if revision is not None \
1551
and len(revision) > 0 and revision[0].get_branch():
1552
location = revision[0].get_branch()
1555
dir, relpath = bzrdir.BzrDir.open_containing(location)
1556
b = dir.open_branch()
1560
if revision is None:
1563
elif len(revision) == 1:
1564
rev1 = rev2 = revision[0].in_history(b).revno
1565
elif len(revision) == 2:
1566
if revision[1].get_branch() != revision[0].get_branch():
1567
# b is taken from revision[0].get_branch(), and
1568
# show_log will use its revision_history. Having
1569
# different branches will lead to weird behaviors.
1570
raise errors.BzrCommandError(
1571
"Log doesn't accept two revisions in different"
1573
if revision[0].spec is None:
1574
# missing begin-range means first revision
1577
rev1 = revision[0].in_history(b).revno
1579
if revision[1].spec is None:
1580
# missing end-range means last known revision
1583
rev2 = revision[1].in_history(b).revno
1585
raise errors.BzrCommandError(
1586
'bzr log --revision takes one or two values.')
1588
# By this point, the revision numbers are converted to the +ve
1589
# form if they were supplied in the -ve form, so we can do
1590
# this comparison in relative safety
1592
(rev2, rev1) = (rev1, rev2)
1594
if log_format is None:
1595
log_format = log.log_formatter_registry.get_default(b)
1597
lf = log_format(show_ids=show_ids, to_file=self.outf,
1598
show_timezone=timezone)
1604
direction=direction,
1605
start_revision=rev1,
1612
def get_log_format(long=False, short=False, line=False, default='long'):
1613
log_format = default
1617
log_format = 'short'
1623
class cmd_touching_revisions(Command):
1624
"""Return revision-ids which affected a particular file.
1626
A more user-friendly interface is "bzr log FILE".
1630
takes_args = ["filename"]
1633
def run(self, filename):
1634
tree, relpath = WorkingTree.open_containing(filename)
1636
inv = tree.read_working_inventory()
1637
file_id = inv.path2id(relpath)
1638
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1639
self.outf.write("%6d %s\n" % (revno, what))
1642
class cmd_ls(Command):
1643
"""List files in a tree.
1646
takes_args = ['path?']
1647
# TODO: Take a revision or remote path and list that tree instead.
1648
takes_options = ['verbose', 'revision',
1649
Option('non-recursive',
1650
help='don\'t recurse into sub-directories'),
1652
help='Print all paths from the root of the branch.'),
1653
Option('unknown', help='Print unknown files'),
1654
Option('versioned', help='Print versioned files'),
1655
Option('ignored', help='Print ignored files'),
1657
Option('null', help='Null separate the files'),
1661
def run(self, revision=None, verbose=False,
1662
non_recursive=False, from_root=False,
1663
unknown=False, versioned=False, ignored=False,
1664
null=False, kind=None, show_ids=False, path=None):
1666
if kind and kind not in ('file', 'directory', 'symlink'):
1667
raise errors.BzrCommandError('invalid kind specified')
1669
if verbose and null:
1670
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1671
all = not (unknown or versioned or ignored)
1673
selection = {'I':ignored, '?':unknown, 'V':versioned}
1680
raise errors.BzrCommandError('cannot specify both --from-root'
1684
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1690
if revision is not None:
1691
tree = branch.repository.revision_tree(
1692
revision[0].in_history(branch).rev_id)
1694
tree = branch.basis_tree()
1696
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1697
if fp.startswith(relpath):
1698
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1699
if non_recursive and '/' in fp:
1701
if not all and not selection[fc]:
1703
if kind is not None and fkind != kind:
1706
kindch = entry.kind_character()
1707
outstring = '%-8s %s%s' % (fc, fp, kindch)
1708
if show_ids and fid is not None:
1709
outstring = "%-50s %s" % (outstring, fid)
1710
self.outf.write(outstring + '\n')
1712
self.outf.write(fp + '\0')
1715
self.outf.write(fid)
1716
self.outf.write('\0')
1724
self.outf.write('%-50s %s\n' % (fp, my_id))
1726
self.outf.write(fp + '\n')
1729
class cmd_unknowns(Command):
1730
"""List unknown files.
1732
See also: "bzr ls --unknown".
1739
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1740
self.outf.write(osutils.quotefn(f) + '\n')
1743
class cmd_ignore(Command):
1744
"""Ignore specified files or patterns.
1746
To remove patterns from the ignore list, edit the .bzrignore file.
1748
Trailing slashes on patterns are ignored.
1749
If the pattern contains a slash or is a regular expression, it is compared
1750
to the whole path from the branch root. Otherwise, it is compared to only
1751
the last component of the path. To match a file only in the root
1752
directory, prepend './'.
1754
Ignore patterns specifying absolute paths are not allowed.
1756
Ignore patterns may include globbing wildcards such as:
1757
? - Matches any single character except '/'
1758
* - Matches 0 or more characters except '/'
1759
/**/ - Matches 0 or more directories in a path
1760
[a-z] - Matches a single character from within a group of characters
1762
Ignore patterns may also be Python regular expressions.
1763
Regular expression ignore patterns are identified by a 'RE:' prefix
1764
followed by the regular expression. Regular expression ignore patterns
1765
may not include named or numbered groups.
1767
Note: ignore patterns containing shell wildcards must be quoted from
1771
bzr ignore ./Makefile
1772
bzr ignore '*.class'
1773
bzr ignore 'lib/**/*.o'
1774
bzr ignore 'RE:lib/.*\.o'
1776
takes_args = ['name_pattern*']
1778
Option('old-default-rules',
1779
help='Out the ignore rules bzr < 0.9 always used.')
1782
def run(self, name_pattern_list=None, old_default_rules=None):
1783
from bzrlib.atomicfile import AtomicFile
1784
if old_default_rules is not None:
1785
# dump the rules and exit
1786
for pattern in ignores.OLD_DEFAULTS:
1789
if not name_pattern_list:
1790
raise errors.BzrCommandError("ignore requires at least one "
1791
"NAME_PATTERN or --old-default-rules")
1792
for name_pattern in name_pattern_list:
1793
if name_pattern[0] == '/':
1794
raise errors.BzrCommandError(
1795
"NAME_PATTERN should not be an absolute path")
1796
tree, relpath = WorkingTree.open_containing(u'.')
1797
ifn = tree.abspath('.bzrignore')
1798
if os.path.exists(ifn):
1801
igns = f.read().decode('utf-8')
1807
# TODO: If the file already uses crlf-style termination, maybe
1808
# we should use that for the newly added lines?
1810
if igns and igns[-1] != '\n':
1812
for name_pattern in name_pattern_list:
1813
igns += name_pattern.rstrip('/') + '\n'
1815
f = AtomicFile(ifn, 'wb')
1817
f.write(igns.encode('utf-8'))
1822
inv = tree.inventory
1823
if inv.path2id('.bzrignore'):
1824
mutter('.bzrignore is already versioned')
1826
mutter('need to make new .bzrignore file versioned')
1827
tree.add(['.bzrignore'])
1830
class cmd_ignored(Command):
1831
"""List ignored files and the patterns that matched them.
1833
See also: bzr ignore"""
1836
tree = WorkingTree.open_containing(u'.')[0]
1837
for path, file_class, kind, file_id, entry in tree.list_files():
1838
if file_class != 'I':
1840
## XXX: Slightly inefficient since this was already calculated
1841
pat = tree.is_ignored(path)
1842
print '%-50s %s' % (path, pat)
1845
class cmd_lookup_revision(Command):
1846
"""Lookup the revision-id from a revision-number
1849
bzr lookup-revision 33
1852
takes_args = ['revno']
1855
def run(self, revno):
1859
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1861
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1864
class cmd_export(Command):
1865
"""Export past revision to destination directory.
1867
If no revision is specified this exports the last committed revision.
1869
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1870
given, try to find the format with the extension. If no extension
1871
is found exports to a directory (equivalent to --format=dir).
1873
Root may be the top directory for tar, tgz and tbz2 formats. If none
1874
is given, the top directory will be the root name of the file.
1876
If branch is omitted then the branch containing the CWD will be used.
1878
Note: export of tree with non-ascii filenames to zip is not supported.
1880
Supported formats Autodetected by extension
1881
----------------- -------------------------
1884
tbz2 .tar.bz2, .tbz2
1888
takes_args = ['dest', 'branch?']
1889
takes_options = ['revision', 'format', 'root']
1890
def run(self, dest, branch=None, revision=None, format=None, root=None):
1891
from bzrlib.export import export
1894
tree = WorkingTree.open_containing(u'.')[0]
1897
b = Branch.open(branch)
1899
if revision is None:
1900
# should be tree.last_revision FIXME
1901
rev_id = b.last_revision()
1903
if len(revision) != 1:
1904
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1905
rev_id = revision[0].in_history(b).rev_id
1906
t = b.repository.revision_tree(rev_id)
1908
export(t, dest, format, root)
1909
except errors.NoSuchExportFormat, e:
1910
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1913
class cmd_cat(Command):
1914
"""Write a file's text from a previous revision."""
1916
takes_options = ['revision', 'name-from-revision']
1917
takes_args = ['filename']
1918
encoding_type = 'exact'
1921
def run(self, filename, revision=None, name_from_revision=False):
1922
if revision is not None and len(revision) != 1:
1923
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1928
tree, relpath = WorkingTree.open_containing(filename)
1930
except (errors.NotBranchError, errors.NotLocalUrl):
1933
if revision is not None and revision[0].get_branch() is not None:
1934
b = Branch.open(revision[0].get_branch())
1936
b, relpath = Branch.open_containing(filename)
1937
tree = b.basis_tree()
1938
if revision is None:
1939
revision_id = b.last_revision()
1941
revision_id = revision[0].in_history(b).rev_id
1943
cur_file_id = tree.path2id(relpath)
1944
rev_tree = b.repository.revision_tree(revision_id)
1945
old_file_id = rev_tree.path2id(relpath)
1947
if name_from_revision:
1948
if old_file_id is None:
1949
raise errors.BzrCommandError("%r is not present in revision %s"
1950
% (filename, revision_id))
1952
rev_tree.print_file(old_file_id)
1953
elif cur_file_id is not None:
1954
rev_tree.print_file(cur_file_id)
1955
elif old_file_id is not None:
1956
rev_tree.print_file(old_file_id)
1958
raise errors.BzrCommandError("%r is not present in revision %s" %
1959
(filename, revision_id))
1962
class cmd_local_time_offset(Command):
1963
"""Show the offset in seconds from GMT to local time."""
1967
print osutils.local_time_offset()
1971
class cmd_commit(Command):
1972
"""Commit changes into a new revision.
1974
If no arguments are given, the entire tree is committed.
1976
If selected files are specified, only changes to those files are
1977
committed. If a directory is specified then the directory and everything
1978
within it is committed.
1980
A selected-file commit may fail in some cases where the committed
1981
tree would be invalid, such as trying to commit a file in a
1982
newly-added directory that is not itself committed.
1984
# TODO: Run hooks on tree to-be-committed, and after commit.
1986
# TODO: Strict commit that fails if there are deleted files.
1987
# (what does "deleted files" mean ??)
1989
# TODO: Give better message for -s, --summary, used by tla people
1991
# XXX: verbose currently does nothing
1993
takes_args = ['selected*']
1994
takes_options = ['message', 'verbose',
1996
help='commit even if nothing has changed'),
1997
Option('file', type=str,
2000
help='file containing commit message'),
2002
help="refuse to commit if there are unknown "
2003
"files in the working tree."),
2005
help="perform a local only commit in a bound "
2006
"branch. Such commits are not pushed to "
2007
"the master branch until a normal commit "
2011
aliases = ['ci', 'checkin']
2013
def run(self, message=None, file=None, verbose=True, selected_list=None,
2014
unchanged=False, strict=False, local=False):
2015
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2016
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2018
from bzrlib.msgeditor import edit_commit_message, \
2019
make_commit_message_template
2021
# TODO: Need a blackbox test for invoking the external editor; may be
2022
# slightly problematic to run this cross-platform.
2024
# TODO: do more checks that the commit will succeed before
2025
# spending the user's valuable time typing a commit message.
2026
tree, selected_list = tree_files(selected_list)
2027
if selected_list == ['']:
2028
# workaround - commit of root of tree should be exactly the same
2029
# as just default commit in that tree, and succeed even though
2030
# selected-file merge commit is not done yet
2033
if local and not tree.branch.get_bound_location():
2034
raise errors.LocalRequiresBoundBranch()
2036
def get_message(commit_obj):
2037
"""Callback to get commit message"""
2038
my_message = message
2039
if my_message is None and not file:
2040
template = make_commit_message_template(tree, selected_list)
2041
my_message = edit_commit_message(template)
2042
if my_message is None:
2043
raise errors.BzrCommandError("please specify a commit"
2044
" message with either --message or --file")
2045
elif my_message and file:
2046
raise errors.BzrCommandError(
2047
"please specify either --message or --file")
2049
my_message = codecs.open(file, 'rt',
2050
bzrlib.user_encoding).read()
2051
if my_message == "":
2052
raise errors.BzrCommandError("empty commit message specified")
2056
reporter = ReportCommitToLog()
2058
reporter = NullCommitReporter()
2061
tree.commit(message_callback=get_message,
2062
specific_files=selected_list,
2063
allow_pointless=unchanged, strict=strict, local=local,
2065
except PointlessCommit:
2066
# FIXME: This should really happen before the file is read in;
2067
# perhaps prepare the commit; get the message; then actually commit
2068
raise errors.BzrCommandError("no changes to commit."
2069
" use --unchanged to commit anyhow")
2070
except ConflictsInTree:
2071
raise errors.BzrCommandError('Conflicts detected in working '
2072
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2074
except StrictCommitFailed:
2075
raise errors.BzrCommandError("Commit refused because there are"
2076
" unknown files in the working tree.")
2077
except errors.BoundBranchOutOfDate, e:
2078
raise errors.BzrCommandError(str(e) + "\n"
2079
'To commit to master branch, run update and then commit.\n'
2080
'You can also pass --local to commit to continue working '
2084
class cmd_check(Command):
2085
"""Validate consistency of branch history.
2087
This command checks various invariants about the branch storage to
2088
detect data corruption or bzr bugs.
2090
takes_args = ['branch?']
2091
takes_options = ['verbose']
2093
def run(self, branch=None, verbose=False):
2094
from bzrlib.check import check
2096
tree = WorkingTree.open_containing()[0]
2097
branch = tree.branch
2099
branch = Branch.open(branch)
2100
check(branch, verbose)
2103
class cmd_upgrade(Command):
2104
"""Upgrade branch storage to current format.
2106
The check command or bzr developers may sometimes advise you to run
2107
this command. When the default format has changed you may also be warned
2108
during other operations to upgrade.
2110
takes_args = ['url?']
2112
RegistryOption('format',
2113
help='Upgrade to a specific format. See "bzr help'
2114
' formats" for details',
2115
registry=bzrdir.format_registry,
2116
converter=bzrdir.format_registry.make_bzrdir,
2117
value_switches=True, title='Branch format'),
2121
def run(self, url='.', format=None):
2122
from bzrlib.upgrade import upgrade
2124
format = bzrdir.format_registry.make_bzrdir('default')
2125
upgrade(url, format)
2128
class cmd_whoami(Command):
2129
"""Show or set bzr user id.
2133
bzr whoami 'Frank Chu <fchu@example.com>'
2135
takes_options = [ Option('email',
2136
help='display email address only'),
2138
help='set identity for the current branch instead of '
2141
takes_args = ['name?']
2142
encoding_type = 'replace'
2145
def run(self, email=False, branch=False, name=None):
2147
# use branch if we're inside one; otherwise global config
2149
c = Branch.open_containing('.')[0].get_config()
2150
except errors.NotBranchError:
2151
c = config.GlobalConfig()
2153
self.outf.write(c.user_email() + '\n')
2155
self.outf.write(c.username() + '\n')
2158
# display a warning if an email address isn't included in the given name.
2160
config.extract_email_address(name)
2161
except errors.NoEmailInUsername, e:
2162
warning('"%s" does not seem to contain an email address. '
2163
'This is allowed, but not recommended.', name)
2165
# use global config unless --branch given
2167
c = Branch.open_containing('.')[0].get_config()
2169
c = config.GlobalConfig()
2170
c.set_user_option('email', name)
2173
class cmd_nick(Command):
2174
"""Print or set the branch nickname.
2176
If unset, the tree root directory name is used as the nickname
2177
To print the current nickname, execute with no argument.
2179
takes_args = ['nickname?']
2180
def run(self, nickname=None):
2181
branch = Branch.open_containing(u'.')[0]
2182
if nickname is None:
2183
self.printme(branch)
2185
branch.nick = nickname
2188
def printme(self, branch):
2192
class cmd_selftest(Command):
2193
"""Run internal test suite.
2195
This creates temporary test directories in the working directory, but not
2196
existing data is affected. These directories are deleted if the tests
2197
pass, or left behind to help in debugging if they fail and --keep-output
2200
If arguments are given, they are regular expressions that say which tests
2201
should run. Tests matching any expression are run, and other tests are
2204
Alternatively if --first is given, matching tests are run first and then
2205
all other tests are run. This is useful if you have been working in a
2206
particular area, but want to make sure nothing else was broken.
2208
If the global option '--no-plugins' is given, plugins are not loaded
2209
before running the selftests. This has two effects: features provided or
2210
modified by plugins will not be tested, and tests provided by plugins will
2215
run only tests relating to 'ignore'
2216
bzr --no-plugins selftest -v
2217
disable plugins and list tests as they're run
2219
# TODO: --list should give a list of all available tests
2221
# NB: this is used from the class without creating an instance, which is
2222
# why it does not have a self parameter.
2223
def get_transport_type(typestring):
2224
"""Parse and return a transport specifier."""
2225
if typestring == "sftp":
2226
from bzrlib.transport.sftp import SFTPAbsoluteServer
2227
return SFTPAbsoluteServer
2228
if typestring == "memory":
2229
from bzrlib.transport.memory import MemoryServer
2231
if typestring == "fakenfs":
2232
from bzrlib.transport.fakenfs import FakeNFSServer
2233
return FakeNFSServer
2234
msg = "No known transport type %s. Supported types are: sftp\n" %\
2236
raise errors.BzrCommandError(msg)
2239
takes_args = ['testspecs*']
2240
takes_options = ['verbose',
2241
Option('one', help='stop when one test fails'),
2242
Option('keep-output',
2243
help='keep output directories when tests fail'),
2245
help='Use a different transport by default '
2246
'throughout the test suite.',
2247
type=get_transport_type),
2248
Option('benchmark', help='run the bzr bencharks.'),
2249
Option('lsprof-timed',
2250
help='generate lsprof output for benchmarked'
2251
' sections of code.'),
2252
Option('cache-dir', type=str,
2253
help='a directory to cache intermediate'
2254
' benchmark steps'),
2255
Option('clean-output',
2256
help='clean temporary tests directories'
2257
' without running tests'),
2259
help='run all tests, but run specified tests first',
2262
encoding_type = 'replace'
2264
def run(self, testspecs_list=None, verbose=None, one=False,
2265
keep_output=False, transport=None, benchmark=None,
2266
lsprof_timed=None, cache_dir=None, clean_output=False,
2269
from bzrlib.tests import selftest
2270
import bzrlib.benchmarks as benchmarks
2271
from bzrlib.benchmarks import tree_creator
2274
from bzrlib.tests import clean_selftest_output
2275
clean_selftest_output()
2278
if cache_dir is not None:
2279
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2280
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2281
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2283
if testspecs_list is not None:
2284
pattern = '|'.join(testspecs_list)
2288
test_suite_factory = benchmarks.test_suite
2291
# TODO: should possibly lock the history file...
2292
benchfile = open(".perf_history", "at", buffering=1)
2294
test_suite_factory = None
2299
result = selftest(verbose=verbose,
2301
stop_on_failure=one,
2302
keep_output=keep_output,
2303
transport=transport,
2304
test_suite_factory=test_suite_factory,
2305
lsprof_timed=lsprof_timed,
2306
bench_history=benchfile,
2307
matching_tests_first=first,
2310
if benchfile is not None:
2313
info('tests passed')
2315
info('tests failed')
2316
return int(not result)
2319
class cmd_version(Command):
2320
"""Show version of bzr."""
2324
from bzrlib.version import show_version
2328
class cmd_rocks(Command):
2329
"""Statement of optimism."""
2335
print "It sure does!"
2338
class cmd_find_merge_base(Command):
2339
"""Find and print a base revision for merging two branches."""
2340
# TODO: Options to specify revisions on either side, as if
2341
# merging only part of the history.
2342
takes_args = ['branch', 'other']
2346
def run(self, branch, other):
2347
from bzrlib.revision import MultipleRevisionSources
2349
branch1 = Branch.open_containing(branch)[0]
2350
branch2 = Branch.open_containing(other)[0]
2352
last1 = branch1.last_revision()
2353
last2 = branch2.last_revision()
2355
source = MultipleRevisionSources(branch1.repository,
2358
base_rev_id = common_ancestor(last1, last2, source)
2360
print 'merge base is revision %s' % base_rev_id
2363
class cmd_merge(Command):
2364
"""Perform a three-way merge.
2366
The branch is the branch you will merge from. By default, it will merge
2367
the latest revision. If you specify a revision, that revision will be
2368
merged. If you specify two revisions, the first will be used as a BASE,
2369
and the second one as OTHER. Revision numbers are always relative to the
2372
By default, bzr will try to merge in all new work from the other
2373
branch, automatically determining an appropriate base. If this
2374
fails, you may need to give an explicit base.
2376
Merge will do its best to combine the changes in two branches, but there
2377
are some kinds of problems only a human can fix. When it encounters those,
2378
it will mark a conflict. A conflict means that you need to fix something,
2379
before you should commit.
2381
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2383
If there is no default branch set, the first merge will set it. After
2384
that, you can omit the branch to use the default. To change the
2385
default, use --remember. The value will only be saved if the remote
2386
location can be accessed.
2388
The results of the merge are placed into the destination working
2389
directory, where they can be reviewed (with bzr diff), tested, and then
2390
committed to record the result of the merge.
2394
To merge the latest revision from bzr.dev
2395
bzr merge ../bzr.dev
2397
To merge changes up to and including revision 82 from bzr.dev
2398
bzr merge -r 82 ../bzr.dev
2400
To merge the changes introduced by 82, without previous changes:
2401
bzr merge -r 81..82 ../bzr.dev
2403
merge refuses to run if there are any uncommitted changes, unless
2406
The following merge types are available:
2408
takes_args = ['branch?']
2409
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2410
Option('show-base', help="Show base revision text in "
2412
Option('uncommitted', help='Apply uncommitted changes'
2413
' from a working copy, instead of branch changes'),
2414
Option('pull', help='If the destination is already'
2415
' completely merged into the source, pull from the'
2416
' source rather than merging. When this happens,'
2417
' you do not need to commit the result.'),
2419
help='branch to merge into, '
2420
'rather than the one containing the working directory',
2426
def run(self, branch=None, revision=None, force=False, merge_type=None,
2427
show_base=False, reprocess=False, remember=False,
2428
uncommitted=False, pull=False,
2431
if merge_type is None:
2432
merge_type = _mod_merge.Merge3Merger
2434
if directory is None: directory = u'.'
2435
tree = WorkingTree.open_containing(directory)[0]
2436
change_reporter = delta.ChangeReporter(tree.inventory)
2438
if branch is not None:
2440
reader = bundle.read_bundle_from_url(branch)
2441
except errors.NotABundle:
2442
pass # Continue on considering this url a Branch
2444
conflicts = merge_bundle(reader, tree, not force, merge_type,
2445
reprocess, show_base, change_reporter)
2451
if revision is None \
2452
or len(revision) < 1 or revision[0].needs_branch():
2453
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2455
if revision is None or len(revision) < 1:
2458
other = [branch, None]
2461
other = [branch, -1]
2462
other_branch, path = Branch.open_containing(branch)
2465
raise errors.BzrCommandError('Cannot use --uncommitted and'
2466
' --revision at the same time.')
2467
branch = revision[0].get_branch() or branch
2468
if len(revision) == 1:
2470
other_branch, path = Branch.open_containing(branch)
2471
revno = revision[0].in_history(other_branch).revno
2472
other = [branch, revno]
2474
assert len(revision) == 2
2475
if None in revision:
2476
raise errors.BzrCommandError(
2477
"Merge doesn't permit empty revision specifier.")
2478
base_branch, path = Branch.open_containing(branch)
2479
branch1 = revision[1].get_branch() or branch
2480
other_branch, path1 = Branch.open_containing(branch1)
2481
if revision[0].get_branch() is not None:
2482
# then path was obtained from it, and is None.
2485
base = [branch, revision[0].in_history(base_branch).revno]
2486
other = [branch1, revision[1].in_history(other_branch).revno]
2488
if tree.branch.get_parent() is None or remember:
2489
tree.branch.set_parent(other_branch.base)
2492
interesting_files = [path]
2494
interesting_files = None
2495
pb = ui.ui_factory.nested_progress_bar()
2498
conflict_count = _merge_helper(
2499
other, base, check_clean=(not force),
2500
merge_type=merge_type,
2501
reprocess=reprocess,
2502
show_base=show_base,
2505
pb=pb, file_list=interesting_files,
2506
change_reporter=change_reporter)
2509
if conflict_count != 0:
2513
except errors.AmbiguousBase, e:
2514
m = ("sorry, bzr can't determine the right merge base yet\n"
2515
"candidates are:\n "
2516
+ "\n ".join(e.bases)
2518
"please specify an explicit base with -r,\n"
2519
"and (if you want) report this to the bzr developers\n")
2522
# TODO: move up to common parent; this isn't merge-specific anymore.
2523
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2524
"""Use tree.branch's parent if none was supplied.
2526
Report if the remembered location was used.
2528
if supplied_location is not None:
2529
return supplied_location
2530
stored_location = tree.branch.get_parent()
2531
mutter("%s", stored_location)
2532
if stored_location is None:
2533
raise errors.BzrCommandError("No location specified or remembered")
2534
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2535
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2536
return stored_location
2539
class cmd_remerge(Command):
2542
Use this if you want to try a different merge technique while resolving
2543
conflicts. Some merge techniques are better than others, and remerge
2544
lets you try different ones on different files.
2546
The options for remerge have the same meaning and defaults as the ones for
2547
merge. The difference is that remerge can (only) be run when there is a
2548
pending merge, and it lets you specify particular files.
2551
$ bzr remerge --show-base
2552
Re-do the merge of all conflicted files, and show the base text in
2553
conflict regions, in addition to the usual THIS and OTHER texts.
2555
$ bzr remerge --merge-type weave --reprocess foobar
2556
Re-do the merge of "foobar", using the weave merge algorithm, with
2557
additional processing to reduce the size of conflict regions.
2559
The following merge types are available:"""
2560
takes_args = ['file*']
2561
takes_options = ['merge-type', 'reprocess',
2562
Option('show-base', help="Show base revision text in "
2565
def run(self, file_list=None, merge_type=None, show_base=False,
2567
if merge_type is None:
2568
merge_type = _mod_merge.Merge3Merger
2569
tree, file_list = tree_files(file_list)
2572
parents = tree.get_parent_ids()
2573
if len(parents) != 2:
2574
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2575
" merges. Not cherrypicking or"
2577
repository = tree.branch.repository
2578
base_revision = common_ancestor(parents[0],
2579
parents[1], repository)
2580
base_tree = repository.revision_tree(base_revision)
2581
other_tree = repository.revision_tree(parents[1])
2582
interesting_ids = None
2584
conflicts = tree.conflicts()
2585
if file_list is not None:
2586
interesting_ids = set()
2587
for filename in file_list:
2588
file_id = tree.path2id(filename)
2590
raise errors.NotVersionedError(filename)
2591
interesting_ids.add(file_id)
2592
if tree.kind(file_id) != "directory":
2595
for name, ie in tree.inventory.iter_entries(file_id):
2596
interesting_ids.add(ie.file_id)
2597
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2599
# Remerge only supports resolving contents conflicts
2600
allowed_conflicts = ('text conflict', 'contents conflict')
2601
restore_files = [c.path for c in conflicts
2602
if c.typestring in allowed_conflicts]
2603
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2604
tree.set_conflicts(ConflictList(new_conflicts))
2605
if file_list is not None:
2606
restore_files = file_list
2607
for filename in restore_files:
2609
restore(tree.abspath(filename))
2610
except errors.NotConflicted:
2612
conflicts = _mod_merge.merge_inner(
2613
tree.branch, other_tree, base_tree,
2615
interesting_ids=interesting_ids,
2616
other_rev_id=parents[1],
2617
merge_type=merge_type,
2618
show_base=show_base,
2619
reprocess=reprocess)
2628
class cmd_revert(Command):
2629
"""Revert files to a previous revision.
2631
Giving a list of files will revert only those files. Otherwise, all files
2632
will be reverted. If the revision is not specified with '--revision', the
2633
last committed revision is used.
2635
To remove only some changes, without reverting to a prior version, use
2636
merge instead. For example, "merge . --r-2..-3" will remove the changes
2637
introduced by -2, without affecting the changes introduced by -1. Or
2638
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2640
By default, any files that have been manually changed will be backed up
2641
first. (Files changed only by merge are not backed up.) Backup files have
2642
'.~#~' appended to their name, where # is a number.
2644
When you provide files, you can use their current pathname or the pathname
2645
from the target revision. So you can use revert to "undelete" a file by
2646
name. If you name a directory, all the contents of that directory will be
2649
takes_options = ['revision', 'no-backup']
2650
takes_args = ['file*']
2651
aliases = ['merge-revert']
2653
def run(self, revision=None, no_backup=False, file_list=None):
2654
if file_list is not None:
2655
if len(file_list) == 0:
2656
raise errors.BzrCommandError("No files specified")
2660
tree, file_list = tree_files(file_list)
2661
if revision is None:
2662
# FIXME should be tree.last_revision
2663
rev_id = tree.last_revision()
2664
elif len(revision) != 1:
2665
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2667
rev_id = revision[0].in_history(tree.branch).rev_id
2668
pb = ui.ui_factory.nested_progress_bar()
2670
tree.revert(file_list,
2671
tree.branch.repository.revision_tree(rev_id),
2672
not no_backup, pb, report_changes=True)
2677
class cmd_assert_fail(Command):
2678
"""Test reporting of assertion failures"""
2679
# intended just for use in testing
2684
raise AssertionError("always fails")
2687
class cmd_help(Command):
2688
"""Show help on a command or other topic.
2690
For a list of all available commands, say 'bzr help commands'.
2692
takes_options = [Option('long', 'show help on all commands')]
2693
takes_args = ['topic?']
2694
aliases = ['?', '--help', '-?', '-h']
2697
def run(self, topic=None, long=False):
2699
if topic is None and long:
2701
bzrlib.help.help(topic)
2704
class cmd_shell_complete(Command):
2705
"""Show appropriate completions for context.
2707
For a list of all available commands, say 'bzr shell-complete'.
2709
takes_args = ['context?']
2714
def run(self, context=None):
2715
import shellcomplete
2716
shellcomplete.shellcomplete(context)
2719
class cmd_fetch(Command):
2720
"""Copy in history from another branch but don't merge it.
2722
This is an internal method used for pull and merge.
2725
takes_args = ['from_branch', 'to_branch']
2726
def run(self, from_branch, to_branch):
2727
from bzrlib.fetch import Fetcher
2728
from_b = Branch.open(from_branch)
2729
to_b = Branch.open(to_branch)
2730
Fetcher(to_b, from_b)
2733
class cmd_missing(Command):
2734
"""Show unmerged/unpulled revisions between two branches.
2736
OTHER_BRANCH may be local or remote.
2738
takes_args = ['other_branch?']
2739
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2741
'Display changes in the local branch only'),
2742
Option('theirs-only',
2743
'Display changes in the remote branch only'),
2748
encoding_type = 'replace'
2751
def run(self, other_branch=None, reverse=False, mine_only=False,
2752
theirs_only=False, log_format=None, long=False, short=False, line=False,
2753
show_ids=False, verbose=False):
2754
from bzrlib.missing import find_unmerged, iter_log_data
2755
from bzrlib.log import log_formatter
2756
local_branch = Branch.open_containing(u".")[0]
2757
parent = local_branch.get_parent()
2758
if other_branch is None:
2759
other_branch = parent
2760
if other_branch is None:
2761
raise errors.BzrCommandError("No peer location known or specified.")
2762
display_url = urlutils.unescape_for_display(parent,
2764
print "Using last location: " + display_url
2766
remote_branch = Branch.open(other_branch)
2767
if remote_branch.base == local_branch.base:
2768
remote_branch = local_branch
2769
local_branch.lock_read()
2771
remote_branch.lock_read()
2773
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2774
if (log_format is None):
2775
log_format = log.log_formatter_registry.get_default(
2777
lf = log_format(to_file=self.outf,
2779
show_timezone='original')
2780
if reverse is False:
2781
local_extra.reverse()
2782
remote_extra.reverse()
2783
if local_extra and not theirs_only:
2784
print "You have %d extra revision(s):" % len(local_extra)
2785
for data in iter_log_data(local_extra, local_branch.repository,
2788
printed_local = True
2790
printed_local = False
2791
if remote_extra and not mine_only:
2792
if printed_local is True:
2794
print "You are missing %d revision(s):" % len(remote_extra)
2795
for data in iter_log_data(remote_extra, remote_branch.repository,
2798
if not remote_extra and not local_extra:
2800
print "Branches are up to date."
2804
remote_branch.unlock()
2806
local_branch.unlock()
2807
if not status_code and parent is None and other_branch is not None:
2808
local_branch.lock_write()
2810
# handle race conditions - a parent might be set while we run.
2811
if local_branch.get_parent() is None:
2812
local_branch.set_parent(remote_branch.base)
2814
local_branch.unlock()
2818
class cmd_plugins(Command):
2823
import bzrlib.plugin
2824
from inspect import getdoc
2825
for name, plugin in bzrlib.plugin.all_plugins().items():
2826
if getattr(plugin, '__path__', None) is not None:
2827
print plugin.__path__[0]
2828
elif getattr(plugin, '__file__', None) is not None:
2829
print plugin.__file__
2835
print '\t', d.split('\n')[0]
2838
class cmd_testament(Command):
2839
"""Show testament (signing-form) of a revision."""
2840
takes_options = ['revision',
2841
Option('long', help='Produce long-format testament'),
2842
Option('strict', help='Produce a strict-format'
2844
takes_args = ['branch?']
2846
def run(self, branch=u'.', revision=None, long=False, strict=False):
2847
from bzrlib.testament import Testament, StrictTestament
2849
testament_class = StrictTestament
2851
testament_class = Testament
2852
b = WorkingTree.open_containing(branch)[0].branch
2855
if revision is None:
2856
rev_id = b.last_revision()
2858
rev_id = revision[0].in_history(b).rev_id
2859
t = testament_class.from_revision(b.repository, rev_id)
2861
sys.stdout.writelines(t.as_text_lines())
2863
sys.stdout.write(t.as_short_text())
2868
class cmd_annotate(Command):
2869
"""Show the origin of each line in a file.
2871
This prints out the given file with an annotation on the left side
2872
indicating which revision, author and date introduced the change.
2874
If the origin is the same for a run of consecutive lines, it is
2875
shown only at the top, unless the --all option is given.
2877
# TODO: annotate directories; showing when each file was last changed
2878
# TODO: if the working copy is modified, show annotations on that
2879
# with new uncommitted lines marked
2880
aliases = ['ann', 'blame', 'praise']
2881
takes_args = ['filename']
2882
takes_options = [Option('all', help='show annotations on all lines'),
2883
Option('long', help='show date in annotations'),
2889
def run(self, filename, all=False, long=False, revision=None,
2891
from bzrlib.annotate import annotate_file
2892
tree, relpath = WorkingTree.open_containing(filename)
2893
branch = tree.branch
2896
if revision is None:
2897
revision_id = branch.last_revision()
2898
elif len(revision) != 1:
2899
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2901
revision_id = revision[0].in_history(branch).rev_id
2902
file_id = tree.inventory.path2id(relpath)
2903
tree = branch.repository.revision_tree(revision_id)
2904
file_version = tree.inventory[file_id].revision
2905
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2911
class cmd_re_sign(Command):
2912
"""Create a digital signature for an existing revision."""
2913
# TODO be able to replace existing ones.
2915
hidden = True # is this right ?
2916
takes_args = ['revision_id*']
2917
takes_options = ['revision']
2919
def run(self, revision_id_list=None, revision=None):
2920
import bzrlib.gpg as gpg
2921
if revision_id_list is not None and revision is not None:
2922
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2923
if revision_id_list is None and revision is None:
2924
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2925
b = WorkingTree.open_containing(u'.')[0].branch
2926
gpg_strategy = gpg.GPGStrategy(b.get_config())
2927
if revision_id_list is not None:
2928
for revision_id in revision_id_list:
2929
b.repository.sign_revision(revision_id, gpg_strategy)
2930
elif revision is not None:
2931
if len(revision) == 1:
2932
revno, rev_id = revision[0].in_history(b)
2933
b.repository.sign_revision(rev_id, gpg_strategy)
2934
elif len(revision) == 2:
2935
# are they both on rh- if so we can walk between them
2936
# might be nice to have a range helper for arbitrary
2937
# revision paths. hmm.
2938
from_revno, from_revid = revision[0].in_history(b)
2939
to_revno, to_revid = revision[1].in_history(b)
2940
if to_revid is None:
2941
to_revno = b.revno()
2942
if from_revno is None or to_revno is None:
2943
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2944
for revno in range(from_revno, to_revno + 1):
2945
b.repository.sign_revision(b.get_rev_id(revno),
2948
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2951
class cmd_bind(Command):
2952
"""Convert the current branch into a checkout of the supplied branch.
2954
Once converted into a checkout, commits must succeed on the master branch
2955
before they will be applied to the local branch.
2957
See "help checkouts" for more information on checkouts.
2960
takes_args = ['location?']
2963
def run(self, location=None):
2964
b, relpath = Branch.open_containing(u'.')
2965
if location is None:
2967
location = b.get_old_bound_location()
2968
except errors.UpgradeRequired:
2969
raise errors.BzrCommandError('No location supplied. '
2970
'This format does not remember old locations.')
2972
if location is None:
2973
raise errors.BzrCommandError('No location supplied and no '
2974
'previous location known')
2975
b_other = Branch.open(location)
2978
except errors.DivergedBranches:
2979
raise errors.BzrCommandError('These branches have diverged.'
2980
' Try merging, and then bind again.')
2983
class cmd_unbind(Command):
2984
"""Convert the current checkout into a regular branch.
2986
After unbinding, the local branch is considered independent and subsequent
2987
commits will be local only.
2989
See "help checkouts" for more information on checkouts.
2996
b, relpath = Branch.open_containing(u'.')
2998
raise errors.BzrCommandError('Local branch is not bound')
3001
class cmd_uncommit(Command):
3002
"""Remove the last committed revision.
3004
--verbose will print out what is being removed.
3005
--dry-run will go through all the motions, but not actually
3008
In the future, uncommit will create a revision bundle, which can then
3012
# TODO: jam 20060108 Add an option to allow uncommit to remove
3013
# unreferenced information in 'branch-as-repository' branches.
3014
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3015
# information in shared branches as well.
3016
takes_options = ['verbose', 'revision',
3017
Option('dry-run', help='Don\'t actually make changes'),
3018
Option('force', help='Say yes to all questions.')]
3019
takes_args = ['location?']
3022
def run(self, location=None,
3023
dry_run=False, verbose=False,
3024
revision=None, force=False):
3025
from bzrlib.log import log_formatter, show_log
3027
from bzrlib.uncommit import uncommit
3029
if location is None:
3031
control, relpath = bzrdir.BzrDir.open_containing(location)
3033
tree = control.open_workingtree()
3035
except (errors.NoWorkingTree, errors.NotLocalUrl):
3037
b = control.open_branch()
3040
if revision is None:
3043
# 'bzr uncommit -r 10' actually means uncommit
3044
# so that the final tree is at revno 10.
3045
# but bzrlib.uncommit.uncommit() actually uncommits
3046
# the revisions that are supplied.
3047
# So we need to offset it by one
3048
revno = revision[0].in_history(b).revno+1
3050
if revno <= b.revno():
3051
rev_id = b.get_rev_id(revno)
3053
self.outf.write('No revisions to uncommit.\n')
3056
lf = log_formatter('short',
3058
show_timezone='original')
3063
direction='forward',
3064
start_revision=revno,
3065
end_revision=b.revno())
3068
print 'Dry-run, pretending to remove the above revisions.'
3070
val = raw_input('Press <enter> to continue')
3072
print 'The above revision(s) will be removed.'
3074
val = raw_input('Are you sure [y/N]? ')
3075
if val.lower() not in ('y', 'yes'):
3079
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3083
class cmd_break_lock(Command):
3084
"""Break a dead lock on a repository, branch or working directory.
3086
CAUTION: Locks should only be broken when you are sure that the process
3087
holding the lock has been stopped.
3089
You can get information on what locks are open via the 'bzr info' command.
3094
takes_args = ['location?']
3096
def run(self, location=None, show=False):
3097
if location is None:
3099
control, relpath = bzrdir.BzrDir.open_containing(location)
3101
control.break_lock()
3102
except NotImplementedError:
3106
class cmd_wait_until_signalled(Command):
3107
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3109
This just prints a line to signal when it is ready, then blocks on stdin.
3115
sys.stdout.write("running\n")
3117
sys.stdin.readline()
3120
class cmd_serve(Command):
3121
"""Run the bzr server."""
3123
aliases = ['server']
3127
help='serve on stdin/out for use from inetd or sshd'),
3129
help='listen for connections on nominated port of the form '
3130
'[hostname:]portnumber. Passing 0 as the port number will '
3131
'result in a dynamically allocated port. Default port is '
3135
help='serve contents of directory',
3137
Option('allow-writes',
3138
help='By default the server is a readonly server. Supplying '
3139
'--allow-writes enables write access to the contents of '
3140
'the served directory and below. '
3144
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3145
from bzrlib.transport import smart
3146
from bzrlib.transport import get_transport
3147
if directory is None:
3148
directory = os.getcwd()
3149
url = urlutils.local_path_to_url(directory)
3150
if not allow_writes:
3151
url = 'readonly+' + url
3152
t = get_transport(url)
3154
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3157
port = smart.BZR_DEFAULT_PORT
3161
host, port = port.split(':')
3165
server = smart.SmartTCPServer(t, host=host, port=port)
3166
print 'listening on port: ', server.port
3171
# command-line interpretation helper for merge-related commands
3172
def _merge_helper(other_revision, base_revision,
3173
check_clean=True, ignore_zero=False,
3174
this_dir=None, backup_files=False,
3176
file_list=None, show_base=False, reprocess=False,
3179
change_reporter=None):
3180
"""Merge changes into a tree.
3183
list(path, revno) Base for three-way merge.
3184
If [None, None] then a base will be automatically determined.
3186
list(path, revno) Other revision for three-way merge.
3188
Directory to merge changes into; '.' by default.
3190
If true, this_dir must have no uncommitted changes before the
3192
ignore_zero - If true, suppress the "zero conflicts" message when
3193
there are no conflicts; should be set when doing something we expect
3194
to complete perfectly.
3195
file_list - If supplied, merge only changes to selected files.
3197
All available ancestors of other_revision and base_revision are
3198
automatically pulled into the branch.
3200
The revno may be -1 to indicate the last revision on the branch, which is
3203
This function is intended for use from the command line; programmatic
3204
clients might prefer to call merge.merge_inner(), which has less magic
3207
# Loading it late, so that we don't always have to import bzrlib.merge
3208
if merge_type is None:
3209
merge_type = _mod_merge.Merge3Merger
3210
if this_dir is None:
3212
this_tree = WorkingTree.open_containing(this_dir)[0]
3213
if show_base and not merge_type is _mod_merge.Merge3Merger:
3214
raise errors.BzrCommandError("Show-base is not supported for this merge"
3215
" type. %s" % merge_type)
3216
if reprocess and not merge_type.supports_reprocess:
3217
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3218
" type %s." % merge_type)
3219
if reprocess and show_base:
3220
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3222
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3223
pb=pb, change_reporter=change_reporter)
3224
merger.pp = ProgressPhase("Merge phase", 5, pb)
3225
merger.pp.next_phase()
3226
merger.check_basis(check_clean)
3227
merger.set_other(other_revision)
3228
merger.pp.next_phase()
3229
merger.set_base(base_revision)
3230
if merger.base_rev_id == merger.other_rev_id:
3231
note('Nothing to do.')
3233
if file_list is None:
3234
if pull and merger.base_rev_id == merger.this_rev_id:
3235
count = merger.this_tree.pull(merger.this_branch,
3236
False, merger.other_rev_id)
3237
note('%d revision(s) pulled.' % (count,))
3239
merger.backup_files = backup_files
3240
merger.merge_type = merge_type
3241
merger.set_interesting_files(file_list)
3242
merger.show_base = show_base
3243
merger.reprocess = reprocess
3244
conflicts = merger.do_merge()
3245
if file_list is None:
3246
merger.set_pending()
3253
merge = _merge_helper
3256
# these get imported and then picked up by the scan for cmd_*
3257
# TODO: Some more consistent way to split command definitions across files;
3258
# we do need to load at least some information about them to know of
3259
# aliases. ideally we would avoid loading the implementation until the
3260
# details were needed.
3261
from bzrlib.cmd_version_info import cmd_version_info
3262
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3263
from bzrlib.bundle.commands import cmd_bundle_revisions
3264
from bzrlib.sign_my_commits import cmd_sign_my_commits
3265
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3266
cmd_weave_plan_merge, cmd_weave_merge_text