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,
545
revision=None, verbose=False):
546
# FIXME: too much stuff is in the command class
548
tree_to = WorkingTree.open_containing(u'.')[0]
549
branch_to = tree_to.branch
550
except errors.NoWorkingTree:
552
branch_to = Branch.open_containing(u'.')[0]
555
if location is not None:
557
reader = bundle.read_bundle_from_url(location)
558
except errors.NotABundle:
559
pass # Continue on considering this url a Branch
561
stored_loc = branch_to.get_parent()
563
if stored_loc is None:
564
raise errors.BzrCommandError("No pull location known or"
567
display_url = urlutils.unescape_for_display(stored_loc,
569
self.outf.write("Using saved location: %s\n" % display_url)
570
location = stored_loc
573
if reader is not None:
574
install_bundle(branch_to.repository, reader)
575
branch_from = branch_to
577
branch_from = Branch.open(location)
579
if branch_to.get_parent() is None or remember:
580
branch_to.set_parent(branch_from.base)
584
if reader is not None:
585
rev_id = reader.target
586
elif len(revision) == 1:
587
rev_id = revision[0].in_history(branch_from).rev_id
589
raise errors.BzrCommandError('bzr pull --revision takes one value.')
591
old_rh = branch_to.revision_history()
592
if tree_to is not None:
593
count = tree_to.pull(branch_from, overwrite, rev_id,
594
delta.ChangeReporter(tree_to.inventory))
596
count = branch_to.pull(branch_from, overwrite, rev_id)
597
note('%d revision(s) pulled.' % (count,))
600
new_rh = branch_to.revision_history()
603
from bzrlib.log import show_changed_revisions
604
show_changed_revisions(branch_to, old_rh, new_rh,
608
class cmd_push(Command):
609
"""Update a mirror of this branch.
611
The target branch will not have its working tree populated because this
612
is both expensive, and is not supported on remote file systems.
614
Some smart servers or protocols *may* put the working tree in place in
617
This command only works on branches that have not diverged. Branches are
618
considered diverged if the destination branch's most recent commit is one
619
that has not been merged (directly or indirectly) by the source branch.
621
If branches have diverged, you can use 'bzr push --overwrite' to replace
622
the other branch completely, discarding its unmerged changes.
624
If you want to ensure you have the different changes in the other branch,
625
do a merge (see bzr help merge) from the other branch, and commit that.
626
After that you will be able to do a push without '--overwrite'.
628
If there is no default push location set, the first push will set it.
629
After that, you can omit the location to use the default. To change the
630
default, use --remember. The value will only be saved if the remote
631
location can be accessed.
634
takes_options = ['remember', 'overwrite', 'verbose',
635
Option('create-prefix',
636
help='Create the path leading up to the branch '
637
'if it does not already exist')]
638
takes_args = ['location?']
639
encoding_type = 'replace'
641
def run(self, location=None, remember=False, overwrite=False,
642
create_prefix=False, verbose=False):
643
# FIXME: Way too big! Put this into a function called from the
646
br_from = Branch.open_containing('.')[0]
647
stored_loc = br_from.get_push_location()
649
if stored_loc is None:
650
raise errors.BzrCommandError("No push location known or specified.")
652
display_url = urlutils.unescape_for_display(stored_loc,
654
self.outf.write("Using saved location: %s\n" % display_url)
655
location = stored_loc
657
to_transport = transport.get_transport(location)
658
location_url = to_transport.base
662
dir_to = bzrdir.BzrDir.open(location_url)
663
br_to = dir_to.open_branch()
664
except errors.NotBranchError:
666
to_transport = to_transport.clone('..')
667
if not create_prefix:
669
relurl = to_transport.relpath(location_url)
670
mutter('creating directory %s => %s', location_url, relurl)
671
to_transport.mkdir(relurl)
672
except errors.NoSuchFile:
673
raise errors.BzrCommandError("Parent directory of %s "
674
"does not exist." % location)
676
current = to_transport.base
677
needed = [(to_transport, to_transport.relpath(location_url))]
680
to_transport, relpath = needed[-1]
681
to_transport.mkdir(relpath)
683
except errors.NoSuchFile:
684
new_transport = to_transport.clone('..')
685
needed.append((new_transport,
686
new_transport.relpath(to_transport.base)))
687
if new_transport.base == to_transport.base:
688
raise errors.BzrCommandError("Could not create "
690
dir_to = br_from.bzrdir.clone(location_url,
691
revision_id=br_from.last_revision())
692
br_to = dir_to.open_branch()
693
count = br_to.last_revision_info()[0]
694
# We successfully created the target, remember it
695
if br_from.get_push_location() is None or remember:
696
br_from.set_push_location(br_to.base)
698
# We were able to connect to the remote location, so remember it
699
# we don't need to successfully push because of possible divergence.
700
if br_from.get_push_location() is None or remember:
701
br_from.set_push_location(br_to.base)
702
old_rh = br_to.revision_history()
705
tree_to = dir_to.open_workingtree()
706
except errors.NotLocalUrl:
707
warning('This transport does not update the working '
708
'tree of: %s' % (br_to.base,))
709
count = br_from.push(br_to, overwrite)
710
except errors.NoWorkingTree:
711
count = br_from.push(br_to, overwrite)
715
count = br_from.push(tree_to.branch, overwrite)
719
except errors.DivergedBranches:
720
raise errors.BzrCommandError('These branches have diverged.'
721
' Try using "merge" and then "push".')
722
note('%d revision(s) pushed.' % (count,))
725
new_rh = br_to.revision_history()
728
from bzrlib.log import show_changed_revisions
729
show_changed_revisions(br_to, old_rh, new_rh,
733
class cmd_branch(Command):
734
"""Create a new copy of a branch.
736
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
737
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
739
To retrieve the branch as of a particular revision, supply the --revision
740
parameter, as in "branch foo/bar -r 5".
742
--basis is to speed up branching from remote branches. When specified, it
743
copies all the file-contents, inventory and revision data from the basis
744
branch before copying anything from the remote branch.
746
takes_args = ['from_location', 'to_location?']
747
takes_options = ['revision', 'basis']
748
aliases = ['get', 'clone']
750
def run(self, from_location, to_location=None, revision=None, basis=None):
753
elif len(revision) > 1:
754
raise errors.BzrCommandError(
755
'bzr branch --revision takes exactly 1 revision value')
757
br_from = Branch.open(from_location)
759
if e.errno == errno.ENOENT:
760
raise errors.BzrCommandError('Source location "%s" does not'
761
' exist.' % to_location)
766
if basis is not None:
767
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
770
if len(revision) == 1 and revision[0] is not None:
771
revision_id = revision[0].in_history(br_from)[1]
773
# FIXME - wt.last_revision, fallback to branch, fall back to
774
# None or perhaps NULL_REVISION to mean copy nothing
776
revision_id = br_from.last_revision()
777
if to_location is None:
778
to_location = os.path.basename(from_location.rstrip("/\\"))
781
name = os.path.basename(to_location) + '\n'
783
to_transport = transport.get_transport(to_location)
785
to_transport.mkdir('.')
786
except errors.FileExists:
787
raise errors.BzrCommandError('Target directory "%s" already'
788
' exists.' % to_location)
789
except errors.NoSuchFile:
790
raise errors.BzrCommandError('Parent of "%s" does not exist.'
793
# preserve whatever source format we have.
794
dir = br_from.bzrdir.sprout(to_transport.base,
795
revision_id, basis_dir)
796
branch = dir.open_branch()
797
except errors.NoSuchRevision:
798
to_transport.delete_tree('.')
799
msg = "The branch %s has no revision %s." % (from_location, revision[0])
800
raise errors.BzrCommandError(msg)
801
except errors.UnlistableBranch:
802
osutils.rmtree(to_location)
803
msg = "The branch %s cannot be used as a --basis" % (basis,)
804
raise errors.BzrCommandError(msg)
806
branch.control_files.put_utf8('branch-name', name)
807
note('Branched %d revision(s).' % branch.revno())
812
class cmd_checkout(Command):
813
"""Create a new checkout of an existing branch.
815
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
816
the branch found in '.'. This is useful if you have removed the working tree
817
or if it was never created - i.e. if you pushed the branch to its current
820
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
821
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
823
To retrieve the branch as of a particular revision, supply the --revision
824
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
825
out of date [so you cannot commit] but it may be useful (i.e. to examine old
828
--basis is to speed up checking out from remote branches. When specified, it
829
uses the inventory and file contents from the basis branch in preference to the
830
branch being checked out.
832
takes_args = ['branch_location?', 'to_location?']
833
takes_options = ['revision', # , 'basis']
834
Option('lightweight',
835
help="perform a lightweight checkout. Lightweight "
836
"checkouts depend on access to the branch for "
837
"every operation. Normal checkouts can perform "
838
"common operations like diff and status without "
839
"such access, and also support local commits."
844
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
848
elif len(revision) > 1:
849
raise errors.BzrCommandError(
850
'bzr checkout --revision takes exactly 1 revision value')
851
if branch_location is None:
852
branch_location = osutils.getcwd()
853
to_location = branch_location
854
source = Branch.open(branch_location)
855
if len(revision) == 1 and revision[0] is not None:
856
revision_id = revision[0].in_history(source)[1]
859
if to_location is None:
860
to_location = os.path.basename(branch_location.rstrip("/\\"))
861
# if the source and to_location are the same,
862
# and there is no working tree,
863
# then reconstitute a branch
864
if (osutils.abspath(to_location) ==
865
osutils.abspath(branch_location)):
867
source.bzrdir.open_workingtree()
868
except errors.NoWorkingTree:
869
source.bzrdir.create_workingtree()
872
os.mkdir(to_location)
874
if e.errno == errno.EEXIST:
875
raise errors.BzrCommandError('Target directory "%s" already'
876
' exists.' % to_location)
877
if e.errno == errno.ENOENT:
878
raise errors.BzrCommandError('Parent of "%s" does not exist.'
882
source.create_checkout(to_location, revision_id, lightweight)
885
class cmd_renames(Command):
886
"""Show list of renamed files.
888
# TODO: Option to show renames between two historical versions.
890
# TODO: Only show renames under dir, rather than in the whole branch.
891
takes_args = ['dir?']
894
def run(self, dir=u'.'):
895
tree = WorkingTree.open_containing(dir)[0]
896
old_inv = tree.basis_tree().inventory
897
new_inv = tree.read_working_inventory()
898
renames = list(_mod_tree.find_renames(old_inv, new_inv))
900
for old_name, new_name in renames:
901
self.outf.write("%s => %s\n" % (old_name, new_name))
904
class cmd_update(Command):
905
"""Update a tree to have the latest code committed to its branch.
907
This will perform a merge into the working tree, and may generate
908
conflicts. If you have any local changes, you will still
909
need to commit them after the update for the update to be complete.
911
If you want to discard your local changes, you can just do a
912
'bzr revert' instead of 'bzr commit' after the update.
914
takes_args = ['dir?']
917
def run(self, dir='.'):
918
tree = WorkingTree.open_containing(dir)[0]
919
master = tree.branch.get_master_branch()
920
if master is not None:
923
tree.lock_tree_write()
925
existing_pending_merges = tree.get_parent_ids()[1:]
926
last_rev = tree.last_revision()
927
if last_rev == tree.branch.last_revision():
928
# may be up to date, check master too.
929
master = tree.branch.get_master_branch()
930
if master is None or last_rev == master.last_revision():
931
revno = tree.branch.revision_id_to_revno(last_rev)
932
note("Tree is up to date at revision %d." % (revno,))
934
conflicts = tree.update()
935
revno = tree.branch.revision_id_to_revno(tree.last_revision())
936
note('Updated to revision %d.' % (revno,))
937
if tree.get_parent_ids()[1:] != existing_pending_merges:
938
note('Your local commits will now show as pending merges with '
939
"'bzr status', and can be committed with 'bzr commit'.")
948
class cmd_info(Command):
949
"""Show information about a working tree, branch or repository.
951
This command will show all known locations and formats associated to the
952
tree, branch or repository. Statistical information is included with
955
Branches and working trees will also report any missing revisions.
957
takes_args = ['location?']
958
takes_options = ['verbose']
961
def run(self, location=None, verbose=False):
962
from bzrlib.info import show_bzrdir_info
963
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
967
class cmd_remove(Command):
968
"""Make a file unversioned.
970
This makes bzr stop tracking changes to a versioned file. It does
971
not delete the working copy.
973
You can specify one or more files, and/or --new. If you specify --new,
974
only 'added' files will be removed. If you specify both, then new files
975
in the specified directories will be removed. If the directories are
976
also new, they will also be removed.
978
takes_args = ['file*']
979
takes_options = ['verbose', Option('new', help='remove newly-added files')]
981
encoding_type = 'replace'
983
def run(self, file_list, verbose=False, new=False):
984
tree, file_list = tree_files(file_list)
986
if file_list is None:
987
raise errors.BzrCommandError('Specify one or more files to'
988
' remove, or use --new.')
990
added = tree.changes_from(tree.basis_tree(),
991
specific_files=file_list).added
992
file_list = sorted([f[0] for f in added], reverse=True)
993
if len(file_list) == 0:
994
raise errors.BzrCommandError('No matching files.')
995
tree.remove(file_list, verbose=verbose, to_file=self.outf)
998
class cmd_file_id(Command):
999
"""Print file_id of a particular file or directory.
1001
The file_id is assigned when the file is first added and remains the
1002
same through all revisions where the file exists, even when it is
1007
takes_args = ['filename']
1010
def run(self, filename):
1011
tree, relpath = WorkingTree.open_containing(filename)
1012
i = tree.inventory.path2id(relpath)
1014
raise errors.NotVersionedError(filename)
1016
self.outf.write(i + '\n')
1019
class cmd_file_path(Command):
1020
"""Print path of file_ids to a file or directory.
1022
This prints one line for each directory down to the target,
1023
starting at the branch root.
1027
takes_args = ['filename']
1030
def run(self, filename):
1031
tree, relpath = WorkingTree.open_containing(filename)
1032
inv = tree.inventory
1033
fid = inv.path2id(relpath)
1035
raise errors.NotVersionedError(filename)
1036
for fip in inv.get_idpath(fid):
1037
self.outf.write(fip + '\n')
1040
class cmd_reconcile(Command):
1041
"""Reconcile bzr metadata in a branch.
1043
This can correct data mismatches that may have been caused by
1044
previous ghost operations or bzr upgrades. You should only
1045
need to run this command if 'bzr check' or a bzr developer
1046
advises you to run it.
1048
If a second branch is provided, cross-branch reconciliation is
1049
also attempted, which will check that data like the tree root
1050
id which was not present in very early bzr versions is represented
1051
correctly in both branches.
1053
At the same time it is run it may recompress data resulting in
1054
a potential saving in disk space or performance gain.
1056
The branch *MUST* be on a listable system such as local disk or sftp.
1058
takes_args = ['branch?']
1060
def run(self, branch="."):
1061
from bzrlib.reconcile import reconcile
1062
dir = bzrdir.BzrDir.open(branch)
1066
class cmd_revision_history(Command):
1067
"""Display the list of revision ids on a branch."""
1068
takes_args = ['location?']
1073
def run(self, location="."):
1074
branch = Branch.open_containing(location)[0]
1075
for revid in branch.revision_history():
1076
self.outf.write(revid)
1077
self.outf.write('\n')
1080
class cmd_ancestry(Command):
1081
"""List all revisions merged into this branch."""
1082
takes_args = ['location?']
1087
def run(self, location="."):
1089
wt = WorkingTree.open_containing(location)[0]
1090
except errors.NoWorkingTree:
1091
b = Branch.open(location)
1092
last_revision = b.last_revision()
1095
last_revision = wt.last_revision()
1097
revision_ids = b.repository.get_ancestry(last_revision)
1098
assert revision_ids[0] is None
1100
for revision_id in revision_ids:
1101
self.outf.write(revision_id + '\n')
1104
class cmd_init(Command):
1105
"""Make a directory into a versioned branch.
1107
Use this to create an empty branch, or before importing an
1110
If there is a repository in a parent directory of the location, then
1111
the history of the branch will be stored in the repository. Otherwise
1112
init creates a standalone branch which carries its own history in
1115
If there is already a branch at the location but it has no working tree,
1116
the tree can be populated with 'bzr checkout'.
1118
Recipe for importing a tree of files:
1123
bzr commit -m 'imported project'
1125
takes_args = ['location?']
1127
RegistryOption('format',
1128
help='Specify a format for this branch. See "bzr '
1129
'help formats" for details',
1130
converter=bzrdir.format_registry.make_bzrdir,
1131
registry=bzrdir.format_registry,
1132
value_switches=True, title="Branch Format"),
1134
def run(self, location=None, format=None):
1136
format = bzrdir.format_registry.make_bzrdir('default')
1137
if location is None:
1140
to_transport = transport.get_transport(location)
1142
# The path has to exist to initialize a
1143
# branch inside of it.
1144
# Just using os.mkdir, since I don't
1145
# believe that we want to create a bunch of
1146
# locations if the user supplies an extended path
1147
# TODO: create-prefix
1149
to_transport.mkdir('.')
1150
except errors.FileExists:
1154
existing_bzrdir = bzrdir.BzrDir.open(location)
1155
except errors.NotBranchError:
1156
# really a NotBzrDir error...
1157
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1159
from bzrlib.transport.local import LocalTransport
1160
if existing_bzrdir.has_branch():
1161
if (isinstance(to_transport, LocalTransport)
1162
and not existing_bzrdir.has_workingtree()):
1163
raise errors.BranchExistsWithoutWorkingTree(location)
1164
raise errors.AlreadyBranchError(location)
1166
existing_bzrdir.create_branch()
1167
existing_bzrdir.create_workingtree()
1170
class cmd_init_repository(Command):
1171
"""Create a shared repository to hold branches.
1173
New branches created under the repository directory will store their revisions
1174
in the repository, not in the branch directory, if the branch format supports
1180
bzr checkout --lightweight repo/trunk trunk-checkout
1184
takes_args = ["location"]
1185
takes_options = [RegistryOption('format',
1186
help='Specify a format for this repository. See'
1187
' "bzr help formats" for details',
1188
registry=bzrdir.format_registry,
1189
converter=bzrdir.format_registry.make_bzrdir,
1190
value_switches=True, title='Repository format'),
1192
help='Allows branches in repository to have'
1194
aliases = ["init-repo"]
1195
def run(self, location, format=None, trees=False):
1197
format = bzrdir.format_registry.make_bzrdir('default')
1199
if location is None:
1202
to_transport = transport.get_transport(location)
1204
to_transport.mkdir('.')
1205
except errors.FileExists:
1208
newdir = format.initialize_on_transport(to_transport)
1209
repo = newdir.create_repository(shared=True)
1210
repo.set_make_working_trees(trees)
1213
class cmd_diff(Command):
1214
"""Show differences in the working tree or between revisions.
1216
If files are listed, only the changes in those files are listed.
1217
Otherwise, all changes for the tree are listed.
1219
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1220
produces patches suitable for "patch -p1".
1224
Shows the difference in the working tree versus the last commit
1226
Difference between the working tree and revision 1
1228
Difference between revision 2 and revision 1
1229
bzr diff --diff-prefix old/:new/
1230
Same as 'bzr diff' but prefix paths with old/ and new/
1231
bzr diff bzr.mine bzr.dev
1232
Show the differences between the two working trees
1234
Show just the differences for 'foo.c'
1236
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1237
# or a graphical diff.
1239
# TODO: Python difflib is not exactly the same as unidiff; should
1240
# either fix it up or prefer to use an external diff.
1242
# TODO: Selected-file diff is inefficient and doesn't show you
1245
# TODO: This probably handles non-Unix newlines poorly.
1247
takes_args = ['file*']
1248
takes_options = ['revision', 'diff-options',
1249
Option('prefix', type=str,
1251
help='Set prefixes to added to old and new filenames, as '
1252
'two values separated by a colon.'),
1254
aliases = ['di', 'dif']
1255
encoding_type = 'exact'
1258
def run(self, revision=None, file_list=None, diff_options=None,
1260
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1262
if (prefix is None) or (prefix == '0'):
1270
old_label, new_label = prefix.split(":")
1272
raise BzrCommandError(
1273
"--prefix expects two values separated by a colon")
1275
if revision and len(revision) > 2:
1276
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1277
' one or two revision specifiers')
1280
tree1, file_list = internal_tree_files(file_list)
1284
except errors.FileInWrongBranch:
1285
if len(file_list) != 2:
1286
raise errors.BzrCommandError("Files are in different branches")
1288
tree1, file1 = WorkingTree.open_containing(file_list[0])
1289
tree2, file2 = WorkingTree.open_containing(file_list[1])
1290
if file1 != "" or file2 != "":
1291
# FIXME diff those two files. rbc 20051123
1292
raise errors.BzrCommandError("Files are in different branches")
1294
except errors.NotBranchError:
1295
if (revision is not None and len(revision) == 2
1296
and not revision[0].needs_branch()
1297
and not revision[1].needs_branch()):
1298
# If both revision specs include a branch, we can
1299
# diff them without needing a local working tree
1300
tree1, tree2 = None, None
1304
if tree2 is not None:
1305
if revision is not None:
1306
# FIXME: but there should be a clean way to diff between
1307
# non-default versions of two trees, it's not hard to do
1309
raise errors.BzrCommandError(
1310
"Sorry, diffing arbitrary revisions across branches "
1311
"is not implemented yet")
1312
return show_diff_trees(tree1, tree2, sys.stdout,
1313
specific_files=file_list,
1314
external_diff_options=diff_options,
1315
old_label=old_label, new_label=new_label)
1317
return diff_cmd_helper(tree1, file_list, diff_options,
1318
revision_specs=revision,
1319
old_label=old_label, new_label=new_label)
1322
class cmd_deleted(Command):
1323
"""List files deleted in the working tree.
1325
# TODO: Show files deleted since a previous revision, or
1326
# between two revisions.
1327
# TODO: Much more efficient way to do this: read in new
1328
# directories with readdir, rather than stating each one. Same
1329
# level of effort but possibly much less IO. (Or possibly not,
1330
# if the directories are very large...)
1331
takes_options = ['show-ids']
1334
def run(self, show_ids=False):
1335
tree = WorkingTree.open_containing(u'.')[0]
1336
old = tree.basis_tree()
1337
for path, ie in old.inventory.iter_entries():
1338
if not tree.has_id(ie.file_id):
1339
self.outf.write(path)
1341
self.outf.write(' ')
1342
self.outf.write(ie.file_id)
1343
self.outf.write('\n')
1346
class cmd_modified(Command):
1347
"""List files modified in working tree.
1349
See also: "bzr status".
1356
tree = WorkingTree.open_containing(u'.')[0]
1357
td = tree.changes_from(tree.basis_tree())
1358
for path, id, kind, text_modified, meta_modified in td.modified:
1359
self.outf.write(path + '\n')
1362
class cmd_added(Command):
1363
"""List files added in working tree.
1365
See also: "bzr status".
1372
wt = WorkingTree.open_containing(u'.')[0]
1373
basis_inv = wt.basis_tree().inventory
1376
if file_id in basis_inv:
1378
if inv.is_root(file_id) and len(basis_inv) == 0:
1380
path = inv.id2path(file_id)
1381
if not os.access(osutils.abspath(path), os.F_OK):
1383
self.outf.write(path + '\n')
1386
class cmd_root(Command):
1387
"""Show the tree root directory.
1389
The root is the nearest enclosing directory with a .bzr control
1391
takes_args = ['filename?']
1393
def run(self, filename=None):
1394
"""Print the branch root."""
1395
tree = WorkingTree.open_containing(filename)[0]
1396
self.outf.write(tree.basedir + '\n')
1399
class cmd_log(Command):
1400
"""Show log of a branch, file, or directory.
1402
By default show the log of the branch containing the working directory.
1404
To request a range of logs, you can use the command -r begin..end
1405
-r revision requests a specific revision, -r ..end or -r begin.. are
1411
bzr log -r -10.. http://server/branch
1414
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1416
takes_args = ['location?']
1417
takes_options = [Option('forward',
1418
help='show from oldest to newest'),
1422
help='show files changed in each revision'),
1423
'show-ids', 'revision',
1427
help='show revisions whose message matches this regexp',
1430
encoding_type = 'replace'
1433
def run(self, location=None, timezone='original',
1440
from bzrlib.log import show_log
1441
assert message is None or isinstance(message, basestring), \
1442
"invalid message argument %r" % message
1443
direction = (forward and 'forward') or 'reverse'
1448
# find the file id to log:
1450
dir, fp = bzrdir.BzrDir.open_containing(location)
1451
b = dir.open_branch()
1455
inv = dir.open_workingtree().inventory
1456
except (errors.NotBranchError, errors.NotLocalUrl):
1457
# either no tree, or is remote.
1458
inv = b.basis_tree().inventory
1459
file_id = inv.path2id(fp)
1461
raise errors.BzrCommandError(
1462
"Path does not have any revision history: %s" %
1466
# FIXME ? log the current subdir only RBC 20060203
1467
if revision is not None \
1468
and len(revision) > 0 and revision[0].get_branch():
1469
location = revision[0].get_branch()
1472
dir, relpath = bzrdir.BzrDir.open_containing(location)
1473
b = dir.open_branch()
1475
if revision is None:
1478
elif len(revision) == 1:
1479
rev1 = rev2 = revision[0].in_history(b).revno
1480
elif len(revision) == 2:
1481
if revision[1].get_branch() != revision[0].get_branch():
1482
# b is taken from revision[0].get_branch(), and
1483
# show_log will use its revision_history. Having
1484
# different branches will lead to weird behaviors.
1485
raise errors.BzrCommandError(
1486
"Log doesn't accept two revisions in different branches.")
1487
if revision[0].spec is None:
1488
# missing begin-range means first revision
1491
rev1 = revision[0].in_history(b).revno
1493
if revision[1].spec is None:
1494
# missing end-range means last known revision
1497
rev2 = revision[1].in_history(b).revno
1499
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1501
# By this point, the revision numbers are converted to the +ve
1502
# form if they were supplied in the -ve form, so we can do
1503
# this comparison in relative safety
1505
(rev2, rev1) = (rev1, rev2)
1507
if log_format is None:
1508
log_format = log.log_formatter_registry.get_default(b)
1510
lf = log_format(show_ids=show_ids, to_file=self.outf,
1511
show_timezone=timezone)
1517
direction=direction,
1518
start_revision=rev1,
1523
def get_log_format(long=False, short=False, line=False, default='long'):
1524
log_format = default
1528
log_format = 'short'
1534
class cmd_touching_revisions(Command):
1535
"""Return revision-ids which affected a particular file.
1537
A more user-friendly interface is "bzr log FILE".
1541
takes_args = ["filename"]
1544
def run(self, filename):
1545
tree, relpath = WorkingTree.open_containing(filename)
1547
inv = tree.read_working_inventory()
1548
file_id = inv.path2id(relpath)
1549
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1550
self.outf.write("%6d %s\n" % (revno, what))
1553
class cmd_ls(Command):
1554
"""List files in a tree.
1557
takes_args = ['path?']
1558
# TODO: Take a revision or remote path and list that tree instead.
1559
takes_options = ['verbose', 'revision',
1560
Option('non-recursive',
1561
help='don\'t recurse into sub-directories'),
1563
help='Print all paths from the root of the branch.'),
1564
Option('unknown', help='Print unknown files'),
1565
Option('versioned', help='Print versioned files'),
1566
Option('ignored', help='Print ignored files'),
1568
Option('null', help='Null separate the files'),
1572
def run(self, revision=None, verbose=False,
1573
non_recursive=False, from_root=False,
1574
unknown=False, versioned=False, ignored=False,
1575
null=False, kind=None, show_ids=False, path=None):
1577
if kind and kind not in ('file', 'directory', 'symlink'):
1578
raise errors.BzrCommandError('invalid kind specified')
1580
if verbose and null:
1581
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1582
all = not (unknown or versioned or ignored)
1584
selection = {'I':ignored, '?':unknown, 'V':versioned}
1591
raise errors.BzrCommandError('cannot specify both --from-root'
1595
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1601
if revision is not None:
1602
tree = branch.repository.revision_tree(
1603
revision[0].in_history(branch).rev_id)
1605
tree = branch.basis_tree()
1607
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1608
if fp.startswith(relpath):
1609
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1610
if non_recursive and '/' in fp:
1612
if not all and not selection[fc]:
1614
if kind is not None and fkind != kind:
1617
kindch = entry.kind_character()
1618
outstring = '%-8s %s%s' % (fc, fp, kindch)
1619
if show_ids and fid is not None:
1620
outstring = "%-50s %s" % (outstring, fid)
1621
self.outf.write(outstring + '\n')
1623
self.outf.write(fp + '\0')
1626
self.outf.write(fid)
1627
self.outf.write('\0')
1635
self.outf.write('%-50s %s\n' % (fp, my_id))
1637
self.outf.write(fp + '\n')
1640
class cmd_unknowns(Command):
1641
"""List unknown files.
1643
See also: "bzr ls --unknown".
1650
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1651
self.outf.write(osutils.quotefn(f) + '\n')
1654
class cmd_ignore(Command):
1655
"""Ignore specified files or patterns.
1657
To remove patterns from the ignore list, edit the .bzrignore file.
1659
Trailing slashes on patterns are ignored.
1660
If the pattern contains a slash or is a regular expression, it is compared
1661
to the whole path from the branch root. Otherwise, it is compared to only
1662
the last component of the path. To match a file only in the root
1663
directory, prepend './'.
1665
Ignore patterns specifying absolute paths are not allowed.
1667
Ignore patterns may include globbing wildcards such as:
1668
? - Matches any single character except '/'
1669
* - Matches 0 or more characters except '/'
1670
/**/ - Matches 0 or more directories in a path
1671
[a-z] - Matches a single character from within a group of characters
1673
Ignore patterns may also be Python regular expressions.
1674
Regular expression ignore patterns are identified by a 'RE:' prefix
1675
followed by the regular expression. Regular expression ignore patterns
1676
may not include named or numbered groups.
1678
Note: ignore patterns containing shell wildcards must be quoted from
1682
bzr ignore ./Makefile
1683
bzr ignore '*.class'
1684
bzr ignore 'lib/**/*.o'
1685
bzr ignore 'RE:lib/.*\.o'
1687
takes_args = ['name_pattern*']
1689
Option('old-default-rules',
1690
help='Out the ignore rules bzr < 0.9 always used.')
1693
def run(self, name_pattern_list=None, old_default_rules=None):
1694
from bzrlib.atomicfile import AtomicFile
1695
if old_default_rules is not None:
1696
# dump the rules and exit
1697
for pattern in ignores.OLD_DEFAULTS:
1700
if not name_pattern_list:
1701
raise errors.BzrCommandError("ignore requires at least one "
1702
"NAME_PATTERN or --old-default-rules")
1703
for name_pattern in name_pattern_list:
1704
if name_pattern[0] == '/':
1705
raise errors.BzrCommandError(
1706
"NAME_PATTERN should not be an absolute path")
1707
tree, relpath = WorkingTree.open_containing(u'.')
1708
ifn = tree.abspath('.bzrignore')
1709
if os.path.exists(ifn):
1712
igns = f.read().decode('utf-8')
1718
# TODO: If the file already uses crlf-style termination, maybe
1719
# we should use that for the newly added lines?
1721
if igns and igns[-1] != '\n':
1723
for name_pattern in name_pattern_list:
1724
igns += name_pattern.rstrip('/') + '\n'
1726
f = AtomicFile(ifn, 'wb')
1728
f.write(igns.encode('utf-8'))
1733
inv = tree.inventory
1734
if inv.path2id('.bzrignore'):
1735
mutter('.bzrignore is already versioned')
1737
mutter('need to make new .bzrignore file versioned')
1738
tree.add(['.bzrignore'])
1741
class cmd_ignored(Command):
1742
"""List ignored files and the patterns that matched them.
1744
See also: bzr ignore"""
1747
tree = WorkingTree.open_containing(u'.')[0]
1748
for path, file_class, kind, file_id, entry in tree.list_files():
1749
if file_class != 'I':
1751
## XXX: Slightly inefficient since this was already calculated
1752
pat = tree.is_ignored(path)
1753
print '%-50s %s' % (path, pat)
1756
class cmd_lookup_revision(Command):
1757
"""Lookup the revision-id from a revision-number
1760
bzr lookup-revision 33
1763
takes_args = ['revno']
1766
def run(self, revno):
1770
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1772
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1775
class cmd_export(Command):
1776
"""Export past revision to destination directory.
1778
If no revision is specified this exports the last committed revision.
1780
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1781
given, try to find the format with the extension. If no extension
1782
is found exports to a directory (equivalent to --format=dir).
1784
Root may be the top directory for tar, tgz and tbz2 formats. If none
1785
is given, the top directory will be the root name of the file.
1787
If branch is omitted then the branch containing the CWD will be used.
1789
Note: export of tree with non-ascii filenames to zip is not supported.
1791
Supported formats Autodetected by extension
1792
----------------- -------------------------
1795
tbz2 .tar.bz2, .tbz2
1799
takes_args = ['dest', 'branch?']
1800
takes_options = ['revision', 'format', 'root']
1801
def run(self, dest, branch=None, revision=None, format=None, root=None):
1802
from bzrlib.export import export
1805
tree = WorkingTree.open_containing(u'.')[0]
1808
b = Branch.open(branch)
1810
if revision is None:
1811
# should be tree.last_revision FIXME
1812
rev_id = b.last_revision()
1814
if len(revision) != 1:
1815
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1816
rev_id = revision[0].in_history(b).rev_id
1817
t = b.repository.revision_tree(rev_id)
1819
export(t, dest, format, root)
1820
except errors.NoSuchExportFormat, e:
1821
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1824
class cmd_cat(Command):
1825
"""Write a file's text from a previous revision."""
1827
takes_options = ['revision', 'name-from-revision']
1828
takes_args = ['filename']
1829
encoding_type = 'exact'
1832
def run(self, filename, revision=None, name_from_revision=False):
1833
if revision is not None and len(revision) != 1:
1834
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1839
tree, relpath = WorkingTree.open_containing(filename)
1841
except (errors.NotBranchError, errors.NotLocalUrl):
1844
if revision is not None and revision[0].get_branch() is not None:
1845
b = Branch.open(revision[0].get_branch())
1847
b, relpath = Branch.open_containing(filename)
1848
tree = b.basis_tree()
1849
if revision is None:
1850
revision_id = b.last_revision()
1852
revision_id = revision[0].in_history(b).rev_id
1854
cur_file_id = tree.path2id(relpath)
1855
rev_tree = b.repository.revision_tree(revision_id)
1856
old_file_id = rev_tree.path2id(relpath)
1858
if name_from_revision:
1859
if old_file_id is None:
1860
raise errors.BzrCommandError("%r is not present in revision %s"
1861
% (filename, revision_id))
1863
rev_tree.print_file(old_file_id)
1864
elif cur_file_id is not None:
1865
rev_tree.print_file(cur_file_id)
1866
elif old_file_id is not None:
1867
rev_tree.print_file(old_file_id)
1869
raise errors.BzrCommandError("%r is not present in revision %s" %
1870
(filename, revision_id))
1873
class cmd_local_time_offset(Command):
1874
"""Show the offset in seconds from GMT to local time."""
1878
print osutils.local_time_offset()
1882
class cmd_commit(Command):
1883
"""Commit changes into a new revision.
1885
If no arguments are given, the entire tree is committed.
1887
If selected files are specified, only changes to those files are
1888
committed. If a directory is specified then the directory and everything
1889
within it is committed.
1891
A selected-file commit may fail in some cases where the committed
1892
tree would be invalid, such as trying to commit a file in a
1893
newly-added directory that is not itself committed.
1895
# TODO: Run hooks on tree to-be-committed, and after commit.
1897
# TODO: Strict commit that fails if there are deleted files.
1898
# (what does "deleted files" mean ??)
1900
# TODO: Give better message for -s, --summary, used by tla people
1902
# XXX: verbose currently does nothing
1904
takes_args = ['selected*']
1905
takes_options = ['message', 'verbose',
1907
help='commit even if nothing has changed'),
1908
Option('file', type=str,
1911
help='file containing commit message'),
1913
help="refuse to commit if there are unknown "
1914
"files in the working tree."),
1916
help="perform a local only commit in a bound "
1917
"branch. Such commits are not pushed to "
1918
"the master branch until a normal commit "
1922
aliases = ['ci', 'checkin']
1924
def run(self, message=None, file=None, verbose=True, selected_list=None,
1925
unchanged=False, strict=False, local=False):
1926
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1927
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1929
from bzrlib.msgeditor import edit_commit_message, \
1930
make_commit_message_template
1932
# TODO: Need a blackbox test for invoking the external editor; may be
1933
# slightly problematic to run this cross-platform.
1935
# TODO: do more checks that the commit will succeed before
1936
# spending the user's valuable time typing a commit message.
1937
tree, selected_list = tree_files(selected_list)
1938
if selected_list == ['']:
1939
# workaround - commit of root of tree should be exactly the same
1940
# as just default commit in that tree, and succeed even though
1941
# selected-file merge commit is not done yet
1944
if local and not tree.branch.get_bound_location():
1945
raise errors.LocalRequiresBoundBranch()
1947
def get_message(commit_obj):
1948
"""Callback to get commit message"""
1949
my_message = message
1950
if my_message is None and not file:
1951
template = make_commit_message_template(tree, selected_list)
1952
my_message = edit_commit_message(template)
1953
if my_message is None:
1954
raise errors.BzrCommandError("please specify a commit"
1955
" message with either --message or --file")
1956
elif my_message and file:
1957
raise errors.BzrCommandError(
1958
"please specify either --message or --file")
1960
my_message = codecs.open(file, 'rt',
1961
bzrlib.user_encoding).read()
1962
if my_message == "":
1963
raise errors.BzrCommandError("empty commit message specified")
1967
reporter = ReportCommitToLog()
1969
reporter = NullCommitReporter()
1972
tree.commit(message_callback=get_message,
1973
specific_files=selected_list,
1974
allow_pointless=unchanged, strict=strict, local=local,
1976
except PointlessCommit:
1977
# FIXME: This should really happen before the file is read in;
1978
# perhaps prepare the commit; get the message; then actually commit
1979
raise errors.BzrCommandError("no changes to commit."
1980
" use --unchanged to commit anyhow")
1981
except ConflictsInTree:
1982
raise errors.BzrCommandError('Conflicts detected in working '
1983
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
1985
except StrictCommitFailed:
1986
raise errors.BzrCommandError("Commit refused because there are"
1987
" unknown files in the working tree.")
1988
except errors.BoundBranchOutOfDate, e:
1989
raise errors.BzrCommandError(str(e) + "\n"
1990
'To commit to master branch, run update and then commit.\n'
1991
'You can also pass --local to commit to continue working '
1995
class cmd_check(Command):
1996
"""Validate consistency of branch history.
1998
This command checks various invariants about the branch storage to
1999
detect data corruption or bzr bugs.
2001
takes_args = ['branch?']
2002
takes_options = ['verbose']
2004
def run(self, branch=None, verbose=False):
2005
from bzrlib.check import check
2007
tree = WorkingTree.open_containing()[0]
2008
branch = tree.branch
2010
branch = Branch.open(branch)
2011
check(branch, verbose)
2014
class cmd_upgrade(Command):
2015
"""Upgrade branch storage to current format.
2017
The check command or bzr developers may sometimes advise you to run
2018
this command. When the default format has changed you may also be warned
2019
during other operations to upgrade.
2021
takes_args = ['url?']
2023
RegistryOption('format',
2024
help='Upgrade to a specific format. See "bzr help'
2025
' formats" for details',
2026
registry=bzrdir.format_registry,
2027
converter=bzrdir.format_registry.make_bzrdir,
2028
value_switches=True, title='Branch format'),
2032
def run(self, url='.', format=None):
2033
from bzrlib.upgrade import upgrade
2035
format = bzrdir.format_registry.make_bzrdir('default')
2036
upgrade(url, format)
2039
class cmd_whoami(Command):
2040
"""Show or set bzr user id.
2044
bzr whoami 'Frank Chu <fchu@example.com>'
2046
takes_options = [ Option('email',
2047
help='display email address only'),
2049
help='set identity for the current branch instead of '
2052
takes_args = ['name?']
2053
encoding_type = 'replace'
2056
def run(self, email=False, branch=False, name=None):
2058
# use branch if we're inside one; otherwise global config
2060
c = Branch.open_containing('.')[0].get_config()
2061
except errors.NotBranchError:
2062
c = config.GlobalConfig()
2064
self.outf.write(c.user_email() + '\n')
2066
self.outf.write(c.username() + '\n')
2069
# display a warning if an email address isn't included in the given name.
2071
config.extract_email_address(name)
2072
except errors.NoEmailInUsername, e:
2073
warning('"%s" does not seem to contain an email address. '
2074
'This is allowed, but not recommended.', name)
2076
# use global config unless --branch given
2078
c = Branch.open_containing('.')[0].get_config()
2080
c = config.GlobalConfig()
2081
c.set_user_option('email', name)
2084
class cmd_nick(Command):
2085
"""Print or set the branch nickname.
2087
If unset, the tree root directory name is used as the nickname
2088
To print the current nickname, execute with no argument.
2090
takes_args = ['nickname?']
2091
def run(self, nickname=None):
2092
branch = Branch.open_containing(u'.')[0]
2093
if nickname is None:
2094
self.printme(branch)
2096
branch.nick = nickname
2099
def printme(self, branch):
2103
class cmd_selftest(Command):
2104
"""Run internal test suite.
2106
This creates temporary test directories in the working directory, but not
2107
existing data is affected. These directories are deleted if the tests
2108
pass, or left behind to help in debugging if they fail and --keep-output
2111
If arguments are given, they are regular expressions that say which tests
2112
should run. Tests matching any expression are run, and other tests are
2115
Alternatively if --first is given, matching tests are run first and then
2116
all other tests are run. This is useful if you have been working in a
2117
particular area, but want to make sure nothing else was broken.
2119
If the global option '--no-plugins' is given, plugins are not loaded
2120
before running the selftests. This has two effects: features provided or
2121
modified by plugins will not be tested, and tests provided by plugins will
2126
run only tests relating to 'ignore'
2127
bzr --no-plugins selftest -v
2128
disable plugins and list tests as they're run
2130
# TODO: --list should give a list of all available tests
2132
# NB: this is used from the class without creating an instance, which is
2133
# why it does not have a self parameter.
2134
def get_transport_type(typestring):
2135
"""Parse and return a transport specifier."""
2136
if typestring == "sftp":
2137
from bzrlib.transport.sftp import SFTPAbsoluteServer
2138
return SFTPAbsoluteServer
2139
if typestring == "memory":
2140
from bzrlib.transport.memory import MemoryServer
2142
if typestring == "fakenfs":
2143
from bzrlib.transport.fakenfs import FakeNFSServer
2144
return FakeNFSServer
2145
msg = "No known transport type %s. Supported types are: sftp\n" %\
2147
raise errors.BzrCommandError(msg)
2150
takes_args = ['testspecs*']
2151
takes_options = ['verbose',
2152
Option('one', help='stop when one test fails'),
2153
Option('keep-output',
2154
help='keep output directories when tests fail'),
2156
help='Use a different transport by default '
2157
'throughout the test suite.',
2158
type=get_transport_type),
2159
Option('benchmark', help='run the bzr bencharks.'),
2160
Option('lsprof-timed',
2161
help='generate lsprof output for benchmarked'
2162
' sections of code.'),
2163
Option('cache-dir', type=str,
2164
help='a directory to cache intermediate'
2165
' benchmark steps'),
2166
Option('clean-output',
2167
help='clean temporary tests directories'
2168
' without running tests'),
2170
help='run all tests, but run specified tests first',
2173
encoding_type = 'replace'
2175
def run(self, testspecs_list=None, verbose=None, one=False,
2176
keep_output=False, transport=None, benchmark=None,
2177
lsprof_timed=None, cache_dir=None, clean_output=False,
2180
from bzrlib.tests import selftest
2181
import bzrlib.benchmarks as benchmarks
2182
from bzrlib.benchmarks import tree_creator
2185
from bzrlib.tests import clean_selftest_output
2186
clean_selftest_output()
2189
if cache_dir is not None:
2190
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2191
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2192
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2194
if testspecs_list is not None:
2195
pattern = '|'.join(testspecs_list)
2199
test_suite_factory = benchmarks.test_suite
2202
# TODO: should possibly lock the history file...
2203
benchfile = open(".perf_history", "at", buffering=1)
2205
test_suite_factory = None
2210
result = selftest(verbose=verbose,
2212
stop_on_failure=one,
2213
keep_output=keep_output,
2214
transport=transport,
2215
test_suite_factory=test_suite_factory,
2216
lsprof_timed=lsprof_timed,
2217
bench_history=benchfile,
2218
matching_tests_first=first,
2221
if benchfile is not None:
2224
info('tests passed')
2226
info('tests failed')
2227
return int(not result)
2230
class cmd_version(Command):
2231
"""Show version of bzr."""
2235
from bzrlib.version import show_version
2239
class cmd_rocks(Command):
2240
"""Statement of optimism."""
2246
print "it sure does!"
2249
class cmd_find_merge_base(Command):
2250
"""Find and print a base revision for merging two branches."""
2251
# TODO: Options to specify revisions on either side, as if
2252
# merging only part of the history.
2253
takes_args = ['branch', 'other']
2257
def run(self, branch, other):
2258
from bzrlib.revision import MultipleRevisionSources
2260
branch1 = Branch.open_containing(branch)[0]
2261
branch2 = Branch.open_containing(other)[0]
2263
last1 = branch1.last_revision()
2264
last2 = branch2.last_revision()
2266
source = MultipleRevisionSources(branch1.repository,
2269
base_rev_id = common_ancestor(last1, last2, source)
2271
print 'merge base is revision %s' % base_rev_id
2274
class cmd_merge(Command):
2275
"""Perform a three-way merge.
2277
The branch is the branch you will merge from. By default, it will merge
2278
the latest revision. If you specify a revision, that revision will be
2279
merged. If you specify two revisions, the first will be used as a BASE,
2280
and the second one as OTHER. Revision numbers are always relative to the
2283
By default, bzr will try to merge in all new work from the other
2284
branch, automatically determining an appropriate base. If this
2285
fails, you may need to give an explicit base.
2287
Merge will do its best to combine the changes in two branches, but there
2288
are some kinds of problems only a human can fix. When it encounters those,
2289
it will mark a conflict. A conflict means that you need to fix something,
2290
before you should commit.
2292
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2294
If there is no default branch set, the first merge will set it. After
2295
that, you can omit the branch to use the default. To change the
2296
default, use --remember. The value will only be saved if the remote
2297
location can be accessed.
2301
To merge the latest revision from bzr.dev
2302
bzr merge ../bzr.dev
2304
To merge changes up to and including revision 82 from bzr.dev
2305
bzr merge -r 82 ../bzr.dev
2307
To merge the changes introduced by 82, without previous changes:
2308
bzr merge -r 81..82 ../bzr.dev
2310
merge refuses to run if there are any uncommitted changes, unless
2313
The following merge types are available:
2315
takes_args = ['branch?']
2316
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2317
Option('show-base', help="Show base revision text in "
2319
Option('uncommitted', help='Apply uncommitted changes'
2320
' from a working copy, instead of branch changes'),
2321
Option('pull', help='If the destination is already'
2322
' completely merged into the source, pull from the'
2323
' source rather than merging. When this happens,'
2324
' you do not need to commit the result.'),
2328
from inspect import getdoc
2329
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2331
def run(self, branch=None, revision=None, force=False, merge_type=None,
2332
show_base=False, reprocess=False, remember=False,
2333
uncommitted=False, pull=False):
2334
if merge_type is None:
2335
merge_type = _mod_merge.Merge3Merger
2337
tree = WorkingTree.open_containing(u'.')[0]
2338
change_reporter = delta.ChangeReporter(tree.inventory)
2340
if branch is not None:
2342
reader = bundle.read_bundle_from_url(branch)
2343
except errors.NotABundle:
2344
pass # Continue on considering this url a Branch
2346
conflicts = merge_bundle(reader, tree, not force, merge_type,
2347
reprocess, show_base, change_reporter)
2353
if revision is None \
2354
or len(revision) < 1 or revision[0].needs_branch():
2355
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2357
if revision is None or len(revision) < 1:
2360
other = [branch, None]
2363
other = [branch, -1]
2364
other_branch, path = Branch.open_containing(branch)
2367
raise errors.BzrCommandError('Cannot use --uncommitted and'
2368
' --revision at the same time.')
2369
branch = revision[0].get_branch() or branch
2370
if len(revision) == 1:
2372
other_branch, path = Branch.open_containing(branch)
2373
revno = revision[0].in_history(other_branch).revno
2374
other = [branch, revno]
2376
assert len(revision) == 2
2377
if None in revision:
2378
raise errors.BzrCommandError(
2379
"Merge doesn't permit empty revision specifier.")
2380
base_branch, path = Branch.open_containing(branch)
2381
branch1 = revision[1].get_branch() or branch
2382
other_branch, path1 = Branch.open_containing(branch1)
2383
if revision[0].get_branch() is not None:
2384
# then path was obtained from it, and is None.
2387
base = [branch, revision[0].in_history(base_branch).revno]
2388
other = [branch1, revision[1].in_history(other_branch).revno]
2390
if tree.branch.get_parent() is None or remember:
2391
tree.branch.set_parent(other_branch.base)
2394
interesting_files = [path]
2396
interesting_files = None
2397
pb = ui.ui_factory.nested_progress_bar()
2400
conflict_count = _merge_helper(
2401
other, base, check_clean=(not force),
2402
merge_type=merge_type,
2403
reprocess=reprocess,
2404
show_base=show_base,
2407
file_list=interesting_files,
2408
change_reporter=change_reporter)
2411
if conflict_count != 0:
2415
except errors.AmbiguousBase, e:
2416
m = ("sorry, bzr can't determine the right merge base yet\n"
2417
"candidates are:\n "
2418
+ "\n ".join(e.bases)
2420
"please specify an explicit base with -r,\n"
2421
"and (if you want) report this to the bzr developers\n")
2424
# TODO: move up to common parent; this isn't merge-specific anymore.
2425
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2426
"""Use tree.branch's parent if none was supplied.
2428
Report if the remembered location was used.
2430
if supplied_location is not None:
2431
return supplied_location
2432
stored_location = tree.branch.get_parent()
2433
mutter("%s", stored_location)
2434
if stored_location is None:
2435
raise errors.BzrCommandError("No location specified or remembered")
2436
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2437
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2438
return stored_location
2441
class cmd_remerge(Command):
2444
Use this if you want to try a different merge technique while resolving
2445
conflicts. Some merge techniques are better than others, and remerge
2446
lets you try different ones on different files.
2448
The options for remerge have the same meaning and defaults as the ones for
2449
merge. The difference is that remerge can (only) be run when there is a
2450
pending merge, and it lets you specify particular files.
2453
$ bzr remerge --show-base
2454
Re-do the merge of all conflicted files, and show the base text in
2455
conflict regions, in addition to the usual THIS and OTHER texts.
2457
$ bzr remerge --merge-type weave --reprocess foobar
2458
Re-do the merge of "foobar", using the weave merge algorithm, with
2459
additional processing to reduce the size of conflict regions.
2461
The following merge types are available:"""
2462
takes_args = ['file*']
2463
takes_options = ['merge-type', 'reprocess',
2464
Option('show-base', help="Show base revision text in "
2468
from inspect import getdoc
2469
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2471
def run(self, file_list=None, merge_type=None, show_base=False,
2473
if merge_type is None:
2474
merge_type = _mod_merge.Merge3Merger
2475
tree, file_list = tree_files(file_list)
2478
parents = tree.get_parent_ids()
2479
if len(parents) != 2:
2480
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2481
" merges. Not cherrypicking or"
2483
repository = tree.branch.repository
2484
base_revision = common_ancestor(parents[0],
2485
parents[1], repository)
2486
base_tree = repository.revision_tree(base_revision)
2487
other_tree = repository.revision_tree(parents[1])
2488
interesting_ids = None
2490
conflicts = tree.conflicts()
2491
if file_list is not None:
2492
interesting_ids = set()
2493
for filename in file_list:
2494
file_id = tree.path2id(filename)
2496
raise errors.NotVersionedError(filename)
2497
interesting_ids.add(file_id)
2498
if tree.kind(file_id) != "directory":
2501
for name, ie in tree.inventory.iter_entries(file_id):
2502
interesting_ids.add(ie.file_id)
2503
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2505
# Remerge only supports resolving contents conflicts
2506
allowed_conflicts = ('text conflict', 'contents conflict')
2507
restore_files = [c.path for c in conflicts
2508
if c.typestring in allowed_conflicts]
2509
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2510
tree.set_conflicts(ConflictList(new_conflicts))
2511
if file_list is not None:
2512
restore_files = file_list
2513
for filename in restore_files:
2515
restore(tree.abspath(filename))
2516
except errors.NotConflicted:
2518
conflicts = _mod_merge.merge_inner(
2519
tree.branch, other_tree, base_tree,
2521
interesting_ids=interesting_ids,
2522
other_rev_id=parents[1],
2523
merge_type=merge_type,
2524
show_base=show_base,
2525
reprocess=reprocess)
2534
class cmd_revert(Command):
2535
"""Revert files to a previous revision.
2537
Giving a list of files will revert only those files. Otherwise, all files
2538
will be reverted. If the revision is not specified with '--revision', the
2539
last committed revision is used.
2541
To remove only some changes, without reverting to a prior version, use
2542
merge instead. For example, "merge . --r-2..-3" will remove the changes
2543
introduced by -2, without affecting the changes introduced by -1. Or
2544
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2546
By default, any files that have been manually changed will be backed up
2547
first. (Files changed only by merge are not backed up.) Backup files have
2548
'.~#~' appended to their name, where # is a number.
2550
When you provide files, you can use their current pathname or the pathname
2551
from the target revision. So you can use revert to "undelete" a file by
2552
name. If you name a directory, all the contents of that directory will be
2555
takes_options = ['revision', 'no-backup']
2556
takes_args = ['file*']
2557
aliases = ['merge-revert']
2559
def run(self, revision=None, no_backup=False, file_list=None):
2560
if file_list is not None:
2561
if len(file_list) == 0:
2562
raise errors.BzrCommandError("No files specified")
2566
tree, file_list = tree_files(file_list)
2567
if revision is None:
2568
# FIXME should be tree.last_revision
2569
rev_id = tree.last_revision()
2570
elif len(revision) != 1:
2571
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2573
rev_id = revision[0].in_history(tree.branch).rev_id
2574
pb = ui.ui_factory.nested_progress_bar()
2576
tree.revert(file_list,
2577
tree.branch.repository.revision_tree(rev_id),
2578
not no_backup, pb, report_changes=True)
2583
class cmd_assert_fail(Command):
2584
"""Test reporting of assertion failures"""
2585
# intended just for use in testing
2590
raise AssertionError("always fails")
2593
class cmd_help(Command):
2594
"""Show help on a command or other topic.
2596
For a list of all available commands, say 'bzr help commands'.
2598
takes_options = [Option('long', 'show help on all commands')]
2599
takes_args = ['topic?']
2600
aliases = ['?', '--help', '-?', '-h']
2603
def run(self, topic=None, long=False):
2605
if topic is None and long:
2607
bzrlib.help.help(topic)
2610
class cmd_shell_complete(Command):
2611
"""Show appropriate completions for context.
2613
For a list of all available commands, say 'bzr shell-complete'.
2615
takes_args = ['context?']
2620
def run(self, context=None):
2621
import shellcomplete
2622
shellcomplete.shellcomplete(context)
2625
class cmd_fetch(Command):
2626
"""Copy in history from another branch but don't merge it.
2628
This is an internal method used for pull and merge.
2631
takes_args = ['from_branch', 'to_branch']
2632
def run(self, from_branch, to_branch):
2633
from bzrlib.fetch import Fetcher
2634
from_b = Branch.open(from_branch)
2635
to_b = Branch.open(to_branch)
2636
Fetcher(to_b, from_b)
2639
class cmd_missing(Command):
2640
"""Show unmerged/unpulled revisions between two branches.
2642
OTHER_BRANCH may be local or remote.
2644
takes_args = ['other_branch?']
2645
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2647
'Display changes in the local branch only'),
2648
Option('theirs-only',
2649
'Display changes in the remote branch only'),
2654
encoding_type = 'replace'
2657
def run(self, other_branch=None, reverse=False, mine_only=False,
2658
theirs_only=False, log_format=None, long=False, short=False, line=False,
2659
show_ids=False, verbose=False):
2660
from bzrlib.missing import find_unmerged, iter_log_data
2661
from bzrlib.log import log_formatter
2662
local_branch = Branch.open_containing(u".")[0]
2663
parent = local_branch.get_parent()
2664
if other_branch is None:
2665
other_branch = parent
2666
if other_branch is None:
2667
raise errors.BzrCommandError("No peer location known or specified.")
2668
display_url = urlutils.unescape_for_display(parent,
2670
print "Using last location: " + display_url
2672
remote_branch = Branch.open(other_branch)
2673
if remote_branch.base == local_branch.base:
2674
remote_branch = local_branch
2675
local_branch.lock_read()
2677
remote_branch.lock_read()
2679
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2680
if (log_format is None):
2681
log_format = log.log_formatter_registry.get_default(
2683
lf = log_format(to_file=self.outf,
2685
show_timezone='original')
2686
if reverse is False:
2687
local_extra.reverse()
2688
remote_extra.reverse()
2689
if local_extra and not theirs_only:
2690
print "You have %d extra revision(s):" % len(local_extra)
2691
for data in iter_log_data(local_extra, local_branch.repository,
2694
printed_local = True
2696
printed_local = False
2697
if remote_extra and not mine_only:
2698
if printed_local is True:
2700
print "You are missing %d revision(s):" % len(remote_extra)
2701
for data in iter_log_data(remote_extra, remote_branch.repository,
2704
if not remote_extra and not local_extra:
2706
print "Branches are up to date."
2710
remote_branch.unlock()
2712
local_branch.unlock()
2713
if not status_code and parent is None and other_branch is not None:
2714
local_branch.lock_write()
2716
# handle race conditions - a parent might be set while we run.
2717
if local_branch.get_parent() is None:
2718
local_branch.set_parent(remote_branch.base)
2720
local_branch.unlock()
2724
class cmd_plugins(Command):
2729
import bzrlib.plugin
2730
from inspect import getdoc
2731
for name, plugin in bzrlib.plugin.all_plugins().items():
2732
if getattr(plugin, '__path__', None) is not None:
2733
print plugin.__path__[0]
2734
elif getattr(plugin, '__file__', None) is not None:
2735
print plugin.__file__
2741
print '\t', d.split('\n')[0]
2744
class cmd_testament(Command):
2745
"""Show testament (signing-form) of a revision."""
2746
takes_options = ['revision',
2747
Option('long', help='Produce long-format testament'),
2748
Option('strict', help='Produce a strict-format'
2750
takes_args = ['branch?']
2752
def run(self, branch=u'.', revision=None, long=False, strict=False):
2753
from bzrlib.testament import Testament, StrictTestament
2755
testament_class = StrictTestament
2757
testament_class = Testament
2758
b = WorkingTree.open_containing(branch)[0].branch
2761
if revision is None:
2762
rev_id = b.last_revision()
2764
rev_id = revision[0].in_history(b).rev_id
2765
t = testament_class.from_revision(b.repository, rev_id)
2767
sys.stdout.writelines(t.as_text_lines())
2769
sys.stdout.write(t.as_short_text())
2774
class cmd_annotate(Command):
2775
"""Show the origin of each line in a file.
2777
This prints out the given file with an annotation on the left side
2778
indicating which revision, author and date introduced the change.
2780
If the origin is the same for a run of consecutive lines, it is
2781
shown only at the top, unless the --all option is given.
2783
# TODO: annotate directories; showing when each file was last changed
2784
# TODO: if the working copy is modified, show annotations on that
2785
# with new uncommitted lines marked
2786
aliases = ['ann', 'blame', 'praise']
2787
takes_args = ['filename']
2788
takes_options = [Option('all', help='show annotations on all lines'),
2789
Option('long', help='show date in annotations'),
2795
def run(self, filename, all=False, long=False, revision=None,
2797
from bzrlib.annotate import annotate_file
2798
tree, relpath = WorkingTree.open_containing(filename)
2799
branch = tree.branch
2802
if revision is None:
2803
revision_id = branch.last_revision()
2804
elif len(revision) != 1:
2805
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2807
revision_id = revision[0].in_history(branch).rev_id
2808
file_id = tree.inventory.path2id(relpath)
2809
tree = branch.repository.revision_tree(revision_id)
2810
file_version = tree.inventory[file_id].revision
2811
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2817
class cmd_re_sign(Command):
2818
"""Create a digital signature for an existing revision."""
2819
# TODO be able to replace existing ones.
2821
hidden = True # is this right ?
2822
takes_args = ['revision_id*']
2823
takes_options = ['revision']
2825
def run(self, revision_id_list=None, revision=None):
2826
import bzrlib.gpg as gpg
2827
if revision_id_list is not None and revision is not None:
2828
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2829
if revision_id_list is None and revision is None:
2830
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2831
b = WorkingTree.open_containing(u'.')[0].branch
2832
gpg_strategy = gpg.GPGStrategy(b.get_config())
2833
if revision_id_list is not None:
2834
for revision_id in revision_id_list:
2835
b.repository.sign_revision(revision_id, gpg_strategy)
2836
elif revision is not None:
2837
if len(revision) == 1:
2838
revno, rev_id = revision[0].in_history(b)
2839
b.repository.sign_revision(rev_id, gpg_strategy)
2840
elif len(revision) == 2:
2841
# are they both on rh- if so we can walk between them
2842
# might be nice to have a range helper for arbitrary
2843
# revision paths. hmm.
2844
from_revno, from_revid = revision[0].in_history(b)
2845
to_revno, to_revid = revision[1].in_history(b)
2846
if to_revid is None:
2847
to_revno = b.revno()
2848
if from_revno is None or to_revno is None:
2849
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2850
for revno in range(from_revno, to_revno + 1):
2851
b.repository.sign_revision(b.get_rev_id(revno),
2854
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2857
class cmd_bind(Command):
2858
"""Bind the current branch to a master branch.
2860
After binding, commits must succeed on the master branch
2861
before they are executed on the local one.
2864
takes_args = ['location']
2867
def run(self, location=None):
2868
b, relpath = Branch.open_containing(u'.')
2869
b_other = Branch.open(location)
2872
except errors.DivergedBranches:
2873
raise errors.BzrCommandError('These branches have diverged.'
2874
' Try merging, and then bind again.')
2877
class cmd_unbind(Command):
2878
"""Unbind the current branch from its master branch.
2880
After unbinding, the local branch is considered independent.
2881
All subsequent commits will be local.
2888
b, relpath = Branch.open_containing(u'.')
2890
raise errors.BzrCommandError('Local branch is not bound')
2893
class cmd_uncommit(Command):
2894
"""Remove the last committed revision.
2896
--verbose will print out what is being removed.
2897
--dry-run will go through all the motions, but not actually
2900
In the future, uncommit will create a revision bundle, which can then
2904
# TODO: jam 20060108 Add an option to allow uncommit to remove
2905
# unreferenced information in 'branch-as-repository' branches.
2906
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2907
# information in shared branches as well.
2908
takes_options = ['verbose', 'revision',
2909
Option('dry-run', help='Don\'t actually make changes'),
2910
Option('force', help='Say yes to all questions.')]
2911
takes_args = ['location?']
2914
def run(self, location=None,
2915
dry_run=False, verbose=False,
2916
revision=None, force=False):
2917
from bzrlib.log import log_formatter, show_log
2919
from bzrlib.uncommit import uncommit
2921
if location is None:
2923
control, relpath = bzrdir.BzrDir.open_containing(location)
2925
tree = control.open_workingtree()
2927
except (errors.NoWorkingTree, errors.NotLocalUrl):
2929
b = control.open_branch()
2932
if revision is None:
2935
# 'bzr uncommit -r 10' actually means uncommit
2936
# so that the final tree is at revno 10.
2937
# but bzrlib.uncommit.uncommit() actually uncommits
2938
# the revisions that are supplied.
2939
# So we need to offset it by one
2940
revno = revision[0].in_history(b).revno+1
2942
if revno <= b.revno():
2943
rev_id = b.get_rev_id(revno)
2945
self.outf.write('No revisions to uncommit.\n')
2948
lf = log_formatter('short',
2950
show_timezone='original')
2955
direction='forward',
2956
start_revision=revno,
2957
end_revision=b.revno())
2960
print 'Dry-run, pretending to remove the above revisions.'
2962
val = raw_input('Press <enter> to continue')
2964
print 'The above revision(s) will be removed.'
2966
val = raw_input('Are you sure [y/N]? ')
2967
if val.lower() not in ('y', 'yes'):
2971
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2975
class cmd_break_lock(Command):
2976
"""Break a dead lock on a repository, branch or working directory.
2978
CAUTION: Locks should only be broken when you are sure that the process
2979
holding the lock has been stopped.
2981
You can get information on what locks are open via the 'bzr info' command.
2986
takes_args = ['location?']
2988
def run(self, location=None, show=False):
2989
if location is None:
2991
control, relpath = bzrdir.BzrDir.open_containing(location)
2993
control.break_lock()
2994
except NotImplementedError:
2998
class cmd_wait_until_signalled(Command):
2999
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3001
This just prints a line to signal when it is ready, then blocks on stdin.
3007
sys.stdout.write("running\n")
3009
sys.stdin.readline()
3012
class cmd_serve(Command):
3013
"""Run the bzr server."""
3015
aliases = ['server']
3019
help='serve on stdin/out for use from inetd or sshd'),
3021
help='listen for connections on nominated port of the form '
3022
'[hostname:]portnumber. Passing 0 as the port number will '
3023
'result in a dynamically allocated port.',
3026
help='serve contents of directory',
3028
Option('allow-writes',
3029
help='By default the server is a readonly server. Supplying '
3030
'--allow-writes enables write access to the contents of '
3031
'the served directory and below. '
3035
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3036
from bzrlib.transport import smart
3037
from bzrlib.transport import get_transport
3038
if directory is None:
3039
directory = os.getcwd()
3040
url = urlutils.local_path_to_url(directory)
3041
if not allow_writes:
3042
url = 'readonly+' + url
3043
t = get_transport(url)
3045
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3046
elif port is not None:
3048
host, port = port.split(':')
3051
server = smart.SmartTCPServer(t, host=host, port=int(port))
3052
print 'listening on port: ', server.port
3055
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3059
# command-line interpretation helper for merge-related commands
3060
def _merge_helper(other_revision, base_revision,
3061
check_clean=True, ignore_zero=False,
3062
this_dir=None, backup_files=False,
3064
file_list=None, show_base=False, reprocess=False,
3067
change_reporter=None):
3068
"""Merge changes into a tree.
3071
list(path, revno) Base for three-way merge.
3072
If [None, None] then a base will be automatically determined.
3074
list(path, revno) Other revision for three-way merge.
3076
Directory to merge changes into; '.' by default.
3078
If true, this_dir must have no uncommitted changes before the
3080
ignore_zero - If true, suppress the "zero conflicts" message when
3081
there are no conflicts; should be set when doing something we expect
3082
to complete perfectly.
3083
file_list - If supplied, merge only changes to selected files.
3085
All available ancestors of other_revision and base_revision are
3086
automatically pulled into the branch.
3088
The revno may be -1 to indicate the last revision on the branch, which is
3091
This function is intended for use from the command line; programmatic
3092
clients might prefer to call merge.merge_inner(), which has less magic
3095
# Loading it late, so that we don't always have to import bzrlib.merge
3096
if merge_type is None:
3097
merge_type = _mod_merge.Merge3Merger
3098
if this_dir is None:
3100
this_tree = WorkingTree.open_containing(this_dir)[0]
3101
if show_base and not merge_type is _mod_merge.Merge3Merger:
3102
raise errors.BzrCommandError("Show-base is not supported for this merge"
3103
" type. %s" % merge_type)
3104
if reprocess and not merge_type.supports_reprocess:
3105
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3106
" type %s." % merge_type)
3107
if reprocess and show_base:
3108
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3110
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3111
pb=pb, change_reporter=change_reporter)
3112
merger.pp = ProgressPhase("Merge phase", 5, pb)
3113
merger.pp.next_phase()
3114
merger.check_basis(check_clean)
3115
merger.set_other(other_revision)
3116
merger.pp.next_phase()
3117
merger.set_base(base_revision)
3118
if merger.base_rev_id == merger.other_rev_id:
3119
note('Nothing to do.')
3121
if file_list is None:
3122
if pull and merger.base_rev_id == merger.this_rev_id:
3123
count = merger.this_tree.pull(merger.this_branch,
3124
False, merger.other_rev_id)
3125
note('%d revision(s) pulled.' % (count,))
3127
merger.backup_files = backup_files
3128
merger.merge_type = merge_type
3129
merger.set_interesting_files(file_list)
3130
merger.show_base = show_base
3131
merger.reprocess = reprocess
3132
conflicts = merger.do_merge()
3133
if file_list is None:
3134
merger.set_pending()
3141
merge = _merge_helper
3144
# these get imported and then picked up by the scan for cmd_*
3145
# TODO: Some more consistent way to split command definitions across files;
3146
# we do need to load at least some information about them to know of
3147
# aliases. ideally we would avoid loading the implementation until the
3148
# details were needed.
3149
from bzrlib.cmd_version_info import cmd_version_info
3150
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3151
from bzrlib.bundle.commands import cmd_bundle_revisions
3152
from bzrlib.sign_my_commits import cmd_sign_my_commits
3153
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3154
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
