1
# Copyright (C) 2004, 2005, 2006 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']
541
takes_args = ['location?']
542
encoding_type = 'replace'
544
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
545
# FIXME: too much stuff is in the command class
547
tree_to = WorkingTree.open_containing(u'.')[0]
548
branch_to = tree_to.branch
549
except errors.NoWorkingTree:
551
branch_to = Branch.open_containing(u'.')[0]
554
if location is not None:
556
reader = bundle.read_bundle_from_url(location)
557
except errors.NotABundle:
558
pass # Continue on considering this url a Branch
560
stored_loc = branch_to.get_parent()
562
if stored_loc is None:
563
raise errors.BzrCommandError("No pull location known or"
566
display_url = urlutils.unescape_for_display(stored_loc,
568
self.outf.write("Using saved location: %s\n" % display_url)
569
location = stored_loc
572
if reader is not None:
573
install_bundle(branch_to.repository, reader)
574
branch_from = branch_to
576
branch_from = Branch.open(location)
578
if branch_to.get_parent() is None or remember:
579
branch_to.set_parent(branch_from.base)
583
if reader is not None:
584
rev_id = reader.target
585
elif len(revision) == 1:
586
rev_id = revision[0].in_history(branch_from).rev_id
588
raise errors.BzrCommandError('bzr pull --revision takes one value.')
590
old_rh = branch_to.revision_history()
591
if tree_to is not None:
592
count = tree_to.pull(branch_from, overwrite, rev_id)
594
count = branch_to.pull(branch_from, overwrite, rev_id)
595
note('%d revision(s) pulled.' % (count,))
598
new_rh = branch_to.revision_history()
601
from bzrlib.log import show_changed_revisions
602
show_changed_revisions(branch_to, old_rh, new_rh,
606
class cmd_push(Command):
607
"""Update a mirror of this branch.
609
The target branch will not have its working tree populated because this
610
is both expensive, and is not supported on remote file systems.
612
Some smart servers or protocols *may* put the working tree in place in
615
This command only works on branches that have not diverged. Branches are
616
considered diverged if the destination branch's most recent commit is one
617
that has not been merged (directly or indirectly) by the source branch.
619
If branches have diverged, you can use 'bzr push --overwrite' to replace
620
the other branch completely, discarding its unmerged changes.
622
If you want to ensure you have the different changes in the other branch,
623
do a merge (see bzr help merge) from the other branch, and commit that.
624
After that you will be able to do a push without '--overwrite'.
626
If there is no default push location set, the first push will set it.
627
After that, you can omit the location to use the default. To change the
628
default, use --remember. The value will only be saved if the remote
629
location can be accessed.
632
takes_options = ['remember', 'overwrite', 'verbose',
633
Option('create-prefix',
634
help='Create the path leading up to the branch '
635
'if it does not already exist')]
636
takes_args = ['location?']
637
encoding_type = 'replace'
639
def run(self, location=None, remember=False, overwrite=False,
640
create_prefix=False, verbose=False):
641
# FIXME: Way too big! Put this into a function called from the
644
br_from = Branch.open_containing('.')[0]
645
stored_loc = br_from.get_push_location()
647
if stored_loc is None:
648
raise errors.BzrCommandError("No push location known or specified.")
650
display_url = urlutils.unescape_for_display(stored_loc,
652
self.outf.write("Using saved location: %s\n" % display_url)
653
location = stored_loc
655
to_transport = transport.get_transport(location)
656
location_url = to_transport.base
660
dir_to = bzrdir.BzrDir.open(location_url)
661
br_to = dir_to.open_branch()
662
except errors.NotBranchError:
664
to_transport = to_transport.clone('..')
665
if not create_prefix:
667
relurl = to_transport.relpath(location_url)
668
mutter('creating directory %s => %s', location_url, relurl)
669
to_transport.mkdir(relurl)
670
except errors.NoSuchFile:
671
raise errors.BzrCommandError("Parent directory of %s "
672
"does not exist." % location)
674
current = to_transport.base
675
needed = [(to_transport, to_transport.relpath(location_url))]
678
to_transport, relpath = needed[-1]
679
to_transport.mkdir(relpath)
681
except errors.NoSuchFile:
682
new_transport = to_transport.clone('..')
683
needed.append((new_transport,
684
new_transport.relpath(to_transport.base)))
685
if new_transport.base == to_transport.base:
686
raise errors.BzrCommandError("Could not create "
688
dir_to = br_from.bzrdir.clone(location_url,
689
revision_id=br_from.last_revision())
690
br_to = dir_to.open_branch()
691
count = br_to.last_revision_info()[0]
692
# We successfully created the target, remember it
693
if br_from.get_push_location() is None or remember:
694
br_from.set_push_location(br_to.base)
696
# We were able to connect to the remote location, so remember it
697
# we don't need to successfully push because of possible divergence.
698
if br_from.get_push_location() is None or remember:
699
br_from.set_push_location(br_to.base)
700
old_rh = br_to.revision_history()
703
tree_to = dir_to.open_workingtree()
704
except errors.NotLocalUrl:
705
warning('This transport does not update the working '
706
'tree of: %s' % (br_to.base,))
707
count = br_from.push(br_to, overwrite)
708
except errors.NoWorkingTree:
709
count = br_from.push(br_to, overwrite)
713
count = br_from.push(tree_to.branch, overwrite)
717
except errors.DivergedBranches:
718
raise errors.BzrCommandError('These branches have diverged.'
719
' Try using "merge" and then "push".')
720
note('%d revision(s) pushed.' % (count,))
723
new_rh = br_to.revision_history()
726
from bzrlib.log import show_changed_revisions
727
show_changed_revisions(br_to, old_rh, new_rh,
731
class cmd_branch(Command):
732
"""Create a new copy of a branch.
734
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
735
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
737
To retrieve the branch as of a particular revision, supply the --revision
738
parameter, as in "branch foo/bar -r 5".
740
--basis is to speed up branching from remote branches. When specified, it
741
copies all the file-contents, inventory and revision data from the basis
742
branch before copying anything from the remote branch.
744
takes_args = ['from_location', 'to_location?']
745
takes_options = ['revision', 'basis']
746
aliases = ['get', 'clone']
748
def run(self, from_location, to_location=None, revision=None, basis=None):
751
elif len(revision) > 1:
752
raise errors.BzrCommandError(
753
'bzr branch --revision takes exactly 1 revision value')
755
br_from = Branch.open(from_location)
757
if e.errno == errno.ENOENT:
758
raise errors.BzrCommandError('Source location "%s" does not'
759
' exist.' % to_location)
764
if basis is not None:
765
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
768
if len(revision) == 1 and revision[0] is not None:
769
revision_id = revision[0].in_history(br_from)[1]
771
# FIXME - wt.last_revision, fallback to branch, fall back to
772
# None or perhaps NULL_REVISION to mean copy nothing
774
revision_id = br_from.last_revision()
775
if to_location is None:
776
to_location = os.path.basename(from_location.rstrip("/\\"))
779
name = os.path.basename(to_location) + '\n'
781
to_transport = transport.get_transport(to_location)
783
to_transport.mkdir('.')
784
except errors.FileExists:
785
raise errors.BzrCommandError('Target directory "%s" already'
786
' exists.' % to_location)
787
except errors.NoSuchFile:
788
raise errors.BzrCommandError('Parent of "%s" does not exist.'
791
# preserve whatever source format we have.
792
dir = br_from.bzrdir.sprout(to_transport.base,
793
revision_id, basis_dir)
794
branch = dir.open_branch()
795
except errors.NoSuchRevision:
796
to_transport.delete_tree('.')
797
msg = "The branch %s has no revision %s." % (from_location, revision[0])
798
raise errors.BzrCommandError(msg)
799
except errors.UnlistableBranch:
800
osutils.rmtree(to_location)
801
msg = "The branch %s cannot be used as a --basis" % (basis,)
802
raise errors.BzrCommandError(msg)
804
branch.control_files.put_utf8('branch-name', name)
805
note('Branched %d revision(s).' % branch.revno())
810
class cmd_checkout(Command):
811
"""Create a new checkout of an existing branch.
813
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
814
the branch found in '.'. This is useful if you have removed the working tree
815
or if it was never created - i.e. if you pushed the branch to its current
818
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
819
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
821
To retrieve the branch as of a particular revision, supply the --revision
822
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
823
out of date [so you cannot commit] but it may be useful (i.e. to examine old
826
--basis is to speed up checking out from remote branches. When specified, it
827
uses the inventory and file contents from the basis branch in preference to the
828
branch being checked out.
830
takes_args = ['branch_location?', 'to_location?']
831
takes_options = ['revision', # , 'basis']
832
Option('lightweight',
833
help="perform a lightweight checkout. Lightweight "
834
"checkouts depend on access to the branch for "
835
"every operation. Normal checkouts can perform "
836
"common operations like diff and status without "
837
"such access, and also support local commits."
842
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
846
elif len(revision) > 1:
847
raise errors.BzrCommandError(
848
'bzr checkout --revision takes exactly 1 revision value')
849
if branch_location is None:
850
branch_location = osutils.getcwd()
851
to_location = branch_location
852
source = Branch.open(branch_location)
853
if len(revision) == 1 and revision[0] is not None:
854
revision_id = revision[0].in_history(source)[1]
857
if to_location is None:
858
to_location = os.path.basename(branch_location.rstrip("/\\"))
859
# if the source and to_location are the same,
860
# and there is no working tree,
861
# then reconstitute a branch
862
if (osutils.abspath(to_location) ==
863
osutils.abspath(branch_location)):
865
source.bzrdir.open_workingtree()
866
except errors.NoWorkingTree:
867
source.bzrdir.create_workingtree()
870
os.mkdir(to_location)
872
if e.errno == errno.EEXIST:
873
raise errors.BzrCommandError('Target directory "%s" already'
874
' exists.' % to_location)
875
if e.errno == errno.ENOENT:
876
raise errors.BzrCommandError('Parent of "%s" does not exist.'
880
source.create_checkout(to_location, revision_id, lightweight)
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?']
1125
RegistryOption('format',
1126
help='Specify a format for this branch. See "bzr '
1127
'help formats" for details',
1128
converter=bzrdir.format_registry.make_bzrdir,
1129
registry=bzrdir.format_registry,
1130
value_switches=True, title="Branch Format"),
1132
def run(self, location=None, format=None):
1134
format = bzrdir.format_registry.make_bzrdir('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 = [RegistryOption('format',
1184
help='Specify a format for this repository. See'
1185
' "bzr help formats" for details',
1186
registry=bzrdir.format_registry,
1187
converter=bzrdir.format_registry.make_bzrdir,
1188
value_switches=True, title='Repository format'),
1190
help='Allows branches in repository to have'
1192
aliases = ["init-repo"]
1193
def run(self, location, format=None, trees=False):
1195
format = bzrdir.format_registry.make_bzrdir('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.
1347
See also: "bzr status".
1354
tree = WorkingTree.open_containing(u'.')[0]
1355
td = tree.changes_from(tree.basis_tree())
1356
for path, id, kind, text_modified, meta_modified in td.modified:
1357
self.outf.write(path + '\n')
1360
class cmd_added(Command):
1361
"""List files added in working tree.
1363
See also: "bzr status".
1370
wt = WorkingTree.open_containing(u'.')[0]
1371
basis_inv = wt.basis_tree().inventory
1374
if file_id in basis_inv:
1376
if inv.is_root(file_id) and len(basis_inv) == 0:
1378
path = inv.id2path(file_id)
1379
if not os.access(osutils.abspath(path), os.F_OK):
1381
self.outf.write(path + '\n')
1384
class cmd_root(Command):
1385
"""Show the tree root directory.
1387
The root is the nearest enclosing directory with a .bzr control
1389
takes_args = ['filename?']
1391
def run(self, filename=None):
1392
"""Print the branch root."""
1393
tree = WorkingTree.open_containing(filename)[0]
1394
self.outf.write(tree.basedir + '\n')
1397
class cmd_log(Command):
1398
"""Show log of a branch, file, or directory.
1400
By default show the log of the branch containing the working directory.
1402
To request a range of logs, you can use the command -r begin..end
1403
-r revision requests a specific revision, -r ..end or -r begin.. are
1409
bzr log -r -10.. http://server/branch
1412
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1414
takes_args = ['location?']
1415
takes_options = [Option('forward',
1416
help='show from oldest to newest'),
1420
help='show files changed in each revision'),
1421
'show-ids', 'revision',
1425
help='show revisions whose message matches this regexp',
1428
encoding_type = 'replace'
1431
def run(self, location=None, timezone='original',
1438
from bzrlib.log import show_log
1439
assert message is None or isinstance(message, basestring), \
1440
"invalid message argument %r" % message
1441
direction = (forward and 'forward') or 'reverse'
1446
# find the file id to log:
1448
dir, fp = bzrdir.BzrDir.open_containing(location)
1449
b = dir.open_branch()
1453
inv = dir.open_workingtree().inventory
1454
except (errors.NotBranchError, errors.NotLocalUrl):
1455
# either no tree, or is remote.
1456
inv = b.basis_tree().inventory
1457
file_id = inv.path2id(fp)
1459
raise errors.BzrCommandError(
1460
"Path does not have any revision history: %s" %
1464
# FIXME ? log the current subdir only RBC 20060203
1465
if revision is not None \
1466
and len(revision) > 0 and revision[0].get_branch():
1467
location = revision[0].get_branch()
1470
dir, relpath = bzrdir.BzrDir.open_containing(location)
1471
b = dir.open_branch()
1473
if revision is None:
1476
elif len(revision) == 1:
1477
rev1 = rev2 = revision[0].in_history(b).revno
1478
elif len(revision) == 2:
1479
if revision[1].get_branch() != revision[0].get_branch():
1480
# b is taken from revision[0].get_branch(), and
1481
# show_log will use its revision_history. Having
1482
# different branches will lead to weird behaviors.
1483
raise errors.BzrCommandError(
1484
"Log doesn't accept two revisions in different branches.")
1485
if revision[0].spec is None:
1486
# missing begin-range means first revision
1489
rev1 = revision[0].in_history(b).revno
1491
if revision[1].spec is None:
1492
# missing end-range means last known revision
1495
rev2 = revision[1].in_history(b).revno
1497
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1499
# By this point, the revision numbers are converted to the +ve
1500
# form if they were supplied in the -ve form, so we can do
1501
# this comparison in relative safety
1503
(rev2, rev1) = (rev1, rev2)
1505
if log_format is None:
1506
log_format = log.log_formatter_registry.get_default(b)
1508
lf = log_format(show_ids=show_ids, to_file=self.outf,
1509
show_timezone=timezone)
1515
direction=direction,
1516
start_revision=rev1,
1521
def get_log_format(long=False, short=False, line=False, default='long'):
1522
log_format = default
1526
log_format = 'short'
1532
class cmd_touching_revisions(Command):
1533
"""Return revision-ids which affected a particular file.
1535
A more user-friendly interface is "bzr log FILE".
1539
takes_args = ["filename"]
1542
def run(self, filename):
1543
tree, relpath = WorkingTree.open_containing(filename)
1545
inv = tree.read_working_inventory()
1546
file_id = inv.path2id(relpath)
1547
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1548
self.outf.write("%6d %s\n" % (revno, what))
1551
class cmd_ls(Command):
1552
"""List files in a tree.
1555
takes_args = ['path?']
1556
# TODO: Take a revision or remote path and list that tree instead.
1557
takes_options = ['verbose', 'revision',
1558
Option('non-recursive',
1559
help='don\'t recurse into sub-directories'),
1561
help='Print all paths from the root of the branch.'),
1562
Option('unknown', help='Print unknown files'),
1563
Option('versioned', help='Print versioned files'),
1564
Option('ignored', help='Print ignored files'),
1566
Option('null', help='Null separate the files'),
1570
def run(self, revision=None, verbose=False,
1571
non_recursive=False, from_root=False,
1572
unknown=False, versioned=False, ignored=False,
1573
null=False, kind=None, show_ids=False, path=None):
1575
if kind and kind not in ('file', 'directory', 'symlink'):
1576
raise errors.BzrCommandError('invalid kind specified')
1578
if verbose and null:
1579
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1580
all = not (unknown or versioned or ignored)
1582
selection = {'I':ignored, '?':unknown, 'V':versioned}
1589
raise errors.BzrCommandError('cannot specify both --from-root'
1593
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1599
if revision is not None:
1600
tree = branch.repository.revision_tree(
1601
revision[0].in_history(branch).rev_id)
1603
tree = branch.basis_tree()
1605
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1606
if fp.startswith(relpath):
1607
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1608
if non_recursive and '/' in fp:
1610
if not all and not selection[fc]:
1612
if kind is not None and fkind != kind:
1615
kindch = entry.kind_character()
1616
outstring = '%-8s %s%s' % (fc, fp, kindch)
1617
if show_ids and fid is not None:
1618
outstring = "%-50s %s" % (outstring, fid)
1619
self.outf.write(outstring + '\n')
1621
self.outf.write(fp + '\0')
1624
self.outf.write(fid)
1625
self.outf.write('\0')
1633
self.outf.write('%-50s %s\n' % (fp, my_id))
1635
self.outf.write(fp + '\n')
1638
class cmd_unknowns(Command):
1639
"""List unknown files.
1641
See also: "bzr ls --unknown".
1648
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1649
self.outf.write(osutils.quotefn(f) + '\n')
1652
class cmd_ignore(Command):
1653
"""Ignore specified files or patterns.
1655
To remove patterns from the ignore list, edit the .bzrignore file.
1657
Trailing slashes on patterns are ignored.
1658
If the pattern contains a slash or is a regular expression, it is compared
1659
to the whole path from the branch root. Otherwise, it is compared to only
1660
the last component of the path. To match a file only in the root
1661
directory, prepend './'.
1663
Ignore patterns specifying absolute paths are not allowed.
1665
Ignore patterns may include globbing wildcards such as:
1666
? - Matches any single character except '/'
1667
* - Matches 0 or more characters except '/'
1668
/**/ - Matches 0 or more directories in a path
1669
[a-z] - Matches a single character from within a group of characters
1671
Ignore patterns may also be Python regular expressions.
1672
Regular expression ignore patterns are identified by a 'RE:' prefix
1673
followed by the regular expression. Regular expression ignore patterns
1674
may not include named or numbered groups.
1676
Note: ignore patterns containing shell wildcards must be quoted from
1680
bzr ignore ./Makefile
1681
bzr ignore '*.class'
1682
bzr ignore 'lib/**/*.o'
1683
bzr ignore 'RE:lib/.*\.o'
1685
takes_args = ['name_pattern*']
1687
Option('old-default-rules',
1688
help='Out the ignore rules bzr < 0.9 always used.')
1691
def run(self, name_pattern_list=None, old_default_rules=None):
1692
from bzrlib.atomicfile import AtomicFile
1693
if old_default_rules is not None:
1694
# dump the rules and exit
1695
for pattern in ignores.OLD_DEFAULTS:
1698
if not name_pattern_list:
1699
raise errors.BzrCommandError("ignore requires at least one "
1700
"NAME_PATTERN or --old-default-rules")
1701
for name_pattern in name_pattern_list:
1702
if name_pattern[0] == '/':
1703
raise errors.BzrCommandError(
1704
"NAME_PATTERN should not be an absolute path")
1705
tree, relpath = WorkingTree.open_containing(u'.')
1706
ifn = tree.abspath('.bzrignore')
1707
if os.path.exists(ifn):
1710
igns = f.read().decode('utf-8')
1716
# TODO: If the file already uses crlf-style termination, maybe
1717
# we should use that for the newly added lines?
1719
if igns and igns[-1] != '\n':
1721
for name_pattern in name_pattern_list:
1722
igns += name_pattern.rstrip('/') + '\n'
1724
f = AtomicFile(ifn, 'wb')
1726
f.write(igns.encode('utf-8'))
1731
inv = tree.inventory
1732
if inv.path2id('.bzrignore'):
1733
mutter('.bzrignore is already versioned')
1735
mutter('need to make new .bzrignore file versioned')
1736
tree.add(['.bzrignore'])
1739
class cmd_ignored(Command):
1740
"""List ignored files and the patterns that matched them.
1742
See also: bzr ignore"""
1745
tree = WorkingTree.open_containing(u'.')[0]
1746
for path, file_class, kind, file_id, entry in tree.list_files():
1747
if file_class != 'I':
1749
## XXX: Slightly inefficient since this was already calculated
1750
pat = tree.is_ignored(path)
1751
print '%-50s %s' % (path, pat)
1754
class cmd_lookup_revision(Command):
1755
"""Lookup the revision-id from a revision-number
1758
bzr lookup-revision 33
1761
takes_args = ['revno']
1764
def run(self, revno):
1768
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1770
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1773
class cmd_export(Command):
1774
"""Export past revision to destination directory.
1776
If no revision is specified this exports the last committed revision.
1778
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1779
given, try to find the format with the extension. If no extension
1780
is found exports to a directory (equivalent to --format=dir).
1782
Root may be the top directory for tar, tgz and tbz2 formats. If none
1783
is given, the top directory will be the root name of the file.
1785
If branch is omitted then the branch containing the CWD will be used.
1787
Note: export of tree with non-ascii filenames to zip is not supported.
1789
Supported formats Autodetected by extension
1790
----------------- -------------------------
1793
tbz2 .tar.bz2, .tbz2
1797
takes_args = ['dest', 'branch?']
1798
takes_options = ['revision', 'format', 'root']
1799
def run(self, dest, branch=None, revision=None, format=None, root=None):
1800
from bzrlib.export import export
1803
tree = WorkingTree.open_containing(u'.')[0]
1806
b = Branch.open(branch)
1808
if revision is None:
1809
# should be tree.last_revision FIXME
1810
rev_id = b.last_revision()
1812
if len(revision) != 1:
1813
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1814
rev_id = revision[0].in_history(b).rev_id
1815
t = b.repository.revision_tree(rev_id)
1817
export(t, dest, format, root)
1818
except errors.NoSuchExportFormat, e:
1819
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1822
class cmd_cat(Command):
1823
"""Write a file's text from a previous revision."""
1825
takes_options = ['revision', 'name-from-revision']
1826
takes_args = ['filename']
1827
encoding_type = 'exact'
1830
def run(self, filename, revision=None, name_from_revision=False):
1831
if revision is not None and len(revision) != 1:
1832
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1837
tree, relpath = WorkingTree.open_containing(filename)
1839
except (errors.NotBranchError, errors.NotLocalUrl):
1842
if revision is not None and revision[0].get_branch() is not None:
1843
b = Branch.open(revision[0].get_branch())
1845
b, relpath = Branch.open_containing(filename)
1846
tree = b.basis_tree()
1847
if revision is None:
1848
revision_id = b.last_revision()
1850
revision_id = revision[0].in_history(b).rev_id
1852
cur_file_id = tree.path2id(relpath)
1853
rev_tree = b.repository.revision_tree(revision_id)
1854
old_file_id = rev_tree.path2id(relpath)
1856
if name_from_revision:
1857
if old_file_id is None:
1858
raise errors.BzrCommandError("%r is not present in revision %s"
1859
% (filename, revision_id))
1861
rev_tree.print_file(old_file_id)
1862
elif cur_file_id is not None:
1863
rev_tree.print_file(cur_file_id)
1864
elif old_file_id is not None:
1865
rev_tree.print_file(old_file_id)
1867
raise errors.BzrCommandError("%r is not present in revision %s" %
1868
(filename, revision_id))
1871
class cmd_local_time_offset(Command):
1872
"""Show the offset in seconds from GMT to local time."""
1876
print osutils.local_time_offset()
1880
class cmd_commit(Command):
1881
"""Commit changes into a new revision.
1883
If no arguments are given, the entire tree is committed.
1885
If selected files are specified, only changes to those files are
1886
committed. If a directory is specified then the directory and everything
1887
within it is committed.
1889
A selected-file commit may fail in some cases where the committed
1890
tree would be invalid, such as trying to commit a file in a
1891
newly-added directory that is not itself committed.
1893
# TODO: Run hooks on tree to-be-committed, and after commit.
1895
# TODO: Strict commit that fails if there are deleted files.
1896
# (what does "deleted files" mean ??)
1898
# TODO: Give better message for -s, --summary, used by tla people
1900
# XXX: verbose currently does nothing
1902
takes_args = ['selected*']
1903
takes_options = ['message', 'verbose',
1905
help='commit even if nothing has changed'),
1906
Option('file', type=str,
1909
help='file containing commit message'),
1911
help="refuse to commit if there are unknown "
1912
"files in the working tree."),
1914
help="perform a local only commit in a bound "
1915
"branch. Such commits are not pushed to "
1916
"the master branch until a normal commit "
1920
aliases = ['ci', 'checkin']
1922
def run(self, message=None, file=None, verbose=True, selected_list=None,
1923
unchanged=False, strict=False, local=False):
1924
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1925
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1927
from bzrlib.msgeditor import edit_commit_message, \
1928
make_commit_message_template
1930
# TODO: Need a blackbox test for invoking the external editor; may be
1931
# slightly problematic to run this cross-platform.
1933
# TODO: do more checks that the commit will succeed before
1934
# spending the user's valuable time typing a commit message.
1935
tree, selected_list = tree_files(selected_list)
1936
if selected_list == ['']:
1937
# workaround - commit of root of tree should be exactly the same
1938
# as just default commit in that tree, and succeed even though
1939
# selected-file merge commit is not done yet
1942
if local and not tree.branch.get_bound_location():
1943
raise errors.LocalRequiresBoundBranch()
1945
def get_message(commit_obj):
1946
"""Callback to get commit message"""
1947
my_message = message
1948
if my_message is None and not file:
1949
template = make_commit_message_template(tree, selected_list)
1950
my_message = edit_commit_message(template)
1951
if my_message is None:
1952
raise errors.BzrCommandError("please specify a commit"
1953
" message with either --message or --file")
1954
elif my_message and file:
1955
raise errors.BzrCommandError(
1956
"please specify either --message or --file")
1958
my_message = codecs.open(file, 'rt',
1959
bzrlib.user_encoding).read()
1960
if my_message == "":
1961
raise errors.BzrCommandError("empty commit message specified")
1965
reporter = ReportCommitToLog()
1967
reporter = NullCommitReporter()
1970
tree.commit(message_callback=get_message,
1971
specific_files=selected_list,
1972
allow_pointless=unchanged, strict=strict, local=local,
1974
except PointlessCommit:
1975
# FIXME: This should really happen before the file is read in;
1976
# perhaps prepare the commit; get the message; then actually commit
1977
raise errors.BzrCommandError("no changes to commit."
1978
" use --unchanged to commit anyhow")
1979
except ConflictsInTree:
1980
raise errors.BzrCommandError('Conflicts detected in working '
1981
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
1983
except StrictCommitFailed:
1984
raise errors.BzrCommandError("Commit refused because there are"
1985
" unknown files in the working tree.")
1986
except errors.BoundBranchOutOfDate, e:
1987
raise errors.BzrCommandError(str(e) + "\n"
1988
'To commit to master branch, run update and then commit.\n'
1989
'You can also pass --local to commit to continue working '
1993
class cmd_check(Command):
1994
"""Validate consistency of branch history.
1996
This command checks various invariants about the branch storage to
1997
detect data corruption or bzr bugs.
1999
takes_args = ['branch?']
2000
takes_options = ['verbose']
2002
def run(self, branch=None, verbose=False):
2003
from bzrlib.check import check
2005
tree = WorkingTree.open_containing()[0]
2006
branch = tree.branch
2008
branch = Branch.open(branch)
2009
check(branch, verbose)
2012
class cmd_upgrade(Command):
2013
"""Upgrade branch storage to current format.
2015
The check command or bzr developers may sometimes advise you to run
2016
this command. When the default format has changed you may also be warned
2017
during other operations to upgrade.
2019
takes_args = ['url?']
2021
RegistryOption('format',
2022
help='Upgrade to a specific format. See "bzr help'
2023
' formats" for details',
2024
registry=bzrdir.format_registry,
2025
converter=bzrdir.format_registry.make_bzrdir,
2026
value_switches=True, title='Branch format'),
2030
def run(self, url='.', format=None):
2031
from bzrlib.upgrade import upgrade
2033
format = bzrdir.format_registry.make_bzrdir('default')
2034
upgrade(url, format)
2037
class cmd_whoami(Command):
2038
"""Show or set bzr user id.
2042
bzr whoami 'Frank Chu <fchu@example.com>'
2044
takes_options = [ Option('email',
2045
help='display email address only'),
2047
help='set identity for the current branch instead of '
2050
takes_args = ['name?']
2051
encoding_type = 'replace'
2054
def run(self, email=False, branch=False, name=None):
2056
# use branch if we're inside one; otherwise global config
2058
c = Branch.open_containing('.')[0].get_config()
2059
except errors.NotBranchError:
2060
c = config.GlobalConfig()
2062
self.outf.write(c.user_email() + '\n')
2064
self.outf.write(c.username() + '\n')
2067
# display a warning if an email address isn't included in the given name.
2069
config.extract_email_address(name)
2070
except errors.NoEmailInUsername, e:
2071
warning('"%s" does not seem to contain an email address. '
2072
'This is allowed, but not recommended.', name)
2074
# use global config unless --branch given
2076
c = Branch.open_containing('.')[0].get_config()
2078
c = config.GlobalConfig()
2079
c.set_user_option('email', name)
2082
class cmd_nick(Command):
2083
"""Print or set the branch nickname.
2085
If unset, the tree root directory name is used as the nickname
2086
To print the current nickname, execute with no argument.
2088
takes_args = ['nickname?']
2089
def run(self, nickname=None):
2090
branch = Branch.open_containing(u'.')[0]
2091
if nickname is None:
2092
self.printme(branch)
2094
branch.nick = nickname
2097
def printme(self, branch):
2101
class cmd_selftest(Command):
2102
"""Run internal test suite.
2104
This creates temporary test directories in the working directory, but not
2105
existing data is affected. These directories are deleted if the tests
2106
pass, or left behind to help in debugging if they fail and --keep-output
2109
If arguments are given, they are regular expressions that say which tests
2110
should run. Tests matching any expression are run, and other tests are
2113
Alternatively if --first is given, matching tests are run first and then
2114
all other tests are run. This is useful if you have been working in a
2115
particular area, but want to make sure nothing else was broken.
2117
If the global option '--no-plugins' is given, plugins are not loaded
2118
before running the selftests. This has two effects: features provided or
2119
modified by plugins will not be tested, and tests provided by plugins will
2124
run only tests relating to 'ignore'
2125
bzr --no-plugins selftest -v
2126
disable plugins and list tests as they're run
2128
# TODO: --list should give a list of all available tests
2130
# NB: this is used from the class without creating an instance, which is
2131
# why it does not have a self parameter.
2132
def get_transport_type(typestring):
2133
"""Parse and return a transport specifier."""
2134
if typestring == "sftp":
2135
from bzrlib.transport.sftp import SFTPAbsoluteServer
2136
return SFTPAbsoluteServer
2137
if typestring == "memory":
2138
from bzrlib.transport.memory import MemoryServer
2140
if typestring == "fakenfs":
2141
from bzrlib.transport.fakenfs import FakeNFSServer
2142
return FakeNFSServer
2143
msg = "No known transport type %s. Supported types are: sftp\n" %\
2145
raise errors.BzrCommandError(msg)
2148
takes_args = ['testspecs*']
2149
takes_options = ['verbose',
2150
Option('one', help='stop when one test fails'),
2151
Option('keep-output',
2152
help='keep output directories when tests fail'),
2154
help='Use a different transport by default '
2155
'throughout the test suite.',
2156
type=get_transport_type),
2157
Option('benchmark', help='run the bzr bencharks.'),
2158
Option('lsprof-timed',
2159
help='generate lsprof output for benchmarked'
2160
' sections of code.'),
2161
Option('cache-dir', type=str,
2162
help='a directory to cache intermediate'
2163
' benchmark steps'),
2164
Option('clean-output',
2165
help='clean temporary tests directories'
2166
' without running tests'),
2168
help='run all tests, but run specified tests first',
2171
encoding_type = 'replace'
2173
def run(self, testspecs_list=None, verbose=None, one=False,
2174
keep_output=False, transport=None, benchmark=None,
2175
lsprof_timed=None, cache_dir=None, clean_output=False,
2178
from bzrlib.tests import selftest
2179
import bzrlib.benchmarks as benchmarks
2180
from bzrlib.benchmarks import tree_creator
2183
from bzrlib.tests import clean_selftest_output
2184
clean_selftest_output()
2187
if cache_dir is not None:
2188
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2189
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2190
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2192
if testspecs_list is not None:
2193
pattern = '|'.join(testspecs_list)
2197
test_suite_factory = benchmarks.test_suite
2200
# TODO: should possibly lock the history file...
2201
benchfile = open(".perf_history", "at", buffering=1)
2203
test_suite_factory = None
2208
result = selftest(verbose=verbose,
2210
stop_on_failure=one,
2211
keep_output=keep_output,
2212
transport=transport,
2213
test_suite_factory=test_suite_factory,
2214
lsprof_timed=lsprof_timed,
2215
bench_history=benchfile,
2216
matching_tests_first=first,
2219
if benchfile is not None:
2222
info('tests passed')
2224
info('tests failed')
2225
return int(not result)
2228
class cmd_version(Command):
2229
"""Show version of bzr."""
2233
from bzrlib.version import show_version
2237
class cmd_rocks(Command):
2238
"""Statement of optimism."""
2244
print "it sure does!"
2247
class cmd_find_merge_base(Command):
2248
"""Find and print a base revision for merging two branches."""
2249
# TODO: Options to specify revisions on either side, as if
2250
# merging only part of the history.
2251
takes_args = ['branch', 'other']
2255
def run(self, branch, other):
2256
from bzrlib.revision import MultipleRevisionSources
2258
branch1 = Branch.open_containing(branch)[0]
2259
branch2 = Branch.open_containing(other)[0]
2261
last1 = branch1.last_revision()
2262
last2 = branch2.last_revision()
2264
source = MultipleRevisionSources(branch1.repository,
2267
base_rev_id = common_ancestor(last1, last2, source)
2269
print 'merge base is revision %s' % base_rev_id
2272
class cmd_merge(Command):
2273
"""Perform a three-way merge.
2275
The branch is the branch you will merge from. By default, it will merge
2276
the latest revision. If you specify a revision, that revision will be
2277
merged. If you specify two revisions, the first will be used as a BASE,
2278
and the second one as OTHER. Revision numbers are always relative to the
2281
By default, bzr will try to merge in all new work from the other
2282
branch, automatically determining an appropriate base. If this
2283
fails, you may need to give an explicit base.
2285
Merge will do its best to combine the changes in two branches, but there
2286
are some kinds of problems only a human can fix. When it encounters those,
2287
it will mark a conflict. A conflict means that you need to fix something,
2288
before you should commit.
2290
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2292
If there is no default branch set, the first merge will set it. After
2293
that, you can omit the branch to use the default. To change the
2294
default, use --remember. The value will only be saved if the remote
2295
location can be accessed.
2299
To merge the latest revision from bzr.dev
2300
bzr merge ../bzr.dev
2302
To merge changes up to and including revision 82 from bzr.dev
2303
bzr merge -r 82 ../bzr.dev
2305
To merge the changes introduced by 82, without previous changes:
2306
bzr merge -r 81..82 ../bzr.dev
2308
merge refuses to run if there are any uncommitted changes, unless
2311
The following merge types are available:
2313
takes_args = ['branch?']
2314
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2315
Option('show-base', help="Show base revision text in "
2317
Option('uncommitted', help='Apply uncommitted changes'
2318
' from a working copy, instead of branch changes'),
2319
Option('pull', help='If the destination is already'
2320
' completely merged into the source, pull from the'
2321
' source rather than merging. When this happens,'
2322
' you do not need to commit the result.'),
2326
from inspect import getdoc
2327
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2329
def run(self, branch=None, revision=None, force=False, merge_type=None,
2330
show_base=False, reprocess=False, remember=False,
2331
uncommitted=False, pull=False):
2332
if merge_type is None:
2333
merge_type = _mod_merge.Merge3Merger
2335
tree = WorkingTree.open_containing(u'.')[0]
2336
change_reporter = delta.ChangeReporter(tree.inventory)
2338
if branch is not None:
2340
reader = bundle.read_bundle_from_url(branch)
2341
except errors.NotABundle:
2342
pass # Continue on considering this url a Branch
2344
conflicts = merge_bundle(reader, tree, not force, merge_type,
2345
reprocess, show_base, change_reporter)
2351
if revision is None \
2352
or len(revision) < 1 or revision[0].needs_branch():
2353
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2355
if revision is None or len(revision) < 1:
2358
other = [branch, None]
2361
other = [branch, -1]
2362
other_branch, path = Branch.open_containing(branch)
2365
raise errors.BzrCommandError('Cannot use --uncommitted and'
2366
' --revision at the same time.')
2367
branch = revision[0].get_branch() or branch
2368
if len(revision) == 1:
2370
other_branch, path = Branch.open_containing(branch)
2371
revno = revision[0].in_history(other_branch).revno
2372
other = [branch, revno]
2374
assert len(revision) == 2
2375
if None in revision:
2376
raise errors.BzrCommandError(
2377
"Merge doesn't permit empty revision specifier.")
2378
base_branch, path = Branch.open_containing(branch)
2379
branch1 = revision[1].get_branch() or branch
2380
other_branch, path1 = Branch.open_containing(branch1)
2381
if revision[0].get_branch() is not None:
2382
# then path was obtained from it, and is None.
2385
base = [branch, revision[0].in_history(base_branch).revno]
2386
other = [branch1, revision[1].in_history(other_branch).revno]
2388
if tree.branch.get_parent() is None or remember:
2389
tree.branch.set_parent(other_branch.base)
2392
interesting_files = [path]
2394
interesting_files = None
2395
pb = ui.ui_factory.nested_progress_bar()
2398
conflict_count = _merge_helper(
2399
other, base, check_clean=(not force),
2400
merge_type=merge_type,
2401
reprocess=reprocess,
2402
show_base=show_base,
2405
file_list=interesting_files,
2406
change_reporter=change_reporter)
2409
if conflict_count != 0:
2413
except errors.AmbiguousBase, e:
2414
m = ("sorry, bzr can't determine the right merge base yet\n"
2415
"candidates are:\n "
2416
+ "\n ".join(e.bases)
2418
"please specify an explicit base with -r,\n"
2419
"and (if you want) report this to the bzr developers\n")
2422
# TODO: move up to common parent; this isn't merge-specific anymore.
2423
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2424
"""Use tree.branch's parent if none was supplied.
2426
Report if the remembered location was used.
2428
if supplied_location is not None:
2429
return supplied_location
2430
stored_location = tree.branch.get_parent()
2431
mutter("%s", stored_location)
2432
if stored_location is None:
2433
raise errors.BzrCommandError("No location specified or remembered")
2434
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2435
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2436
return stored_location
2439
class cmd_remerge(Command):
2442
Use this if you want to try a different merge technique while resolving
2443
conflicts. Some merge techniques are better than others, and remerge
2444
lets you try different ones on different files.
2446
The options for remerge have the same meaning and defaults as the ones for
2447
merge. The difference is that remerge can (only) be run when there is a
2448
pending merge, and it lets you specify particular files.
2451
$ bzr remerge --show-base
2452
Re-do the merge of all conflicted files, and show the base text in
2453
conflict regions, in addition to the usual THIS and OTHER texts.
2455
$ bzr remerge --merge-type weave --reprocess foobar
2456
Re-do the merge of "foobar", using the weave merge algorithm, with
2457
additional processing to reduce the size of conflict regions.
2459
The following merge types are available:"""
2460
takes_args = ['file*']
2461
takes_options = ['merge-type', 'reprocess',
2462
Option('show-base', help="Show base revision text in "
2466
from inspect import getdoc
2467
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2469
def run(self, file_list=None, merge_type=None, show_base=False,
2471
if merge_type is None:
2472
merge_type = _mod_merge.Merge3Merger
2473
tree, file_list = tree_files(file_list)
2476
parents = tree.get_parent_ids()
2477
if len(parents) != 2:
2478
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2479
" merges. Not cherrypicking or"
2481
repository = tree.branch.repository
2482
base_revision = common_ancestor(parents[0],
2483
parents[1], repository)
2484
base_tree = repository.revision_tree(base_revision)
2485
other_tree = repository.revision_tree(parents[1])
2486
interesting_ids = None
2488
conflicts = tree.conflicts()
2489
if file_list is not None:
2490
interesting_ids = set()
2491
for filename in file_list:
2492
file_id = tree.path2id(filename)
2494
raise errors.NotVersionedError(filename)
2495
interesting_ids.add(file_id)
2496
if tree.kind(file_id) != "directory":
2499
for name, ie in tree.inventory.iter_entries(file_id):
2500
interesting_ids.add(ie.file_id)
2501
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2503
# Remerge only supports resolving contents conflicts
2504
allowed_conflicts = ('text conflict', 'contents conflict')
2505
restore_files = [c.path for c in conflicts
2506
if c.typestring in allowed_conflicts]
2507
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2508
tree.set_conflicts(ConflictList(new_conflicts))
2509
if file_list is not None:
2510
restore_files = file_list
2511
for filename in restore_files:
2513
restore(tree.abspath(filename))
2514
except errors.NotConflicted:
2516
conflicts = _mod_merge.merge_inner(
2517
tree.branch, other_tree, base_tree,
2519
interesting_ids=interesting_ids,
2520
other_rev_id=parents[1],
2521
merge_type=merge_type,
2522
show_base=show_base,
2523
reprocess=reprocess)
2532
class cmd_revert(Command):
2533
"""Revert files to a previous revision.
2535
Giving a list of files will revert only those files. Otherwise, all files
2536
will be reverted. If the revision is not specified with '--revision', the
2537
last committed revision is used.
2539
To remove only some changes, without reverting to a prior version, use
2540
merge instead. For example, "merge . --r-2..-3" will remove the changes
2541
introduced by -2, without affecting the changes introduced by -1. Or
2542
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2544
By default, any files that have been manually changed will be backed up
2545
first. (Files changed only by merge are not backed up.) Backup files have
2546
'.~#~' appended to their name, where # is a number.
2548
When you provide files, you can use their current pathname or the pathname
2549
from the target revision. So you can use revert to "undelete" a file by
2550
name. If you name a directory, all the contents of that directory will be
2553
takes_options = ['revision', 'no-backup']
2554
takes_args = ['file*']
2555
aliases = ['merge-revert']
2557
def run(self, revision=None, no_backup=False, file_list=None):
2558
if file_list is not None:
2559
if len(file_list) == 0:
2560
raise errors.BzrCommandError("No files specified")
2564
tree, file_list = tree_files(file_list)
2565
if revision is None:
2566
# FIXME should be tree.last_revision
2567
rev_id = tree.last_revision()
2568
elif len(revision) != 1:
2569
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2571
rev_id = revision[0].in_history(tree.branch).rev_id
2572
pb = ui.ui_factory.nested_progress_bar()
2574
tree.revert(file_list,
2575
tree.branch.repository.revision_tree(rev_id),
2576
not no_backup, pb, report_changes=True)
2581
class cmd_assert_fail(Command):
2582
"""Test reporting of assertion failures"""
2583
# intended just for use in testing
2588
raise AssertionError("always fails")
2591
class cmd_help(Command):
2592
"""Show help on a command or other topic.
2594
For a list of all available commands, say 'bzr help commands'.
2596
takes_options = [Option('long', 'show help on all commands')]
2597
takes_args = ['topic?']
2598
aliases = ['?', '--help', '-?', '-h']
2601
def run(self, topic=None, long=False):
2603
if topic is None and long:
2605
bzrlib.help.help(topic)
2608
class cmd_shell_complete(Command):
2609
"""Show appropriate completions for context.
2611
For a list of all available commands, say 'bzr shell-complete'.
2613
takes_args = ['context?']
2618
def run(self, context=None):
2619
import shellcomplete
2620
shellcomplete.shellcomplete(context)
2623
class cmd_fetch(Command):
2624
"""Copy in history from another branch but don't merge it.
2626
This is an internal method used for pull and merge.
2629
takes_args = ['from_branch', 'to_branch']
2630
def run(self, from_branch, to_branch):
2631
from bzrlib.fetch import Fetcher
2632
from_b = Branch.open(from_branch)
2633
to_b = Branch.open(to_branch)
2634
Fetcher(to_b, from_b)
2637
class cmd_missing(Command):
2638
"""Show unmerged/unpulled revisions between two branches.
2640
OTHER_BRANCH may be local or remote.
2642
takes_args = ['other_branch?']
2643
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2645
'Display changes in the local branch only'),
2646
Option('theirs-only',
2647
'Display changes in the remote branch only'),
2652
encoding_type = 'replace'
2655
def run(self, other_branch=None, reverse=False, mine_only=False,
2656
theirs_only=False, log_format=None, long=False, short=False, line=False,
2657
show_ids=False, verbose=False):
2658
from bzrlib.missing import find_unmerged, iter_log_data
2659
from bzrlib.log import log_formatter
2660
local_branch = Branch.open_containing(u".")[0]
2661
parent = local_branch.get_parent()
2662
if other_branch is None:
2663
other_branch = parent
2664
if other_branch is None:
2665
raise errors.BzrCommandError("No peer location known or specified.")
2666
display_url = urlutils.unescape_for_display(parent,
2668
print "Using last location: " + display_url
2670
remote_branch = Branch.open(other_branch)
2671
if remote_branch.base == local_branch.base:
2672
remote_branch = local_branch
2673
local_branch.lock_read()
2675
remote_branch.lock_read()
2677
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2678
if (log_format is None):
2679
log_format = log.log_formatter_registry.get_default(
2681
lf = log_format(to_file=self.outf,
2683
show_timezone='original')
2684
if reverse is False:
2685
local_extra.reverse()
2686
remote_extra.reverse()
2687
if local_extra and not theirs_only:
2688
print "You have %d extra revision(s):" % len(local_extra)
2689
for data in iter_log_data(local_extra, local_branch.repository,
2692
printed_local = True
2694
printed_local = False
2695
if remote_extra and not mine_only:
2696
if printed_local is True:
2698
print "You are missing %d revision(s):" % len(remote_extra)
2699
for data in iter_log_data(remote_extra, remote_branch.repository,
2702
if not remote_extra and not local_extra:
2704
print "Branches are up to date."
2708
remote_branch.unlock()
2710
local_branch.unlock()
2711
if not status_code and parent is None and other_branch is not None:
2712
local_branch.lock_write()
2714
# handle race conditions - a parent might be set while we run.
2715
if local_branch.get_parent() is None:
2716
local_branch.set_parent(remote_branch.base)
2718
local_branch.unlock()
2722
class cmd_plugins(Command):
2727
import bzrlib.plugin
2728
from inspect import getdoc
2729
for name, plugin in bzrlib.plugin.all_plugins().items():
2730
if getattr(plugin, '__path__', None) is not None:
2731
print plugin.__path__[0]
2732
elif getattr(plugin, '__file__', None) is not None:
2733
print plugin.__file__
2739
print '\t', d.split('\n')[0]
2742
class cmd_testament(Command):
2743
"""Show testament (signing-form) of a revision."""
2744
takes_options = ['revision',
2745
Option('long', help='Produce long-format testament'),
2746
Option('strict', help='Produce a strict-format'
2748
takes_args = ['branch?']
2750
def run(self, branch=u'.', revision=None, long=False, strict=False):
2751
from bzrlib.testament import Testament, StrictTestament
2753
testament_class = StrictTestament
2755
testament_class = Testament
2756
b = WorkingTree.open_containing(branch)[0].branch
2759
if revision is None:
2760
rev_id = b.last_revision()
2762
rev_id = revision[0].in_history(b).rev_id
2763
t = testament_class.from_revision(b.repository, rev_id)
2765
sys.stdout.writelines(t.as_text_lines())
2767
sys.stdout.write(t.as_short_text())
2772
class cmd_annotate(Command):
2773
"""Show the origin of each line in a file.
2775
This prints out the given file with an annotation on the left side
2776
indicating which revision, author and date introduced the change.
2778
If the origin is the same for a run of consecutive lines, it is
2779
shown only at the top, unless the --all option is given.
2781
# TODO: annotate directories; showing when each file was last changed
2782
# TODO: if the working copy is modified, show annotations on that
2783
# with new uncommitted lines marked
2784
aliases = ['ann', 'blame', 'praise']
2785
takes_args = ['filename']
2786
takes_options = [Option('all', help='show annotations on all lines'),
2787
Option('long', help='show date in annotations'),
2793
def run(self, filename, all=False, long=False, revision=None,
2795
from bzrlib.annotate import annotate_file
2796
tree, relpath = WorkingTree.open_containing(filename)
2797
branch = tree.branch
2800
if revision is None:
2801
revision_id = branch.last_revision()
2802
elif len(revision) != 1:
2803
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2805
revision_id = revision[0].in_history(branch).rev_id
2806
file_id = tree.inventory.path2id(relpath)
2807
tree = branch.repository.revision_tree(revision_id)
2808
file_version = tree.inventory[file_id].revision
2809
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2815
class cmd_re_sign(Command):
2816
"""Create a digital signature for an existing revision."""
2817
# TODO be able to replace existing ones.
2819
hidden = True # is this right ?
2820
takes_args = ['revision_id*']
2821
takes_options = ['revision']
2823
def run(self, revision_id_list=None, revision=None):
2824
import bzrlib.gpg as gpg
2825
if revision_id_list is not None and revision is not None:
2826
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2827
if revision_id_list is None and revision is None:
2828
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2829
b = WorkingTree.open_containing(u'.')[0].branch
2830
gpg_strategy = gpg.GPGStrategy(b.get_config())
2831
if revision_id_list is not None:
2832
for revision_id in revision_id_list:
2833
b.repository.sign_revision(revision_id, gpg_strategy)
2834
elif revision is not None:
2835
if len(revision) == 1:
2836
revno, rev_id = revision[0].in_history(b)
2837
b.repository.sign_revision(rev_id, gpg_strategy)
2838
elif len(revision) == 2:
2839
# are they both on rh- if so we can walk between them
2840
# might be nice to have a range helper for arbitrary
2841
# revision paths. hmm.
2842
from_revno, from_revid = revision[0].in_history(b)
2843
to_revno, to_revid = revision[1].in_history(b)
2844
if to_revid is None:
2845
to_revno = b.revno()
2846
if from_revno is None or to_revno is None:
2847
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2848
for revno in range(from_revno, to_revno + 1):
2849
b.repository.sign_revision(b.get_rev_id(revno),
2852
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2855
class cmd_bind(Command):
2856
"""Bind the current branch to a master branch.
2858
After binding, commits must succeed on the master branch
2859
before they are executed on the local one.
2862
takes_args = ['location']
2865
def run(self, location=None):
2866
b, relpath = Branch.open_containing(u'.')
2867
b_other = Branch.open(location)
2870
except errors.DivergedBranches:
2871
raise errors.BzrCommandError('These branches have diverged.'
2872
' Try merging, and then bind again.')
2875
class cmd_unbind(Command):
2876
"""Unbind the current branch from its master branch.
2878
After unbinding, the local branch is considered independent.
2879
All subsequent commits will be local.
2886
b, relpath = Branch.open_containing(u'.')
2888
raise errors.BzrCommandError('Local branch is not bound')
2891
class cmd_uncommit(Command):
2892
"""Remove the last committed revision.
2894
--verbose will print out what is being removed.
2895
--dry-run will go through all the motions, but not actually
2898
In the future, uncommit will create a revision bundle, which can then
2902
# TODO: jam 20060108 Add an option to allow uncommit to remove
2903
# unreferenced information in 'branch-as-repository' branches.
2904
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2905
# information in shared branches as well.
2906
takes_options = ['verbose', 'revision',
2907
Option('dry-run', help='Don\'t actually make changes'),
2908
Option('force', help='Say yes to all questions.')]
2909
takes_args = ['location?']
2912
def run(self, location=None,
2913
dry_run=False, verbose=False,
2914
revision=None, force=False):
2915
from bzrlib.log import log_formatter, show_log
2917
from bzrlib.uncommit import uncommit
2919
if location is None:
2921
control, relpath = bzrdir.BzrDir.open_containing(location)
2923
tree = control.open_workingtree()
2925
except (errors.NoWorkingTree, errors.NotLocalUrl):
2927
b = control.open_branch()
2930
if revision is None:
2933
# 'bzr uncommit -r 10' actually means uncommit
2934
# so that the final tree is at revno 10.
2935
# but bzrlib.uncommit.uncommit() actually uncommits
2936
# the revisions that are supplied.
2937
# So we need to offset it by one
2938
revno = revision[0].in_history(b).revno+1
2940
if revno <= b.revno():
2941
rev_id = b.get_rev_id(revno)
2943
self.outf.write('No revisions to uncommit.\n')
2946
lf = log_formatter('short',
2948
show_timezone='original')
2953
direction='forward',
2954
start_revision=revno,
2955
end_revision=b.revno())
2958
print 'Dry-run, pretending to remove the above revisions.'
2960
val = raw_input('Press <enter> to continue')
2962
print 'The above revision(s) will be removed.'
2964
val = raw_input('Are you sure [y/N]? ')
2965
if val.lower() not in ('y', 'yes'):
2969
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2973
class cmd_break_lock(Command):
2974
"""Break a dead lock on a repository, branch or working directory.
2976
CAUTION: Locks should only be broken when you are sure that the process
2977
holding the lock has been stopped.
2979
You can get information on what locks are open via the 'bzr info' command.
2984
takes_args = ['location?']
2986
def run(self, location=None, show=False):
2987
if location is None:
2989
control, relpath = bzrdir.BzrDir.open_containing(location)
2991
control.break_lock()
2992
except NotImplementedError:
2996
class cmd_wait_until_signalled(Command):
2997
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
2999
This just prints a line to signal when it is ready, then blocks on stdin.
3005
sys.stdout.write("running\n")
3007
sys.stdin.readline()
3010
class cmd_serve(Command):
3011
"""Run the bzr server."""
3013
aliases = ['server']
3017
help='serve on stdin/out for use from inetd or sshd'),
3019
help='listen for connections on nominated port of the form '
3020
'[hostname:]portnumber. Passing 0 as the port number will '
3021
'result in a dynamically allocated port.',
3024
help='serve contents of directory',
3026
Option('allow-writes',
3027
help='By default the server is a readonly server. Supplying '
3028
'--allow-writes enables write access to the contents of '
3029
'the served directory and below. '
3033
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3034
from bzrlib.transport import smart
3035
from bzrlib.transport import get_transport
3036
if directory is None:
3037
directory = os.getcwd()
3038
url = urlutils.local_path_to_url(directory)
3039
if not allow_writes:
3040
url = 'readonly+' + url
3041
t = get_transport(url)
3043
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3044
elif port is not None:
3046
host, port = port.split(':')
3049
server = smart.SmartTCPServer(t, host=host, port=int(port))
3050
print 'listening on port: ', server.port
3053
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3057
# command-line interpretation helper for merge-related commands
3058
def _merge_helper(other_revision, base_revision,
3059
check_clean=True, ignore_zero=False,
3060
this_dir=None, backup_files=False,
3062
file_list=None, show_base=False, reprocess=False,
3065
change_reporter=None):
3066
"""Merge changes into a tree.
3069
list(path, revno) Base for three-way merge.
3070
If [None, None] then a base will be automatically determined.
3072
list(path, revno) Other revision for three-way merge.
3074
Directory to merge changes into; '.' by default.
3076
If true, this_dir must have no uncommitted changes before the
3078
ignore_zero - If true, suppress the "zero conflicts" message when
3079
there are no conflicts; should be set when doing something we expect
3080
to complete perfectly.
3081
file_list - If supplied, merge only changes to selected files.
3083
All available ancestors of other_revision and base_revision are
3084
automatically pulled into the branch.
3086
The revno may be -1 to indicate the last revision on the branch, which is
3089
This function is intended for use from the command line; programmatic
3090
clients might prefer to call merge.merge_inner(), which has less magic
3093
# Loading it late, so that we don't always have to import bzrlib.merge
3094
if merge_type is None:
3095
merge_type = _mod_merge.Merge3Merger
3096
if this_dir is None:
3098
this_tree = WorkingTree.open_containing(this_dir)[0]
3099
if show_base and not merge_type is _mod_merge.Merge3Merger:
3100
raise errors.BzrCommandError("Show-base is not supported for this merge"
3101
" type. %s" % merge_type)
3102
if reprocess and not merge_type.supports_reprocess:
3103
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3104
" type %s." % merge_type)
3105
if reprocess and show_base:
3106
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3108
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3109
pb=pb, change_reporter=change_reporter)
3110
merger.pp = ProgressPhase("Merge phase", 5, pb)
3111
merger.pp.next_phase()
3112
merger.check_basis(check_clean)
3113
merger.set_other(other_revision)
3114
merger.pp.next_phase()
3115
merger.set_base(base_revision)
3116
if merger.base_rev_id == merger.other_rev_id:
3117
note('Nothing to do.')
3119
if file_list is None:
3120
if pull and merger.base_rev_id == merger.this_rev_id:
3121
count = merger.this_tree.pull(merger.this_branch,
3122
False, merger.other_rev_id)
3123
note('%d revision(s) pulled.' % (count,))
3125
merger.backup_files = backup_files
3126
merger.merge_type = merge_type
3127
merger.set_interesting_files(file_list)
3128
merger.show_base = show_base
3129
merger.reprocess = reprocess
3130
conflicts = merger.do_merge()
3131
if file_list is None:
3132
merger.set_pending()
3139
merge = _merge_helper
3142
# these get imported and then picked up by the scan for cmd_*
3143
# TODO: Some more consistent way to split command definitions across files;
3144
# we do need to load at least some information about them to know of
3145
# aliases. ideally we would avoid loading the implementation until the
3146
# details were needed.
3147
from bzrlib.cmd_version_info import cmd_version_info
3148
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3149
from bzrlib.bundle.commands import cmd_bundle_revisions
3150
from bzrlib.sign_my_commits import cmd_sign_my_commits
3151
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3152
cmd_weave_plan_merge, cmd_weave_merge_text