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(), """
45
from bzrlib.branch import Branch
46
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
47
from bzrlib.conflicts import ConflictList
48
from bzrlib.revision import common_ancestor
49
from bzrlib.revisionspec import RevisionSpec
50
from bzrlib.workingtree import WorkingTree
53
from bzrlib.commands import Command, display_command
54
from bzrlib.option import Option
55
from bzrlib.progress import DummyProgress, ProgressPhase
56
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
59
def tree_files(file_list, default_branch=u'.'):
61
return internal_tree_files(file_list, default_branch)
62
except errors.FileInWrongBranch, e:
63
raise errors.BzrCommandError("%s is not in the same branch as %s" %
64
(e.path, file_list[0]))
67
# XXX: Bad function name; should possibly also be a class method of
68
# WorkingTree rather than a function.
69
def internal_tree_files(file_list, default_branch=u'.'):
70
"""Convert command-line paths to a WorkingTree and relative paths.
72
This is typically used for command-line processors that take one or
73
more filenames, and infer the workingtree that contains them.
75
The filenames given are not required to exist.
77
:param file_list: Filenames to convert.
79
:param default_branch: Fallback tree path to use if file_list is empty or
82
:return: workingtree, [relative_paths]
84
if file_list is None or len(file_list) == 0:
85
return WorkingTree.open_containing(default_branch)[0], file_list
86
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
88
for filename in file_list:
90
new_list.append(tree.relpath(osutils.dereference_path(filename)))
91
except errors.PathNotChild:
92
raise errors.FileInWrongBranch(tree.branch, filename)
96
def get_format_type(typestring):
97
"""Parse and return a format specifier."""
98
# Have to use BzrDirMetaFormat1 directly, so that
99
# RepositoryFormat.set_default_format works
100
if typestring == "default":
101
return bzrdir.BzrDirMetaFormat1()
103
return bzrdir.format_registry.make_bzrdir(typestring)
105
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
106
raise errors.BzrCommandError(msg)
109
# TODO: Make sure no commands unconditionally use the working directory as a
110
# branch. If a filename argument is used, the first of them should be used to
111
# specify the branch. (Perhaps this can be factored out into some kind of
112
# Argument class, representing a file in a branch, where the first occurrence
115
class cmd_status(Command):
116
"""Display status summary.
118
This reports on versioned and unknown files, reporting them
119
grouped by state. Possible states are:
122
Versioned in the working copy but not in the previous revision.
125
Versioned in the previous revision but removed or deleted
129
Path of this file changed from the previous revision;
130
the text may also have changed. This includes files whose
131
parent directory was renamed.
134
Text has changed since the previous revision.
137
Not versioned and not matching an ignore pattern.
139
To see ignored files use 'bzr ignored'. For details in the
140
changes to file texts, use 'bzr diff'.
142
--short gives a one character status flag for each item, similar
143
to the SVN's status command.
145
If no arguments are specified, the status of the entire working
146
directory is shown. Otherwise, only the status of the specified
147
files or directories is reported. If a directory is given, status
148
is reported for everything inside that directory.
150
If a revision argument is given, the status is calculated against
151
that revision, or between two revisions if two are provided.
154
# TODO: --no-recurse, --recurse options
156
takes_args = ['file*']
157
takes_options = ['show-ids', 'revision', 'short']
158
aliases = ['st', 'stat']
160
encoding_type = 'replace'
163
def run(self, show_ids=False, file_list=None, revision=None, short=False):
164
from bzrlib.status import show_tree_status
166
tree, file_list = tree_files(file_list)
168
show_tree_status(tree, show_ids=show_ids,
169
specific_files=file_list, revision=revision,
174
class cmd_cat_revision(Command):
175
"""Write out metadata for a revision.
177
The revision to print can either be specified by a specific
178
revision identifier, or you can use --revision.
182
takes_args = ['revision_id?']
183
takes_options = ['revision']
184
# cat-revision is more for frontends so should be exact
188
def run(self, revision_id=None, revision=None):
190
if revision_id is not None and revision is not None:
191
raise errors.BzrCommandError('You can only supply one of'
192
' revision_id or --revision')
193
if revision_id is None and revision is None:
194
raise errors.BzrCommandError('You must supply either'
195
' --revision or a revision_id')
196
b = WorkingTree.open_containing(u'.')[0].branch
198
# TODO: jam 20060112 should cat-revision always output utf-8?
199
if revision_id is not None:
200
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
201
elif revision is not None:
204
raise errors.BzrCommandError('You cannot specify a NULL'
206
revno, rev_id = rev.in_history(b)
207
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
210
class cmd_remove_tree(Command):
211
"""Remove the working tree from a given branch/checkout.
213
Since a lightweight checkout is little more than a working tree
214
this will refuse to run against one.
219
takes_args = ['location?']
221
def run(self, location='.'):
222
d = bzrdir.BzrDir.open(location)
225
working = d.open_workingtree()
226
except errors.NoWorkingTree:
227
raise errors.BzrCommandError("No working tree to remove")
228
except errors.NotLocalUrl:
229
raise errors.BzrCommandError("You cannot remove the working tree of a "
232
working_path = working.bzrdir.root_transport.base
233
branch_path = working.branch.bzrdir.root_transport.base
234
if working_path != branch_path:
235
raise errors.BzrCommandError("You cannot remove the working tree from "
236
"a lightweight checkout")
238
d.destroy_workingtree()
241
class cmd_revno(Command):
242
"""Show current revision number.
244
This is equal to the number of revisions on this branch.
247
takes_args = ['location?']
250
def run(self, location=u'.'):
251
self.outf.write(str(Branch.open_containing(location)[0].revno()))
252
self.outf.write('\n')
255
class cmd_revision_info(Command):
256
"""Show revision number and revision id for a given revision identifier.
259
takes_args = ['revision_info*']
260
takes_options = ['revision']
263
def run(self, revision=None, revision_info_list=[]):
266
if revision is not None:
267
revs.extend(revision)
268
if revision_info_list is not None:
269
for rev in revision_info_list:
270
revs.append(RevisionSpec.from_string(rev))
272
raise errors.BzrCommandError('You must supply a revision identifier')
274
b = WorkingTree.open_containing(u'.')[0].branch
277
revinfo = rev.in_history(b)
278
if revinfo.revno is None:
279
print ' %s' % revinfo.rev_id
281
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
284
class cmd_add(Command):
285
"""Add specified files or directories.
287
In non-recursive mode, all the named items are added, regardless
288
of whether they were previously ignored. A warning is given if
289
any of the named files are already versioned.
291
In recursive mode (the default), files are treated the same way
292
but the behaviour for directories is different. Directories that
293
are already versioned do not give a warning. All directories,
294
whether already versioned or not, are searched for files or
295
subdirectories that are neither versioned or ignored, and these
296
are added. This search proceeds recursively into versioned
297
directories. If no names are given '.' is assumed.
299
Therefore simply saying 'bzr add' will version all files that
300
are currently unknown.
302
Adding a file whose parent directory is not versioned will
303
implicitly add the parent, and so on up to the root. This means
304
you should never need to explicitly add a directory, they'll just
305
get added when you add a file in the directory.
307
--dry-run will show which files would be added, but not actually
310
--file-ids-from will try to use the file ids from the supplied path.
311
It looks up ids trying to find a matching parent directory with the
312
same filename, and then by pure path.
314
takes_args = ['file*']
315
takes_options = ['no-recurse', 'dry-run', 'verbose',
316
Option('file-ids-from', type=unicode,
317
help='Lookup file ids from here')]
318
encoding_type = 'replace'
320
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
324
if file_ids_from is not None:
326
base_tree, base_path = WorkingTree.open_containing(
328
except errors.NoWorkingTree:
329
base_branch, base_path = Branch.open_containing(
331
base_tree = base_branch.basis_tree()
333
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
334
to_file=self.outf, should_print=(not is_quiet()))
336
action = bzrlib.add.AddAction(to_file=self.outf,
337
should_print=(not is_quiet()))
339
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
340
action=action, save=not dry_run)
343
for glob in sorted(ignored.keys()):
344
for path in ignored[glob]:
345
self.outf.write("ignored %s matching \"%s\"\n"
349
for glob, paths in ignored.items():
350
match_len += len(paths)
351
self.outf.write("ignored %d file(s).\n" % match_len)
352
self.outf.write("If you wish to add some of these files,"
353
" please add them by name.\n")
356
class cmd_mkdir(Command):
357
"""Create a new versioned directory.
359
This is equivalent to creating the directory and then adding it.
362
takes_args = ['dir+']
363
encoding_type = 'replace'
365
def run(self, dir_list):
368
wt, dd = WorkingTree.open_containing(d)
370
self.outf.write('added %s\n' % d)
373
class cmd_relpath(Command):
374
"""Show path of a file relative to root"""
376
takes_args = ['filename']
380
def run(self, filename):
381
# TODO: jam 20050106 Can relpath return a munged path if
382
# sys.stdout encoding cannot represent it?
383
tree, relpath = WorkingTree.open_containing(filename)
384
self.outf.write(relpath)
385
self.outf.write('\n')
388
class cmd_inventory(Command):
389
"""Show inventory of the current working copy or a revision.
391
It is possible to limit the output to a particular entry
392
type using the --kind option. For example: --kind file.
394
It is also possible to restrict the list of files to a specific
395
set. For example: bzr inventory --show-ids this/file
398
takes_options = ['revision', 'show-ids', 'kind']
399
takes_args = ['file*']
402
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
403
if kind and kind not in ['file', 'directory', 'symlink']:
404
raise errors.BzrCommandError('invalid kind specified')
406
work_tree, file_list = tree_files(file_list)
408
if revision is not None:
409
if len(revision) > 1:
410
raise errors.BzrCommandError('bzr inventory --revision takes'
411
' exactly one revision identifier')
412
revision_id = revision[0].in_history(work_tree.branch).rev_id
413
tree = work_tree.branch.repository.revision_tree(revision_id)
415
# We include work_tree as well as 'tree' here
416
# So that doing '-r 10 path/foo' will lookup whatever file
417
# exists now at 'path/foo' even if it has been renamed, as
418
# well as whatever files existed in revision 10 at path/foo
419
trees = [tree, work_tree]
424
if file_list is not None:
425
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
426
require_versioned=True)
427
# find_ids_across_trees may include some paths that don't
429
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
430
for file_id in file_ids if file_id in tree)
432
entries = tree.inventory.entries()
434
for path, entry in entries:
435
if kind and kind != entry.kind:
438
self.outf.write('%-50s %s\n' % (path, entry.file_id))
440
self.outf.write(path)
441
self.outf.write('\n')
444
class cmd_mv(Command):
445
"""Move or rename a file.
448
bzr mv OLDNAME NEWNAME
449
bzr mv SOURCE... DESTINATION
451
If the last argument is a versioned directory, all the other names
452
are moved into it. Otherwise, there must be exactly two arguments
453
and the file is changed to a new name, which must not already exist.
455
Files cannot be moved between branches.
458
takes_args = ['names*']
459
aliases = ['move', 'rename']
460
encoding_type = 'replace'
462
def run(self, names_list):
463
if names_list is None:
466
if len(names_list) < 2:
467
raise errors.BzrCommandError("missing file argument")
468
tree, rel_names = tree_files(names_list)
470
if os.path.isdir(names_list[-1]):
471
# move into existing directory
472
for pair in tree.move(rel_names[:-1], rel_names[-1]):
473
self.outf.write("%s => %s\n" % pair)
475
if len(names_list) != 2:
476
raise errors.BzrCommandError('to mv multiple files the destination '
477
'must be a versioned directory')
478
tree.rename_one(rel_names[0], rel_names[1])
479
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
482
class cmd_pull(Command):
483
"""Turn this branch into a mirror of another branch.
485
This command only works on branches that have not diverged. Branches are
486
considered diverged if the destination branch's most recent commit is one
487
that has not been merged (directly or indirectly) into the parent.
489
If branches have diverged, you can use 'bzr merge' to integrate the changes
490
from one into the other. Once one branch has merged, the other should
491
be able to pull it again.
493
If you want to forget your local changes and just update your branch to
494
match the remote one, use pull --overwrite.
496
If there is no default location set, the first pull will set it. After
497
that, you can omit the location to use the default. To change the
498
default, use --remember. The value will only be saved if the remote
499
location can be accessed.
502
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
504
help='branch to pull into, '
505
'rather than the one containing the working directory',
510
takes_args = ['location?']
511
encoding_type = 'replace'
513
def run(self, location=None, remember=False, overwrite=False,
514
revision=None, verbose=False,
516
# FIXME: too much stuff is in the command class
517
if directory is None:
520
tree_to = WorkingTree.open_containing(directory)[0]
521
branch_to = tree_to.branch
522
except errors.NoWorkingTree:
524
branch_to = Branch.open_containing(directory)[0]
527
if location is not None:
529
reader = bundle.read_bundle_from_url(location)
530
except errors.NotABundle:
531
pass # Continue on considering this url a Branch
533
stored_loc = branch_to.get_parent()
535
if stored_loc is None:
536
raise errors.BzrCommandError("No pull location known or"
539
display_url = urlutils.unescape_for_display(stored_loc,
541
self.outf.write("Using saved location: %s\n" % display_url)
542
location = stored_loc
544
if reader is not None:
545
install_bundle(branch_to.repository, reader)
546
branch_from = branch_to
548
branch_from = Branch.open(location)
550
if branch_to.get_parent() is None or remember:
551
branch_to.set_parent(branch_from.base)
555
if reader is not None:
556
rev_id = reader.target
557
elif len(revision) == 1:
558
rev_id = revision[0].in_history(branch_from).rev_id
560
raise errors.BzrCommandError('bzr pull --revision takes one value.')
562
old_rh = branch_to.revision_history()
563
if tree_to is not None:
564
count = tree_to.pull(branch_from, overwrite, rev_id)
566
count = branch_to.pull(branch_from, overwrite, rev_id)
567
_copy_tags_maybe(branch_from, branch_to)
568
note('%d revision(s) pulled.' % (count,))
571
new_rh = branch_to.revision_history()
574
from bzrlib.log import show_changed_revisions
575
show_changed_revisions(branch_to, old_rh, new_rh,
579
class cmd_push(Command):
580
"""Update a mirror of this branch.
582
The target branch will not have its working tree populated because this
583
is both expensive, and is not supported on remote file systems.
585
Some smart servers or protocols *may* put the working tree in place in
588
This command only works on branches that have not diverged. Branches are
589
considered diverged if the destination branch's most recent commit is one
590
that has not been merged (directly or indirectly) by the source branch.
592
If branches have diverged, you can use 'bzr push --overwrite' to replace
593
the other branch completely, discarding its unmerged changes.
595
If you want to ensure you have the different changes in the other branch,
596
do a merge (see bzr help merge) from the other branch, and commit that.
597
After that you will be able to do a push without '--overwrite'.
599
If there is no default push location set, the first push will set it.
600
After that, you can omit the location to use the default. To change the
601
default, use --remember. The value will only be saved if the remote
602
location can be accessed.
605
takes_options = ['remember', 'overwrite', 'verbose',
606
Option('create-prefix',
607
help='Create the path leading up to the branch '
608
'if it does not already exist'),
610
help='branch to push from, '
611
'rather than the one containing the working directory',
616
takes_args = ['location?']
617
encoding_type = 'replace'
619
def run(self, location=None, remember=False, overwrite=False,
620
create_prefix=False, verbose=False,
622
# FIXME: Way too big! Put this into a function called from the
624
if directory is None:
626
br_from = Branch.open_containing(directory)[0]
627
stored_loc = br_from.get_push_location()
629
if stored_loc is None:
630
raise errors.BzrCommandError("No push location known or specified.")
632
display_url = urlutils.unescape_for_display(stored_loc,
634
self.outf.write("Using saved location: %s\n" % display_url)
635
location = stored_loc
637
to_transport = transport.get_transport(location)
638
location_url = to_transport.base
642
dir_to = bzrdir.BzrDir.open(location_url)
643
br_to = dir_to.open_branch()
644
except errors.NotBranchError:
646
to_transport = to_transport.clone('..')
647
if not create_prefix:
649
relurl = to_transport.relpath(location_url)
650
mutter('creating directory %s => %s', location_url, relurl)
651
to_transport.mkdir(relurl)
652
except errors.NoSuchFile:
653
raise errors.BzrCommandError("Parent directory of %s "
654
"does not exist." % location)
656
current = to_transport.base
657
needed = [(to_transport, to_transport.relpath(location_url))]
660
to_transport, relpath = needed[-1]
661
to_transport.mkdir(relpath)
663
except errors.NoSuchFile:
664
new_transport = to_transport.clone('..')
665
needed.append((new_transport,
666
new_transport.relpath(to_transport.base)))
667
if new_transport.base == to_transport.base:
668
raise errors.BzrCommandError("Could not create "
670
dir_to = br_from.bzrdir.clone(location_url,
671
revision_id=br_from.last_revision())
672
br_to = dir_to.open_branch()
673
count = len(br_to.revision_history())
674
# We successfully created the target, remember it
675
if br_from.get_push_location() is None or remember:
676
br_from.set_push_location(br_to.base)
678
# We were able to connect to the remote location, so remember it
679
# we don't need to successfully push because of possible divergence.
680
if br_from.get_push_location() is None or remember:
681
br_from.set_push_location(br_to.base)
682
old_rh = br_to.revision_history()
685
tree_to = dir_to.open_workingtree()
686
except errors.NotLocalUrl:
687
warning('This transport does not update the working '
688
'tree of: %s' % (br_to.base,))
689
count = br_to.pull(br_from, overwrite)
690
except errors.NoWorkingTree:
691
count = br_to.pull(br_from, overwrite)
693
count = tree_to.pull(br_from, overwrite)
694
except errors.DivergedBranches:
695
raise errors.BzrCommandError('These branches have diverged.'
696
' Try using "merge" and then "push".')
697
_copy_tags_maybe(br_from, br_to)
698
note('%d revision(s) pushed.' % (count,))
701
new_rh = br_to.revision_history()
704
from bzrlib.log import show_changed_revisions
705
show_changed_revisions(br_to, old_rh, new_rh,
709
class cmd_branch(Command):
710
"""Create a new copy of a branch.
712
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
713
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
715
To retrieve the branch as of a particular revision, supply the --revision
716
parameter, as in "branch foo/bar -r 5".
718
--basis is to speed up branching from remote branches. When specified, it
719
copies all the file-contents, inventory and revision data from the basis
720
branch before copying anything from the remote branch.
722
takes_args = ['from_location', 'to_location?']
723
takes_options = ['revision', 'basis']
724
aliases = ['get', 'clone']
726
def run(self, from_location, to_location=None, revision=None, basis=None):
729
elif len(revision) > 1:
730
raise errors.BzrCommandError(
731
'bzr branch --revision takes exactly 1 revision value')
733
br_from = Branch.open(from_location)
735
if e.errno == errno.ENOENT:
736
raise errors.BzrCommandError('Source location "%s" does not'
737
' exist.' % to_location)
742
if basis is not None:
743
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
746
if len(revision) == 1 and revision[0] is not None:
747
revision_id = revision[0].in_history(br_from)[1]
749
# FIXME - wt.last_revision, fallback to branch, fall back to
750
# None or perhaps NULL_REVISION to mean copy nothing
752
revision_id = br_from.last_revision()
753
if to_location is None:
754
to_location = os.path.basename(from_location.rstrip("/\\"))
757
name = os.path.basename(to_location) + '\n'
759
to_transport = transport.get_transport(to_location)
761
to_transport.mkdir('.')
762
except errors.FileExists:
763
raise errors.BzrCommandError('Target directory "%s" already'
764
' exists.' % to_location)
765
except errors.NoSuchFile:
766
raise errors.BzrCommandError('Parent of "%s" does not exist.'
769
# preserve whatever source format we have.
770
dir = br_from.bzrdir.sprout(to_transport.base,
771
revision_id, basis_dir)
772
branch = dir.open_branch()
773
except errors.NoSuchRevision:
774
to_transport.delete_tree('.')
775
msg = "The branch %s has no revision %s." % (from_location, revision[0])
776
raise errors.BzrCommandError(msg)
777
except errors.UnlistableBranch:
778
osutils.rmtree(to_location)
779
msg = "The branch %s cannot be used as a --basis" % (basis,)
780
raise errors.BzrCommandError(msg)
782
branch.control_files.put_utf8('branch-name', name)
783
_copy_tags_maybe(br_from, branch)
784
note('Branched %d revision(s).' % branch.revno())
789
def _copy_tags_maybe(from_branch, to_branch):
790
"""Copy tags between repositories if necessary and possible.
792
This method has common command-line behaviour about handling
795
from_repo = from_branch.repository
796
to_repo = to_branch.repository
797
if not from_repo.supports_tags():
798
# obviously nothing to copy
800
# TODO: give a warning if the source format supports tags and actually has
801
# tags, but the destination doesn't accept them.
802
from_repo.copy_tags_to(to_repo)
805
class cmd_checkout(Command):
806
"""Create a new checkout of an existing branch.
808
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
809
the branch found in '.'. This is useful if you have removed the working tree
810
or if it was never created - i.e. if you pushed the branch to its current
813
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
814
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
816
To retrieve the branch as of a particular revision, supply the --revision
817
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
818
out of date [so you cannot commit] but it may be useful (i.e. to examine old
821
--basis is to speed up checking out from remote branches. When specified, it
822
uses the inventory and file contents from the basis branch in preference to the
823
branch being checked out.
825
takes_args = ['branch_location?', 'to_location?']
826
takes_options = ['revision', # , 'basis']
827
Option('lightweight',
828
help="perform a lightweight checkout. Lightweight "
829
"checkouts depend on access to the branch for "
830
"every operation. Normal checkouts can perform "
831
"common operations like diff and status without "
832
"such access, and also support local commits."
837
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
841
elif len(revision) > 1:
842
raise errors.BzrCommandError(
843
'bzr checkout --revision takes exactly 1 revision value')
844
if branch_location is None:
845
branch_location = osutils.getcwd()
846
to_location = branch_location
847
source = Branch.open(branch_location)
848
if len(revision) == 1 and revision[0] is not None:
849
revision_id = revision[0].in_history(source)[1]
852
if to_location is None:
853
to_location = os.path.basename(branch_location.rstrip("/\\"))
854
# if the source and to_location are the same,
855
# and there is no working tree,
856
# then reconstitute a branch
857
if (osutils.abspath(to_location) ==
858
osutils.abspath(branch_location)):
860
source.bzrdir.open_workingtree()
861
except errors.NoWorkingTree:
862
source.bzrdir.create_workingtree()
865
os.mkdir(to_location)
867
if e.errno == errno.EEXIST:
868
raise errors.BzrCommandError('Target directory "%s" already'
869
' exists.' % to_location)
870
if e.errno == errno.ENOENT:
871
raise errors.BzrCommandError('Parent of "%s" does not exist.'
875
old_format = bzrdir.BzrDirFormat.get_default_format()
876
bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
878
source.create_checkout(to_location, revision_id, lightweight)
880
bzrdir.BzrDirFormat.set_default_format(old_format)
883
class cmd_renames(Command):
884
"""Show list of renamed files.
886
# TODO: Option to show renames between two historical versions.
888
# TODO: Only show renames under dir, rather than in the whole branch.
889
takes_args = ['dir?']
892
def run(self, dir=u'.'):
893
tree = WorkingTree.open_containing(dir)[0]
894
old_inv = tree.basis_tree().inventory
895
new_inv = tree.read_working_inventory()
896
renames = list(_mod_tree.find_renames(old_inv, new_inv))
898
for old_name, new_name in renames:
899
self.outf.write("%s => %s\n" % (old_name, new_name))
902
class cmd_update(Command):
903
"""Update a tree to have the latest code committed to its branch.
905
This will perform a merge into the working tree, and may generate
906
conflicts. If you have any local changes, you will still
907
need to commit them after the update for the update to be complete.
909
If you want to discard your local changes, you can just do a
910
'bzr revert' instead of 'bzr commit' after the update.
912
takes_args = ['dir?']
915
def run(self, dir='.'):
916
tree = WorkingTree.open_containing(dir)[0]
917
master = tree.branch.get_master_branch()
918
if master is not None:
921
tree.lock_tree_write()
923
existing_pending_merges = tree.get_parent_ids()[1:]
924
last_rev = tree.last_revision()
925
if last_rev == tree.branch.last_revision():
926
# may be up to date, check master too.
927
master = tree.branch.get_master_branch()
928
if master is None or last_rev == master.last_revision():
929
revno = tree.branch.revision_id_to_revno(last_rev)
930
note("Tree is up to date at revision %d." % (revno,))
932
conflicts = tree.update()
933
revno = tree.branch.revision_id_to_revno(tree.last_revision())
934
note('Updated to revision %d.' % (revno,))
935
if tree.get_parent_ids()[1:] != existing_pending_merges:
936
note('Your local commits will now show as pending merges with '
937
"'bzr status', and can be committed with 'bzr commit'.")
946
class cmd_info(Command):
947
"""Show information about a working tree, branch or repository.
949
This command will show all known locations and formats associated to the
950
tree, branch or repository. Statistical information is included with
953
Branches and working trees will also report any missing revisions.
955
takes_args = ['location?']
956
takes_options = ['verbose']
959
def run(self, location=None, verbose=False):
960
from bzrlib.info import show_bzrdir_info
961
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
965
class cmd_remove(Command):
966
"""Make a file unversioned.
968
This makes bzr stop tracking changes to a versioned file. It does
969
not delete the working copy.
971
You can specify one or more files, and/or --new. If you specify --new,
972
only 'added' files will be removed. If you specify both, then new files
973
in the specified directories will be removed. If the directories are
974
also new, they will also be removed.
976
takes_args = ['file*']
977
takes_options = ['verbose', Option('new', help='remove newly-added files')]
979
encoding_type = 'replace'
981
def run(self, file_list, verbose=False, new=False):
982
tree, file_list = tree_files(file_list)
984
if file_list is None:
985
raise errors.BzrCommandError('Specify one or more files to'
986
' remove, or use --new.')
988
added = tree.changes_from(tree.basis_tree(),
989
specific_files=file_list).added
990
file_list = sorted([f[0] for f in added], reverse=True)
991
if len(file_list) == 0:
992
raise errors.BzrCommandError('No matching files.')
993
tree.remove(file_list, verbose=verbose, to_file=self.outf)
996
class cmd_file_id(Command):
997
"""Print file_id of a particular file or directory.
999
The file_id is assigned when the file is first added and remains the
1000
same through all revisions where the file exists, even when it is
1005
takes_args = ['filename']
1008
def run(self, filename):
1009
tree, relpath = WorkingTree.open_containing(filename)
1010
i = tree.inventory.path2id(relpath)
1012
raise errors.NotVersionedError(filename)
1014
self.outf.write(i + '\n')
1017
class cmd_file_path(Command):
1018
"""Print path of file_ids to a file or directory.
1020
This prints one line for each directory down to the target,
1021
starting at the branch root.
1025
takes_args = ['filename']
1028
def run(self, filename):
1029
tree, relpath = WorkingTree.open_containing(filename)
1030
inv = tree.inventory
1031
fid = inv.path2id(relpath)
1033
raise errors.NotVersionedError(filename)
1034
for fip in inv.get_idpath(fid):
1035
self.outf.write(fip + '\n')
1038
class cmd_reconcile(Command):
1039
"""Reconcile bzr metadata in a branch.
1041
This can correct data mismatches that may have been caused by
1042
previous ghost operations or bzr upgrades. You should only
1043
need to run this command if 'bzr check' or a bzr developer
1044
advises you to run it.
1046
If a second branch is provided, cross-branch reconciliation is
1047
also attempted, which will check that data like the tree root
1048
id which was not present in very early bzr versions is represented
1049
correctly in both branches.
1051
At the same time it is run it may recompress data resulting in
1052
a potential saving in disk space or performance gain.
1054
The branch *MUST* be on a listable system such as local disk or sftp.
1056
takes_args = ['branch?']
1058
def run(self, branch="."):
1059
from bzrlib.reconcile import reconcile
1060
dir = bzrdir.BzrDir.open(branch)
1064
class cmd_revision_history(Command):
1065
"""Display the list of revision ids on a branch."""
1066
takes_args = ['location?']
1071
def run(self, location="."):
1072
branch = Branch.open_containing(location)[0]
1073
for revid in branch.revision_history():
1074
self.outf.write(revid)
1075
self.outf.write('\n')
1078
class cmd_ancestry(Command):
1079
"""List all revisions merged into this branch."""
1080
takes_args = ['location?']
1085
def run(self, location="."):
1087
wt = WorkingTree.open_containing(location)[0]
1088
except errors.NoWorkingTree:
1089
b = Branch.open(location)
1090
last_revision = b.last_revision()
1093
last_revision = wt.last_revision()
1095
revision_ids = b.repository.get_ancestry(last_revision)
1096
assert revision_ids[0] is None
1098
for revision_id in revision_ids:
1099
self.outf.write(revision_id + '\n')
1102
class cmd_init(Command):
1103
"""Make a directory into a versioned branch.
1105
Use this to create an empty branch, or before importing an
1108
If there is a repository in a parent directory of the location, then
1109
the history of the branch will be stored in the repository. Otherwise
1110
init creates a standalone branch which carries its own history in
1113
If there is already a branch at the location but it has no working tree,
1114
the tree can be populated with 'bzr checkout'.
1116
Recipe for importing a tree of files:
1121
bzr commit -m 'imported project'
1123
takes_args = ['location?']
1126
help='Specify a format for this branch. Current'
1127
' formats are: default, knit, metaweave and'
1128
' weave. Default is knit; metaweave and'
1129
' weave are deprecated',
1130
type=get_format_type),
1132
def run(self, location=None, format=None):
1134
format = get_format_type('default')
1135
if location is None:
1138
to_transport = transport.get_transport(location)
1140
# The path has to exist to initialize a
1141
# branch inside of it.
1142
# Just using os.mkdir, since I don't
1143
# believe that we want to create a bunch of
1144
# locations if the user supplies an extended path
1145
# TODO: create-prefix
1147
to_transport.mkdir('.')
1148
except errors.FileExists:
1152
existing_bzrdir = bzrdir.BzrDir.open(location)
1153
except errors.NotBranchError:
1154
# really a NotBzrDir error...
1155
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1157
from bzrlib.transport.local import LocalTransport
1158
if existing_bzrdir.has_branch():
1159
if (isinstance(to_transport, LocalTransport)
1160
and not existing_bzrdir.has_workingtree()):
1161
raise errors.BranchExistsWithoutWorkingTree(location)
1162
raise errors.AlreadyBranchError(location)
1164
existing_bzrdir.create_branch()
1165
existing_bzrdir.create_workingtree()
1168
class cmd_init_repository(Command):
1169
"""Create a shared repository to hold branches.
1171
New branches created under the repository directory will store their revisions
1172
in the repository, not in the branch directory, if the branch format supports
1178
bzr checkout --lightweight repo/trunk trunk-checkout
1182
takes_args = ["location"]
1183
takes_options = [Option('format',
1184
help='Specify a format for this repository.'
1185
' Current formats are: default, knit,'
1186
' metaweave and weave. Default is knit;'
1187
' metaweave and weave are deprecated',
1188
type=get_format_type),
1190
help='Allows branches in repository to have'
1192
aliases = ["init-repo"]
1193
def run(self, location, format=None, trees=False):
1195
format = get_format_type('default')
1197
if location is None:
1200
to_transport = transport.get_transport(location)
1202
to_transport.mkdir('.')
1203
except errors.FileExists:
1206
newdir = format.initialize_on_transport(to_transport)
1207
repo = newdir.create_repository(shared=True)
1208
repo.set_make_working_trees(trees)
1211
class cmd_diff(Command):
1212
"""Show differences in the working tree or between revisions.
1214
If files are listed, only the changes in those files are listed.
1215
Otherwise, all changes for the tree are listed.
1217
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1218
produces patches suitable for "patch -p1".
1222
Shows the difference in the working tree versus the last commit
1224
Difference between the working tree and revision 1
1226
Difference between revision 2 and revision 1
1227
bzr diff --diff-prefix old/:new/
1228
Same as 'bzr diff' but prefix paths with old/ and new/
1229
bzr diff bzr.mine bzr.dev
1230
Show the differences between the two working trees
1232
Show just the differences for 'foo.c'
1234
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1235
# or a graphical diff.
1237
# TODO: Python difflib is not exactly the same as unidiff; should
1238
# either fix it up or prefer to use an external diff.
1240
# TODO: Selected-file diff is inefficient and doesn't show you
1243
# TODO: This probably handles non-Unix newlines poorly.
1245
takes_args = ['file*']
1246
takes_options = ['revision', 'diff-options',
1247
Option('prefix', type=str,
1249
help='Set prefixes to added to old and new filenames, as '
1250
'two values separated by a colon.'),
1252
aliases = ['di', 'dif']
1253
encoding_type = 'exact'
1256
def run(self, revision=None, file_list=None, diff_options=None,
1258
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1260
if (prefix is None) or (prefix == '0'):
1268
old_label, new_label = prefix.split(":")
1270
raise BzrCommandError(
1271
"--prefix expects two values separated by a colon")
1273
if revision and len(revision) > 2:
1274
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1275
' one or two revision specifiers')
1278
tree1, file_list = internal_tree_files(file_list)
1282
except errors.FileInWrongBranch:
1283
if len(file_list) != 2:
1284
raise errors.BzrCommandError("Files are in different branches")
1286
tree1, file1 = WorkingTree.open_containing(file_list[0])
1287
tree2, file2 = WorkingTree.open_containing(file_list[1])
1288
if file1 != "" or file2 != "":
1289
# FIXME diff those two files. rbc 20051123
1290
raise errors.BzrCommandError("Files are in different branches")
1292
except errors.NotBranchError:
1293
if (revision is not None and len(revision) == 2
1294
and not revision[0].needs_branch()
1295
and not revision[1].needs_branch()):
1296
# If both revision specs include a branch, we can
1297
# diff them without needing a local working tree
1298
tree1, tree2 = None, None
1302
if tree2 is not None:
1303
if revision is not None:
1304
# FIXME: but there should be a clean way to diff between
1305
# non-default versions of two trees, it's not hard to do
1307
raise errors.BzrCommandError(
1308
"Sorry, diffing arbitrary revisions across branches "
1309
"is not implemented yet")
1310
return show_diff_trees(tree1, tree2, sys.stdout,
1311
specific_files=file_list,
1312
external_diff_options=diff_options,
1313
old_label=old_label, new_label=new_label)
1315
return diff_cmd_helper(tree1, file_list, diff_options,
1316
revision_specs=revision,
1317
old_label=old_label, new_label=new_label)
1320
class cmd_deleted(Command):
1321
"""List files deleted in the working tree.
1323
# TODO: Show files deleted since a previous revision, or
1324
# between two revisions.
1325
# TODO: Much more efficient way to do this: read in new
1326
# directories with readdir, rather than stating each one. Same
1327
# level of effort but possibly much less IO. (Or possibly not,
1328
# if the directories are very large...)
1329
takes_options = ['show-ids']
1332
def run(self, show_ids=False):
1333
tree = WorkingTree.open_containing(u'.')[0]
1334
old = tree.basis_tree()
1335
for path, ie in old.inventory.iter_entries():
1336
if not tree.has_id(ie.file_id):
1337
self.outf.write(path)
1339
self.outf.write(' ')
1340
self.outf.write(ie.file_id)
1341
self.outf.write('\n')
1344
class cmd_modified(Command):
1345
"""List files modified in working tree."""
1349
tree = WorkingTree.open_containing(u'.')[0]
1350
td = tree.changes_from(tree.basis_tree())
1351
for path, id, kind, text_modified, meta_modified in td.modified:
1352
self.outf.write(path + '\n')
1355
class cmd_added(Command):
1356
"""List files added in working tree."""
1360
wt = WorkingTree.open_containing(u'.')[0]
1361
basis_inv = wt.basis_tree().inventory
1364
if file_id in basis_inv:
1366
if inv.is_root(file_id) and len(basis_inv) == 0:
1368
path = inv.id2path(file_id)
1369
if not os.access(osutils.abspath(path), os.F_OK):
1371
self.outf.write(path + '\n')
1374
class cmd_root(Command):
1375
"""Show the tree root directory.
1377
The root is the nearest enclosing directory with a .bzr control
1379
takes_args = ['filename?']
1381
def run(self, filename=None):
1382
"""Print the branch root."""
1383
tree = WorkingTree.open_containing(filename)[0]
1384
self.outf.write(tree.basedir + '\n')
1387
class cmd_log(Command):
1388
"""Show log of a branch, file, or directory.
1390
By default show the log of the branch containing the working directory.
1392
To request a range of logs, you can use the command -r begin..end
1393
-r revision requests a specific revision, -r ..end or -r begin.. are
1399
bzr log -r -10.. http://server/branch
1402
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1404
takes_args = ['location?']
1405
takes_options = [Option('forward',
1406
help='show from oldest to newest'),
1410
help='show files changed in each revision'),
1411
'show-ids', 'revision',
1416
help='show revisions whose message matches this regexp',
1420
encoding_type = 'replace'
1423
def run(self, location=None, timezone='original',
1433
from bzrlib.log import log_formatter, show_log
1434
assert message is None or isinstance(message, basestring), \
1435
"invalid message argument %r" % message
1436
direction = (forward and 'forward') or 'reverse'
1441
# find the file id to log:
1443
dir, fp = bzrdir.BzrDir.open_containing(location)
1444
b = dir.open_branch()
1448
inv = dir.open_workingtree().inventory
1449
except (errors.NotBranchError, errors.NotLocalUrl):
1450
# either no tree, or is remote.
1451
inv = b.basis_tree().inventory
1452
file_id = inv.path2id(fp)
1454
raise errors.BzrCommandError(
1455
"Path does not have any revision history: %s" %
1459
# FIXME ? log the current subdir only RBC 20060203
1460
if revision is not None \
1461
and len(revision) > 0 and revision[0].get_branch():
1462
location = revision[0].get_branch()
1465
dir, relpath = bzrdir.BzrDir.open_containing(location)
1466
b = dir.open_branch()
1468
if revision is None:
1471
elif len(revision) == 1:
1472
rev1 = rev2 = revision[0].in_history(b).revno
1473
elif len(revision) == 2:
1474
if revision[1].get_branch() != revision[0].get_branch():
1475
# b is taken from revision[0].get_branch(), and
1476
# show_log will use its revision_history. Having
1477
# different branches will lead to weird behaviors.
1478
raise errors.BzrCommandError(
1479
"Log doesn't accept two revisions in different branches.")
1480
if revision[0].spec is None:
1481
# missing begin-range means first revision
1484
rev1 = revision[0].in_history(b).revno
1486
if revision[1].spec is None:
1487
# missing end-range means last known revision
1490
rev2 = revision[1].in_history(b).revno
1492
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1494
# By this point, the revision numbers are converted to the +ve
1495
# form if they were supplied in the -ve form, so we can do
1496
# this comparison in relative safety
1498
(rev2, rev1) = (rev1, rev2)
1500
if (log_format is None):
1501
default = b.get_config().log_format()
1502
log_format = get_log_format(long=long, short=short, line=line,
1504
lf = log_formatter(log_format,
1507
show_timezone=timezone)
1513
direction=direction,
1514
start_revision=rev1,
1519
def get_log_format(long=False, short=False, line=False, default='long'):
1520
log_format = default
1524
log_format = 'short'
1530
class cmd_touching_revisions(Command):
1531
"""Return revision-ids which affected a particular file.
1533
A more user-friendly interface is "bzr log FILE".
1537
takes_args = ["filename"]
1540
def run(self, filename):
1541
tree, relpath = WorkingTree.open_containing(filename)
1543
inv = tree.read_working_inventory()
1544
file_id = inv.path2id(relpath)
1545
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1546
self.outf.write("%6d %s\n" % (revno, what))
1549
class cmd_ls(Command):
1550
"""List files in a tree.
1553
takes_args = ['path?']
1554
# TODO: Take a revision or remote path and list that tree instead.
1555
takes_options = ['verbose', 'revision',
1556
Option('non-recursive',
1557
help='don\'t recurse into sub-directories'),
1559
help='Print all paths from the root of the branch.'),
1560
Option('unknown', help='Print unknown files'),
1561
Option('versioned', help='Print versioned files'),
1562
Option('ignored', help='Print ignored files'),
1564
Option('null', help='Null separate the files'),
1568
def run(self, revision=None, verbose=False,
1569
non_recursive=False, from_root=False,
1570
unknown=False, versioned=False, ignored=False,
1571
null=False, kind=None, show_ids=False, path=None):
1573
if kind and kind not in ('file', 'directory', 'symlink'):
1574
raise errors.BzrCommandError('invalid kind specified')
1576
if verbose and null:
1577
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1578
all = not (unknown or versioned or ignored)
1580
selection = {'I':ignored, '?':unknown, 'V':versioned}
1587
raise errors.BzrCommandError('cannot specify both --from-root'
1591
tree, relpath = WorkingTree.open_containing(fs_path)
1596
if revision is not None:
1597
tree = tree.branch.repository.revision_tree(
1598
revision[0].in_history(tree.branch).rev_id)
1600
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1601
if fp.startswith(relpath):
1602
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1603
if non_recursive and '/' in fp:
1605
if not all and not selection[fc]:
1607
if kind is not None and fkind != kind:
1610
kindch = entry.kind_character()
1611
outstring = '%-8s %s%s' % (fc, fp, kindch)
1612
if show_ids and fid is not None:
1613
outstring = "%-50s %s" % (outstring, fid)
1614
self.outf.write(outstring + '\n')
1616
self.outf.write(fp + '\0')
1619
self.outf.write(fid)
1620
self.outf.write('\0')
1628
self.outf.write('%-50s %s\n' % (fp, my_id))
1630
self.outf.write(fp + '\n')
1633
class cmd_unknowns(Command):
1634
"""List unknown files."""
1637
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1638
self.outf.write(osutils.quotefn(f) + '\n')
1641
class cmd_ignore(Command):
1642
"""Ignore specified files or patterns.
1644
To remove patterns from the ignore list, edit the .bzrignore file.
1646
Trailing slashes on patterns are ignored.
1647
If the pattern contains a slash or is a regular expression, it is compared
1648
to the whole path from the branch root. Otherwise, it is compared to only
1649
the last component of the path. To match a file only in the root
1650
directory, prepend './'.
1652
Ignore patterns specifying absolute paths are not allowed.
1654
Ignore patterns may include globbing wildcards such as:
1655
? - Matches any single character except '/'
1656
* - Matches 0 or more characters except '/'
1657
/**/ - Matches 0 or more directories in a path
1658
[a-z] - Matches a single character from within a group of characters
1660
Ignore patterns may also be Python regular expressions.
1661
Regular expression ignore patterns are identified by a 'RE:' prefix
1662
followed by the regular expression. Regular expression ignore patterns
1663
may not include named or numbered groups.
1665
Note: ignore patterns containing shell wildcards must be quoted from
1669
bzr ignore ./Makefile
1670
bzr ignore '*.class'
1671
bzr ignore 'lib/**/*.o'
1672
bzr ignore 'RE:lib/.*\.o'
1674
takes_args = ['name_pattern*']
1676
Option('old-default-rules',
1677
help='Out the ignore rules bzr < 0.9 always used.')
1680
def run(self, name_pattern_list=None, old_default_rules=None):
1681
from bzrlib.atomicfile import AtomicFile
1682
if old_default_rules is not None:
1683
# dump the rules and exit
1684
for pattern in ignores.OLD_DEFAULTS:
1687
if not name_pattern_list:
1688
raise errors.BzrCommandError("ignore requires at least one "
1689
"NAME_PATTERN or --old-default-rules")
1690
for name_pattern in name_pattern_list:
1691
if name_pattern[0] == '/':
1692
raise errors.BzrCommandError(
1693
"NAME_PATTERN should not be an absolute path")
1694
tree, relpath = WorkingTree.open_containing(u'.')
1695
ifn = tree.abspath('.bzrignore')
1696
if os.path.exists(ifn):
1699
igns = f.read().decode('utf-8')
1705
# TODO: If the file already uses crlf-style termination, maybe
1706
# we should use that for the newly added lines?
1708
if igns and igns[-1] != '\n':
1710
for name_pattern in name_pattern_list:
1711
igns += name_pattern.rstrip('/') + '\n'
1713
f = AtomicFile(ifn, 'wb')
1715
f.write(igns.encode('utf-8'))
1720
inv = tree.inventory
1721
if inv.path2id('.bzrignore'):
1722
mutter('.bzrignore is already versioned')
1724
mutter('need to make new .bzrignore file versioned')
1725
tree.add(['.bzrignore'])
1728
class cmd_ignored(Command):
1729
"""List ignored files and the patterns that matched them.
1731
See also: bzr ignore"""
1734
tree = WorkingTree.open_containing(u'.')[0]
1735
for path, file_class, kind, file_id, entry in tree.list_files():
1736
if file_class != 'I':
1738
## XXX: Slightly inefficient since this was already calculated
1739
pat = tree.is_ignored(path)
1740
print '%-50s %s' % (path, pat)
1743
class cmd_lookup_revision(Command):
1744
"""Lookup the revision-id from a revision-number
1747
bzr lookup-revision 33
1750
takes_args = ['revno']
1753
def run(self, revno):
1757
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1759
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1762
class cmd_export(Command):
1763
"""Export past revision to destination directory.
1765
If no revision is specified this exports the last committed revision.
1767
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1768
given, try to find the format with the extension. If no extension
1769
is found exports to a directory (equivalent to --format=dir).
1771
Root may be the top directory for tar, tgz and tbz2 formats. If none
1772
is given, the top directory will be the root name of the file.
1774
If branch is omitted then the branch containing the CWD will be used.
1776
Note: export of tree with non-ascii filenames to zip is not supported.
1778
Supported formats Autodetected by extension
1779
----------------- -------------------------
1782
tbz2 .tar.bz2, .tbz2
1786
takes_args = ['dest', 'branch?']
1787
takes_options = ['revision', 'format', 'root']
1788
def run(self, dest, branch=None, revision=None, format=None, root=None):
1789
from bzrlib.export import export
1792
tree = WorkingTree.open_containing(u'.')[0]
1795
b = Branch.open(branch)
1797
if revision is None:
1798
# should be tree.last_revision FIXME
1799
rev_id = b.last_revision()
1801
if len(revision) != 1:
1802
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1803
rev_id = revision[0].in_history(b).rev_id
1804
t = b.repository.revision_tree(rev_id)
1806
export(t, dest, format, root)
1807
except errors.NoSuchExportFormat, e:
1808
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1811
class cmd_cat(Command):
1812
"""Write a file's text from a previous revision."""
1814
takes_options = ['revision', 'name-from-revision']
1815
takes_args = ['filename']
1816
encoding_type = 'exact'
1819
def run(self, filename, revision=None, name_from_revision=False):
1820
if revision is not None and len(revision) != 1:
1821
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1826
tree, relpath = WorkingTree.open_containing(filename)
1828
except (errors.NotBranchError, errors.NotLocalUrl):
1831
if revision is not None and revision[0].get_branch() is not None:
1832
b = Branch.open(revision[0].get_branch())
1834
b, relpath = Branch.open_containing(filename)
1835
tree = b.basis_tree()
1836
if revision is None:
1837
revision_id = b.last_revision()
1839
revision_id = revision[0].in_history(b).rev_id
1841
cur_file_id = tree.path2id(relpath)
1842
rev_tree = b.repository.revision_tree(revision_id)
1843
old_file_id = rev_tree.path2id(relpath)
1845
if name_from_revision:
1846
if old_file_id is None:
1847
raise errors.BzrCommandError("%r is not present in revision %s"
1848
% (filename, revision_id))
1850
rev_tree.print_file(old_file_id)
1851
elif cur_file_id is not None:
1852
rev_tree.print_file(cur_file_id)
1853
elif old_file_id is not None:
1854
rev_tree.print_file(old_file_id)
1856
raise errors.BzrCommandError("%r is not present in revision %s" %
1857
(filename, revision_id))
1860
class cmd_local_time_offset(Command):
1861
"""Show the offset in seconds from GMT to local time."""
1865
print osutils.local_time_offset()
1869
class cmd_commit(Command):
1870
"""Commit changes into a new revision.
1872
If no arguments are given, the entire tree is committed.
1874
If selected files are specified, only changes to those files are
1875
committed. If a directory is specified then the directory and everything
1876
within it is committed.
1878
A selected-file commit may fail in some cases where the committed
1879
tree would be invalid, such as trying to commit a file in a
1880
newly-added directory that is not itself committed.
1882
# TODO: Run hooks on tree to-be-committed, and after commit.
1884
# TODO: Strict commit that fails if there are deleted files.
1885
# (what does "deleted files" mean ??)
1887
# TODO: Give better message for -s, --summary, used by tla people
1889
# XXX: verbose currently does nothing
1891
takes_args = ['selected*']
1892
takes_options = ['message', 'verbose',
1894
help='commit even if nothing has changed'),
1895
Option('file', type=str,
1898
help='file containing commit message'),
1900
help="refuse to commit if there are unknown "
1901
"files in the working tree."),
1903
help="perform a local only commit in a bound "
1904
"branch. Such commits are not pushed to "
1905
"the master branch until a normal commit "
1909
aliases = ['ci', 'checkin']
1911
def run(self, message=None, file=None, verbose=True, selected_list=None,
1912
unchanged=False, strict=False, local=False):
1913
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1914
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1916
from bzrlib.msgeditor import edit_commit_message, \
1917
make_commit_message_template
1919
# TODO: Need a blackbox test for invoking the external editor; may be
1920
# slightly problematic to run this cross-platform.
1922
# TODO: do more checks that the commit will succeed before
1923
# spending the user's valuable time typing a commit message.
1924
tree, selected_list = tree_files(selected_list)
1925
if selected_list == ['']:
1926
# workaround - commit of root of tree should be exactly the same
1927
# as just default commit in that tree, and succeed even though
1928
# selected-file merge commit is not done yet
1931
if local and not tree.branch.get_bound_location():
1932
raise errors.LocalRequiresBoundBranch()
1934
def get_message(commit_obj):
1935
"""Callback to get commit message"""
1936
my_message = message
1937
if my_message is None and not file:
1938
template = make_commit_message_template(tree, selected_list)
1939
my_message = edit_commit_message(template)
1940
if my_message is None:
1941
raise errors.BzrCommandError("please specify a commit"
1942
" message with either --message or --file")
1943
elif my_message and file:
1944
raise errors.BzrCommandError(
1945
"please specify either --message or --file")
1947
my_message = codecs.open(file, 'rt',
1948
bzrlib.user_encoding).read()
1949
if my_message == "":
1950
raise errors.BzrCommandError("empty commit message specified")
1954
reporter = ReportCommitToLog()
1956
reporter = NullCommitReporter()
1959
tree.commit(message_callback=get_message,
1960
specific_files=selected_list,
1961
allow_pointless=unchanged, strict=strict, local=local,
1963
except PointlessCommit:
1964
# FIXME: This should really happen before the file is read in;
1965
# perhaps prepare the commit; get the message; then actually commit
1966
raise errors.BzrCommandError("no changes to commit."
1967
" use --unchanged to commit anyhow")
1968
except ConflictsInTree:
1969
raise errors.BzrCommandError('Conflicts detected in working '
1970
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
1972
except StrictCommitFailed:
1973
raise errors.BzrCommandError("Commit refused because there are"
1974
" unknown files in the working tree.")
1975
except errors.BoundBranchOutOfDate, e:
1976
raise errors.BzrCommandError(str(e) + "\n"
1977
'To commit to master branch, run update and then commit.\n'
1978
'You can also pass --local to commit to continue working '
1982
class cmd_check(Command):
1983
"""Validate consistency of branch history.
1985
This command checks various invariants about the branch storage to
1986
detect data corruption or bzr bugs.
1988
takes_args = ['branch?']
1989
takes_options = ['verbose']
1991
def run(self, branch=None, verbose=False):
1992
from bzrlib.check import check
1994
tree = WorkingTree.open_containing()[0]
1995
branch = tree.branch
1997
branch = Branch.open(branch)
1998
check(branch, verbose)
2001
class cmd_upgrade(Command):
2002
"""Upgrade branch storage to current format.
2004
The check command or bzr developers may sometimes advise you to run
2005
this command. When the default format has changed you may also be warned
2006
during other operations to upgrade.
2008
takes_args = ['url?']
2011
help='Upgrade to a specific format. Current formats'
2012
' are: default, knit, metaweave and weave.'
2013
' Default is knit; metaweave and weave are'
2015
type=get_format_type),
2019
def run(self, url='.', format=None):
2020
from bzrlib.upgrade import upgrade
2022
format = get_format_type('default')
2023
upgrade(url, format)
2026
class cmd_whoami(Command):
2027
"""Show or set bzr user id.
2031
bzr whoami 'Frank Chu <fchu@example.com>'
2033
takes_options = [ Option('email',
2034
help='display email address only'),
2036
help='set identity for the current branch instead of '
2039
takes_args = ['name?']
2040
encoding_type = 'replace'
2043
def run(self, email=False, branch=False, name=None):
2045
# use branch if we're inside one; otherwise global config
2047
c = Branch.open_containing('.')[0].get_config()
2048
except errors.NotBranchError:
2049
c = config.GlobalConfig()
2051
self.outf.write(c.user_email() + '\n')
2053
self.outf.write(c.username() + '\n')
2056
# display a warning if an email address isn't included in the given name.
2058
config.extract_email_address(name)
2059
except errors.NoEmailInUsername, e:
2060
warning('"%s" does not seem to contain an email address. '
2061
'This is allowed, but not recommended.', name)
2063
# use global config unless --branch given
2065
c = Branch.open_containing('.')[0].get_config()
2067
c = config.GlobalConfig()
2068
c.set_user_option('email', name)
2071
class cmd_nick(Command):
2072
"""Print or set the branch nickname.
2074
If unset, the tree root directory name is used as the nickname
2075
To print the current nickname, execute with no argument.
2077
takes_args = ['nickname?']
2078
def run(self, nickname=None):
2079
branch = Branch.open_containing(u'.')[0]
2080
if nickname is None:
2081
self.printme(branch)
2083
branch.nick = nickname
2086
def printme(self, branch):
2090
class cmd_selftest(Command):
2091
"""Run internal test suite.
2093
This creates temporary test directories in the working directory,
2094
but not existing data is affected. These directories are deleted
2095
if the tests pass, or left behind to help in debugging if they
2096
fail and --keep-output is specified.
2098
If arguments are given, they are regular expressions that say
2099
which tests should run.
2101
If the global option '--no-plugins' is given, plugins are not loaded
2102
before running the selftests. This has two effects: features provided or
2103
modified by plugins will not be tested, and tests provided by plugins will
2108
bzr --no-plugins selftest -v
2110
# TODO: --list should give a list of all available tests
2112
# NB: this is used from the class without creating an instance, which is
2113
# why it does not have a self parameter.
2114
def get_transport_type(typestring):
2115
"""Parse and return a transport specifier."""
2116
if typestring == "sftp":
2117
from bzrlib.transport.sftp import SFTPAbsoluteServer
2118
return SFTPAbsoluteServer
2119
if typestring == "memory":
2120
from bzrlib.transport.memory import MemoryServer
2122
if typestring == "fakenfs":
2123
from bzrlib.transport.fakenfs import FakeNFSServer
2124
return FakeNFSServer
2125
msg = "No known transport type %s. Supported types are: sftp\n" %\
2127
raise errors.BzrCommandError(msg)
2130
takes_args = ['testspecs*']
2131
takes_options = ['verbose',
2132
Option('one', help='stop when one test fails'),
2133
Option('keep-output',
2134
help='keep output directories when tests fail'),
2136
help='Use a different transport by default '
2137
'throughout the test suite.',
2138
type=get_transport_type),
2139
Option('benchmark', help='run the bzr bencharks.'),
2140
Option('lsprof-timed',
2141
help='generate lsprof output for benchmarked'
2142
' sections of code.'),
2143
Option('cache-dir', type=str,
2144
help='a directory to cache intermediate'
2145
' benchmark steps'),
2146
Option('clean-output',
2147
help='clean temporary tests directories'
2148
' without running tests'),
2150
encoding_type = 'replace'
2152
def run(self, testspecs_list=None, verbose=None, one=False,
2153
keep_output=False, transport=None, benchmark=None,
2154
lsprof_timed=None, cache_dir=None, clean_output=False):
2156
from bzrlib.tests import selftest
2157
import bzrlib.benchmarks as benchmarks
2158
from bzrlib.benchmarks import tree_creator
2161
from bzrlib.tests import clean_selftest_output
2162
clean_selftest_output()
2165
if cache_dir is not None:
2166
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2167
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2168
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2170
if testspecs_list is not None:
2171
pattern = '|'.join(testspecs_list)
2175
test_suite_factory = benchmarks.test_suite
2178
# TODO: should possibly lock the history file...
2179
benchfile = open(".perf_history", "at", buffering=1)
2181
test_suite_factory = None
2186
result = selftest(verbose=verbose,
2188
stop_on_failure=one,
2189
keep_output=keep_output,
2190
transport=transport,
2191
test_suite_factory=test_suite_factory,
2192
lsprof_timed=lsprof_timed,
2193
bench_history=benchfile)
2195
if benchfile is not None:
2198
info('tests passed')
2200
info('tests failed')
2201
return int(not result)
2204
class cmd_version(Command):
2205
"""Show version of bzr."""
2209
from bzrlib.version import show_version
2213
class cmd_rocks(Command):
2214
"""Statement of optimism."""
2220
print "it sure does!"
2223
class cmd_find_merge_base(Command):
2224
"""Find and print a base revision for merging two branches."""
2225
# TODO: Options to specify revisions on either side, as if
2226
# merging only part of the history.
2227
takes_args = ['branch', 'other']
2231
def run(self, branch, other):
2232
from bzrlib.revision import MultipleRevisionSources
2234
branch1 = Branch.open_containing(branch)[0]
2235
branch2 = Branch.open_containing(other)[0]
2237
history_1 = branch1.revision_history()
2238
history_2 = branch2.revision_history()
2240
last1 = branch1.last_revision()
2241
last2 = branch2.last_revision()
2243
source = MultipleRevisionSources(branch1.repository,
2246
base_rev_id = common_ancestor(last1, last2, source)
2248
print 'merge base is revision %s' % base_rev_id
2251
class cmd_merge(Command):
2252
"""Perform a three-way merge.
2254
The branch is the branch you will merge from. By default, it will merge
2255
the latest revision. If you specify a revision, that revision will be
2256
merged. If you specify two revisions, the first will be used as a BASE,
2257
and the second one as OTHER. Revision numbers are always relative to the
2260
By default, bzr will try to merge in all new work from the other
2261
branch, automatically determining an appropriate base. If this
2262
fails, you may need to give an explicit base.
2264
Merge will do its best to combine the changes in two branches, but there
2265
are some kinds of problems only a human can fix. When it encounters those,
2266
it will mark a conflict. A conflict means that you need to fix something,
2267
before you should commit.
2269
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2271
If there is no default branch set, the first merge will set it. After
2272
that, you can omit the branch to use the default. To change the
2273
default, use --remember. The value will only be saved if the remote
2274
location can be accessed.
2276
The results of the merge are placed into the destination working
2277
directory, where they can be reviewed (with bzr diff), tested, and then
2278
committed to record the result of the merge.
2282
To merge the latest revision from bzr.dev
2283
bzr merge ../bzr.dev
2285
To merge changes up to and including revision 82 from bzr.dev
2286
bzr merge -r 82 ../bzr.dev
2288
To merge the changes introduced by 82, without previous changes:
2289
bzr merge -r 81..82 ../bzr.dev
2291
merge refuses to run if there are any uncommitted changes, unless
2294
The following merge types are available:
2296
takes_args = ['branch?']
2297
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2298
Option('show-base', help="Show base revision text in "
2300
Option('uncommitted', help='Apply uncommitted changes'
2301
' from a working copy, instead of branch changes'),
2302
Option('pull', help='If the destination is already'
2303
' completely merged into the source, pull from the'
2304
' source rather than merging. When this happens,'
2305
' you do not need to commit the result.'),
2307
help='branch to push from, '
2308
'rather than the one containing the working directory',
2315
from inspect import getdoc
2316
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2318
def run(self, branch=None, revision=None, force=False, merge_type=None,
2319
show_base=False, reprocess=False, remember=False,
2320
uncommitted=False, pull=False,
2323
if merge_type is None:
2324
merge_type = _mod_merge.Merge3Merger
2325
if directory is None: directory = u'.'
2326
tree = WorkingTree.open_containing(directory)[0]
2328
if branch is not None:
2330
reader = bundle.read_bundle_from_url(branch)
2331
except errors.NotABundle:
2332
pass # Continue on considering this url a Branch
2334
conflicts = merge_bundle(reader, tree, not force, merge_type,
2335
reprocess, show_base)
2341
if revision is None \
2342
or len(revision) < 1 or revision[0].needs_branch():
2343
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2345
if revision is None or len(revision) < 1:
2348
other = [branch, None]
2351
other = [branch, -1]
2352
other_branch, path = Branch.open_containing(branch)
2355
raise errors.BzrCommandError('Cannot use --uncommitted and'
2356
' --revision at the same time.')
2357
branch = revision[0].get_branch() or branch
2358
if len(revision) == 1:
2360
other_branch, path = Branch.open_containing(branch)
2361
revno = revision[0].in_history(other_branch).revno
2362
other = [branch, revno]
2364
assert len(revision) == 2
2365
if None in revision:
2366
raise errors.BzrCommandError(
2367
"Merge doesn't permit empty revision specifier.")
2368
base_branch, path = Branch.open_containing(branch)
2369
branch1 = revision[1].get_branch() or branch
2370
other_branch, path1 = Branch.open_containing(branch1)
2371
if revision[0].get_branch() is not None:
2372
# then path was obtained from it, and is None.
2375
base = [branch, revision[0].in_history(base_branch).revno]
2376
other = [branch1, revision[1].in_history(other_branch).revno]
2378
if tree.branch.get_parent() is None or remember:
2379
tree.branch.set_parent(other_branch.base)
2381
# pull tags now... it's a bit inconsistent to do it ahead of copying
2382
# the history but that's done inside the merge code
2383
_copy_tags_maybe(other_branch, tree.branch)
2386
interesting_files = [path]
2388
interesting_files = None
2389
pb = ui.ui_factory.nested_progress_bar()
2392
conflict_count = _merge_helper(
2393
other, base, check_clean=(not force),
2394
merge_type=merge_type,
2395
reprocess=reprocess,
2396
show_base=show_base,
2399
pb=pb, file_list=interesting_files)
2402
if conflict_count != 0:
2406
except errors.AmbiguousBase, e:
2407
m = ("sorry, bzr can't determine the right merge base yet\n"
2408
"candidates are:\n "
2409
+ "\n ".join(e.bases)
2411
"please specify an explicit base with -r,\n"
2412
"and (if you want) report this to the bzr developers\n")
2415
# TODO: move up to common parent; this isn't merge-specific anymore.
2416
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2417
"""Use tree.branch's parent if none was supplied.
2419
Report if the remembered location was used.
2421
if supplied_location is not None:
2422
return supplied_location
2423
stored_location = tree.branch.get_parent()
2424
mutter("%s", stored_location)
2425
if stored_location is None:
2426
raise errors.BzrCommandError("No location specified or remembered")
2427
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2428
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2429
return stored_location
2432
class cmd_remerge(Command):
2435
Use this if you want to try a different merge technique while resolving
2436
conflicts. Some merge techniques are better than others, and remerge
2437
lets you try different ones on different files.
2439
The options for remerge have the same meaning and defaults as the ones for
2440
merge. The difference is that remerge can (only) be run when there is a
2441
pending merge, and it lets you specify particular files.
2444
$ bzr remerge --show-base
2445
Re-do the merge of all conflicted files, and show the base text in
2446
conflict regions, in addition to the usual THIS and OTHER texts.
2448
$ bzr remerge --merge-type weave --reprocess foobar
2449
Re-do the merge of "foobar", using the weave merge algorithm, with
2450
additional processing to reduce the size of conflict regions.
2452
The following merge types are available:"""
2453
takes_args = ['file*']
2454
takes_options = ['merge-type', 'reprocess',
2455
Option('show-base', help="Show base revision text in "
2459
from inspect import getdoc
2460
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2462
def run(self, file_list=None, merge_type=None, show_base=False,
2464
if merge_type is None:
2465
merge_type = _mod_merge.Merge3Merger
2466
tree, file_list = tree_files(file_list)
2469
parents = tree.get_parent_ids()
2470
if len(parents) != 2:
2471
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2472
" merges. Not cherrypicking or"
2474
repository = tree.branch.repository
2475
base_revision = common_ancestor(parents[0],
2476
parents[1], repository)
2477
base_tree = repository.revision_tree(base_revision)
2478
other_tree = repository.revision_tree(parents[1])
2479
interesting_ids = None
2481
conflicts = tree.conflicts()
2482
if file_list is not None:
2483
interesting_ids = set()
2484
for filename in file_list:
2485
file_id = tree.path2id(filename)
2487
raise errors.NotVersionedError(filename)
2488
interesting_ids.add(file_id)
2489
if tree.kind(file_id) != "directory":
2492
for name, ie in tree.inventory.iter_entries(file_id):
2493
interesting_ids.add(ie.file_id)
2494
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2496
# Remerge only supports resolving contents conflicts
2497
allowed_conflicts = ('text conflict', 'contents conflict')
2498
restore_files = [c.path for c in conflicts
2499
if c.typestring in allowed_conflicts]
2500
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2501
tree.set_conflicts(ConflictList(new_conflicts))
2502
if file_list is not None:
2503
restore_files = file_list
2504
for filename in restore_files:
2506
restore(tree.abspath(filename))
2507
except errors.NotConflicted:
2509
conflicts = _mod_merge.merge_inner(
2510
tree.branch, other_tree, base_tree,
2512
interesting_ids=interesting_ids,
2513
other_rev_id=parents[1],
2514
merge_type=merge_type,
2515
show_base=show_base,
2516
reprocess=reprocess)
2525
class cmd_revert(Command):
2526
"""Revert files to a previous revision.
2528
Giving a list of files will revert only those files. Otherwise, all files
2529
will be reverted. If the revision is not specified with '--revision', the
2530
last committed revision is used.
2532
To remove only some changes, without reverting to a prior version, use
2533
merge instead. For example, "merge . --r-2..-3" will remove the changes
2534
introduced by -2, without affecting the changes introduced by -1. Or
2535
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2537
By default, any files that have been manually changed will be backed up
2538
first. (Files changed only by merge are not backed up.) Backup files have
2539
'.~#~' appended to their name, where # is a number.
2541
When you provide files, you can use their current pathname or the pathname
2542
from the target revision. So you can use revert to "undelete" a file by
2543
name. If you name a directory, all the contents of that directory will be
2546
takes_options = ['revision', 'no-backup']
2547
takes_args = ['file*']
2548
aliases = ['merge-revert']
2550
def run(self, revision=None, no_backup=False, file_list=None):
2551
if file_list is not None:
2552
if len(file_list) == 0:
2553
raise errors.BzrCommandError("No files specified")
2557
tree, file_list = tree_files(file_list)
2558
if revision is None:
2559
# FIXME should be tree.last_revision
2560
rev_id = tree.last_revision()
2561
elif len(revision) != 1:
2562
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2564
rev_id = revision[0].in_history(tree.branch).rev_id
2565
pb = ui.ui_factory.nested_progress_bar()
2567
tree.revert(file_list,
2568
tree.branch.repository.revision_tree(rev_id),
2574
class cmd_assert_fail(Command):
2575
"""Test reporting of assertion failures"""
2576
# intended just for use in testing
2581
raise AssertionError("always fails")
2584
class cmd_help(Command):
2585
"""Show help on a command or other topic.
2587
For a list of all available commands, say 'bzr help commands'.
2589
takes_options = [Option('long', 'show help on all commands')]
2590
takes_args = ['topic?']
2591
aliases = ['?', '--help', '-?', '-h']
2594
def run(self, topic=None, long=False):
2596
if topic is None and long:
2598
bzrlib.help.help(topic)
2601
class cmd_shell_complete(Command):
2602
"""Show appropriate completions for context.
2604
For a list of all available commands, say 'bzr shell-complete'.
2606
takes_args = ['context?']
2611
def run(self, context=None):
2612
import shellcomplete
2613
shellcomplete.shellcomplete(context)
2616
class cmd_fetch(Command):
2617
"""Copy in history from another branch but don't merge it.
2619
This is an internal method used for pull and merge.
2622
takes_args = ['from_branch', 'to_branch']
2623
def run(self, from_branch, to_branch):
2624
from bzrlib.fetch import Fetcher
2625
from_b = Branch.open(from_branch)
2626
to_b = Branch.open(to_branch)
2627
Fetcher(to_b, from_b)
2630
class cmd_missing(Command):
2631
"""Show unmerged/unpulled revisions between two branches.
2633
OTHER_BRANCH may be local or remote.
2635
takes_args = ['other_branch?']
2636
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2638
'Display changes in the local branch only'),
2639
Option('theirs-only',
2640
'Display changes in the remote branch only'),
2648
encoding_type = 'replace'
2651
def run(self, other_branch=None, reverse=False, mine_only=False,
2652
theirs_only=False, log_format=None, long=False, short=False, line=False,
2653
show_ids=False, verbose=False):
2654
from bzrlib.missing import find_unmerged, iter_log_data
2655
from bzrlib.log import log_formatter
2656
local_branch = Branch.open_containing(u".")[0]
2657
parent = local_branch.get_parent()
2658
if other_branch is None:
2659
other_branch = parent
2660
if other_branch is None:
2661
raise errors.BzrCommandError("No peer location known or specified.")
2662
print "Using last location: " + local_branch.get_parent()
2663
remote_branch = Branch.open(other_branch)
2664
if remote_branch.base == local_branch.base:
2665
remote_branch = local_branch
2666
local_branch.lock_read()
2668
remote_branch.lock_read()
2670
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2671
if (log_format is None):
2672
default = local_branch.get_config().log_format()
2673
log_format = get_log_format(long=long, short=short,
2674
line=line, default=default)
2675
lf = log_formatter(log_format,
2678
show_timezone='original')
2679
if reverse is False:
2680
local_extra.reverse()
2681
remote_extra.reverse()
2682
if local_extra and not theirs_only:
2683
print "You have %d extra revision(s):" % len(local_extra)
2684
for data in iter_log_data(local_extra, local_branch.repository,
2687
printed_local = True
2689
printed_local = False
2690
if remote_extra and not mine_only:
2691
if printed_local is True:
2693
print "You are missing %d revision(s):" % len(remote_extra)
2694
for data in iter_log_data(remote_extra, remote_branch.repository,
2697
if not remote_extra and not local_extra:
2699
print "Branches are up to date."
2703
remote_branch.unlock()
2705
local_branch.unlock()
2706
if not status_code and parent is None and other_branch is not None:
2707
local_branch.lock_write()
2709
# handle race conditions - a parent might be set while we run.
2710
if local_branch.get_parent() is None:
2711
local_branch.set_parent(remote_branch.base)
2713
local_branch.unlock()
2717
class cmd_plugins(Command):
2722
import bzrlib.plugin
2723
from inspect import getdoc
2724
for name, plugin in bzrlib.plugin.all_plugins().items():
2725
if getattr(plugin, '__path__', None) is not None:
2726
print plugin.__path__[0]
2727
elif getattr(plugin, '__file__', None) is not None:
2728
print plugin.__file__
2734
print '\t', d.split('\n')[0]
2737
class cmd_testament(Command):
2738
"""Show testament (signing-form) of a revision."""
2739
takes_options = ['revision',
2740
Option('long', help='Produce long-format testament'),
2741
Option('strict', help='Produce a strict-format'
2743
takes_args = ['branch?']
2745
def run(self, branch=u'.', revision=None, long=False, strict=False):
2746
from bzrlib.testament import Testament, StrictTestament
2748
testament_class = StrictTestament
2750
testament_class = Testament
2751
b = WorkingTree.open_containing(branch)[0].branch
2754
if revision is None:
2755
rev_id = b.last_revision()
2757
rev_id = revision[0].in_history(b).rev_id
2758
t = testament_class.from_revision(b.repository, rev_id)
2760
sys.stdout.writelines(t.as_text_lines())
2762
sys.stdout.write(t.as_short_text())
2767
class cmd_annotate(Command):
2768
"""Show the origin of each line in a file.
2770
This prints out the given file with an annotation on the left side
2771
indicating which revision, author and date introduced the change.
2773
If the origin is the same for a run of consecutive lines, it is
2774
shown only at the top, unless the --all option is given.
2776
# TODO: annotate directories; showing when each file was last changed
2777
# TODO: if the working copy is modified, show annotations on that
2778
# with new uncommitted lines marked
2779
aliases = ['ann', 'blame', 'praise']
2780
takes_args = ['filename']
2781
takes_options = [Option('all', help='show annotations on all lines'),
2782
Option('long', help='show date in annotations'),
2788
def run(self, filename, all=False, long=False, revision=None,
2790
from bzrlib.annotate import annotate_file
2791
tree, relpath = WorkingTree.open_containing(filename)
2792
branch = tree.branch
2795
if revision is None:
2796
revision_id = branch.last_revision()
2797
elif len(revision) != 1:
2798
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2800
revision_id = revision[0].in_history(branch).rev_id
2801
file_id = tree.inventory.path2id(relpath)
2802
tree = branch.repository.revision_tree(revision_id)
2803
file_version = tree.inventory[file_id].revision
2804
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2810
class cmd_re_sign(Command):
2811
"""Create a digital signature for an existing revision."""
2812
# TODO be able to replace existing ones.
2814
hidden = True # is this right ?
2815
takes_args = ['revision_id*']
2816
takes_options = ['revision']
2818
def run(self, revision_id_list=None, revision=None):
2819
import bzrlib.gpg as gpg
2820
if revision_id_list is not None and revision is not None:
2821
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2822
if revision_id_list is None and revision is None:
2823
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2824
b = WorkingTree.open_containing(u'.')[0].branch
2825
gpg_strategy = gpg.GPGStrategy(b.get_config())
2826
if revision_id_list is not None:
2827
for revision_id in revision_id_list:
2828
b.repository.sign_revision(revision_id, gpg_strategy)
2829
elif revision is not None:
2830
if len(revision) == 1:
2831
revno, rev_id = revision[0].in_history(b)
2832
b.repository.sign_revision(rev_id, gpg_strategy)
2833
elif len(revision) == 2:
2834
# are they both on rh- if so we can walk between them
2835
# might be nice to have a range helper for arbitrary
2836
# revision paths. hmm.
2837
from_revno, from_revid = revision[0].in_history(b)
2838
to_revno, to_revid = revision[1].in_history(b)
2839
if to_revid is None:
2840
to_revno = b.revno()
2841
if from_revno is None or to_revno is None:
2842
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2843
for revno in range(from_revno, to_revno + 1):
2844
b.repository.sign_revision(b.get_rev_id(revno),
2847
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2850
class cmd_bind(Command):
2851
"""Bind the current branch to a master branch.
2853
After binding, commits must succeed on the master branch
2854
before they are executed on the local one.
2857
takes_args = ['location']
2860
def run(self, location=None):
2861
b, relpath = Branch.open_containing(u'.')
2862
b_other = Branch.open(location)
2865
except errors.DivergedBranches:
2866
raise errors.BzrCommandError('These branches have diverged.'
2867
' Try merging, and then bind again.')
2870
class cmd_unbind(Command):
2871
"""Unbind the current branch from its master branch.
2873
After unbinding, the local branch is considered independent.
2874
All subsequent commits will be local.
2881
b, relpath = Branch.open_containing(u'.')
2883
raise errors.BzrCommandError('Local branch is not bound')
2886
class cmd_uncommit(Command):
2887
"""Remove the last committed revision.
2889
--verbose will print out what is being removed.
2890
--dry-run will go through all the motions, but not actually
2893
In the future, uncommit will create a revision bundle, which can then
2897
# TODO: jam 20060108 Add an option to allow uncommit to remove
2898
# unreferenced information in 'branch-as-repository' branches.
2899
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2900
# information in shared branches as well.
2901
takes_options = ['verbose', 'revision',
2902
Option('dry-run', help='Don\'t actually make changes'),
2903
Option('force', help='Say yes to all questions.')]
2904
takes_args = ['location?']
2907
def run(self, location=None,
2908
dry_run=False, verbose=False,
2909
revision=None, force=False):
2910
from bzrlib.log import log_formatter, show_log
2912
from bzrlib.uncommit import uncommit
2914
if location is None:
2916
control, relpath = bzrdir.BzrDir.open_containing(location)
2918
tree = control.open_workingtree()
2920
except (errors.NoWorkingTree, errors.NotLocalUrl):
2922
b = control.open_branch()
2925
if revision is None:
2928
# 'bzr uncommit -r 10' actually means uncommit
2929
# so that the final tree is at revno 10.
2930
# but bzrlib.uncommit.uncommit() actually uncommits
2931
# the revisions that are supplied.
2932
# So we need to offset it by one
2933
revno = revision[0].in_history(b).revno+1
2935
if revno <= b.revno():
2936
rev_id = b.get_rev_id(revno)
2938
self.outf.write('No revisions to uncommit.\n')
2941
lf = log_formatter('short',
2943
show_timezone='original')
2948
direction='forward',
2949
start_revision=revno,
2950
end_revision=b.revno())
2953
print 'Dry-run, pretending to remove the above revisions.'
2955
val = raw_input('Press <enter> to continue')
2957
print 'The above revision(s) will be removed.'
2959
val = raw_input('Are you sure [y/N]? ')
2960
if val.lower() not in ('y', 'yes'):
2964
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2968
class cmd_break_lock(Command):
2969
"""Break a dead lock on a repository, branch or working directory.
2971
CAUTION: Locks should only be broken when you are sure that the process
2972
holding the lock has been stopped.
2974
You can get information on what locks are open via the 'bzr info' command.
2979
takes_args = ['location?']
2981
def run(self, location=None, show=False):
2982
if location is None:
2984
control, relpath = bzrdir.BzrDir.open_containing(location)
2986
control.break_lock()
2987
except NotImplementedError:
2991
class cmd_wait_until_signalled(Command):
2992
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
2994
This just prints a line to signal when it is ready, then blocks on stdin.
3000
sys.stdout.write("running\n")
3002
sys.stdin.readline()
3005
class cmd_serve(Command):
3006
"""Run the bzr server."""
3008
aliases = ['server']
3012
help='serve on stdin/out for use from inetd or sshd'),
3014
help='listen for connections on nominated port of the form '
3015
'[hostname:]portnumber. Passing 0 as the port number will '
3016
'result in a dynamically allocated port.',
3019
help='serve contents of directory',
3021
Option('allow-writes',
3022
help='By default the server is a readonly server. Supplying '
3023
'--allow-writes enables write access to the contents of '
3024
'the served directory and below. '
3028
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3029
from bzrlib.transport import smart
3030
from bzrlib.transport import get_transport
3031
if directory is None:
3032
directory = os.getcwd()
3033
url = urlutils.local_path_to_url(directory)
3034
if not allow_writes:
3035
url = 'readonly+' + url
3036
t = get_transport(url)
3038
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3039
elif port is not None:
3041
host, port = port.split(':')
3044
server = smart.SmartTCPServer(t, host=host, port=int(port))
3045
print 'listening on port: ', server.port
3048
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3052
class cmd_tag(Command):
3053
"""Create a tag naming a revision.
3055
Tags give human-meaningful names to revisions. Commands that take a -r
3056
(--revision) option can be given -rtag:X, where X is any previously
3059
Tags are stored in the repository, and apply to all branches stored
3060
in the repository. Tags are copied from one branch to another along
3061
when you branch, push, pull or merge.
3064
takes_args = ['tag_name']
3067
help='branch or repository to tag',
3074
def run(self, tag_name, directory='.', revision=None):
3075
branch, relpath = Branch.open_containing(directory)
3077
if len(revision) != 1:
3078
raise errors.BzrCommandError(
3079
"Tags can only be placed on a single revision, "
3081
revision_id = revision[0].in_history(branch).rev_id
3083
revision_id = branch.last_revision()
3084
branch.repository.set_tag(tag_name, revision_id)
3085
self.outf.write('created tag %s' % tag_name)
3088
# command-line interpretation helper for merge-related commands
3089
def _merge_helper(other_revision, base_revision,
3090
check_clean=True, ignore_zero=False,
3091
this_dir=None, backup_files=False,
3093
file_list=None, show_base=False, reprocess=False,
3095
pb=DummyProgress()):
3096
"""Merge changes into a tree.
3099
list(path, revno) Base for three-way merge.
3100
If [None, None] then a base will be automatically determined.
3102
list(path, revno) Other revision for three-way merge.
3104
Directory to merge changes into; '.' by default.
3106
If true, this_dir must have no uncommitted changes before the
3108
ignore_zero - If true, suppress the "zero conflicts" message when
3109
there are no conflicts; should be set when doing something we expect
3110
to complete perfectly.
3111
file_list - If supplied, merge only changes to selected files.
3113
All available ancestors of other_revision and base_revision are
3114
automatically pulled into the branch.
3116
The revno may be -1 to indicate the last revision on the branch, which is
3119
This function is intended for use from the command line; programmatic
3120
clients might prefer to call merge.merge_inner(), which has less magic
3123
# Loading it late, so that we don't always have to import bzrlib.merge
3124
if merge_type is None:
3125
merge_type = _mod_merge.Merge3Merger
3126
if this_dir is None:
3128
this_tree = WorkingTree.open_containing(this_dir)[0]
3129
if show_base and not merge_type is _mod_merge.Merge3Merger:
3130
raise errors.BzrCommandError("Show-base is not supported for this merge"
3131
" type. %s" % merge_type)
3132
if reprocess and not merge_type.supports_reprocess:
3133
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3134
" type %s." % merge_type)
3135
if reprocess and show_base:
3136
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3138
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3140
merger.pp = ProgressPhase("Merge phase", 5, pb)
3141
merger.pp.next_phase()
3142
merger.check_basis(check_clean)
3143
merger.set_other(other_revision)
3144
merger.pp.next_phase()
3145
merger.set_base(base_revision)
3146
if merger.base_rev_id == merger.other_rev_id:
3147
note('Nothing to do.')
3149
if file_list is None:
3150
if pull and merger.base_rev_id == merger.this_rev_id:
3151
count = merger.this_tree.pull(merger.this_branch,
3152
False, merger.other_rev_id)
3153
note('%d revision(s) pulled.' % (count,))
3155
merger.backup_files = backup_files
3156
merger.merge_type = merge_type
3157
merger.set_interesting_files(file_list)
3158
merger.show_base = show_base
3159
merger.reprocess = reprocess
3160
conflicts = merger.do_merge()
3161
if file_list is None:
3162
merger.set_pending()
3169
merge = _merge_helper
3172
# these get imported and then picked up by the scan for cmd_*
3173
# TODO: Some more consistent way to split command definitions across files;
3174
# we do need to load at least some information about them to know of
3175
# aliases. ideally we would avoid loading the implementation until the
3176
# details were needed.
3177
from bzrlib.cmd_version_info import cmd_version_info
3178
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3179
from bzrlib.bundle.commands import cmd_bundle_revisions
3180
from bzrlib.sign_my_commits import cmd_sign_my_commits
3181
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3182
cmd_weave_plan_merge, cmd_weave_merge_text