1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
47
from bzrlib.branch import Branch
48
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
49
from bzrlib.conflicts import ConflictList
50
from bzrlib.revision import common_ancestor
51
from bzrlib.revisionspec import RevisionSpec
52
from bzrlib.workingtree import WorkingTree
55
from bzrlib.commands import Command, display_command
56
from bzrlib.option import Option, RegistryOption
57
from bzrlib.progress import DummyProgress, ProgressPhase
58
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
61
def tree_files(file_list, default_branch=u'.'):
63
return internal_tree_files(file_list, default_branch)
64
except errors.FileInWrongBranch, e:
65
raise errors.BzrCommandError("%s is not in the same branch as %s" %
66
(e.path, file_list[0]))
69
# XXX: Bad function name; should possibly also be a class method of
70
# WorkingTree rather than a function.
71
def internal_tree_files(file_list, default_branch=u'.'):
72
"""Convert command-line paths to a WorkingTree and relative paths.
74
This is typically used for command-line processors that take one or
75
more filenames, and infer the workingtree that contains them.
77
The filenames given are not required to exist.
79
:param file_list: Filenames to convert.
81
:param default_branch: Fallback tree path to use if file_list is empty or
84
:return: workingtree, [relative_paths]
86
if file_list is None or len(file_list) == 0:
87
return WorkingTree.open_containing(default_branch)[0], file_list
88
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
90
for filename in file_list:
92
new_list.append(tree.relpath(osutils.dereference_path(filename)))
93
except errors.PathNotChild:
94
raise errors.FileInWrongBranch(tree.branch, filename)
98
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
99
def get_format_type(typestring):
100
"""Parse and return a format specifier."""
101
# Have to use BzrDirMetaFormat1 directly, so that
102
# RepositoryFormat.set_default_format works
103
if typestring == "default":
104
return bzrdir.BzrDirMetaFormat1()
106
return bzrdir.format_registry.make_bzrdir(typestring)
108
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
109
raise errors.BzrCommandError(msg)
112
# TODO: Make sure no commands unconditionally use the working directory as a
113
# branch. If a filename argument is used, the first of them should be used to
114
# specify the branch. (Perhaps this can be factored out into some kind of
115
# Argument class, representing a file in a branch, where the first occurrence
118
class cmd_status(Command):
119
"""Display status summary.
121
This reports on versioned and unknown files, reporting them
122
grouped by state. Possible states are:
125
Versioned in the working copy but not in the previous revision.
128
Versioned in the previous revision but removed or deleted
132
Path of this file changed from the previous revision;
133
the text may also have changed. This includes files whose
134
parent directory was renamed.
137
Text has changed since the previous revision.
140
File kind has been changed (e.g. from file to directory).
143
Not versioned and not matching an ignore pattern.
145
To see ignored files use 'bzr ignored'. For details in the
146
changes to file texts, use 'bzr diff'.
148
--short gives a status flags for each item, similar to the SVN's status
151
Column 1: versioning / renames
157
P Entry for a pending merge (not a file)
166
* The execute bit was changed
168
If no arguments are specified, the status of the entire working
169
directory is shown. Otherwise, only the status of the specified
170
files or directories is reported. If a directory is given, status
171
is reported for everything inside that directory.
173
If a revision argument is given, the status is calculated against
174
that revision, or between two revisions if two are provided.
177
# TODO: --no-recurse, --recurse options
179
takes_args = ['file*']
180
takes_options = ['show-ids', 'revision', 'short']
181
aliases = ['st', 'stat']
183
encoding_type = 'replace'
186
def run(self, show_ids=False, file_list=None, revision=None, short=False):
187
from bzrlib.status import show_tree_status
189
tree, file_list = tree_files(file_list)
191
show_tree_status(tree, show_ids=show_ids,
192
specific_files=file_list, revision=revision,
197
class cmd_cat_revision(Command):
198
"""Write out metadata for a revision.
200
The revision to print can either be specified by a specific
201
revision identifier, or you can use --revision.
205
takes_args = ['revision_id?']
206
takes_options = ['revision']
207
# cat-revision is more for frontends so should be exact
211
def run(self, revision_id=None, revision=None):
213
if revision_id is not None and revision is not None:
214
raise errors.BzrCommandError('You can only supply one of'
215
' revision_id or --revision')
216
if revision_id is None and revision is None:
217
raise errors.BzrCommandError('You must supply either'
218
' --revision or a revision_id')
219
b = WorkingTree.open_containing(u'.')[0].branch
221
# TODO: jam 20060112 should cat-revision always output utf-8?
222
if revision_id is not None:
223
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
224
elif revision is not None:
227
raise errors.BzrCommandError('You cannot specify a NULL'
229
revno, rev_id = rev.in_history(b)
230
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
233
class cmd_remove_tree(Command):
234
"""Remove the working tree from a given branch/checkout.
236
Since a lightweight checkout is little more than a working tree
237
this will refuse to run against one.
242
takes_args = ['location?']
244
def run(self, location='.'):
245
d = bzrdir.BzrDir.open(location)
248
working = d.open_workingtree()
249
except errors.NoWorkingTree:
250
raise errors.BzrCommandError("No working tree to remove")
251
except errors.NotLocalUrl:
252
raise errors.BzrCommandError("You cannot remove the working tree of a "
255
working_path = working.bzrdir.root_transport.base
256
branch_path = working.branch.bzrdir.root_transport.base
257
if working_path != branch_path:
258
raise errors.BzrCommandError("You cannot remove the working tree from "
259
"a lightweight checkout")
261
d.destroy_workingtree()
264
class cmd_revno(Command):
265
"""Show current revision number.
267
This is equal to the number of revisions on this branch.
270
takes_args = ['location?']
273
def run(self, location=u'.'):
274
self.outf.write(str(Branch.open_containing(location)[0].revno()))
275
self.outf.write('\n')
278
class cmd_revision_info(Command):
279
"""Show revision number and revision id for a given revision identifier.
282
takes_args = ['revision_info*']
283
takes_options = ['revision']
286
def run(self, revision=None, revision_info_list=[]):
289
if revision is not None:
290
revs.extend(revision)
291
if revision_info_list is not None:
292
for rev in revision_info_list:
293
revs.append(RevisionSpec.from_string(rev))
295
raise errors.BzrCommandError('You must supply a revision identifier')
297
b = WorkingTree.open_containing(u'.')[0].branch
300
revinfo = rev.in_history(b)
301
if revinfo.revno is None:
302
print ' %s' % revinfo.rev_id
304
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
307
class cmd_add(Command):
308
"""Add specified files or directories.
310
In non-recursive mode, all the named items are added, regardless
311
of whether they were previously ignored. A warning is given if
312
any of the named files are already versioned.
314
In recursive mode (the default), files are treated the same way
315
but the behaviour for directories is different. Directories that
316
are already versioned do not give a warning. All directories,
317
whether already versioned or not, are searched for files or
318
subdirectories that are neither versioned or ignored, and these
319
are added. This search proceeds recursively into versioned
320
directories. If no names are given '.' is assumed.
322
Therefore simply saying 'bzr add' will version all files that
323
are currently unknown.
325
Adding a file whose parent directory is not versioned will
326
implicitly add the parent, and so on up to the root. This means
327
you should never need to explicitly add a directory, they'll just
328
get added when you add a file in the directory.
330
--dry-run will show which files would be added, but not actually
333
--file-ids-from will try to use the file ids from the supplied path.
334
It looks up ids trying to find a matching parent directory with the
335
same filename, and then by pure path.
337
takes_args = ['file*']
338
takes_options = ['no-recurse', 'dry-run', 'verbose',
339
Option('file-ids-from', type=unicode,
340
help='Lookup file ids from here')]
341
encoding_type = 'replace'
343
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
347
if file_ids_from is not None:
349
base_tree, base_path = WorkingTree.open_containing(
351
except errors.NoWorkingTree:
352
base_branch, base_path = Branch.open_containing(
354
base_tree = base_branch.basis_tree()
356
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
357
to_file=self.outf, should_print=(not is_quiet()))
359
action = bzrlib.add.AddAction(to_file=self.outf,
360
should_print=(not is_quiet()))
362
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
363
action=action, save=not dry_run)
366
for glob in sorted(ignored.keys()):
367
for path in ignored[glob]:
368
self.outf.write("ignored %s matching \"%s\"\n"
372
for glob, paths in ignored.items():
373
match_len += len(paths)
374
self.outf.write("ignored %d file(s).\n" % match_len)
375
self.outf.write("If you wish to add some of these files,"
376
" please add them by name.\n")
379
class cmd_mkdir(Command):
380
"""Create a new versioned directory.
382
This is equivalent to creating the directory and then adding it.
385
takes_args = ['dir+']
386
encoding_type = 'replace'
388
def run(self, dir_list):
391
wt, dd = WorkingTree.open_containing(d)
393
self.outf.write('added %s\n' % d)
396
class cmd_relpath(Command):
397
"""Show path of a file relative to root"""
399
takes_args = ['filename']
403
def run(self, filename):
404
# TODO: jam 20050106 Can relpath return a munged path if
405
# sys.stdout encoding cannot represent it?
406
tree, relpath = WorkingTree.open_containing(filename)
407
self.outf.write(relpath)
408
self.outf.write('\n')
411
class cmd_inventory(Command):
412
"""Show inventory of the current working copy or a revision.
414
It is possible to limit the output to a particular entry
415
type using the --kind option. For example: --kind file.
417
It is also possible to restrict the list of files to a specific
418
set. For example: bzr inventory --show-ids this/file
425
takes_options = ['revision', 'show-ids', 'kind']
427
takes_args = ['file*']
430
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
431
if kind and kind not in ['file', 'directory', 'symlink']:
432
raise errors.BzrCommandError('invalid kind specified')
434
work_tree, file_list = tree_files(file_list)
436
if revision is not None:
437
if len(revision) > 1:
438
raise errors.BzrCommandError('bzr inventory --revision takes'
439
' exactly one revision identifier')
440
revision_id = revision[0].in_history(work_tree.branch).rev_id
441
tree = work_tree.branch.repository.revision_tree(revision_id)
443
# We include work_tree as well as 'tree' here
444
# So that doing '-r 10 path/foo' will lookup whatever file
445
# exists now at 'path/foo' even if it has been renamed, as
446
# well as whatever files existed in revision 10 at path/foo
447
trees = [tree, work_tree]
452
if file_list is not None:
453
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
454
require_versioned=True)
455
# find_ids_across_trees may include some paths that don't
457
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
458
for file_id in file_ids if file_id in tree)
460
entries = tree.inventory.entries()
462
for path, entry in entries:
463
if kind and kind != entry.kind:
466
self.outf.write('%-50s %s\n' % (path, entry.file_id))
468
self.outf.write(path)
469
self.outf.write('\n')
472
class cmd_mv(Command):
473
"""Move or rename a file.
476
bzr mv OLDNAME NEWNAME
477
bzr mv SOURCE... DESTINATION
479
If the last argument is a versioned directory, all the other names
480
are moved into it. Otherwise, there must be exactly two arguments
481
and the file is changed to a new name.
483
If OLDNAME does not exist on the filesystem but is versioned and
484
NEWNAME does exist on the filesystem but is not versioned, mv
485
assumes that the file has been manually moved and only updates
486
its internal inventory to reflect that change.
487
The same is valid when moving many SOURCE files to a DESTINATION.
489
Files cannot be moved between branches.
492
takes_args = ['names*']
493
takes_options = [Option("after", help="move only the bzr identifier"
494
" of the file (file has already been moved). Use this flag if"
495
" bzr is not able to detect this itself.")]
496
aliases = ['move', 'rename']
497
encoding_type = 'replace'
499
def run(self, names_list, after=False):
500
if names_list is None:
503
if len(names_list) < 2:
504
raise errors.BzrCommandError("missing file argument")
505
tree, rel_names = tree_files(names_list)
507
if os.path.isdir(names_list[-1]):
508
# move into existing directory
509
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
510
self.outf.write("%s => %s\n" % pair)
512
if len(names_list) != 2:
513
raise errors.BzrCommandError('to mv multiple files the'
514
' destination must be a versioned'
516
tree.rename_one(rel_names[0], rel_names[1], after=after)
517
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
520
class cmd_pull(Command):
521
"""Turn this branch into a mirror of another branch.
523
This command only works on branches that have not diverged. Branches are
524
considered diverged if the destination branch's most recent commit is one
525
that has not been merged (directly or indirectly) into the parent.
527
If branches have diverged, you can use 'bzr merge' to integrate the changes
528
from one into the other. Once one branch has merged, the other should
529
be able to pull it again.
531
If you want to forget your local changes and just update your branch to
532
match the remote one, use pull --overwrite.
534
If there is no default location set, the first pull will set it. After
535
that, you can omit the location to use the default. To change the
536
default, use --remember. The value will only be saved if the remote
537
location can be accessed.
540
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
542
help='branch to pull into, '
543
'rather than the one containing the working directory',
548
takes_args = ['location?']
549
encoding_type = 'replace'
551
def run(self, location=None, remember=False, overwrite=False,
552
revision=None, verbose=False,
554
# FIXME: too much stuff is in the command class
555
if directory is None:
558
tree_to = WorkingTree.open_containing(directory)[0]
559
branch_to = tree_to.branch
560
except errors.NoWorkingTree:
562
branch_to = Branch.open_containing(directory)[0]
565
if location is not None:
567
reader = bundle.read_bundle_from_url(location)
568
except errors.NotABundle:
569
pass # Continue on considering this url a Branch
571
stored_loc = branch_to.get_parent()
573
if stored_loc is None:
574
raise errors.BzrCommandError("No pull location known or"
577
display_url = urlutils.unescape_for_display(stored_loc,
579
self.outf.write("Using saved location: %s\n" % display_url)
580
location = stored_loc
582
if reader is not None:
583
install_bundle(branch_to.repository, reader)
584
branch_from = branch_to
586
branch_from = Branch.open(location)
588
if branch_to.get_parent() is None or remember:
589
branch_to.set_parent(branch_from.base)
593
if reader is not None:
594
rev_id = reader.target
595
elif len(revision) == 1:
596
rev_id = revision[0].in_history(branch_from).rev_id
598
raise errors.BzrCommandError('bzr pull --revision takes one value.')
600
old_rh = branch_to.revision_history()
601
if tree_to is not None:
602
count = tree_to.pull(branch_from, overwrite, rev_id)
604
count = branch_to.pull(branch_from, overwrite, rev_id)
605
_copy_tags_maybe(branch_from, branch_to)
606
note('%d revision(s) pulled.' % (count,))
609
new_rh = branch_to.revision_history()
612
from bzrlib.log import show_changed_revisions
613
show_changed_revisions(branch_to, old_rh, new_rh,
617
class cmd_push(Command):
618
"""Update a mirror of this branch.
620
The target branch will not have its working tree populated because this
621
is both expensive, and is not supported on remote file systems.
623
Some smart servers or protocols *may* put the working tree in place in
626
This command only works on branches that have not diverged. Branches are
627
considered diverged if the destination branch's most recent commit is one
628
that has not been merged (directly or indirectly) by the source branch.
630
If branches have diverged, you can use 'bzr push --overwrite' to replace
631
the other branch completely, discarding its unmerged changes.
633
If you want to ensure you have the different changes in the other branch,
634
do a merge (see bzr help merge) from the other branch, and commit that.
635
After that you will be able to do a push without '--overwrite'.
637
If there is no default push location set, the first push will set it.
638
After that, you can omit the location to use the default. To change the
639
default, use --remember. The value will only be saved if the remote
640
location can be accessed.
643
takes_options = ['remember', 'overwrite', 'verbose',
644
Option('create-prefix',
645
help='Create the path leading up to the branch '
646
'if it does not already exist'),
648
help='branch to push from, '
649
'rather than the one containing the working directory',
653
Option('use-existing-dir',
654
help='By default push will fail if the target'
655
' directory exists, but does not already'
656
' have a control directory. This flag will'
657
' allow push to proceed.'),
659
takes_args = ['location?']
660
encoding_type = 'replace'
662
def run(self, location=None, remember=False, overwrite=False,
663
create_prefix=False, verbose=False,
665
use_existing_dir=False,
667
# FIXME: Way too big! Put this into a function called from the
669
if directory is None:
671
br_from = Branch.open_containing(directory)[0]
672
stored_loc = br_from.get_push_location()
674
if stored_loc is None:
675
raise errors.BzrCommandError("No push location known or specified.")
677
display_url = urlutils.unescape_for_display(stored_loc,
679
self.outf.write("Using saved location: %s\n" % display_url)
680
location = stored_loc
682
to_transport = transport.get_transport(location)
683
location_url = to_transport.base
688
br_to = repository_to = dir_to = None
690
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
691
except errors.NotBranchError:
692
pass # Didn't find anything
694
# If we can open a branch, use its direct repository, otherwise see
695
# if there is a repository without a branch.
697
br_to = dir_to.open_branch()
698
except errors.NotBranchError:
699
# Didn't find a branch, can we find a repository?
701
repository_to = dir_to.find_repository()
702
except errors.NoRepositoryPresent:
705
# Found a branch, so we must have found a repository
706
repository_to = br_to.repository
710
# XXX: Refactor the create_prefix/no_create_prefix code into a
711
# common helper function
713
to_transport.mkdir('.')
714
except errors.FileExists:
715
if not use_existing_dir:
716
raise errors.BzrCommandError("Target directory %s"
717
" already exists, but does not have a valid .bzr"
718
" directory. Supply --use-existing-dir to push"
719
" there anyway." % location)
720
except errors.NoSuchFile:
721
if not create_prefix:
722
raise errors.BzrCommandError("Parent directory of %s"
724
"\nYou may supply --create-prefix to create all"
725
" leading parent directories."
728
cur_transport = to_transport
729
needed = [cur_transport]
730
# Recurse upwards until we can create a directory successfully
732
new_transport = cur_transport.clone('..')
733
if new_transport.base == cur_transport.base:
734
raise errors.BzrCommandError("Failed to create path"
738
new_transport.mkdir('.')
739
except errors.NoSuchFile:
740
needed.append(new_transport)
741
cur_transport = new_transport
745
# Now we only need to create child directories
747
cur_transport = needed.pop()
748
cur_transport.mkdir('.')
750
# Now the target directory exists, but doesn't have a .bzr
751
# directory. So we need to create it, along with any work to create
752
# all of the dependent branches, etc.
753
dir_to = br_from.bzrdir.clone(location_url,
754
revision_id=br_from.last_revision())
755
br_to = dir_to.open_branch()
756
count = br_to.last_revision_info()[0]
757
# We successfully created the target, remember it
758
if br_from.get_push_location() is None or remember:
759
br_from.set_push_location(br_to.base)
760
elif repository_to is None:
761
# we have a bzrdir but no branch or repository
762
# XXX: Figure out what to do other than complain.
763
raise errors.BzrCommandError("At %s you have a valid .bzr control"
764
" directory, but not a branch or repository. This is an"
765
" unsupported configuration. Please move the target directory"
766
" out of the way and try again."
769
# We have a repository but no branch, copy the revisions, and then
771
last_revision_id = br_from.last_revision()
772
repository_to.fetch(br_from.repository,
773
revision_id=last_revision_id)
774
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
775
count = len(br_to.revision_history())
776
if br_from.get_push_location() is None or remember:
777
br_from.set_push_location(br_to.base)
778
else: # We have a valid to branch
779
# We were able to connect to the remote location, so remember it
780
# we don't need to successfully push because of possible divergence.
781
if br_from.get_push_location() is None or remember:
782
br_from.set_push_location(br_to.base)
783
old_rh = br_to.revision_history()
786
tree_to = dir_to.open_workingtree()
787
except errors.NotLocalUrl:
788
warning('This transport does not update the working '
789
'tree of: %s' % (br_to.base,))
790
count = br_from.push(br_to, overwrite)
791
except errors.NoWorkingTree:
792
count = br_from.push(br_to, overwrite)
796
count = br_from.push(tree_to.branch, overwrite)
800
except errors.DivergedBranches:
801
raise errors.BzrCommandError('These branches have diverged.'
802
' Try using "merge" and then "push".')
803
_copy_tags_maybe(br_from, br_to)
804
note('%d revision(s) pushed.' % (count,))
807
new_rh = br_to.revision_history()
810
from bzrlib.log import show_changed_revisions
811
show_changed_revisions(br_to, old_rh, new_rh,
815
class cmd_branch(Command):
816
"""Create a new copy of a branch.
818
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
819
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
821
To retrieve the branch as of a particular revision, supply the --revision
822
parameter, as in "branch foo/bar -r 5".
824
--basis is to speed up branching from remote branches. When specified, it
825
copies all the file-contents, inventory and revision data from the basis
826
branch before copying anything from the remote branch.
828
takes_args = ['from_location', 'to_location?']
829
takes_options = ['revision', 'basis']
830
aliases = ['get', 'clone']
832
def run(self, from_location, to_location=None, revision=None, basis=None):
835
elif len(revision) > 1:
836
raise errors.BzrCommandError(
837
'bzr branch --revision takes exactly 1 revision value')
839
br_from = Branch.open(from_location)
842
if basis is not None:
843
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
846
if len(revision) == 1 and revision[0] is not None:
847
revision_id = revision[0].in_history(br_from)[1]
849
# FIXME - wt.last_revision, fallback to branch, fall back to
850
# None or perhaps NULL_REVISION to mean copy nothing
852
revision_id = br_from.last_revision()
853
if to_location is None:
854
to_location = os.path.basename(from_location.rstrip("/\\"))
857
name = os.path.basename(to_location) + '\n'
859
to_transport = transport.get_transport(to_location)
861
to_transport.mkdir('.')
862
except errors.FileExists:
863
raise errors.BzrCommandError('Target directory "%s" already'
864
' exists.' % to_location)
865
except errors.NoSuchFile:
866
raise errors.BzrCommandError('Parent of "%s" does not exist.'
869
# preserve whatever source format we have.
870
dir = br_from.bzrdir.sprout(to_transport.base,
871
revision_id, basis_dir)
872
branch = dir.open_branch()
873
except errors.NoSuchRevision:
874
to_transport.delete_tree('.')
875
msg = "The branch %s has no revision %s." % (from_location, revision[0])
876
raise errors.BzrCommandError(msg)
877
except errors.UnlistableBranch:
878
osutils.rmtree(to_location)
879
msg = "The branch %s cannot be used as a --basis" % (basis,)
880
raise errors.BzrCommandError(msg)
882
branch.control_files.put_utf8('branch-name', name)
883
_copy_tags_maybe(br_from, branch)
884
note('Branched %d revision(s).' % branch.revno())
889
def _copy_tags_maybe(from_branch, to_branch):
890
"""Copy tags between repositories if necessary and possible.
892
This method has common command-line behaviour about handling
895
if not from_branch.tags.supports_tags():
896
# obviously nothing to copy
898
# TODO: give a warning if the source format supports tags and actually has
899
# tags, but the destination doesn't accept them.
900
from_branch.copy_tags_to(to_branch)
903
class cmd_checkout(Command):
904
"""Create a new checkout of an existing branch.
906
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
907
the branch found in '.'. This is useful if you have removed the working tree
908
or if it was never created - i.e. if you pushed the branch to its current
911
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
912
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
914
To retrieve the branch as of a particular revision, supply the --revision
915
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
916
out of date [so you cannot commit] but it may be useful (i.e. to examine old
919
--basis is to speed up checking out from remote branches. When specified, it
920
uses the inventory and file contents from the basis branch in preference to the
921
branch being checked out.
923
See "help checkouts" for more information on checkouts.
925
takes_args = ['branch_location?', 'to_location?']
926
takes_options = ['revision', # , 'basis']
927
Option('lightweight',
928
help="perform a lightweight checkout. Lightweight "
929
"checkouts depend on access to the branch for "
930
"every operation. Normal checkouts can perform "
931
"common operations like diff and status without "
932
"such access, and also support local commits."
937
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
941
elif len(revision) > 1:
942
raise errors.BzrCommandError(
943
'bzr checkout --revision takes exactly 1 revision value')
944
if branch_location is None:
945
branch_location = osutils.getcwd()
946
to_location = branch_location
947
source = Branch.open(branch_location)
948
if len(revision) == 1 and revision[0] is not None:
949
revision_id = revision[0].in_history(source)[1]
952
if to_location is None:
953
to_location = os.path.basename(branch_location.rstrip("/\\"))
954
# if the source and to_location are the same,
955
# and there is no working tree,
956
# then reconstitute a branch
957
if (osutils.abspath(to_location) ==
958
osutils.abspath(branch_location)):
960
source.bzrdir.open_workingtree()
961
except errors.NoWorkingTree:
962
source.bzrdir.create_workingtree()
965
os.mkdir(to_location)
967
if e.errno == errno.EEXIST:
968
raise errors.BzrCommandError('Target directory "%s" already'
969
' exists.' % to_location)
970
if e.errno == errno.ENOENT:
971
raise errors.BzrCommandError('Parent of "%s" does not exist.'
975
source.create_checkout(to_location, revision_id, lightweight)
978
class cmd_renames(Command):
979
"""Show list of renamed files.
981
# TODO: Option to show renames between two historical versions.
983
# TODO: Only show renames under dir, rather than in the whole branch.
984
takes_args = ['dir?']
987
def run(self, dir=u'.'):
988
tree = WorkingTree.open_containing(dir)[0]
989
old_inv = tree.basis_tree().inventory
990
new_inv = tree.read_working_inventory()
991
renames = list(_mod_tree.find_renames(old_inv, new_inv))
993
for old_name, new_name in renames:
994
self.outf.write("%s => %s\n" % (old_name, new_name))
997
class cmd_update(Command):
998
"""Update a tree to have the latest code committed to its branch.
1000
This will perform a merge into the working tree, and may generate
1001
conflicts. If you have any local changes, you will still
1002
need to commit them after the update for the update to be complete.
1004
If you want to discard your local changes, you can just do a
1005
'bzr revert' instead of 'bzr commit' after the update.
1007
takes_args = ['dir?']
1010
def run(self, dir='.'):
1011
tree = WorkingTree.open_containing(dir)[0]
1012
master = tree.branch.get_master_branch()
1013
if master is not None:
1016
tree.lock_tree_write()
1018
existing_pending_merges = tree.get_parent_ids()[1:]
1019
last_rev = tree.last_revision()
1020
if last_rev == tree.branch.last_revision():
1021
# may be up to date, check master too.
1022
master = tree.branch.get_master_branch()
1023
if master is None or last_rev == master.last_revision():
1024
revno = tree.branch.revision_id_to_revno(last_rev)
1025
note("Tree is up to date at revision %d." % (revno,))
1027
conflicts = tree.update()
1028
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1029
note('Updated to revision %d.' % (revno,))
1030
if tree.get_parent_ids()[1:] != existing_pending_merges:
1031
note('Your local commits will now show as pending merges with '
1032
"'bzr status', and can be committed with 'bzr commit'.")
1041
class cmd_info(Command):
1042
"""Show information about a working tree, branch or repository.
1044
This command will show all known locations and formats associated to the
1045
tree, branch or repository. Statistical information is included with
1048
Branches and working trees will also report any missing revisions.
1050
takes_args = ['location?']
1051
takes_options = ['verbose']
1054
def run(self, location=None, verbose=False):
1055
from bzrlib.info import show_bzrdir_info
1056
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1060
class cmd_remove(Command):
1061
"""Make a file unversioned.
1063
This makes bzr stop tracking changes to a versioned file. It does
1064
not delete the working copy.
1066
You can specify one or more files, and/or --new. If you specify --new,
1067
only 'added' files will be removed. If you specify both, then new files
1068
in the specified directories will be removed. If the directories are
1069
also new, they will also be removed.
1071
takes_args = ['file*']
1072
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1074
encoding_type = 'replace'
1076
def run(self, file_list, verbose=False, new=False):
1077
tree, file_list = tree_files(file_list)
1079
if file_list is None:
1080
raise errors.BzrCommandError('Specify one or more files to'
1081
' remove, or use --new.')
1083
added = tree.changes_from(tree.basis_tree(),
1084
specific_files=file_list).added
1085
file_list = sorted([f[0] for f in added], reverse=True)
1086
if len(file_list) == 0:
1087
raise errors.BzrCommandError('No matching files.')
1088
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1091
class cmd_file_id(Command):
1092
"""Print file_id of a particular file or directory.
1094
The file_id is assigned when the file is first added and remains the
1095
same through all revisions where the file exists, even when it is
1100
takes_args = ['filename']
1103
def run(self, filename):
1104
tree, relpath = WorkingTree.open_containing(filename)
1105
i = tree.inventory.path2id(relpath)
1107
raise errors.NotVersionedError(filename)
1109
self.outf.write(i + '\n')
1112
class cmd_file_path(Command):
1113
"""Print path of file_ids to a file or directory.
1115
This prints one line for each directory down to the target,
1116
starting at the branch root.
1120
takes_args = ['filename']
1123
def run(self, filename):
1124
tree, relpath = WorkingTree.open_containing(filename)
1125
inv = tree.inventory
1126
fid = inv.path2id(relpath)
1128
raise errors.NotVersionedError(filename)
1129
for fip in inv.get_idpath(fid):
1130
self.outf.write(fip + '\n')
1133
class cmd_reconcile(Command):
1134
"""Reconcile bzr metadata in a branch.
1136
This can correct data mismatches that may have been caused by
1137
previous ghost operations or bzr upgrades. You should only
1138
need to run this command if 'bzr check' or a bzr developer
1139
advises you to run it.
1141
If a second branch is provided, cross-branch reconciliation is
1142
also attempted, which will check that data like the tree root
1143
id which was not present in very early bzr versions is represented
1144
correctly in both branches.
1146
At the same time it is run it may recompress data resulting in
1147
a potential saving in disk space or performance gain.
1149
The branch *MUST* be on a listable system such as local disk or sftp.
1151
takes_args = ['branch?']
1153
def run(self, branch="."):
1154
from bzrlib.reconcile import reconcile
1155
dir = bzrdir.BzrDir.open(branch)
1159
class cmd_revision_history(Command):
1160
"""Display the list of revision ids on a branch."""
1161
takes_args = ['location?']
1166
def run(self, location="."):
1167
branch = Branch.open_containing(location)[0]
1168
for revid in branch.revision_history():
1169
self.outf.write(revid)
1170
self.outf.write('\n')
1173
class cmd_ancestry(Command):
1174
"""List all revisions merged into this branch."""
1175
takes_args = ['location?']
1180
def run(self, location="."):
1182
wt = WorkingTree.open_containing(location)[0]
1183
except errors.NoWorkingTree:
1184
b = Branch.open(location)
1185
last_revision = b.last_revision()
1188
last_revision = wt.last_revision()
1190
revision_ids = b.repository.get_ancestry(last_revision)
1191
assert revision_ids[0] is None
1193
for revision_id in revision_ids:
1194
self.outf.write(revision_id + '\n')
1197
class cmd_init(Command):
1198
"""Make a directory into a versioned branch.
1200
Use this to create an empty branch, or before importing an
1203
If there is a repository in a parent directory of the location, then
1204
the history of the branch will be stored in the repository. Otherwise
1205
init creates a standalone branch which carries its own history in
1208
If there is already a branch at the location but it has no working tree,
1209
the tree can be populated with 'bzr checkout'.
1211
Recipe for importing a tree of files:
1216
bzr commit -m 'imported project'
1218
takes_args = ['location?']
1220
RegistryOption('format',
1221
help='Specify a format for this branch. '
1222
'See "help formats".',
1223
registry=bzrdir.format_registry,
1224
converter=bzrdir.format_registry.make_bzrdir,
1225
value_switches=True,
1226
title="Branch Format",
1229
def run(self, location=None, format=None):
1231
format = bzrdir.format_registry.make_bzrdir('default')
1232
if location is None:
1235
to_transport = transport.get_transport(location)
1237
# The path has to exist to initialize a
1238
# branch inside of it.
1239
# Just using os.mkdir, since I don't
1240
# believe that we want to create a bunch of
1241
# locations if the user supplies an extended path
1242
# TODO: create-prefix
1244
to_transport.mkdir('.')
1245
except errors.FileExists:
1249
existing_bzrdir = bzrdir.BzrDir.open(location)
1250
except errors.NotBranchError:
1251
# really a NotBzrDir error...
1252
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1254
from bzrlib.transport.local import LocalTransport
1255
if existing_bzrdir.has_branch():
1256
if (isinstance(to_transport, LocalTransport)
1257
and not existing_bzrdir.has_workingtree()):
1258
raise errors.BranchExistsWithoutWorkingTree(location)
1259
raise errors.AlreadyBranchError(location)
1261
existing_bzrdir.create_branch()
1262
existing_bzrdir.create_workingtree()
1265
class cmd_init_repository(Command):
1266
"""Create a shared repository to hold branches.
1268
New branches created under the repository directory will store their revisions
1269
in the repository, not in the branch directory, if the branch format supports
1275
bzr checkout --lightweight repo/trunk trunk-checkout
1279
takes_args = ["location"]
1280
takes_options = [RegistryOption('format',
1281
help='Specify a format for this repository. See'
1282
' "bzr help formats" for details',
1283
registry=bzrdir.format_registry,
1284
converter=bzrdir.format_registry.make_bzrdir,
1285
value_switches=True, title='Repository format'),
1287
help='Allows branches in repository to have'
1289
aliases = ["init-repo"]
1290
def run(self, location, format=None, trees=False):
1292
format = bzrdir.format_registry.make_bzrdir('default')
1294
if location is None:
1297
to_transport = transport.get_transport(location)
1299
to_transport.mkdir('.')
1300
except errors.FileExists:
1303
newdir = format.initialize_on_transport(to_transport)
1304
repo = newdir.create_repository(shared=True)
1305
repo.set_make_working_trees(trees)
1308
class cmd_diff(Command):
1309
"""Show differences in the working tree or between revisions.
1311
If files are listed, only the changes in those files are listed.
1312
Otherwise, all changes for the tree are listed.
1314
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1315
produces patches suitable for "patch -p1".
1319
Shows the difference in the working tree versus the last commit
1321
Difference between the working tree and revision 1
1323
Difference between revision 2 and revision 1
1324
bzr diff --diff-prefix old/:new/
1325
Same as 'bzr diff' but prefix paths with old/ and new/
1326
bzr diff bzr.mine bzr.dev
1327
Show the differences between the two working trees
1329
Show just the differences for 'foo.c'
1331
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1332
# or a graphical diff.
1334
# TODO: Python difflib is not exactly the same as unidiff; should
1335
# either fix it up or prefer to use an external diff.
1337
# TODO: Selected-file diff is inefficient and doesn't show you
1340
# TODO: This probably handles non-Unix newlines poorly.
1342
takes_args = ['file*']
1343
takes_options = ['revision', 'diff-options',
1344
Option('prefix', type=str,
1346
help='Set prefixes to added to old and new filenames, as '
1347
'two values separated by a colon.'),
1349
aliases = ['di', 'dif']
1350
encoding_type = 'exact'
1353
def run(self, revision=None, file_list=None, diff_options=None,
1355
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1357
if (prefix is None) or (prefix == '0'):
1365
old_label, new_label = prefix.split(":")
1367
raise BzrCommandError(
1368
"--prefix expects two values separated by a colon")
1370
if revision and len(revision) > 2:
1371
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1372
' one or two revision specifiers')
1375
tree1, file_list = internal_tree_files(file_list)
1379
except errors.FileInWrongBranch:
1380
if len(file_list) != 2:
1381
raise errors.BzrCommandError("Files are in different branches")
1383
tree1, file1 = WorkingTree.open_containing(file_list[0])
1384
tree2, file2 = WorkingTree.open_containing(file_list[1])
1385
if file1 != "" or file2 != "":
1386
# FIXME diff those two files. rbc 20051123
1387
raise errors.BzrCommandError("Files are in different branches")
1389
except errors.NotBranchError:
1390
if (revision is not None and len(revision) == 2
1391
and not revision[0].needs_branch()
1392
and not revision[1].needs_branch()):
1393
# If both revision specs include a branch, we can
1394
# diff them without needing a local working tree
1395
tree1, tree2 = None, None
1399
if tree2 is not None:
1400
if revision is not None:
1401
# FIXME: but there should be a clean way to diff between
1402
# non-default versions of two trees, it's not hard to do
1404
raise errors.BzrCommandError(
1405
"Sorry, diffing arbitrary revisions across branches "
1406
"is not implemented yet")
1407
return show_diff_trees(tree1, tree2, sys.stdout,
1408
specific_files=file_list,
1409
external_diff_options=diff_options,
1410
old_label=old_label, new_label=new_label)
1412
return diff_cmd_helper(tree1, file_list, diff_options,
1413
revision_specs=revision,
1414
old_label=old_label, new_label=new_label)
1417
class cmd_deleted(Command):
1418
"""List files deleted in the working tree.
1420
# TODO: Show files deleted since a previous revision, or
1421
# between two revisions.
1422
# TODO: Much more efficient way to do this: read in new
1423
# directories with readdir, rather than stating each one. Same
1424
# level of effort but possibly much less IO. (Or possibly not,
1425
# if the directories are very large...)
1426
takes_options = ['show-ids']
1429
def run(self, show_ids=False):
1430
tree = WorkingTree.open_containing(u'.')[0]
1431
old = tree.basis_tree()
1432
for path, ie in old.inventory.iter_entries():
1433
if not tree.has_id(ie.file_id):
1434
self.outf.write(path)
1436
self.outf.write(' ')
1437
self.outf.write(ie.file_id)
1438
self.outf.write('\n')
1441
class cmd_modified(Command):
1442
"""List files modified in working tree.
1444
See also: "bzr status".
1451
tree = WorkingTree.open_containing(u'.')[0]
1452
td = tree.changes_from(tree.basis_tree())
1453
for path, id, kind, text_modified, meta_modified in td.modified:
1454
self.outf.write(path + '\n')
1457
class cmd_added(Command):
1458
"""List files added in working tree.
1460
See also: "bzr status".
1467
wt = WorkingTree.open_containing(u'.')[0]
1468
basis_inv = wt.basis_tree().inventory
1471
if file_id in basis_inv:
1473
if inv.is_root(file_id) and len(basis_inv) == 0:
1475
path = inv.id2path(file_id)
1476
if not os.access(osutils.abspath(path), os.F_OK):
1478
self.outf.write(path + '\n')
1481
class cmd_root(Command):
1482
"""Show the tree root directory.
1484
The root is the nearest enclosing directory with a .bzr control
1486
takes_args = ['filename?']
1488
def run(self, filename=None):
1489
"""Print the branch root."""
1490
tree = WorkingTree.open_containing(filename)[0]
1491
self.outf.write(tree.basedir + '\n')
1494
class cmd_log(Command):
1495
"""Show log of a branch, file, or directory.
1497
By default show the log of the branch containing the working directory.
1499
To request a range of logs, you can use the command -r begin..end
1500
-r revision requests a specific revision, -r ..end or -r begin.. are
1506
bzr log -r -10.. http://server/branch
1509
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1511
takes_args = ['location?']
1512
takes_options = [Option('forward',
1513
help='show from oldest to newest'),
1517
help='show files changed in each revision'),
1518
'show-ids', 'revision',
1522
help='show revisions whose message matches this regexp',
1525
encoding_type = 'replace'
1528
def run(self, location=None, timezone='original',
1535
from bzrlib.log import show_log
1536
assert message is None or isinstance(message, basestring), \
1537
"invalid message argument %r" % message
1538
direction = (forward and 'forward') or 'reverse'
1543
# find the file id to log:
1545
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1549
tree = b.basis_tree()
1550
inv = tree.inventory
1551
file_id = inv.path2id(fp)
1553
raise errors.BzrCommandError(
1554
"Path does not have any revision history: %s" %
1558
# FIXME ? log the current subdir only RBC 20060203
1559
if revision is not None \
1560
and len(revision) > 0 and revision[0].get_branch():
1561
location = revision[0].get_branch()
1564
dir, relpath = bzrdir.BzrDir.open_containing(location)
1565
b = dir.open_branch()
1567
if revision is None:
1570
elif len(revision) == 1:
1571
rev1 = rev2 = revision[0].in_history(b).revno
1572
elif len(revision) == 2:
1573
if revision[1].get_branch() != revision[0].get_branch():
1574
# b is taken from revision[0].get_branch(), and
1575
# show_log will use its revision_history. Having
1576
# different branches will lead to weird behaviors.
1577
raise errors.BzrCommandError(
1578
"Log doesn't accept two revisions in different branches.")
1579
if revision[0].spec is None:
1580
# missing begin-range means first revision
1583
rev1 = revision[0].in_history(b).revno
1585
if revision[1].spec is None:
1586
# missing end-range means last known revision
1589
rev2 = revision[1].in_history(b).revno
1591
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1593
# By this point, the revision numbers are converted to the +ve
1594
# form if they were supplied in the -ve form, so we can do
1595
# this comparison in relative safety
1597
(rev2, rev1) = (rev1, rev2)
1599
if log_format is None:
1600
log_format = log.log_formatter_registry.get_default(b)
1602
lf = log_format(show_ids=show_ids, to_file=self.outf,
1603
show_timezone=timezone)
1609
direction=direction,
1610
start_revision=rev1,
1615
def get_log_format(long=False, short=False, line=False, default='long'):
1616
log_format = default
1620
log_format = 'short'
1626
class cmd_touching_revisions(Command):
1627
"""Return revision-ids which affected a particular file.
1629
A more user-friendly interface is "bzr log FILE".
1633
takes_args = ["filename"]
1636
def run(self, filename):
1637
tree, relpath = WorkingTree.open_containing(filename)
1639
inv = tree.read_working_inventory()
1640
file_id = inv.path2id(relpath)
1641
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1642
self.outf.write("%6d %s\n" % (revno, what))
1645
class cmd_ls(Command):
1646
"""List files in a tree.
1649
takes_args = ['path?']
1650
# TODO: Take a revision or remote path and list that tree instead.
1651
takes_options = ['verbose', 'revision',
1652
Option('non-recursive',
1653
help='don\'t recurse into sub-directories'),
1655
help='Print all paths from the root of the branch.'),
1656
Option('unknown', help='Print unknown files'),
1657
Option('versioned', help='Print versioned files'),
1658
Option('ignored', help='Print ignored files'),
1660
Option('null', help='Null separate the files'),
1664
def run(self, revision=None, verbose=False,
1665
non_recursive=False, from_root=False,
1666
unknown=False, versioned=False, ignored=False,
1667
null=False, kind=None, show_ids=False, path=None):
1669
if kind and kind not in ('file', 'directory', 'symlink'):
1670
raise errors.BzrCommandError('invalid kind specified')
1672
if verbose and null:
1673
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1674
all = not (unknown or versioned or ignored)
1676
selection = {'I':ignored, '?':unknown, 'V':versioned}
1683
raise errors.BzrCommandError('cannot specify both --from-root'
1687
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1693
if revision is not None:
1694
tree = branch.repository.revision_tree(
1695
revision[0].in_history(branch).rev_id)
1697
tree = branch.basis_tree()
1699
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1700
if fp.startswith(relpath):
1701
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1702
if non_recursive and '/' in fp:
1704
if not all and not selection[fc]:
1706
if kind is not None and fkind != kind:
1709
kindch = entry.kind_character()
1710
outstring = '%-8s %s%s' % (fc, fp, kindch)
1711
if show_ids and fid is not None:
1712
outstring = "%-50s %s" % (outstring, fid)
1713
self.outf.write(outstring + '\n')
1715
self.outf.write(fp + '\0')
1718
self.outf.write(fid)
1719
self.outf.write('\0')
1727
self.outf.write('%-50s %s\n' % (fp, my_id))
1729
self.outf.write(fp + '\n')
1732
class cmd_unknowns(Command):
1733
"""List unknown files.
1735
See also: "bzr ls --unknown".
1742
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1743
self.outf.write(osutils.quotefn(f) + '\n')
1746
class cmd_ignore(Command):
1747
"""Ignore specified files or patterns.
1749
To remove patterns from the ignore list, edit the .bzrignore file.
1751
Trailing slashes on patterns are ignored.
1752
If the pattern contains a slash or is a regular expression, it is compared
1753
to the whole path from the branch root. Otherwise, it is compared to only
1754
the last component of the path. To match a file only in the root
1755
directory, prepend './'.
1757
Ignore patterns specifying absolute paths are not allowed.
1759
Ignore patterns may include globbing wildcards such as:
1760
? - Matches any single character except '/'
1761
* - Matches 0 or more characters except '/'
1762
/**/ - Matches 0 or more directories in a path
1763
[a-z] - Matches a single character from within a group of characters
1765
Ignore patterns may also be Python regular expressions.
1766
Regular expression ignore patterns are identified by a 'RE:' prefix
1767
followed by the regular expression. Regular expression ignore patterns
1768
may not include named or numbered groups.
1770
Note: ignore patterns containing shell wildcards must be quoted from
1774
bzr ignore ./Makefile
1775
bzr ignore '*.class'
1776
bzr ignore 'lib/**/*.o'
1777
bzr ignore 'RE:lib/.*\.o'
1779
takes_args = ['name_pattern*']
1781
Option('old-default-rules',
1782
help='Out the ignore rules bzr < 0.9 always used.')
1785
def run(self, name_pattern_list=None, old_default_rules=None):
1786
from bzrlib.atomicfile import AtomicFile
1787
if old_default_rules is not None:
1788
# dump the rules and exit
1789
for pattern in ignores.OLD_DEFAULTS:
1792
if not name_pattern_list:
1793
raise errors.BzrCommandError("ignore requires at least one "
1794
"NAME_PATTERN or --old-default-rules")
1795
for name_pattern in name_pattern_list:
1796
if name_pattern[0] == '/':
1797
raise errors.BzrCommandError(
1798
"NAME_PATTERN should not be an absolute path")
1799
tree, relpath = WorkingTree.open_containing(u'.')
1800
ifn = tree.abspath('.bzrignore')
1801
if os.path.exists(ifn):
1804
igns = f.read().decode('utf-8')
1810
# TODO: If the file already uses crlf-style termination, maybe
1811
# we should use that for the newly added lines?
1813
if igns and igns[-1] != '\n':
1815
for name_pattern in name_pattern_list:
1816
igns += name_pattern.rstrip('/') + '\n'
1818
f = AtomicFile(ifn, 'wb')
1820
f.write(igns.encode('utf-8'))
1825
inv = tree.inventory
1826
if inv.path2id('.bzrignore'):
1827
mutter('.bzrignore is already versioned')
1829
mutter('need to make new .bzrignore file versioned')
1830
tree.add(['.bzrignore'])
1833
class cmd_ignored(Command):
1834
"""List ignored files and the patterns that matched them.
1836
See also: bzr ignore"""
1839
tree = WorkingTree.open_containing(u'.')[0]
1840
for path, file_class, kind, file_id, entry in tree.list_files():
1841
if file_class != 'I':
1843
## XXX: Slightly inefficient since this was already calculated
1844
pat = tree.is_ignored(path)
1845
print '%-50s %s' % (path, pat)
1848
class cmd_lookup_revision(Command):
1849
"""Lookup the revision-id from a revision-number
1852
bzr lookup-revision 33
1855
takes_args = ['revno']
1858
def run(self, revno):
1862
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1864
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1867
class cmd_export(Command):
1868
"""Export past revision to destination directory.
1870
If no revision is specified this exports the last committed revision.
1872
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1873
given, try to find the format with the extension. If no extension
1874
is found exports to a directory (equivalent to --format=dir).
1876
Root may be the top directory for tar, tgz and tbz2 formats. If none
1877
is given, the top directory will be the root name of the file.
1879
If branch is omitted then the branch containing the CWD will be used.
1881
Note: export of tree with non-ascii filenames to zip is not supported.
1883
Supported formats Autodetected by extension
1884
----------------- -------------------------
1887
tbz2 .tar.bz2, .tbz2
1891
takes_args = ['dest', 'branch?']
1892
takes_options = ['revision', 'format', 'root']
1893
def run(self, dest, branch=None, revision=None, format=None, root=None):
1894
from bzrlib.export import export
1897
tree = WorkingTree.open_containing(u'.')[0]
1900
b = Branch.open(branch)
1902
if revision is None:
1903
# should be tree.last_revision FIXME
1904
rev_id = b.last_revision()
1906
if len(revision) != 1:
1907
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1908
rev_id = revision[0].in_history(b).rev_id
1909
t = b.repository.revision_tree(rev_id)
1911
export(t, dest, format, root)
1912
except errors.NoSuchExportFormat, e:
1913
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1916
class cmd_cat(Command):
1917
"""Write a file's text from a previous revision."""
1919
takes_options = ['revision', 'name-from-revision']
1920
takes_args = ['filename']
1921
encoding_type = 'exact'
1924
def run(self, filename, revision=None, name_from_revision=False):
1925
if revision is not None and len(revision) != 1:
1926
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1931
tree, relpath = WorkingTree.open_containing(filename)
1933
except (errors.NotBranchError, errors.NotLocalUrl):
1936
if revision is not None and revision[0].get_branch() is not None:
1937
b = Branch.open(revision[0].get_branch())
1939
b, relpath = Branch.open_containing(filename)
1940
tree = b.basis_tree()
1941
if revision is None:
1942
revision_id = b.last_revision()
1944
revision_id = revision[0].in_history(b).rev_id
1946
cur_file_id = tree.path2id(relpath)
1947
rev_tree = b.repository.revision_tree(revision_id)
1948
old_file_id = rev_tree.path2id(relpath)
1950
if name_from_revision:
1951
if old_file_id is None:
1952
raise errors.BzrCommandError("%r is not present in revision %s"
1953
% (filename, revision_id))
1955
rev_tree.print_file(old_file_id)
1956
elif cur_file_id is not None:
1957
rev_tree.print_file(cur_file_id)
1958
elif old_file_id is not None:
1959
rev_tree.print_file(old_file_id)
1961
raise errors.BzrCommandError("%r is not present in revision %s" %
1962
(filename, revision_id))
1965
class cmd_local_time_offset(Command):
1966
"""Show the offset in seconds from GMT to local time."""
1970
print osutils.local_time_offset()
1974
class cmd_commit(Command):
1975
"""Commit changes into a new revision.
1977
If no arguments are given, the entire tree is committed.
1979
If selected files are specified, only changes to those files are
1980
committed. If a directory is specified then the directory and everything
1981
within it is committed.
1983
A selected-file commit may fail in some cases where the committed
1984
tree would be invalid, such as trying to commit a file in a
1985
newly-added directory that is not itself committed.
1987
# TODO: Run hooks on tree to-be-committed, and after commit.
1989
# TODO: Strict commit that fails if there are deleted files.
1990
# (what does "deleted files" mean ??)
1992
# TODO: Give better message for -s, --summary, used by tla people
1994
# XXX: verbose currently does nothing
1996
takes_args = ['selected*']
1997
takes_options = ['message', 'verbose',
1999
help='commit even if nothing has changed'),
2000
Option('file', type=str,
2003
help='file containing commit message'),
2005
help="refuse to commit if there are unknown "
2006
"files in the working tree."),
2008
help="perform a local only commit in a bound "
2009
"branch. Such commits are not pushed to "
2010
"the master branch until a normal commit "
2014
aliases = ['ci', 'checkin']
2016
def run(self, message=None, file=None, verbose=True, selected_list=None,
2017
unchanged=False, strict=False, local=False):
2018
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2019
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2021
from bzrlib.msgeditor import edit_commit_message, \
2022
make_commit_message_template
2024
# TODO: Need a blackbox test for invoking the external editor; may be
2025
# slightly problematic to run this cross-platform.
2027
# TODO: do more checks that the commit will succeed before
2028
# spending the user's valuable time typing a commit message.
2029
tree, selected_list = tree_files(selected_list)
2030
if selected_list == ['']:
2031
# workaround - commit of root of tree should be exactly the same
2032
# as just default commit in that tree, and succeed even though
2033
# selected-file merge commit is not done yet
2036
if local and not tree.branch.get_bound_location():
2037
raise errors.LocalRequiresBoundBranch()
2039
def get_message(commit_obj):
2040
"""Callback to get commit message"""
2041
my_message = message
2042
if my_message is None and not file:
2043
template = make_commit_message_template(tree, selected_list)
2044
my_message = edit_commit_message(template)
2045
if my_message is None:
2046
raise errors.BzrCommandError("please specify a commit"
2047
" message with either --message or --file")
2048
elif my_message and file:
2049
raise errors.BzrCommandError(
2050
"please specify either --message or --file")
2052
my_message = codecs.open(file, 'rt',
2053
bzrlib.user_encoding).read()
2054
if my_message == "":
2055
raise errors.BzrCommandError("empty commit message specified")
2059
reporter = ReportCommitToLog()
2061
reporter = NullCommitReporter()
2064
tree.commit(message_callback=get_message,
2065
specific_files=selected_list,
2066
allow_pointless=unchanged, strict=strict, local=local,
2068
except PointlessCommit:
2069
# FIXME: This should really happen before the file is read in;
2070
# perhaps prepare the commit; get the message; then actually commit
2071
raise errors.BzrCommandError("no changes to commit."
2072
" use --unchanged to commit anyhow")
2073
except ConflictsInTree:
2074
raise errors.BzrCommandError('Conflicts detected in working '
2075
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2077
except StrictCommitFailed:
2078
raise errors.BzrCommandError("Commit refused because there are"
2079
" unknown files in the working tree.")
2080
except errors.BoundBranchOutOfDate, e:
2081
raise errors.BzrCommandError(str(e) + "\n"
2082
'To commit to master branch, run update and then commit.\n'
2083
'You can also pass --local to commit to continue working '
2087
class cmd_check(Command):
2088
"""Validate consistency of branch history.
2090
This command checks various invariants about the branch storage to
2091
detect data corruption or bzr bugs.
2093
takes_args = ['branch?']
2094
takes_options = ['verbose']
2096
def run(self, branch=None, verbose=False):
2097
from bzrlib.check import check
2099
tree = WorkingTree.open_containing()[0]
2100
branch = tree.branch
2102
branch = Branch.open(branch)
2103
check(branch, verbose)
2106
class cmd_upgrade(Command):
2107
"""Upgrade branch storage to current format.
2109
The check command or bzr developers may sometimes advise you to run
2110
this command. When the default format has changed you may also be warned
2111
during other operations to upgrade.
2113
takes_args = ['url?']
2115
RegistryOption('format',
2116
help='Upgrade to a specific format. See "bzr help'
2117
' formats" for details',
2118
registry=bzrdir.format_registry,
2119
converter=bzrdir.format_registry.make_bzrdir,
2120
value_switches=True, title='Branch format'),
2124
def run(self, url='.', format=None):
2125
from bzrlib.upgrade import upgrade
2127
format = bzrdir.format_registry.make_bzrdir('default')
2128
upgrade(url, format)
2131
class cmd_whoami(Command):
2132
"""Show or set bzr user id.
2136
bzr whoami 'Frank Chu <fchu@example.com>'
2138
takes_options = [ Option('email',
2139
help='display email address only'),
2141
help='set identity for the current branch instead of '
2144
takes_args = ['name?']
2145
encoding_type = 'replace'
2148
def run(self, email=False, branch=False, name=None):
2150
# use branch if we're inside one; otherwise global config
2152
c = Branch.open_containing('.')[0].get_config()
2153
except errors.NotBranchError:
2154
c = config.GlobalConfig()
2156
self.outf.write(c.user_email() + '\n')
2158
self.outf.write(c.username() + '\n')
2161
# display a warning if an email address isn't included in the given name.
2163
config.extract_email_address(name)
2164
except errors.NoEmailInUsername, e:
2165
warning('"%s" does not seem to contain an email address. '
2166
'This is allowed, but not recommended.', name)
2168
# use global config unless --branch given
2170
c = Branch.open_containing('.')[0].get_config()
2172
c = config.GlobalConfig()
2173
c.set_user_option('email', name)
2176
class cmd_nick(Command):
2177
"""Print or set the branch nickname.
2179
If unset, the tree root directory name is used as the nickname
2180
To print the current nickname, execute with no argument.
2182
takes_args = ['nickname?']
2183
def run(self, nickname=None):
2184
branch = Branch.open_containing(u'.')[0]
2185
if nickname is None:
2186
self.printme(branch)
2188
branch.nick = nickname
2191
def printme(self, branch):
2195
class cmd_selftest(Command):
2196
"""Run internal test suite.
2198
This creates temporary test directories in the working directory, but not
2199
existing data is affected. These directories are deleted if the tests
2200
pass, or left behind to help in debugging if they fail and --keep-output
2203
If arguments are given, they are regular expressions that say which tests
2204
should run. Tests matching any expression are run, and other tests are
2207
Alternatively if --first is given, matching tests are run first and then
2208
all other tests are run. This is useful if you have been working in a
2209
particular area, but want to make sure nothing else was broken.
2211
If the global option '--no-plugins' is given, plugins are not loaded
2212
before running the selftests. This has two effects: features provided or
2213
modified by plugins will not be tested, and tests provided by plugins will
2218
run only tests relating to 'ignore'
2219
bzr --no-plugins selftest -v
2220
disable plugins and list tests as they're run
2222
# TODO: --list should give a list of all available tests
2224
# NB: this is used from the class without creating an instance, which is
2225
# why it does not have a self parameter.
2226
def get_transport_type(typestring):
2227
"""Parse and return a transport specifier."""
2228
if typestring == "sftp":
2229
from bzrlib.transport.sftp import SFTPAbsoluteServer
2230
return SFTPAbsoluteServer
2231
if typestring == "memory":
2232
from bzrlib.transport.memory import MemoryServer
2234
if typestring == "fakenfs":
2235
from bzrlib.transport.fakenfs import FakeNFSServer
2236
return FakeNFSServer
2237
msg = "No known transport type %s. Supported types are: sftp\n" %\
2239
raise errors.BzrCommandError(msg)
2242
takes_args = ['testspecs*']
2243
takes_options = ['verbose',
2244
Option('one', help='stop when one test fails'),
2245
Option('keep-output',
2246
help='keep output directories when tests fail'),
2248
help='Use a different transport by default '
2249
'throughout the test suite.',
2250
type=get_transport_type),
2251
Option('benchmark', help='run the bzr bencharks.'),
2252
Option('lsprof-timed',
2253
help='generate lsprof output for benchmarked'
2254
' sections of code.'),
2255
Option('cache-dir', type=str,
2256
help='a directory to cache intermediate'
2257
' benchmark steps'),
2258
Option('clean-output',
2259
help='clean temporary tests directories'
2260
' without running tests'),
2262
help='run all tests, but run specified tests first',
2265
encoding_type = 'replace'
2267
def run(self, testspecs_list=None, verbose=None, one=False,
2268
keep_output=False, transport=None, benchmark=None,
2269
lsprof_timed=None, cache_dir=None, clean_output=False,
2272
from bzrlib.tests import selftest
2273
import bzrlib.benchmarks as benchmarks
2274
from bzrlib.benchmarks import tree_creator
2277
from bzrlib.tests import clean_selftest_output
2278
clean_selftest_output()
2281
if cache_dir is not None:
2282
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2283
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2284
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2286
if testspecs_list is not None:
2287
pattern = '|'.join(testspecs_list)
2291
test_suite_factory = benchmarks.test_suite
2294
# TODO: should possibly lock the history file...
2295
benchfile = open(".perf_history", "at", buffering=1)
2297
test_suite_factory = None
2302
result = selftest(verbose=verbose,
2304
stop_on_failure=one,
2305
keep_output=keep_output,
2306
transport=transport,
2307
test_suite_factory=test_suite_factory,
2308
lsprof_timed=lsprof_timed,
2309
bench_history=benchfile,
2310
matching_tests_first=first,
2313
if benchfile is not None:
2316
info('tests passed')
2318
info('tests failed')
2319
return int(not result)
2322
class cmd_version(Command):
2323
"""Show version of bzr."""
2327
from bzrlib.version import show_version
2331
class cmd_rocks(Command):
2332
"""Statement of optimism."""
2338
print "it sure does!"
2341
class cmd_find_merge_base(Command):
2342
"""Find and print a base revision for merging two branches."""
2343
# TODO: Options to specify revisions on either side, as if
2344
# merging only part of the history.
2345
takes_args = ['branch', 'other']
2349
def run(self, branch, other):
2350
from bzrlib.revision import MultipleRevisionSources
2352
branch1 = Branch.open_containing(branch)[0]
2353
branch2 = Branch.open_containing(other)[0]
2355
last1 = branch1.last_revision()
2356
last2 = branch2.last_revision()
2358
source = MultipleRevisionSources(branch1.repository,
2361
base_rev_id = common_ancestor(last1, last2, source)
2363
print 'merge base is revision %s' % base_rev_id
2366
class cmd_merge(Command):
2367
"""Perform a three-way merge.
2369
The branch is the branch you will merge from. By default, it will merge
2370
the latest revision. If you specify a revision, that revision will be
2371
merged. If you specify two revisions, the first will be used as a BASE,
2372
and the second one as OTHER. Revision numbers are always relative to the
2375
By default, bzr will try to merge in all new work from the other
2376
branch, automatically determining an appropriate base. If this
2377
fails, you may need to give an explicit base.
2379
Merge will do its best to combine the changes in two branches, but there
2380
are some kinds of problems only a human can fix. When it encounters those,
2381
it will mark a conflict. A conflict means that you need to fix something,
2382
before you should commit.
2384
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2386
If there is no default branch set, the first merge will set it. After
2387
that, you can omit the branch to use the default. To change the
2388
default, use --remember. The value will only be saved if the remote
2389
location can be accessed.
2391
The results of the merge are placed into the destination working
2392
directory, where they can be reviewed (with bzr diff), tested, and then
2393
committed to record the result of the merge.
2397
To merge the latest revision from bzr.dev
2398
bzr merge ../bzr.dev
2400
To merge changes up to and including revision 82 from bzr.dev
2401
bzr merge -r 82 ../bzr.dev
2403
To merge the changes introduced by 82, without previous changes:
2404
bzr merge -r 81..82 ../bzr.dev
2406
merge refuses to run if there are any uncommitted changes, unless
2409
The following merge types are available:
2411
takes_args = ['branch?']
2412
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2413
Option('show-base', help="Show base revision text in "
2415
Option('uncommitted', help='Apply uncommitted changes'
2416
' from a working copy, instead of branch changes'),
2417
Option('pull', help='If the destination is already'
2418
' completely merged into the source, pull from the'
2419
' source rather than merging. When this happens,'
2420
' you do not need to commit the result.'),
2422
help='branch to push from, '
2423
'rather than the one containing the working directory',
2429
def run(self, branch=None, revision=None, force=False, merge_type=None,
2430
show_base=False, reprocess=False, remember=False,
2431
uncommitted=False, pull=False,
2434
if merge_type is None:
2435
merge_type = _mod_merge.Merge3Merger
2436
if directory is None: directory = u'.'
2437
tree = WorkingTree.open_containing(directory)[0]
2439
if branch is not None:
2441
reader = bundle.read_bundle_from_url(branch)
2442
except errors.NotABundle:
2443
pass # Continue on considering this url a Branch
2445
conflicts = merge_bundle(reader, tree, not force, merge_type,
2446
reprocess, show_base)
2452
if revision is None \
2453
or len(revision) < 1 or revision[0].needs_branch():
2454
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2456
if revision is None or len(revision) < 1:
2459
other = [branch, None]
2462
other = [branch, -1]
2463
other_branch, path = Branch.open_containing(branch)
2466
raise errors.BzrCommandError('Cannot use --uncommitted and'
2467
' --revision at the same time.')
2468
branch = revision[0].get_branch() or branch
2469
if len(revision) == 1:
2471
other_branch, path = Branch.open_containing(branch)
2472
revno = revision[0].in_history(other_branch).revno
2473
other = [branch, revno]
2475
assert len(revision) == 2
2476
if None in revision:
2477
raise errors.BzrCommandError(
2478
"Merge doesn't permit empty revision specifier.")
2479
base_branch, path = Branch.open_containing(branch)
2480
branch1 = revision[1].get_branch() or branch
2481
other_branch, path1 = Branch.open_containing(branch1)
2482
if revision[0].get_branch() is not None:
2483
# then path was obtained from it, and is None.
2486
base = [branch, revision[0].in_history(base_branch).revno]
2487
other = [branch1, revision[1].in_history(other_branch).revno]
2489
if tree.branch.get_parent() is None or remember:
2490
tree.branch.set_parent(other_branch.base)
2492
# pull tags now... it's a bit inconsistent to do it ahead of copying
2493
# the history but that's done inside the merge code
2494
_copy_tags_maybe(other_branch, tree.branch)
2497
interesting_files = [path]
2499
interesting_files = None
2500
pb = ui.ui_factory.nested_progress_bar()
2503
conflict_count = _merge_helper(
2504
other, base, check_clean=(not force),
2505
merge_type=merge_type,
2506
reprocess=reprocess,
2507
show_base=show_base,
2510
pb=pb, file_list=interesting_files)
2513
if conflict_count != 0:
2517
except errors.AmbiguousBase, e:
2518
m = ("sorry, bzr can't determine the right merge base yet\n"
2519
"candidates are:\n "
2520
+ "\n ".join(e.bases)
2522
"please specify an explicit base with -r,\n"
2523
"and (if you want) report this to the bzr developers\n")
2526
# TODO: move up to common parent; this isn't merge-specific anymore.
2527
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2528
"""Use tree.branch's parent if none was supplied.
2530
Report if the remembered location was used.
2532
if supplied_location is not None:
2533
return supplied_location
2534
stored_location = tree.branch.get_parent()
2535
mutter("%s", stored_location)
2536
if stored_location is None:
2537
raise errors.BzrCommandError("No location specified or remembered")
2538
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2539
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2540
return stored_location
2543
class cmd_remerge(Command):
2546
Use this if you want to try a different merge technique while resolving
2547
conflicts. Some merge techniques are better than others, and remerge
2548
lets you try different ones on different files.
2550
The options for remerge have the same meaning and defaults as the ones for
2551
merge. The difference is that remerge can (only) be run when there is a
2552
pending merge, and it lets you specify particular files.
2555
$ bzr remerge --show-base
2556
Re-do the merge of all conflicted files, and show the base text in
2557
conflict regions, in addition to the usual THIS and OTHER texts.
2559
$ bzr remerge --merge-type weave --reprocess foobar
2560
Re-do the merge of "foobar", using the weave merge algorithm, with
2561
additional processing to reduce the size of conflict regions.
2563
The following merge types are available:"""
2564
takes_args = ['file*']
2565
takes_options = ['merge-type', 'reprocess',
2566
Option('show-base', help="Show base revision text in "
2569
def run(self, file_list=None, merge_type=None, show_base=False,
2571
if merge_type is None:
2572
merge_type = _mod_merge.Merge3Merger
2573
tree, file_list = tree_files(file_list)
2576
parents = tree.get_parent_ids()
2577
if len(parents) != 2:
2578
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2579
" merges. Not cherrypicking or"
2581
repository = tree.branch.repository
2582
base_revision = common_ancestor(parents[0],
2583
parents[1], repository)
2584
base_tree = repository.revision_tree(base_revision)
2585
other_tree = repository.revision_tree(parents[1])
2586
interesting_ids = None
2588
conflicts = tree.conflicts()
2589
if file_list is not None:
2590
interesting_ids = set()
2591
for filename in file_list:
2592
file_id = tree.path2id(filename)
2594
raise errors.NotVersionedError(filename)
2595
interesting_ids.add(file_id)
2596
if tree.kind(file_id) != "directory":
2599
for name, ie in tree.inventory.iter_entries(file_id):
2600
interesting_ids.add(ie.file_id)
2601
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2603
# Remerge only supports resolving contents conflicts
2604
allowed_conflicts = ('text conflict', 'contents conflict')
2605
restore_files = [c.path for c in conflicts
2606
if c.typestring in allowed_conflicts]
2607
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2608
tree.set_conflicts(ConflictList(new_conflicts))
2609
if file_list is not None:
2610
restore_files = file_list
2611
for filename in restore_files:
2613
restore(tree.abspath(filename))
2614
except errors.NotConflicted:
2616
conflicts = _mod_merge.merge_inner(
2617
tree.branch, other_tree, base_tree,
2619
interesting_ids=interesting_ids,
2620
other_rev_id=parents[1],
2621
merge_type=merge_type,
2622
show_base=show_base,
2623
reprocess=reprocess)
2632
class cmd_revert(Command):
2633
"""Revert files to a previous revision.
2635
Giving a list of files will revert only those files. Otherwise, all files
2636
will be reverted. If the revision is not specified with '--revision', the
2637
last committed revision is used.
2639
To remove only some changes, without reverting to a prior version, use
2640
merge instead. For example, "merge . --r-2..-3" will remove the changes
2641
introduced by -2, without affecting the changes introduced by -1. Or
2642
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2644
By default, any files that have been manually changed will be backed up
2645
first. (Files changed only by merge are not backed up.) Backup files have
2646
'.~#~' appended to their name, where # is a number.
2648
When you provide files, you can use their current pathname or the pathname
2649
from the target revision. So you can use revert to "undelete" a file by
2650
name. If you name a directory, all the contents of that directory will be
2653
takes_options = ['revision', 'no-backup']
2654
takes_args = ['file*']
2655
aliases = ['merge-revert']
2657
def run(self, revision=None, no_backup=False, file_list=None):
2658
if file_list is not None:
2659
if len(file_list) == 0:
2660
raise errors.BzrCommandError("No files specified")
2664
tree, file_list = tree_files(file_list)
2665
if revision is None:
2666
# FIXME should be tree.last_revision
2667
rev_id = tree.last_revision()
2668
elif len(revision) != 1:
2669
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2671
rev_id = revision[0].in_history(tree.branch).rev_id
2672
pb = ui.ui_factory.nested_progress_bar()
2674
tree.revert(file_list,
2675
tree.branch.repository.revision_tree(rev_id),
2676
not no_backup, pb, report_changes=True)
2681
class cmd_assert_fail(Command):
2682
"""Test reporting of assertion failures"""
2683
# intended just for use in testing
2688
raise AssertionError("always fails")
2691
class cmd_help(Command):
2692
"""Show help on a command or other topic.
2694
For a list of all available commands, say 'bzr help commands'.
2696
takes_options = [Option('long', 'show help on all commands')]
2697
takes_args = ['topic?']
2698
aliases = ['?', '--help', '-?', '-h']
2701
def run(self, topic=None, long=False):
2703
if topic is None and long:
2705
bzrlib.help.help(topic)
2708
class cmd_shell_complete(Command):
2709
"""Show appropriate completions for context.
2711
For a list of all available commands, say 'bzr shell-complete'.
2713
takes_args = ['context?']
2718
def run(self, context=None):
2719
import shellcomplete
2720
shellcomplete.shellcomplete(context)
2723
class cmd_fetch(Command):
2724
"""Copy in history from another branch but don't merge it.
2726
This is an internal method used for pull and merge.
2729
takes_args = ['from_branch', 'to_branch']
2730
def run(self, from_branch, to_branch):
2731
from bzrlib.fetch import Fetcher
2732
from_b = Branch.open(from_branch)
2733
to_b = Branch.open(to_branch)
2734
Fetcher(to_b, from_b)
2737
class cmd_missing(Command):
2738
"""Show unmerged/unpulled revisions between two branches.
2740
OTHER_BRANCH may be local or remote.
2742
takes_args = ['other_branch?']
2743
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2745
'Display changes in the local branch only'),
2746
Option('theirs-only',
2747
'Display changes in the remote branch only'),
2752
encoding_type = 'replace'
2755
def run(self, other_branch=None, reverse=False, mine_only=False,
2756
theirs_only=False, log_format=None, long=False, short=False, line=False,
2757
show_ids=False, verbose=False):
2758
from bzrlib.missing import find_unmerged, iter_log_data
2759
from bzrlib.log import log_formatter
2760
local_branch = Branch.open_containing(u".")[0]
2761
parent = local_branch.get_parent()
2762
if other_branch is None:
2763
other_branch = parent
2764
if other_branch is None:
2765
raise errors.BzrCommandError("No peer location known or specified.")
2766
display_url = urlutils.unescape_for_display(parent,
2768
print "Using last location: " + display_url
2770
remote_branch = Branch.open(other_branch)
2771
if remote_branch.base == local_branch.base:
2772
remote_branch = local_branch
2773
local_branch.lock_read()
2775
remote_branch.lock_read()
2777
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2778
if (log_format is None):
2779
log_format = log.log_formatter_registry.get_default(
2781
lf = log_format(to_file=self.outf,
2783
show_timezone='original')
2784
if reverse is False:
2785
local_extra.reverse()
2786
remote_extra.reverse()
2787
if local_extra and not theirs_only:
2788
print "You have %d extra revision(s):" % len(local_extra)
2789
for data in iter_log_data(local_extra, local_branch.repository,
2792
printed_local = True
2794
printed_local = False
2795
if remote_extra and not mine_only:
2796
if printed_local is True:
2798
print "You are missing %d revision(s):" % len(remote_extra)
2799
for data in iter_log_data(remote_extra, remote_branch.repository,
2802
if not remote_extra and not local_extra:
2804
print "Branches are up to date."
2808
remote_branch.unlock()
2810
local_branch.unlock()
2811
if not status_code and parent is None and other_branch is not None:
2812
local_branch.lock_write()
2814
# handle race conditions - a parent might be set while we run.
2815
if local_branch.get_parent() is None:
2816
local_branch.set_parent(remote_branch.base)
2818
local_branch.unlock()
2822
class cmd_plugins(Command):
2827
import bzrlib.plugin
2828
from inspect import getdoc
2829
for name, plugin in bzrlib.plugin.all_plugins().items():
2830
if getattr(plugin, '__path__', None) is not None:
2831
print plugin.__path__[0]
2832
elif getattr(plugin, '__file__', None) is not None:
2833
print plugin.__file__
2839
print '\t', d.split('\n')[0]
2842
class cmd_testament(Command):
2843
"""Show testament (signing-form) of a revision."""
2844
takes_options = ['revision',
2845
Option('long', help='Produce long-format testament'),
2846
Option('strict', help='Produce a strict-format'
2848
takes_args = ['branch?']
2850
def run(self, branch=u'.', revision=None, long=False, strict=False):
2851
from bzrlib.testament import Testament, StrictTestament
2853
testament_class = StrictTestament
2855
testament_class = Testament
2856
b = WorkingTree.open_containing(branch)[0].branch
2859
if revision is None:
2860
rev_id = b.last_revision()
2862
rev_id = revision[0].in_history(b).rev_id
2863
t = testament_class.from_revision(b.repository, rev_id)
2865
sys.stdout.writelines(t.as_text_lines())
2867
sys.stdout.write(t.as_short_text())
2872
class cmd_annotate(Command):
2873
"""Show the origin of each line in a file.
2875
This prints out the given file with an annotation on the left side
2876
indicating which revision, author and date introduced the change.
2878
If the origin is the same for a run of consecutive lines, it is
2879
shown only at the top, unless the --all option is given.
2881
# TODO: annotate directories; showing when each file was last changed
2882
# TODO: if the working copy is modified, show annotations on that
2883
# with new uncommitted lines marked
2884
aliases = ['ann', 'blame', 'praise']
2885
takes_args = ['filename']
2886
takes_options = [Option('all', help='show annotations on all lines'),
2887
Option('long', help='show date in annotations'),
2893
def run(self, filename, all=False, long=False, revision=None,
2895
from bzrlib.annotate import annotate_file
2896
tree, relpath = WorkingTree.open_containing(filename)
2897
branch = tree.branch
2900
if revision is None:
2901
revision_id = branch.last_revision()
2902
elif len(revision) != 1:
2903
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2905
revision_id = revision[0].in_history(branch).rev_id
2906
file_id = tree.inventory.path2id(relpath)
2907
tree = branch.repository.revision_tree(revision_id)
2908
file_version = tree.inventory[file_id].revision
2909
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2915
class cmd_re_sign(Command):
2916
"""Create a digital signature for an existing revision."""
2917
# TODO be able to replace existing ones.
2919
hidden = True # is this right ?
2920
takes_args = ['revision_id*']
2921
takes_options = ['revision']
2923
def run(self, revision_id_list=None, revision=None):
2924
import bzrlib.gpg as gpg
2925
if revision_id_list is not None and revision is not None:
2926
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2927
if revision_id_list is None and revision is None:
2928
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2929
b = WorkingTree.open_containing(u'.')[0].branch
2930
gpg_strategy = gpg.GPGStrategy(b.get_config())
2931
if revision_id_list is not None:
2932
for revision_id in revision_id_list:
2933
b.repository.sign_revision(revision_id, gpg_strategy)
2934
elif revision is not None:
2935
if len(revision) == 1:
2936
revno, rev_id = revision[0].in_history(b)
2937
b.repository.sign_revision(rev_id, gpg_strategy)
2938
elif len(revision) == 2:
2939
# are they both on rh- if so we can walk between them
2940
# might be nice to have a range helper for arbitrary
2941
# revision paths. hmm.
2942
from_revno, from_revid = revision[0].in_history(b)
2943
to_revno, to_revid = revision[1].in_history(b)
2944
if to_revid is None:
2945
to_revno = b.revno()
2946
if from_revno is None or to_revno is None:
2947
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2948
for revno in range(from_revno, to_revno + 1):
2949
b.repository.sign_revision(b.get_rev_id(revno),
2952
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2955
class cmd_bind(Command):
2956
"""Convert the current branch into a checkout of the supplied branch.
2958
Once converted into a checkout, commits must succeed on the master branch
2959
before they will be applied to the local branch.
2961
See "help checkouts" for more information on checkouts.
2964
takes_args = ['location']
2967
def run(self, location=None):
2968
b, relpath = Branch.open_containing(u'.')
2969
b_other = Branch.open(location)
2972
except errors.DivergedBranches:
2973
raise errors.BzrCommandError('These branches have diverged.'
2974
' Try merging, and then bind again.')
2977
class cmd_unbind(Command):
2978
"""Convert the current checkout into a regular branch.
2980
After unbinding, the local branch is considered independent and subsequent
2981
commits will be local only.
2983
See "help checkouts" for more information on checkouts.
2990
b, relpath = Branch.open_containing(u'.')
2992
raise errors.BzrCommandError('Local branch is not bound')
2995
class cmd_uncommit(Command):
2996
"""Remove the last committed revision.
2998
--verbose will print out what is being removed.
2999
--dry-run will go through all the motions, but not actually
3002
In the future, uncommit will create a revision bundle, which can then
3006
# TODO: jam 20060108 Add an option to allow uncommit to remove
3007
# unreferenced information in 'branch-as-repository' branches.
3008
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3009
# information in shared branches as well.
3010
takes_options = ['verbose', 'revision',
3011
Option('dry-run', help='Don\'t actually make changes'),
3012
Option('force', help='Say yes to all questions.')]
3013
takes_args = ['location?']
3016
def run(self, location=None,
3017
dry_run=False, verbose=False,
3018
revision=None, force=False):
3019
from bzrlib.log import log_formatter, show_log
3021
from bzrlib.uncommit import uncommit
3023
if location is None:
3025
control, relpath = bzrdir.BzrDir.open_containing(location)
3027
tree = control.open_workingtree()
3029
except (errors.NoWorkingTree, errors.NotLocalUrl):
3031
b = control.open_branch()
3034
if revision is None:
3037
# 'bzr uncommit -r 10' actually means uncommit
3038
# so that the final tree is at revno 10.
3039
# but bzrlib.uncommit.uncommit() actually uncommits
3040
# the revisions that are supplied.
3041
# So we need to offset it by one
3042
revno = revision[0].in_history(b).revno+1
3044
if revno <= b.revno():
3045
rev_id = b.get_rev_id(revno)
3047
self.outf.write('No revisions to uncommit.\n')
3050
lf = log_formatter('short',
3052
show_timezone='original')
3057
direction='forward',
3058
start_revision=revno,
3059
end_revision=b.revno())
3062
print 'Dry-run, pretending to remove the above revisions.'
3064
val = raw_input('Press <enter> to continue')
3066
print 'The above revision(s) will be removed.'
3068
val = raw_input('Are you sure [y/N]? ')
3069
if val.lower() not in ('y', 'yes'):
3073
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3077
class cmd_break_lock(Command):
3078
"""Break a dead lock on a repository, branch or working directory.
3080
CAUTION: Locks should only be broken when you are sure that the process
3081
holding the lock has been stopped.
3083
You can get information on what locks are open via the 'bzr info' command.
3088
takes_args = ['location?']
3090
def run(self, location=None, show=False):
3091
if location is None:
3093
control, relpath = bzrdir.BzrDir.open_containing(location)
3095
control.break_lock()
3096
except NotImplementedError:
3100
class cmd_wait_until_signalled(Command):
3101
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3103
This just prints a line to signal when it is ready, then blocks on stdin.
3109
sys.stdout.write("running\n")
3111
sys.stdin.readline()
3114
class cmd_serve(Command):
3115
"""Run the bzr server."""
3117
aliases = ['server']
3121
help='serve on stdin/out for use from inetd or sshd'),
3123
help='listen for connections on nominated port of the form '
3124
'[hostname:]portnumber. Passing 0 as the port number will '
3125
'result in a dynamically allocated port.',
3128
help='serve contents of directory',
3130
Option('allow-writes',
3131
help='By default the server is a readonly server. Supplying '
3132
'--allow-writes enables write access to the contents of '
3133
'the served directory and below. '
3137
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3138
from bzrlib.transport import smart
3139
from bzrlib.transport import get_transport
3140
if directory is None:
3141
directory = os.getcwd()
3142
url = urlutils.local_path_to_url(directory)
3143
if not allow_writes:
3144
url = 'readonly+' + url
3145
t = get_transport(url)
3147
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3148
elif port is not None:
3150
host, port = port.split(':')
3153
server = smart.SmartTCPServer(t, host=host, port=int(port))
3154
print 'listening on port: ', server.port
3157
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3161
class cmd_tag(Command):
3162
"""Create a tag naming a revision.
3164
Tags give human-meaningful names to revisions. Commands that take a -r
3165
(--revision) option can be given -rtag:X, where X is any previously
3168
Tags are stored in the repository, and apply to all branches stored
3169
in the repository. Tags are copied from one branch to another along
3170
when you branch, push, pull or merge.
3173
takes_args = ['tag_name']
3176
help='branch in which to place the tag',
3183
def run(self, tag_name, directory='.', revision=None):
3184
branch, relpath = Branch.open_containing(directory)
3186
if len(revision) != 1:
3187
raise errors.BzrCommandError(
3188
"Tags can only be placed on a single revision, "
3190
revision_id = revision[0].in_history(branch).rev_id
3192
revision_id = branch.last_revision()
3193
branch.tags.set_tag(tag_name, revision_id)
3194
self.outf.write('created tag %s' % tag_name)
3197
# command-line interpretation helper for merge-related commands
3198
def _merge_helper(other_revision, base_revision,
3199
check_clean=True, ignore_zero=False,
3200
this_dir=None, backup_files=False,
3202
file_list=None, show_base=False, reprocess=False,
3204
pb=DummyProgress()):
3205
"""Merge changes into a tree.
3208
list(path, revno) Base for three-way merge.
3209
If [None, None] then a base will be automatically determined.
3211
list(path, revno) Other revision for three-way merge.
3213
Directory to merge changes into; '.' by default.
3215
If true, this_dir must have no uncommitted changes before the
3217
ignore_zero - If true, suppress the "zero conflicts" message when
3218
there are no conflicts; should be set when doing something we expect
3219
to complete perfectly.
3220
file_list - If supplied, merge only changes to selected files.
3222
All available ancestors of other_revision and base_revision are
3223
automatically pulled into the branch.
3225
The revno may be -1 to indicate the last revision on the branch, which is
3228
This function is intended for use from the command line; programmatic
3229
clients might prefer to call merge.merge_inner(), which has less magic
3232
# Loading it late, so that we don't always have to import bzrlib.merge
3233
if merge_type is None:
3234
merge_type = _mod_merge.Merge3Merger
3235
if this_dir is None:
3237
this_tree = WorkingTree.open_containing(this_dir)[0]
3238
if show_base and not merge_type is _mod_merge.Merge3Merger:
3239
raise errors.BzrCommandError("Show-base is not supported for this merge"
3240
" type. %s" % merge_type)
3241
if reprocess and not merge_type.supports_reprocess:
3242
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3243
" type %s." % merge_type)
3244
if reprocess and show_base:
3245
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3247
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3249
merger.pp = ProgressPhase("Merge phase", 5, pb)
3250
merger.pp.next_phase()
3251
merger.check_basis(check_clean)
3252
merger.set_other(other_revision)
3253
merger.pp.next_phase()
3254
merger.set_base(base_revision)
3255
if merger.base_rev_id == merger.other_rev_id:
3256
note('Nothing to do.')
3258
if file_list is None:
3259
if pull and merger.base_rev_id == merger.this_rev_id:
3260
count = merger.this_tree.pull(merger.this_branch,
3261
False, merger.other_rev_id)
3262
note('%d revision(s) pulled.' % (count,))
3264
merger.backup_files = backup_files
3265
merger.merge_type = merge_type
3266
merger.set_interesting_files(file_list)
3267
merger.show_base = show_base
3268
merger.reprocess = reprocess
3269
conflicts = merger.do_merge()
3270
if file_list is None:
3271
merger.set_pending()
3278
merge = _merge_helper
3281
# these get imported and then picked up by the scan for cmd_*
3282
# TODO: Some more consistent way to split command definitions across files;
3283
# we do need to load at least some information about them to know of
3284
# aliases. ideally we would avoid loading the implementation until the
3285
# details were needed.
3286
from bzrlib.cmd_version_info import cmd_version_info
3287
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3288
from bzrlib.bundle.commands import cmd_bundle_revisions
3289
from bzrlib.sign_my_commits import cmd_sign_my_commits
3290
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3291
cmd_weave_plan_merge, cmd_weave_merge_text