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
421
takes_options = ['revision', 'show-ids', 'kind']
422
takes_args = ['file*']
425
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
426
if kind and kind not in ['file', 'directory', 'symlink']:
427
raise errors.BzrCommandError('invalid kind specified')
429
work_tree, file_list = tree_files(file_list)
431
if revision is not None:
432
if len(revision) > 1:
433
raise errors.BzrCommandError('bzr inventory --revision takes'
434
' exactly one revision identifier')
435
revision_id = revision[0].in_history(work_tree.branch).rev_id
436
tree = work_tree.branch.repository.revision_tree(revision_id)
438
# We include work_tree as well as 'tree' here
439
# So that doing '-r 10 path/foo' will lookup whatever file
440
# exists now at 'path/foo' even if it has been renamed, as
441
# well as whatever files existed in revision 10 at path/foo
442
trees = [tree, work_tree]
447
if file_list is not None:
448
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
449
require_versioned=True)
450
# find_ids_across_trees may include some paths that don't
452
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
453
for file_id in file_ids if file_id in tree)
455
entries = tree.inventory.entries()
457
for path, entry in entries:
458
if kind and kind != entry.kind:
461
self.outf.write('%-50s %s\n' % (path, entry.file_id))
463
self.outf.write(path)
464
self.outf.write('\n')
467
class cmd_mv(Command):
468
"""Move or rename a file.
471
bzr mv OLDNAME NEWNAME
472
bzr mv SOURCE... DESTINATION
474
If the last argument is a versioned directory, all the other names
475
are moved into it. Otherwise, there must be exactly two arguments
476
and the file is changed to a new name.
478
If OLDNAME does not exist on the filesystem but is versioned and
479
NEWNAME does exist on the filesystem but is not versioned, mv
480
assumes that the file has been manually moved and only updates
481
its internal inventory to reflect that change.
482
The same is valid when moving many SOURCE files to a DESTINATION.
484
Files cannot be moved between branches.
487
takes_args = ['names*']
488
takes_options = [Option("after", help="move only the bzr identifier"
489
" of the file (file has already been moved). Use this flag if"
490
" bzr is not able to detect this itself.")]
491
aliases = ['move', 'rename']
492
encoding_type = 'replace'
494
def run(self, names_list, after=False):
495
if names_list is None:
498
if len(names_list) < 2:
499
raise errors.BzrCommandError("missing file argument")
500
tree, rel_names = tree_files(names_list)
502
if os.path.isdir(names_list[-1]):
503
# move into existing directory
504
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
505
self.outf.write("%s => %s\n" % pair)
507
if len(names_list) != 2:
508
raise errors.BzrCommandError('to mv multiple files the'
509
' destination must be a versioned'
511
tree.rename_one(rel_names[0], rel_names[1], after=after)
512
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
515
class cmd_pull(Command):
516
"""Turn this branch into a mirror of another branch.
518
This command only works on branches that have not diverged. Branches are
519
considered diverged if the destination branch's most recent commit is one
520
that has not been merged (directly or indirectly) into the parent.
522
If branches have diverged, you can use 'bzr merge' to integrate the changes
523
from one into the other. Once one branch has merged, the other should
524
be able to pull it again.
526
If you want to forget your local changes and just update your branch to
527
match the remote one, use pull --overwrite.
529
If there is no default location set, the first pull will set it. After
530
that, you can omit the location to use the default. To change the
531
default, use --remember. The value will only be saved if the remote
532
location can be accessed.
535
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
536
takes_args = ['location?']
537
encoding_type = 'replace'
539
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
540
# FIXME: too much stuff is in the command class
542
tree_to = WorkingTree.open_containing(u'.')[0]
543
branch_to = tree_to.branch
544
except errors.NoWorkingTree:
546
branch_to = Branch.open_containing(u'.')[0]
549
if location is not None:
551
reader = bundle.read_bundle_from_url(location)
552
except errors.NotABundle:
553
pass # Continue on considering this url a Branch
555
stored_loc = branch_to.get_parent()
557
if stored_loc is None:
558
raise errors.BzrCommandError("No pull location known or"
561
display_url = urlutils.unescape_for_display(stored_loc,
563
self.outf.write("Using saved location: %s\n" % display_url)
564
location = stored_loc
567
if reader is not None:
568
install_bundle(branch_to.repository, reader)
569
branch_from = branch_to
571
branch_from = Branch.open(location)
573
if branch_to.get_parent() is None or remember:
574
branch_to.set_parent(branch_from.base)
578
if reader is not None:
579
rev_id = reader.target
580
elif len(revision) == 1:
581
rev_id = revision[0].in_history(branch_from).rev_id
583
raise errors.BzrCommandError('bzr pull --revision takes one value.')
585
old_rh = branch_to.revision_history()
586
if tree_to is not None:
587
count = tree_to.pull(branch_from, overwrite, rev_id)
589
count = branch_to.pull(branch_from, overwrite, rev_id)
590
note('%d revision(s) pulled.' % (count,))
593
new_rh = branch_to.revision_history()
596
from bzrlib.log import show_changed_revisions
597
show_changed_revisions(branch_to, old_rh, new_rh,
601
class cmd_push(Command):
602
"""Update a mirror of this branch.
604
The target branch will not have its working tree populated because this
605
is both expensive, and is not supported on remote file systems.
607
Some smart servers or protocols *may* put the working tree in place in
610
This command only works on branches that have not diverged. Branches are
611
considered diverged if the destination branch's most recent commit is one
612
that has not been merged (directly or indirectly) by the source branch.
614
If branches have diverged, you can use 'bzr push --overwrite' to replace
615
the other branch completely, discarding its unmerged changes.
617
If you want to ensure you have the different changes in the other branch,
618
do a merge (see bzr help merge) from the other branch, and commit that.
619
After that you will be able to do a push without '--overwrite'.
621
If there is no default push location set, the first push will set it.
622
After that, you can omit the location to use the default. To change the
623
default, use --remember. The value will only be saved if the remote
624
location can be accessed.
627
takes_options = ['remember', 'overwrite', 'verbose',
628
Option('create-prefix',
629
help='Create the path leading up to the branch '
630
'if it does not already exist')]
631
takes_args = ['location?']
632
encoding_type = 'replace'
634
def run(self, location=None, remember=False, overwrite=False,
635
create_prefix=False, verbose=False):
636
# FIXME: Way too big! Put this into a function called from the
639
br_from = Branch.open_containing('.')[0]
640
stored_loc = br_from.get_push_location()
642
if stored_loc is None:
643
raise errors.BzrCommandError("No push location known or specified.")
645
display_url = urlutils.unescape_for_display(stored_loc,
647
self.outf.write("Using saved location: %s\n" % display_url)
648
location = stored_loc
650
to_transport = transport.get_transport(location)
651
location_url = to_transport.base
655
dir_to = bzrdir.BzrDir.open(location_url)
656
br_to = dir_to.open_branch()
657
except errors.NotBranchError:
659
to_transport = to_transport.clone('..')
660
if not create_prefix:
662
relurl = to_transport.relpath(location_url)
663
mutter('creating directory %s => %s', location_url, relurl)
664
to_transport.mkdir(relurl)
665
except errors.NoSuchFile:
666
raise errors.BzrCommandError("Parent directory of %s "
667
"does not exist." % location)
669
current = to_transport.base
670
needed = [(to_transport, to_transport.relpath(location_url))]
673
to_transport, relpath = needed[-1]
674
to_transport.mkdir(relpath)
676
except errors.NoSuchFile:
677
new_transport = to_transport.clone('..')
678
needed.append((new_transport,
679
new_transport.relpath(to_transport.base)))
680
if new_transport.base == to_transport.base:
681
raise errors.BzrCommandError("Could not create "
683
dir_to = br_from.bzrdir.clone(location_url,
684
revision_id=br_from.last_revision())
685
br_to = dir_to.open_branch()
686
count = br_to.last_revision_info()[0]
687
# We successfully created the target, remember it
688
if br_from.get_push_location() is None or remember:
689
br_from.set_push_location(br_to.base)
691
# We were able to connect to the remote location, so remember it
692
# we don't need to successfully push because of possible divergence.
693
if br_from.get_push_location() is None or remember:
694
br_from.set_push_location(br_to.base)
695
old_rh = br_to.revision_history()
698
tree_to = dir_to.open_workingtree()
699
except errors.NotLocalUrl:
700
warning('This transport does not update the working '
701
'tree of: %s' % (br_to.base,))
702
count = br_from.push(br_to, overwrite)
703
except errors.NoWorkingTree:
704
count = br_from.push(br_to, overwrite)
708
count = br_from.push(tree_to.branch, overwrite)
712
except errors.DivergedBranches:
713
raise errors.BzrCommandError('These branches have diverged.'
714
' Try using "merge" and then "push".')
715
note('%d revision(s) pushed.' % (count,))
718
new_rh = br_to.revision_history()
721
from bzrlib.log import show_changed_revisions
722
show_changed_revisions(br_to, old_rh, new_rh,
726
class cmd_branch(Command):
727
"""Create a new copy of a branch.
729
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
730
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
732
To retrieve the branch as of a particular revision, supply the --revision
733
parameter, as in "branch foo/bar -r 5".
735
--basis is to speed up branching from remote branches. When specified, it
736
copies all the file-contents, inventory and revision data from the basis
737
branch before copying anything from the remote branch.
739
takes_args = ['from_location', 'to_location?']
740
takes_options = ['revision', 'basis']
741
aliases = ['get', 'clone']
743
def run(self, from_location, to_location=None, revision=None, basis=None):
746
elif len(revision) > 1:
747
raise errors.BzrCommandError(
748
'bzr branch --revision takes exactly 1 revision value')
750
br_from = Branch.open(from_location)
752
if e.errno == errno.ENOENT:
753
raise errors.BzrCommandError('Source location "%s" does not'
754
' exist.' % to_location)
759
if basis is not None:
760
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
763
if len(revision) == 1 and revision[0] is not None:
764
revision_id = revision[0].in_history(br_from)[1]
766
# FIXME - wt.last_revision, fallback to branch, fall back to
767
# None or perhaps NULL_REVISION to mean copy nothing
769
revision_id = br_from.last_revision()
770
if to_location is None:
771
to_location = os.path.basename(from_location.rstrip("/\\"))
774
name = os.path.basename(to_location) + '\n'
776
to_transport = transport.get_transport(to_location)
778
to_transport.mkdir('.')
779
except errors.FileExists:
780
raise errors.BzrCommandError('Target directory "%s" already'
781
' exists.' % to_location)
782
except errors.NoSuchFile:
783
raise errors.BzrCommandError('Parent of "%s" does not exist.'
786
# preserve whatever source format we have.
787
dir = br_from.bzrdir.sprout(to_transport.base,
788
revision_id, basis_dir)
789
branch = dir.open_branch()
790
except errors.NoSuchRevision:
791
to_transport.delete_tree('.')
792
msg = "The branch %s has no revision %s." % (from_location, revision[0])
793
raise errors.BzrCommandError(msg)
794
except errors.UnlistableBranch:
795
osutils.rmtree(to_location)
796
msg = "The branch %s cannot be used as a --basis" % (basis,)
797
raise errors.BzrCommandError(msg)
799
branch.control_files.put_utf8('branch-name', name)
800
note('Branched %d revision(s).' % branch.revno())
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
source.create_checkout(to_location, revision_id, lightweight)
878
class cmd_renames(Command):
879
"""Show list of renamed files.
881
# TODO: Option to show renames between two historical versions.
883
# TODO: Only show renames under dir, rather than in the whole branch.
884
takes_args = ['dir?']
887
def run(self, dir=u'.'):
888
tree = WorkingTree.open_containing(dir)[0]
889
old_inv = tree.basis_tree().inventory
890
new_inv = tree.read_working_inventory()
891
renames = list(_mod_tree.find_renames(old_inv, new_inv))
893
for old_name, new_name in renames:
894
self.outf.write("%s => %s\n" % (old_name, new_name))
897
class cmd_update(Command):
898
"""Update a tree to have the latest code committed to its branch.
900
This will perform a merge into the working tree, and may generate
901
conflicts. If you have any local changes, you will still
902
need to commit them after the update for the update to be complete.
904
If you want to discard your local changes, you can just do a
905
'bzr revert' instead of 'bzr commit' after the update.
907
takes_args = ['dir?']
910
def run(self, dir='.'):
911
tree = WorkingTree.open_containing(dir)[0]
912
master = tree.branch.get_master_branch()
913
if master is not None:
916
tree.lock_tree_write()
918
existing_pending_merges = tree.get_parent_ids()[1:]
919
last_rev = tree.last_revision()
920
if last_rev == tree.branch.last_revision():
921
# may be up to date, check master too.
922
master = tree.branch.get_master_branch()
923
if master is None or last_rev == master.last_revision():
924
revno = tree.branch.revision_id_to_revno(last_rev)
925
note("Tree is up to date at revision %d." % (revno,))
927
conflicts = tree.update()
928
revno = tree.branch.revision_id_to_revno(tree.last_revision())
929
note('Updated to revision %d.' % (revno,))
930
if tree.get_parent_ids()[1:] != existing_pending_merges:
931
note('Your local commits will now show as pending merges with '
932
"'bzr status', and can be committed with 'bzr commit'.")
941
class cmd_info(Command):
942
"""Show information about a working tree, branch or repository.
944
This command will show all known locations and formats associated to the
945
tree, branch or repository. Statistical information is included with
948
Branches and working trees will also report any missing revisions.
950
takes_args = ['location?']
951
takes_options = ['verbose']
954
def run(self, location=None, verbose=False):
955
from bzrlib.info import show_bzrdir_info
956
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
960
class cmd_remove(Command):
961
"""Make a file unversioned.
963
This makes bzr stop tracking changes to a versioned file. It does
964
not delete the working copy.
966
You can specify one or more files, and/or --new. If you specify --new,
967
only 'added' files will be removed. If you specify both, then new files
968
in the specified directories will be removed. If the directories are
969
also new, they will also be removed.
971
takes_args = ['file*']
972
takes_options = ['verbose', Option('new', help='remove newly-added files')]
974
encoding_type = 'replace'
976
def run(self, file_list, verbose=False, new=False):
977
tree, file_list = tree_files(file_list)
979
if file_list is None:
980
raise errors.BzrCommandError('Specify one or more files to'
981
' remove, or use --new.')
983
added = tree.changes_from(tree.basis_tree(),
984
specific_files=file_list).added
985
file_list = sorted([f[0] for f in added], reverse=True)
986
if len(file_list) == 0:
987
raise errors.BzrCommandError('No matching files.')
988
tree.remove(file_list, verbose=verbose, to_file=self.outf)
991
class cmd_file_id(Command):
992
"""Print file_id of a particular file or directory.
994
The file_id is assigned when the file is first added and remains the
995
same through all revisions where the file exists, even when it is
1000
takes_args = ['filename']
1003
def run(self, filename):
1004
tree, relpath = WorkingTree.open_containing(filename)
1005
i = tree.inventory.path2id(relpath)
1007
raise errors.NotVersionedError(filename)
1009
self.outf.write(i + '\n')
1012
class cmd_file_path(Command):
1013
"""Print path of file_ids to a file or directory.
1015
This prints one line for each directory down to the target,
1016
starting at the branch root.
1020
takes_args = ['filename']
1023
def run(self, filename):
1024
tree, relpath = WorkingTree.open_containing(filename)
1025
inv = tree.inventory
1026
fid = inv.path2id(relpath)
1028
raise errors.NotVersionedError(filename)
1029
for fip in inv.get_idpath(fid):
1030
self.outf.write(fip + '\n')
1033
class cmd_reconcile(Command):
1034
"""Reconcile bzr metadata in a branch.
1036
This can correct data mismatches that may have been caused by
1037
previous ghost operations or bzr upgrades. You should only
1038
need to run this command if 'bzr check' or a bzr developer
1039
advises you to run it.
1041
If a second branch is provided, cross-branch reconciliation is
1042
also attempted, which will check that data like the tree root
1043
id which was not present in very early bzr versions is represented
1044
correctly in both branches.
1046
At the same time it is run it may recompress data resulting in
1047
a potential saving in disk space or performance gain.
1049
The branch *MUST* be on a listable system such as local disk or sftp.
1051
takes_args = ['branch?']
1053
def run(self, branch="."):
1054
from bzrlib.reconcile import reconcile
1055
dir = bzrdir.BzrDir.open(branch)
1059
class cmd_revision_history(Command):
1060
"""Display the list of revision ids on a branch."""
1061
takes_args = ['location?']
1066
def run(self, location="."):
1067
branch = Branch.open_containing(location)[0]
1068
for revid in branch.revision_history():
1069
self.outf.write(revid)
1070
self.outf.write('\n')
1073
class cmd_ancestry(Command):
1074
"""List all revisions merged into this branch."""
1075
takes_args = ['location?']
1080
def run(self, location="."):
1082
wt = WorkingTree.open_containing(location)[0]
1083
except errors.NoWorkingTree:
1084
b = Branch.open(location)
1085
last_revision = b.last_revision()
1088
last_revision = wt.last_revision()
1090
revision_ids = b.repository.get_ancestry(last_revision)
1091
assert revision_ids[0] is None
1093
for revision_id in revision_ids:
1094
self.outf.write(revision_id + '\n')
1097
class cmd_init(Command):
1098
"""Make a directory into a versioned branch.
1100
Use this to create an empty branch, or before importing an
1103
If there is a repository in a parent directory of the location, then
1104
the history of the branch will be stored in the repository. Otherwise
1105
init creates a standalone branch which carries its own history in
1108
If there is already a branch at the location but it has no working tree,
1109
the tree can be populated with 'bzr checkout'.
1111
Recipe for importing a tree of files:
1116
bzr commit -m 'imported project'
1118
takes_args = ['location?']
1120
RegistryOption('format',
1121
help='Specify a format for this branch. Current'
1122
' formats are: default, knit, metaweave and'
1123
' weave. Default is knit; metaweave and'
1124
' weave are deprecated',
1125
converter=bzrdir.format_registry.make_bzrdir,
1126
registry=bzrdir.format_registry,
1127
value_switches=True),
1129
def run(self, location=None, format=None):
1131
format = bzrdir.format_registry.make_bzrdir('default')
1132
if location is None:
1135
to_transport = transport.get_transport(location)
1137
# The path has to exist to initialize a
1138
# branch inside of it.
1139
# Just using os.mkdir, since I don't
1140
# believe that we want to create a bunch of
1141
# locations if the user supplies an extended path
1142
# TODO: create-prefix
1144
to_transport.mkdir('.')
1145
except errors.FileExists:
1149
existing_bzrdir = bzrdir.BzrDir.open(location)
1150
except errors.NotBranchError:
1151
# really a NotBzrDir error...
1152
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1154
from bzrlib.transport.local import LocalTransport
1155
if existing_bzrdir.has_branch():
1156
if (isinstance(to_transport, LocalTransport)
1157
and not existing_bzrdir.has_workingtree()):
1158
raise errors.BranchExistsWithoutWorkingTree(location)
1159
raise errors.AlreadyBranchError(location)
1161
existing_bzrdir.create_branch()
1162
existing_bzrdir.create_workingtree()
1165
class cmd_init_repository(Command):
1166
"""Create a shared repository to hold branches.
1168
New branches created under the repository directory will store their revisions
1169
in the repository, not in the branch directory, if the branch format supports
1175
bzr checkout --lightweight repo/trunk trunk-checkout
1179
takes_args = ["location"]
1180
takes_options = [RegistryOption('format',
1181
help='Specify a format for this repository.'
1182
' Current formats are: default, knit,'
1183
' metaweave and weave. Default is knit;'
1184
' metaweave and weave are deprecated',
1185
registry=bzrdir.format_registry,
1186
converter=bzrdir.format_registry.make_bzrdir,
1187
value_switches=True),
1189
help='Allows branches in repository to have'
1191
aliases = ["init-repo"]
1192
def run(self, location, format=None, trees=False):
1194
format = bzrdir.format_registry.make_bzrdir('default')
1196
if location is None:
1199
to_transport = transport.get_transport(location)
1201
to_transport.mkdir('.')
1202
except errors.FileExists:
1205
newdir = format.initialize_on_transport(to_transport)
1206
repo = newdir.create_repository(shared=True)
1207
repo.set_make_working_trees(trees)
1210
class cmd_diff(Command):
1211
"""Show differences in the working tree or between revisions.
1213
If files are listed, only the changes in those files are listed.
1214
Otherwise, all changes for the tree are listed.
1216
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1217
produces patches suitable for "patch -p1".
1221
Shows the difference in the working tree versus the last commit
1223
Difference between the working tree and revision 1
1225
Difference between revision 2 and revision 1
1226
bzr diff --diff-prefix old/:new/
1227
Same as 'bzr diff' but prefix paths with old/ and new/
1228
bzr diff bzr.mine bzr.dev
1229
Show the differences between the two working trees
1231
Show just the differences for 'foo.c'
1233
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1234
# or a graphical diff.
1236
# TODO: Python difflib is not exactly the same as unidiff; should
1237
# either fix it up or prefer to use an external diff.
1239
# TODO: Selected-file diff is inefficient and doesn't show you
1242
# TODO: This probably handles non-Unix newlines poorly.
1244
takes_args = ['file*']
1245
takes_options = ['revision', 'diff-options',
1246
Option('prefix', type=str,
1248
help='Set prefixes to added to old and new filenames, as '
1249
'two values separated by a colon.'),
1251
aliases = ['di', 'dif']
1252
encoding_type = 'exact'
1255
def run(self, revision=None, file_list=None, diff_options=None,
1257
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1259
if (prefix is None) or (prefix == '0'):
1267
old_label, new_label = prefix.split(":")
1269
raise BzrCommandError(
1270
"--prefix expects two values separated by a colon")
1272
if revision and len(revision) > 2:
1273
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1274
' one or two revision specifiers')
1277
tree1, file_list = internal_tree_files(file_list)
1281
except errors.FileInWrongBranch:
1282
if len(file_list) != 2:
1283
raise errors.BzrCommandError("Files are in different branches")
1285
tree1, file1 = WorkingTree.open_containing(file_list[0])
1286
tree2, file2 = WorkingTree.open_containing(file_list[1])
1287
if file1 != "" or file2 != "":
1288
# FIXME diff those two files. rbc 20051123
1289
raise errors.BzrCommandError("Files are in different branches")
1291
except errors.NotBranchError:
1292
if (revision is not None and len(revision) == 2
1293
and not revision[0].needs_branch()
1294
and not revision[1].needs_branch()):
1295
# If both revision specs include a branch, we can
1296
# diff them without needing a local working tree
1297
tree1, tree2 = None, None
1301
if tree2 is not None:
1302
if revision is not None:
1303
# FIXME: but there should be a clean way to diff between
1304
# non-default versions of two trees, it's not hard to do
1306
raise errors.BzrCommandError(
1307
"Sorry, diffing arbitrary revisions across branches "
1308
"is not implemented yet")
1309
return show_diff_trees(tree1, tree2, sys.stdout,
1310
specific_files=file_list,
1311
external_diff_options=diff_options,
1312
old_label=old_label, new_label=new_label)
1314
return diff_cmd_helper(tree1, file_list, diff_options,
1315
revision_specs=revision,
1316
old_label=old_label, new_label=new_label)
1319
class cmd_deleted(Command):
1320
"""List files deleted in the working tree.
1322
# TODO: Show files deleted since a previous revision, or
1323
# between two revisions.
1324
# TODO: Much more efficient way to do this: read in new
1325
# directories with readdir, rather than stating each one. Same
1326
# level of effort but possibly much less IO. (Or possibly not,
1327
# if the directories are very large...)
1328
takes_options = ['show-ids']
1331
def run(self, show_ids=False):
1332
tree = WorkingTree.open_containing(u'.')[0]
1333
old = tree.basis_tree()
1334
for path, ie in old.inventory.iter_entries():
1335
if not tree.has_id(ie.file_id):
1336
self.outf.write(path)
1338
self.outf.write(' ')
1339
self.outf.write(ie.file_id)
1340
self.outf.write('\n')
1343
class cmd_modified(Command):
1344
"""List files modified in working tree."""
1348
tree = WorkingTree.open_containing(u'.')[0]
1349
td = tree.changes_from(tree.basis_tree())
1350
for path, id, kind, text_modified, meta_modified in td.modified:
1351
self.outf.write(path + '\n')
1354
class cmd_added(Command):
1355
"""List files added in working tree."""
1359
wt = WorkingTree.open_containing(u'.')[0]
1360
basis_inv = wt.basis_tree().inventory
1363
if file_id in basis_inv:
1365
if inv.is_root(file_id) and len(basis_inv) == 0:
1367
path = inv.id2path(file_id)
1368
if not os.access(osutils.abspath(path), os.F_OK):
1370
self.outf.write(path + '\n')
1373
class cmd_root(Command):
1374
"""Show the tree root directory.
1376
The root is the nearest enclosing directory with a .bzr control
1378
takes_args = ['filename?']
1380
def run(self, filename=None):
1381
"""Print the branch root."""
1382
tree = WorkingTree.open_containing(filename)[0]
1383
self.outf.write(tree.basedir + '\n')
1386
class cmd_log(Command):
1387
"""Show log of a branch, file, or directory.
1389
By default show the log of the branch containing the working directory.
1391
To request a range of logs, you can use the command -r begin..end
1392
-r revision requests a specific revision, -r ..end or -r begin.. are
1398
bzr log -r -10.. http://server/branch
1401
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1403
takes_args = ['location?']
1404
takes_options = [Option('forward',
1405
help='show from oldest to newest'),
1409
help='show files changed in each revision'),
1410
'show-ids', 'revision',
1415
help='show revisions whose message matches this regexp',
1419
encoding_type = 'replace'
1422
def run(self, location=None, timezone='original',
1432
from bzrlib.log import log_formatter, show_log
1433
assert message is None or isinstance(message, basestring), \
1434
"invalid message argument %r" % message
1435
direction = (forward and 'forward') or 'reverse'
1440
# find the file id to log:
1442
dir, fp = bzrdir.BzrDir.open_containing(location)
1443
b = dir.open_branch()
1447
inv = dir.open_workingtree().inventory
1448
except (errors.NotBranchError, errors.NotLocalUrl):
1449
# either no tree, or is remote.
1450
inv = b.basis_tree().inventory
1451
file_id = inv.path2id(fp)
1453
raise errors.BzrCommandError(
1454
"Path does not have any revision history: %s" %
1458
# FIXME ? log the current subdir only RBC 20060203
1459
if revision is not None \
1460
and len(revision) > 0 and revision[0].get_branch():
1461
location = revision[0].get_branch()
1464
dir, relpath = bzrdir.BzrDir.open_containing(location)
1465
b = dir.open_branch()
1467
if revision is None:
1470
elif len(revision) == 1:
1471
rev1 = rev2 = revision[0].in_history(b).revno
1472
elif len(revision) == 2:
1473
if revision[1].get_branch() != revision[0].get_branch():
1474
# b is taken from revision[0].get_branch(), and
1475
# show_log will use its revision_history. Having
1476
# different branches will lead to weird behaviors.
1477
raise errors.BzrCommandError(
1478
"Log doesn't accept two revisions in different branches.")
1479
if revision[0].spec is None:
1480
# missing begin-range means first revision
1483
rev1 = revision[0].in_history(b).revno
1485
if revision[1].spec is None:
1486
# missing end-range means last known revision
1489
rev2 = revision[1].in_history(b).revno
1491
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1493
# By this point, the revision numbers are converted to the +ve
1494
# form if they were supplied in the -ve form, so we can do
1495
# this comparison in relative safety
1497
(rev2, rev1) = (rev1, rev2)
1499
if (log_format is None):
1500
default = b.get_config().log_format()
1501
log_format = get_log_format(long=long, short=short, line=line,
1503
lf = log_formatter(log_format,
1506
show_timezone=timezone)
1512
direction=direction,
1513
start_revision=rev1,
1518
def get_log_format(long=False, short=False, line=False, default='long'):
1519
log_format = default
1523
log_format = 'short'
1529
class cmd_touching_revisions(Command):
1530
"""Return revision-ids which affected a particular file.
1532
A more user-friendly interface is "bzr log FILE".
1536
takes_args = ["filename"]
1539
def run(self, filename):
1540
tree, relpath = WorkingTree.open_containing(filename)
1542
inv = tree.read_working_inventory()
1543
file_id = inv.path2id(relpath)
1544
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1545
self.outf.write("%6d %s\n" % (revno, what))
1548
class cmd_ls(Command):
1549
"""List files in a tree.
1552
takes_args = ['path?']
1553
# TODO: Take a revision or remote path and list that tree instead.
1554
takes_options = ['verbose', 'revision',
1555
Option('non-recursive',
1556
help='don\'t recurse into sub-directories'),
1558
help='Print all paths from the root of the branch.'),
1559
Option('unknown', help='Print unknown files'),
1560
Option('versioned', help='Print versioned files'),
1561
Option('ignored', help='Print ignored files'),
1563
Option('null', help='Null separate the files'),
1567
def run(self, revision=None, verbose=False,
1568
non_recursive=False, from_root=False,
1569
unknown=False, versioned=False, ignored=False,
1570
null=False, kind=None, show_ids=False, path=None):
1572
if kind and kind not in ('file', 'directory', 'symlink'):
1573
raise errors.BzrCommandError('invalid kind specified')
1575
if verbose and null:
1576
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1577
all = not (unknown or versioned or ignored)
1579
selection = {'I':ignored, '?':unknown, 'V':versioned}
1586
raise errors.BzrCommandError('cannot specify both --from-root'
1590
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1596
if revision is not None:
1597
tree = branch.repository.revision_tree(
1598
revision[0].in_history(branch).rev_id)
1600
tree = branch.basis_tree()
1602
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1603
if fp.startswith(relpath):
1604
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1605
if non_recursive and '/' in fp:
1607
if not all and not selection[fc]:
1609
if kind is not None and fkind != kind:
1612
kindch = entry.kind_character()
1613
outstring = '%-8s %s%s' % (fc, fp, kindch)
1614
if show_ids and fid is not None:
1615
outstring = "%-50s %s" % (outstring, fid)
1616
self.outf.write(outstring + '\n')
1618
self.outf.write(fp + '\0')
1621
self.outf.write(fid)
1622
self.outf.write('\0')
1630
self.outf.write('%-50s %s\n' % (fp, my_id))
1632
self.outf.write(fp + '\n')
1635
class cmd_unknowns(Command):
1636
"""List unknown files."""
1639
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1640
self.outf.write(osutils.quotefn(f) + '\n')
1643
class cmd_ignore(Command):
1644
"""Ignore specified files or patterns.
1646
To remove patterns from the ignore list, edit the .bzrignore file.
1648
Trailing slashes on patterns are ignored.
1649
If the pattern contains a slash or is a regular expression, it is compared
1650
to the whole path from the branch root. Otherwise, it is compared to only
1651
the last component of the path. To match a file only in the root
1652
directory, prepend './'.
1654
Ignore patterns specifying absolute paths are not allowed.
1656
Ignore patterns may include globbing wildcards such as:
1657
? - Matches any single character except '/'
1658
* - Matches 0 or more characters except '/'
1659
/**/ - Matches 0 or more directories in a path
1660
[a-z] - Matches a single character from within a group of characters
1662
Ignore patterns may also be Python regular expressions.
1663
Regular expression ignore patterns are identified by a 'RE:' prefix
1664
followed by the regular expression. Regular expression ignore patterns
1665
may not include named or numbered groups.
1667
Note: ignore patterns containing shell wildcards must be quoted from
1671
bzr ignore ./Makefile
1672
bzr ignore '*.class'
1673
bzr ignore 'lib/**/*.o'
1674
bzr ignore 'RE:lib/.*\.o'
1676
takes_args = ['name_pattern*']
1678
Option('old-default-rules',
1679
help='Out the ignore rules bzr < 0.9 always used.')
1682
def run(self, name_pattern_list=None, old_default_rules=None):
1683
from bzrlib.atomicfile import AtomicFile
1684
if old_default_rules is not None:
1685
# dump the rules and exit
1686
for pattern in ignores.OLD_DEFAULTS:
1689
if not name_pattern_list:
1690
raise errors.BzrCommandError("ignore requires at least one "
1691
"NAME_PATTERN or --old-default-rules")
1692
for name_pattern in name_pattern_list:
1693
if name_pattern[0] == '/':
1694
raise errors.BzrCommandError(
1695
"NAME_PATTERN should not be an absolute path")
1696
tree, relpath = WorkingTree.open_containing(u'.')
1697
ifn = tree.abspath('.bzrignore')
1698
if os.path.exists(ifn):
1701
igns = f.read().decode('utf-8')
1707
# TODO: If the file already uses crlf-style termination, maybe
1708
# we should use that for the newly added lines?
1710
if igns and igns[-1] != '\n':
1712
for name_pattern in name_pattern_list:
1713
igns += name_pattern.rstrip('/') + '\n'
1715
f = AtomicFile(ifn, 'wb')
1717
f.write(igns.encode('utf-8'))
1722
inv = tree.inventory
1723
if inv.path2id('.bzrignore'):
1724
mutter('.bzrignore is already versioned')
1726
mutter('need to make new .bzrignore file versioned')
1727
tree.add(['.bzrignore'])
1730
class cmd_ignored(Command):
1731
"""List ignored files and the patterns that matched them.
1733
See also: bzr ignore"""
1736
tree = WorkingTree.open_containing(u'.')[0]
1737
for path, file_class, kind, file_id, entry in tree.list_files():
1738
if file_class != 'I':
1740
## XXX: Slightly inefficient since this was already calculated
1741
pat = tree.is_ignored(path)
1742
print '%-50s %s' % (path, pat)
1745
class cmd_lookup_revision(Command):
1746
"""Lookup the revision-id from a revision-number
1749
bzr lookup-revision 33
1752
takes_args = ['revno']
1755
def run(self, revno):
1759
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1761
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1764
class cmd_export(Command):
1765
"""Export past revision to destination directory.
1767
If no revision is specified this exports the last committed revision.
1769
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1770
given, try to find the format with the extension. If no extension
1771
is found exports to a directory (equivalent to --format=dir).
1773
Root may be the top directory for tar, tgz and tbz2 formats. If none
1774
is given, the top directory will be the root name of the file.
1776
If branch is omitted then the branch containing the CWD will be used.
1778
Note: export of tree with non-ascii filenames to zip is not supported.
1780
Supported formats Autodetected by extension
1781
----------------- -------------------------
1784
tbz2 .tar.bz2, .tbz2
1788
takes_args = ['dest', 'branch?']
1789
takes_options = ['revision', 'format', 'root']
1790
def run(self, dest, branch=None, revision=None, format=None, root=None):
1791
from bzrlib.export import export
1794
tree = WorkingTree.open_containing(u'.')[0]
1797
b = Branch.open(branch)
1799
if revision is None:
1800
# should be tree.last_revision FIXME
1801
rev_id = b.last_revision()
1803
if len(revision) != 1:
1804
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1805
rev_id = revision[0].in_history(b).rev_id
1806
t = b.repository.revision_tree(rev_id)
1808
export(t, dest, format, root)
1809
except errors.NoSuchExportFormat, e:
1810
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1813
class cmd_cat(Command):
1814
"""Write a file's text from a previous revision."""
1816
takes_options = ['revision', 'name-from-revision']
1817
takes_args = ['filename']
1818
encoding_type = 'exact'
1821
def run(self, filename, revision=None, name_from_revision=False):
1822
if revision is not None and len(revision) != 1:
1823
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1828
tree, relpath = WorkingTree.open_containing(filename)
1830
except (errors.NotBranchError, errors.NotLocalUrl):
1833
if revision is not None and revision[0].get_branch() is not None:
1834
b = Branch.open(revision[0].get_branch())
1836
b, relpath = Branch.open_containing(filename)
1837
tree = b.basis_tree()
1838
if revision is None:
1839
revision_id = b.last_revision()
1841
revision_id = revision[0].in_history(b).rev_id
1843
cur_file_id = tree.path2id(relpath)
1844
rev_tree = b.repository.revision_tree(revision_id)
1845
old_file_id = rev_tree.path2id(relpath)
1847
if name_from_revision:
1848
if old_file_id is None:
1849
raise errors.BzrCommandError("%r is not present in revision %s"
1850
% (filename, revision_id))
1852
rev_tree.print_file(old_file_id)
1853
elif cur_file_id is not None:
1854
rev_tree.print_file(cur_file_id)
1855
elif old_file_id is not None:
1856
rev_tree.print_file(old_file_id)
1858
raise errors.BzrCommandError("%r is not present in revision %s" %
1859
(filename, revision_id))
1862
class cmd_local_time_offset(Command):
1863
"""Show the offset in seconds from GMT to local time."""
1867
print osutils.local_time_offset()
1871
class cmd_commit(Command):
1872
"""Commit changes into a new revision.
1874
If no arguments are given, the entire tree is committed.
1876
If selected files are specified, only changes to those files are
1877
committed. If a directory is specified then the directory and everything
1878
within it is committed.
1880
A selected-file commit may fail in some cases where the committed
1881
tree would be invalid, such as trying to commit a file in a
1882
newly-added directory that is not itself committed.
1884
# TODO: Run hooks on tree to-be-committed, and after commit.
1886
# TODO: Strict commit that fails if there are deleted files.
1887
# (what does "deleted files" mean ??)
1889
# TODO: Give better message for -s, --summary, used by tla people
1891
# XXX: verbose currently does nothing
1893
takes_args = ['selected*']
1894
takes_options = ['message', 'verbose',
1896
help='commit even if nothing has changed'),
1897
Option('file', type=str,
1900
help='file containing commit message'),
1902
help="refuse to commit if there are unknown "
1903
"files in the working tree."),
1905
help="perform a local only commit in a bound "
1906
"branch. Such commits are not pushed to "
1907
"the master branch until a normal commit "
1911
aliases = ['ci', 'checkin']
1913
def run(self, message=None, file=None, verbose=True, selected_list=None,
1914
unchanged=False, strict=False, local=False):
1915
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1916
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1918
from bzrlib.msgeditor import edit_commit_message, \
1919
make_commit_message_template
1921
# TODO: Need a blackbox test for invoking the external editor; may be
1922
# slightly problematic to run this cross-platform.
1924
# TODO: do more checks that the commit will succeed before
1925
# spending the user's valuable time typing a commit message.
1926
tree, selected_list = tree_files(selected_list)
1927
if selected_list == ['']:
1928
# workaround - commit of root of tree should be exactly the same
1929
# as just default commit in that tree, and succeed even though
1930
# selected-file merge commit is not done yet
1933
if local and not tree.branch.get_bound_location():
1934
raise errors.LocalRequiresBoundBranch()
1936
def get_message(commit_obj):
1937
"""Callback to get commit message"""
1938
my_message = message
1939
if my_message is None and not file:
1940
template = make_commit_message_template(tree, selected_list)
1941
my_message = edit_commit_message(template)
1942
if my_message is None:
1943
raise errors.BzrCommandError("please specify a commit"
1944
" message with either --message or --file")
1945
elif my_message and file:
1946
raise errors.BzrCommandError(
1947
"please specify either --message or --file")
1949
my_message = codecs.open(file, 'rt',
1950
bzrlib.user_encoding).read()
1951
if my_message == "":
1952
raise errors.BzrCommandError("empty commit message specified")
1956
reporter = ReportCommitToLog()
1958
reporter = NullCommitReporter()
1961
tree.commit(message_callback=get_message,
1962
specific_files=selected_list,
1963
allow_pointless=unchanged, strict=strict, local=local,
1965
except PointlessCommit:
1966
# FIXME: This should really happen before the file is read in;
1967
# perhaps prepare the commit; get the message; then actually commit
1968
raise errors.BzrCommandError("no changes to commit."
1969
" use --unchanged to commit anyhow")
1970
except ConflictsInTree:
1971
raise errors.BzrCommandError('Conflicts detected in working '
1972
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
1974
except StrictCommitFailed:
1975
raise errors.BzrCommandError("Commit refused because there are"
1976
" unknown files in the working tree.")
1977
except errors.BoundBranchOutOfDate, e:
1978
raise errors.BzrCommandError(str(e) + "\n"
1979
'To commit to master branch, run update and then commit.\n'
1980
'You can also pass --local to commit to continue working '
1984
class cmd_check(Command):
1985
"""Validate consistency of branch history.
1987
This command checks various invariants about the branch storage to
1988
detect data corruption or bzr bugs.
1990
takes_args = ['branch?']
1991
takes_options = ['verbose']
1993
def run(self, branch=None, verbose=False):
1994
from bzrlib.check import check
1996
tree = WorkingTree.open_containing()[0]
1997
branch = tree.branch
1999
branch = Branch.open(branch)
2000
check(branch, verbose)
2003
class cmd_upgrade(Command):
2004
"""Upgrade branch storage to current format.
2006
The check command or bzr developers may sometimes advise you to run
2007
this command. When the default format has changed you may also be warned
2008
during other operations to upgrade.
2010
takes_args = ['url?']
2012
RegistryOption('format',
2013
help='Upgrade to a specific format. Current formats'
2014
' are: default, knit, metaweave and weave.'
2015
' Default is knit; metaweave and weave are'
2017
registry=bzrdir.format_registry,
2018
converter=bzrdir.format_registry.make_bzrdir,
2019
value_switches=True),
2023
def run(self, url='.', format=None):
2024
from bzrlib.upgrade import upgrade
2026
format = bzrdir.format_registry.make_bzrdir('default')
2027
upgrade(url, format)
2030
class cmd_whoami(Command):
2031
"""Show or set bzr user id.
2035
bzr whoami 'Frank Chu <fchu@example.com>'
2037
takes_options = [ Option('email',
2038
help='display email address only'),
2040
help='set identity for the current branch instead of '
2043
takes_args = ['name?']
2044
encoding_type = 'replace'
2047
def run(self, email=False, branch=False, name=None):
2049
# use branch if we're inside one; otherwise global config
2051
c = Branch.open_containing('.')[0].get_config()
2052
except errors.NotBranchError:
2053
c = config.GlobalConfig()
2055
self.outf.write(c.user_email() + '\n')
2057
self.outf.write(c.username() + '\n')
2060
# display a warning if an email address isn't included in the given name.
2062
config.extract_email_address(name)
2063
except errors.NoEmailInUsername, e:
2064
warning('"%s" does not seem to contain an email address. '
2065
'This is allowed, but not recommended.', name)
2067
# use global config unless --branch given
2069
c = Branch.open_containing('.')[0].get_config()
2071
c = config.GlobalConfig()
2072
c.set_user_option('email', name)
2075
class cmd_nick(Command):
2076
"""Print or set the branch nickname.
2078
If unset, the tree root directory name is used as the nickname
2079
To print the current nickname, execute with no argument.
2081
takes_args = ['nickname?']
2082
def run(self, nickname=None):
2083
branch = Branch.open_containing(u'.')[0]
2084
if nickname is None:
2085
self.printme(branch)
2087
branch.nick = nickname
2090
def printme(self, branch):
2094
class cmd_selftest(Command):
2095
"""Run internal test suite.
2097
This creates temporary test directories in the working directory, but not
2098
existing data is affected. These directories are deleted if the tests
2099
pass, or left behind to help in debugging if they fail and --keep-output
2102
If arguments are given, they are regular expressions that say which tests
2103
should run. Tests matching any expression are run, and other tests are
2106
Alternatively if --first is given, matching tests are run first and then
2107
all other tests are run. This is useful if you have been working in a
2108
particular area, but want to make sure nothing else was broken.
2110
If the global option '--no-plugins' is given, plugins are not loaded
2111
before running the selftests. This has two effects: features provided or
2112
modified by plugins will not be tested, and tests provided by plugins will
2117
run only tests relating to 'ignore'
2118
bzr --no-plugins selftest -v
2119
disable plugins and list tests as they're run
2121
# TODO: --list should give a list of all available tests
2123
# NB: this is used from the class without creating an instance, which is
2124
# why it does not have a self parameter.
2125
def get_transport_type(typestring):
2126
"""Parse and return a transport specifier."""
2127
if typestring == "sftp":
2128
from bzrlib.transport.sftp import SFTPAbsoluteServer
2129
return SFTPAbsoluteServer
2130
if typestring == "memory":
2131
from bzrlib.transport.memory import MemoryServer
2133
if typestring == "fakenfs":
2134
from bzrlib.transport.fakenfs import FakeNFSServer
2135
return FakeNFSServer
2136
msg = "No known transport type %s. Supported types are: sftp\n" %\
2138
raise errors.BzrCommandError(msg)
2141
takes_args = ['testspecs*']
2142
takes_options = ['verbose',
2143
Option('one', help='stop when one test fails'),
2144
Option('keep-output',
2145
help='keep output directories when tests fail'),
2147
help='Use a different transport by default '
2148
'throughout the test suite.',
2149
type=get_transport_type),
2150
Option('benchmark', help='run the bzr bencharks.'),
2151
Option('lsprof-timed',
2152
help='generate lsprof output for benchmarked'
2153
' sections of code.'),
2154
Option('cache-dir', type=str,
2155
help='a directory to cache intermediate'
2156
' benchmark steps'),
2157
Option('clean-output',
2158
help='clean temporary tests directories'
2159
' without running tests'),
2161
help='run all tests, but run specified tests first',
2164
encoding_type = 'replace'
2166
def run(self, testspecs_list=None, verbose=None, one=False,
2167
keep_output=False, transport=None, benchmark=None,
2168
lsprof_timed=None, cache_dir=None, clean_output=False,
2171
from bzrlib.tests import selftest
2172
import bzrlib.benchmarks as benchmarks
2173
from bzrlib.benchmarks import tree_creator
2176
from bzrlib.tests import clean_selftest_output
2177
clean_selftest_output()
2180
if cache_dir is not None:
2181
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2182
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2183
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2185
if testspecs_list is not None:
2186
pattern = '|'.join(testspecs_list)
2190
test_suite_factory = benchmarks.test_suite
2193
# TODO: should possibly lock the history file...
2194
benchfile = open(".perf_history", "at", buffering=1)
2196
test_suite_factory = None
2201
result = selftest(verbose=verbose,
2203
stop_on_failure=one,
2204
keep_output=keep_output,
2205
transport=transport,
2206
test_suite_factory=test_suite_factory,
2207
lsprof_timed=lsprof_timed,
2208
bench_history=benchfile,
2209
matching_tests_first=first,
2212
if benchfile is not None:
2215
info('tests passed')
2217
info('tests failed')
2218
return int(not result)
2221
class cmd_version(Command):
2222
"""Show version of bzr."""
2226
from bzrlib.version import show_version
2230
class cmd_rocks(Command):
2231
"""Statement of optimism."""
2237
print "it sure does!"
2240
class cmd_find_merge_base(Command):
2241
"""Find and print a base revision for merging two branches."""
2242
# TODO: Options to specify revisions on either side, as if
2243
# merging only part of the history.
2244
takes_args = ['branch', 'other']
2248
def run(self, branch, other):
2249
from bzrlib.revision import MultipleRevisionSources
2251
branch1 = Branch.open_containing(branch)[0]
2252
branch2 = Branch.open_containing(other)[0]
2254
last1 = branch1.last_revision()
2255
last2 = branch2.last_revision()
2257
source = MultipleRevisionSources(branch1.repository,
2260
base_rev_id = common_ancestor(last1, last2, source)
2262
print 'merge base is revision %s' % base_rev_id
2265
class cmd_merge(Command):
2266
"""Perform a three-way merge.
2268
The branch is the branch you will merge from. By default, it will merge
2269
the latest revision. If you specify a revision, that revision will be
2270
merged. If you specify two revisions, the first will be used as a BASE,
2271
and the second one as OTHER. Revision numbers are always relative to the
2274
By default, bzr will try to merge in all new work from the other
2275
branch, automatically determining an appropriate base. If this
2276
fails, you may need to give an explicit base.
2278
Merge will do its best to combine the changes in two branches, but there
2279
are some kinds of problems only a human can fix. When it encounters those,
2280
it will mark a conflict. A conflict means that you need to fix something,
2281
before you should commit.
2283
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2285
If there is no default branch set, the first merge will set it. After
2286
that, you can omit the branch to use the default. To change the
2287
default, use --remember. The value will only be saved if the remote
2288
location can be accessed.
2292
To merge the latest revision from bzr.dev
2293
bzr merge ../bzr.dev
2295
To merge changes up to and including revision 82 from bzr.dev
2296
bzr merge -r 82 ../bzr.dev
2298
To merge the changes introduced by 82, without previous changes:
2299
bzr merge -r 81..82 ../bzr.dev
2301
merge refuses to run if there are any uncommitted changes, unless
2304
The following merge types are available:
2306
takes_args = ['branch?']
2307
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2308
Option('show-base', help="Show base revision text in "
2310
Option('uncommitted', help='Apply uncommitted changes'
2311
' from a working copy, instead of branch changes'),
2312
Option('pull', help='If the destination is already'
2313
' completely merged into the source, pull from the'
2314
' source rather than merging. When this happens,'
2315
' you do not need to commit the result.'),
2319
from inspect import getdoc
2320
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2322
def run(self, branch=None, revision=None, force=False, merge_type=None,
2323
show_base=False, reprocess=False, remember=False,
2324
uncommitted=False, pull=False):
2325
if merge_type is None:
2326
merge_type = _mod_merge.Merge3Merger
2328
tree = WorkingTree.open_containing(u'.')[0]
2330
if branch is not None:
2332
reader = bundle.read_bundle_from_url(branch)
2333
except errors.NotABundle:
2334
pass # Continue on considering this url a Branch
2336
conflicts = merge_bundle(reader, tree, not force, merge_type,
2337
reprocess, show_base)
2343
if revision is None \
2344
or len(revision) < 1 or revision[0].needs_branch():
2345
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2347
if revision is None or len(revision) < 1:
2350
other = [branch, None]
2353
other = [branch, -1]
2354
other_branch, path = Branch.open_containing(branch)
2357
raise errors.BzrCommandError('Cannot use --uncommitted and'
2358
' --revision at the same time.')
2359
branch = revision[0].get_branch() or branch
2360
if len(revision) == 1:
2362
other_branch, path = Branch.open_containing(branch)
2363
revno = revision[0].in_history(other_branch).revno
2364
other = [branch, revno]
2366
assert len(revision) == 2
2367
if None in revision:
2368
raise errors.BzrCommandError(
2369
"Merge doesn't permit empty revision specifier.")
2370
base_branch, path = Branch.open_containing(branch)
2371
branch1 = revision[1].get_branch() or branch
2372
other_branch, path1 = Branch.open_containing(branch1)
2373
if revision[0].get_branch() is not None:
2374
# then path was obtained from it, and is None.
2377
base = [branch, revision[0].in_history(base_branch).revno]
2378
other = [branch1, revision[1].in_history(other_branch).revno]
2380
if tree.branch.get_parent() is None or remember:
2381
tree.branch.set_parent(other_branch.base)
2384
interesting_files = [path]
2386
interesting_files = None
2387
pb = ui.ui_factory.nested_progress_bar()
2390
conflict_count = _merge_helper(
2391
other, base, check_clean=(not force),
2392
merge_type=merge_type,
2393
reprocess=reprocess,
2394
show_base=show_base,
2396
pb=pb, file_list=interesting_files)
2399
if conflict_count != 0:
2403
except errors.AmbiguousBase, e:
2404
m = ("sorry, bzr can't determine the right merge base yet\n"
2405
"candidates are:\n "
2406
+ "\n ".join(e.bases)
2408
"please specify an explicit base with -r,\n"
2409
"and (if you want) report this to the bzr developers\n")
2412
# TODO: move up to common parent; this isn't merge-specific anymore.
2413
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2414
"""Use tree.branch's parent if none was supplied.
2416
Report if the remembered location was used.
2418
if supplied_location is not None:
2419
return supplied_location
2420
stored_location = tree.branch.get_parent()
2421
mutter("%s", stored_location)
2422
if stored_location is None:
2423
raise errors.BzrCommandError("No location specified or remembered")
2424
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2425
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2426
return stored_location
2429
class cmd_remerge(Command):
2432
Use this if you want to try a different merge technique while resolving
2433
conflicts. Some merge techniques are better than others, and remerge
2434
lets you try different ones on different files.
2436
The options for remerge have the same meaning and defaults as the ones for
2437
merge. The difference is that remerge can (only) be run when there is a
2438
pending merge, and it lets you specify particular files.
2441
$ bzr remerge --show-base
2442
Re-do the merge of all conflicted files, and show the base text in
2443
conflict regions, in addition to the usual THIS and OTHER texts.
2445
$ bzr remerge --merge-type weave --reprocess foobar
2446
Re-do the merge of "foobar", using the weave merge algorithm, with
2447
additional processing to reduce the size of conflict regions.
2449
The following merge types are available:"""
2450
takes_args = ['file*']
2451
takes_options = ['merge-type', 'reprocess',
2452
Option('show-base', help="Show base revision text in "
2456
from inspect import getdoc
2457
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2459
def run(self, file_list=None, merge_type=None, show_base=False,
2461
if merge_type is None:
2462
merge_type = _mod_merge.Merge3Merger
2463
tree, file_list = tree_files(file_list)
2466
parents = tree.get_parent_ids()
2467
if len(parents) != 2:
2468
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2469
" merges. Not cherrypicking or"
2471
repository = tree.branch.repository
2472
base_revision = common_ancestor(parents[0],
2473
parents[1], repository)
2474
base_tree = repository.revision_tree(base_revision)
2475
other_tree = repository.revision_tree(parents[1])
2476
interesting_ids = None
2478
conflicts = tree.conflicts()
2479
if file_list is not None:
2480
interesting_ids = set()
2481
for filename in file_list:
2482
file_id = tree.path2id(filename)
2484
raise errors.NotVersionedError(filename)
2485
interesting_ids.add(file_id)
2486
if tree.kind(file_id) != "directory":
2489
for name, ie in tree.inventory.iter_entries(file_id):
2490
interesting_ids.add(ie.file_id)
2491
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2493
# Remerge only supports resolving contents conflicts
2494
allowed_conflicts = ('text conflict', 'contents conflict')
2495
restore_files = [c.path for c in conflicts
2496
if c.typestring in allowed_conflicts]
2497
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2498
tree.set_conflicts(ConflictList(new_conflicts))
2499
if file_list is not None:
2500
restore_files = file_list
2501
for filename in restore_files:
2503
restore(tree.abspath(filename))
2504
except errors.NotConflicted:
2506
conflicts = _mod_merge.merge_inner(
2507
tree.branch, other_tree, base_tree,
2509
interesting_ids=interesting_ids,
2510
other_rev_id=parents[1],
2511
merge_type=merge_type,
2512
show_base=show_base,
2513
reprocess=reprocess)
2522
class cmd_revert(Command):
2523
"""Revert files to a previous revision.
2525
Giving a list of files will revert only those files. Otherwise, all files
2526
will be reverted. If the revision is not specified with '--revision', the
2527
last committed revision is used.
2529
To remove only some changes, without reverting to a prior version, use
2530
merge instead. For example, "merge . --r-2..-3" will remove the changes
2531
introduced by -2, without affecting the changes introduced by -1. Or
2532
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2534
By default, any files that have been manually changed will be backed up
2535
first. (Files changed only by merge are not backed up.) Backup files have
2536
'.~#~' appended to their name, where # is a number.
2538
When you provide files, you can use their current pathname or the pathname
2539
from the target revision. So you can use revert to "undelete" a file by
2540
name. If you name a directory, all the contents of that directory will be
2543
takes_options = ['revision', 'no-backup']
2544
takes_args = ['file*']
2545
aliases = ['merge-revert']
2547
def run(self, revision=None, no_backup=False, file_list=None):
2548
if file_list is not None:
2549
if len(file_list) == 0:
2550
raise errors.BzrCommandError("No files specified")
2554
tree, file_list = tree_files(file_list)
2555
if revision is None:
2556
# FIXME should be tree.last_revision
2557
rev_id = tree.last_revision()
2558
elif len(revision) != 1:
2559
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2561
rev_id = revision[0].in_history(tree.branch).rev_id
2562
pb = ui.ui_factory.nested_progress_bar()
2564
tree.revert(file_list,
2565
tree.branch.repository.revision_tree(rev_id),
2566
not no_backup, pb, report_changes=True)
2571
class cmd_assert_fail(Command):
2572
"""Test reporting of assertion failures"""
2573
# intended just for use in testing
2578
raise AssertionError("always fails")
2581
class cmd_help(Command):
2582
"""Show help on a command or other topic.
2584
For a list of all available commands, say 'bzr help commands'.
2586
takes_options = [Option('long', 'show help on all commands')]
2587
takes_args = ['topic?']
2588
aliases = ['?', '--help', '-?', '-h']
2591
def run(self, topic=None, long=False):
2593
if topic is None and long:
2595
bzrlib.help.help(topic)
2598
class cmd_shell_complete(Command):
2599
"""Show appropriate completions for context.
2601
For a list of all available commands, say 'bzr shell-complete'.
2603
takes_args = ['context?']
2608
def run(self, context=None):
2609
import shellcomplete
2610
shellcomplete.shellcomplete(context)
2613
class cmd_fetch(Command):
2614
"""Copy in history from another branch but don't merge it.
2616
This is an internal method used for pull and merge.
2619
takes_args = ['from_branch', 'to_branch']
2620
def run(self, from_branch, to_branch):
2621
from bzrlib.fetch import Fetcher
2622
from_b = Branch.open(from_branch)
2623
to_b = Branch.open(to_branch)
2624
Fetcher(to_b, from_b)
2627
class cmd_missing(Command):
2628
"""Show unmerged/unpulled revisions between two branches.
2630
OTHER_BRANCH may be local or remote.
2632
takes_args = ['other_branch?']
2633
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2635
'Display changes in the local branch only'),
2636
Option('theirs-only',
2637
'Display changes in the remote branch only'),
2645
encoding_type = 'replace'
2648
def run(self, other_branch=None, reverse=False, mine_only=False,
2649
theirs_only=False, log_format=None, long=False, short=False, line=False,
2650
show_ids=False, verbose=False):
2651
from bzrlib.missing import find_unmerged, iter_log_data
2652
from bzrlib.log import log_formatter
2653
local_branch = Branch.open_containing(u".")[0]
2654
parent = local_branch.get_parent()
2655
if other_branch is None:
2656
other_branch = parent
2657
if other_branch is None:
2658
raise errors.BzrCommandError("No peer location known or specified.")
2659
display_url = urlutils.unescape_for_display(parent,
2661
print "Using last location: " + display_url
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
# command-line interpretation helper for merge-related commands
3053
def _merge_helper(other_revision, base_revision,
3054
check_clean=True, ignore_zero=False,
3055
this_dir=None, backup_files=False,
3057
file_list=None, show_base=False, reprocess=False,
3059
pb=DummyProgress()):
3060
"""Merge changes into a tree.
3063
list(path, revno) Base for three-way merge.
3064
If [None, None] then a base will be automatically determined.
3066
list(path, revno) Other revision for three-way merge.
3068
Directory to merge changes into; '.' by default.
3070
If true, this_dir must have no uncommitted changes before the
3072
ignore_zero - If true, suppress the "zero conflicts" message when
3073
there are no conflicts; should be set when doing something we expect
3074
to complete perfectly.
3075
file_list - If supplied, merge only changes to selected files.
3077
All available ancestors of other_revision and base_revision are
3078
automatically pulled into the branch.
3080
The revno may be -1 to indicate the last revision on the branch, which is
3083
This function is intended for use from the command line; programmatic
3084
clients might prefer to call merge.merge_inner(), which has less magic
3087
# Loading it late, so that we don't always have to import bzrlib.merge
3088
if merge_type is None:
3089
merge_type = _mod_merge.Merge3Merger
3090
if this_dir is None:
3092
this_tree = WorkingTree.open_containing(this_dir)[0]
3093
if show_base and not merge_type is _mod_merge.Merge3Merger:
3094
raise errors.BzrCommandError("Show-base is not supported for this merge"
3095
" type. %s" % merge_type)
3096
if reprocess and not merge_type.supports_reprocess:
3097
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3098
" type %s." % merge_type)
3099
if reprocess and show_base:
3100
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3102
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3104
merger.pp = ProgressPhase("Merge phase", 5, pb)
3105
merger.pp.next_phase()
3106
merger.check_basis(check_clean)
3107
merger.set_other(other_revision)
3108
merger.pp.next_phase()
3109
merger.set_base(base_revision)
3110
if merger.base_rev_id == merger.other_rev_id:
3111
note('Nothing to do.')
3113
if file_list is None:
3114
if pull and merger.base_rev_id == merger.this_rev_id:
3115
count = merger.this_tree.pull(merger.this_branch,
3116
False, merger.other_rev_id)
3117
note('%d revision(s) pulled.' % (count,))
3119
merger.backup_files = backup_files
3120
merger.merge_type = merge_type
3121
merger.set_interesting_files(file_list)
3122
merger.show_base = show_base
3123
merger.reprocess = reprocess
3124
conflicts = merger.do_merge()
3125
if file_list is None:
3126
merger.set_pending()
3133
merge = _merge_helper
3136
# these get imported and then picked up by the scan for cmd_*
3137
# TODO: Some more consistent way to split command definitions across files;
3138
# we do need to load at least some information about them to know of
3139
# aliases. ideally we would avoid loading the implementation until the
3140
# details were needed.
3141
from bzrlib.cmd_version_info import cmd_version_info
3142
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3143
from bzrlib.bundle.commands import cmd_bundle_revisions
3144
from bzrlib.sign_my_commits import cmd_sign_my_commits
3145
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3146
cmd_weave_plan_merge, cmd_weave_merge_text