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
See "help checkouts" for more information on checkouts.
827
takes_args = ['branch_location?', 'to_location?']
828
takes_options = ['revision', # , 'basis']
829
Option('lightweight',
830
help="perform a lightweight checkout. Lightweight "
831
"checkouts depend on access to the branch for "
832
"every operation. Normal checkouts can perform "
833
"common operations like diff and status without "
834
"such access, and also support local commits."
839
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
843
elif len(revision) > 1:
844
raise errors.BzrCommandError(
845
'bzr checkout --revision takes exactly 1 revision value')
846
if branch_location is None:
847
branch_location = osutils.getcwd()
848
to_location = branch_location
849
source = Branch.open(branch_location)
850
if len(revision) == 1 and revision[0] is not None:
851
revision_id = revision[0].in_history(source)[1]
854
if to_location is None:
855
to_location = os.path.basename(branch_location.rstrip("/\\"))
856
# if the source and to_location are the same,
857
# and there is no working tree,
858
# then reconstitute a branch
859
if (osutils.abspath(to_location) ==
860
osutils.abspath(branch_location)):
862
source.bzrdir.open_workingtree()
863
except errors.NoWorkingTree:
864
source.bzrdir.create_workingtree()
867
os.mkdir(to_location)
869
if e.errno == errno.EEXIST:
870
raise errors.BzrCommandError('Target directory "%s" already'
871
' exists.' % to_location)
872
if e.errno == errno.ENOENT:
873
raise errors.BzrCommandError('Parent of "%s" does not exist.'
877
source.create_checkout(to_location, revision_id, lightweight)
880
class cmd_renames(Command):
881
"""Show list of renamed files.
883
# TODO: Option to show renames between two historical versions.
885
# TODO: Only show renames under dir, rather than in the whole branch.
886
takes_args = ['dir?']
889
def run(self, dir=u'.'):
890
tree = WorkingTree.open_containing(dir)[0]
891
old_inv = tree.basis_tree().inventory
892
new_inv = tree.read_working_inventory()
893
renames = list(_mod_tree.find_renames(old_inv, new_inv))
895
for old_name, new_name in renames:
896
self.outf.write("%s => %s\n" % (old_name, new_name))
899
class cmd_update(Command):
900
"""Update a tree to have the latest code committed to its branch.
902
This will perform a merge into the working tree, and may generate
903
conflicts. If you have any local changes, you will still
904
need to commit them after the update for the update to be complete.
906
If you want to discard your local changes, you can just do a
907
'bzr revert' instead of 'bzr commit' after the update.
909
takes_args = ['dir?']
912
def run(self, dir='.'):
913
tree = WorkingTree.open_containing(dir)[0]
914
master = tree.branch.get_master_branch()
915
if master is not None:
918
tree.lock_tree_write()
920
existing_pending_merges = tree.get_parent_ids()[1:]
921
last_rev = tree.last_revision()
922
if last_rev == tree.branch.last_revision():
923
# may be up to date, check master too.
924
master = tree.branch.get_master_branch()
925
if master is None or last_rev == master.last_revision():
926
revno = tree.branch.revision_id_to_revno(last_rev)
927
note("Tree is up to date at revision %d." % (revno,))
929
conflicts = tree.update()
930
revno = tree.branch.revision_id_to_revno(tree.last_revision())
931
note('Updated to revision %d.' % (revno,))
932
if tree.get_parent_ids()[1:] != existing_pending_merges:
933
note('Your local commits will now show as pending merges with '
934
"'bzr status', and can be committed with 'bzr commit'.")
943
class cmd_info(Command):
944
"""Show information about a working tree, branch or repository.
946
This command will show all known locations and formats associated to the
947
tree, branch or repository. Statistical information is included with
950
Branches and working trees will also report any missing revisions.
952
takes_args = ['location?']
953
takes_options = ['verbose']
956
def run(self, location=None, verbose=False):
957
from bzrlib.info import show_bzrdir_info
958
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
962
class cmd_remove(Command):
963
"""Make a file unversioned.
965
This makes bzr stop tracking changes to a versioned file. It does
966
not delete the working copy.
968
You can specify one or more files, and/or --new. If you specify --new,
969
only 'added' files will be removed. If you specify both, then new files
970
in the specified directories will be removed. If the directories are
971
also new, they will also be removed.
973
takes_args = ['file*']
974
takes_options = ['verbose', Option('new', help='remove newly-added files')]
976
encoding_type = 'replace'
978
def run(self, file_list, verbose=False, new=False):
979
tree, file_list = tree_files(file_list)
981
if file_list is None:
982
raise errors.BzrCommandError('Specify one or more files to'
983
' remove, or use --new.')
985
added = tree.changes_from(tree.basis_tree(),
986
specific_files=file_list).added
987
file_list = sorted([f[0] for f in added], reverse=True)
988
if len(file_list) == 0:
989
raise errors.BzrCommandError('No matching files.')
990
tree.remove(file_list, verbose=verbose, to_file=self.outf)
993
class cmd_file_id(Command):
994
"""Print file_id of a particular file or directory.
996
The file_id is assigned when the file is first added and remains the
997
same through all revisions where the file exists, even when it is
1002
takes_args = ['filename']
1005
def run(self, filename):
1006
tree, relpath = WorkingTree.open_containing(filename)
1007
i = tree.inventory.path2id(relpath)
1009
raise errors.NotVersionedError(filename)
1011
self.outf.write(i + '\n')
1014
class cmd_file_path(Command):
1015
"""Print path of file_ids to a file or directory.
1017
This prints one line for each directory down to the target,
1018
starting at the branch root.
1022
takes_args = ['filename']
1025
def run(self, filename):
1026
tree, relpath = WorkingTree.open_containing(filename)
1027
inv = tree.inventory
1028
fid = inv.path2id(relpath)
1030
raise errors.NotVersionedError(filename)
1031
for fip in inv.get_idpath(fid):
1032
self.outf.write(fip + '\n')
1035
class cmd_reconcile(Command):
1036
"""Reconcile bzr metadata in a branch.
1038
This can correct data mismatches that may have been caused by
1039
previous ghost operations or bzr upgrades. You should only
1040
need to run this command if 'bzr check' or a bzr developer
1041
advises you to run it.
1043
If a second branch is provided, cross-branch reconciliation is
1044
also attempted, which will check that data like the tree root
1045
id which was not present in very early bzr versions is represented
1046
correctly in both branches.
1048
At the same time it is run it may recompress data resulting in
1049
a potential saving in disk space or performance gain.
1051
The branch *MUST* be on a listable system such as local disk or sftp.
1053
takes_args = ['branch?']
1055
def run(self, branch="."):
1056
from bzrlib.reconcile import reconcile
1057
dir = bzrdir.BzrDir.open(branch)
1061
class cmd_revision_history(Command):
1062
"""Display the list of revision ids on a branch."""
1063
takes_args = ['location?']
1068
def run(self, location="."):
1069
branch = Branch.open_containing(location)[0]
1070
for revid in branch.revision_history():
1071
self.outf.write(revid)
1072
self.outf.write('\n')
1075
class cmd_ancestry(Command):
1076
"""List all revisions merged into this branch."""
1077
takes_args = ['location?']
1082
def run(self, location="."):
1084
wt = WorkingTree.open_containing(location)[0]
1085
except errors.NoWorkingTree:
1086
b = Branch.open(location)
1087
last_revision = b.last_revision()
1090
last_revision = wt.last_revision()
1092
revision_ids = b.repository.get_ancestry(last_revision)
1093
assert revision_ids[0] is None
1095
for revision_id in revision_ids:
1096
self.outf.write(revision_id + '\n')
1099
class cmd_init(Command):
1100
"""Make a directory into a versioned branch.
1102
Use this to create an empty branch, or before importing an
1105
If there is a repository in a parent directory of the location, then
1106
the history of the branch will be stored in the repository. Otherwise
1107
init creates a standalone branch which carries its own history in
1110
If there is already a branch at the location but it has no working tree,
1111
the tree can be populated with 'bzr checkout'.
1113
Recipe for importing a tree of files:
1118
bzr commit -m 'imported project'
1120
takes_args = ['location?']
1122
RegistryOption('format',
1123
help='Specify a format for this branch. See "bzr '
1124
'help formats" for details',
1125
converter=bzrdir.format_registry.make_bzrdir,
1126
registry=bzrdir.format_registry,
1127
value_switches=True, title="Branch Format"),
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. See'
1182
' "bzr help formats" for details',
1183
registry=bzrdir.format_registry,
1184
converter=bzrdir.format_registry.make_bzrdir,
1185
value_switches=True, title='Repository format'),
1187
help='Allows branches in repository to have'
1189
aliases = ["init-repo"]
1190
def run(self, location, format=None, trees=False):
1192
format = bzrdir.format_registry.make_bzrdir('default')
1194
if location is None:
1197
to_transport = transport.get_transport(location)
1199
to_transport.mkdir('.')
1200
except errors.FileExists:
1203
newdir = format.initialize_on_transport(to_transport)
1204
repo = newdir.create_repository(shared=True)
1205
repo.set_make_working_trees(trees)
1208
class cmd_diff(Command):
1209
"""Show differences in the working tree or between revisions.
1211
If files are listed, only the changes in those files are listed.
1212
Otherwise, all changes for the tree are listed.
1214
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1215
produces patches suitable for "patch -p1".
1219
Shows the difference in the working tree versus the last commit
1221
Difference between the working tree and revision 1
1223
Difference between revision 2 and revision 1
1224
bzr diff --diff-prefix old/:new/
1225
Same as 'bzr diff' but prefix paths with old/ and new/
1226
bzr diff bzr.mine bzr.dev
1227
Show the differences between the two working trees
1229
Show just the differences for 'foo.c'
1231
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1232
# or a graphical diff.
1234
# TODO: Python difflib is not exactly the same as unidiff; should
1235
# either fix it up or prefer to use an external diff.
1237
# TODO: Selected-file diff is inefficient and doesn't show you
1240
# TODO: This probably handles non-Unix newlines poorly.
1242
takes_args = ['file*']
1243
takes_options = ['revision', 'diff-options',
1244
Option('prefix', type=str,
1246
help='Set prefixes to added to old and new filenames, as '
1247
'two values separated by a colon.'),
1249
aliases = ['di', 'dif']
1250
encoding_type = 'exact'
1253
def run(self, revision=None, file_list=None, diff_options=None,
1255
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1257
if (prefix is None) or (prefix == '0'):
1265
old_label, new_label = prefix.split(":")
1267
raise BzrCommandError(
1268
"--prefix expects two values separated by a colon")
1270
if revision and len(revision) > 2:
1271
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1272
' one or two revision specifiers')
1275
tree1, file_list = internal_tree_files(file_list)
1279
except errors.FileInWrongBranch:
1280
if len(file_list) != 2:
1281
raise errors.BzrCommandError("Files are in different branches")
1283
tree1, file1 = WorkingTree.open_containing(file_list[0])
1284
tree2, file2 = WorkingTree.open_containing(file_list[1])
1285
if file1 != "" or file2 != "":
1286
# FIXME diff those two files. rbc 20051123
1287
raise errors.BzrCommandError("Files are in different branches")
1289
except errors.NotBranchError:
1290
if (revision is not None and len(revision) == 2
1291
and not revision[0].needs_branch()
1292
and not revision[1].needs_branch()):
1293
# If both revision specs include a branch, we can
1294
# diff them without needing a local working tree
1295
tree1, tree2 = None, None
1299
if tree2 is not None:
1300
if revision is not None:
1301
# FIXME: but there should be a clean way to diff between
1302
# non-default versions of two trees, it's not hard to do
1304
raise errors.BzrCommandError(
1305
"Sorry, diffing arbitrary revisions across branches "
1306
"is not implemented yet")
1307
return show_diff_trees(tree1, tree2, sys.stdout,
1308
specific_files=file_list,
1309
external_diff_options=diff_options,
1310
old_label=old_label, new_label=new_label)
1312
return diff_cmd_helper(tree1, file_list, diff_options,
1313
revision_specs=revision,
1314
old_label=old_label, new_label=new_label)
1317
class cmd_deleted(Command):
1318
"""List files deleted in the working tree.
1320
# TODO: Show files deleted since a previous revision, or
1321
# between two revisions.
1322
# TODO: Much more efficient way to do this: read in new
1323
# directories with readdir, rather than stating each one. Same
1324
# level of effort but possibly much less IO. (Or possibly not,
1325
# if the directories are very large...)
1326
takes_options = ['show-ids']
1329
def run(self, show_ids=False):
1330
tree = WorkingTree.open_containing(u'.')[0]
1331
old = tree.basis_tree()
1332
for path, ie in old.inventory.iter_entries():
1333
if not tree.has_id(ie.file_id):
1334
self.outf.write(path)
1336
self.outf.write(' ')
1337
self.outf.write(ie.file_id)
1338
self.outf.write('\n')
1341
class cmd_modified(Command):
1342
"""List files modified in working tree."""
1346
tree = WorkingTree.open_containing(u'.')[0]
1347
td = tree.changes_from(tree.basis_tree())
1348
for path, id, kind, text_modified, meta_modified in td.modified:
1349
self.outf.write(path + '\n')
1352
class cmd_added(Command):
1353
"""List files added in working tree."""
1357
wt = WorkingTree.open_containing(u'.')[0]
1358
basis_inv = wt.basis_tree().inventory
1361
if file_id in basis_inv:
1363
if inv.is_root(file_id) and len(basis_inv) == 0:
1365
path = inv.id2path(file_id)
1366
if not os.access(osutils.abspath(path), os.F_OK):
1368
self.outf.write(path + '\n')
1371
class cmd_root(Command):
1372
"""Show the tree root directory.
1374
The root is the nearest enclosing directory with a .bzr control
1376
takes_args = ['filename?']
1378
def run(self, filename=None):
1379
"""Print the branch root."""
1380
tree = WorkingTree.open_containing(filename)[0]
1381
self.outf.write(tree.basedir + '\n')
1384
class cmd_log(Command):
1385
"""Show log of a branch, file, or directory.
1387
By default show the log of the branch containing the working directory.
1389
To request a range of logs, you can use the command -r begin..end
1390
-r revision requests a specific revision, -r ..end or -r begin.. are
1396
bzr log -r -10.. http://server/branch
1399
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1401
takes_args = ['location?']
1402
takes_options = [Option('forward',
1403
help='show from oldest to newest'),
1407
help='show files changed in each revision'),
1408
'show-ids', 'revision',
1412
help='show revisions whose message matches this regexp',
1415
encoding_type = 'replace'
1418
def run(self, location=None, timezone='original',
1425
from bzrlib.log import show_log
1426
assert message is None or isinstance(message, basestring), \
1427
"invalid message argument %r" % message
1428
direction = (forward and 'forward') or 'reverse'
1433
# find the file id to log:
1435
dir, fp = bzrdir.BzrDir.open_containing(location)
1436
b = dir.open_branch()
1440
inv = dir.open_workingtree().inventory
1441
except (errors.NotBranchError, errors.NotLocalUrl):
1442
# either no tree, or is remote.
1443
inv = b.basis_tree().inventory
1444
file_id = inv.path2id(fp)
1446
raise errors.BzrCommandError(
1447
"Path does not have any revision history: %s" %
1451
# FIXME ? log the current subdir only RBC 20060203
1452
if revision is not None \
1453
and len(revision) > 0 and revision[0].get_branch():
1454
location = revision[0].get_branch()
1457
dir, relpath = bzrdir.BzrDir.open_containing(location)
1458
b = dir.open_branch()
1460
if revision is None:
1463
elif len(revision) == 1:
1464
rev1 = rev2 = revision[0].in_history(b).revno
1465
elif len(revision) == 2:
1466
if revision[1].get_branch() != revision[0].get_branch():
1467
# b is taken from revision[0].get_branch(), and
1468
# show_log will use its revision_history. Having
1469
# different branches will lead to weird behaviors.
1470
raise errors.BzrCommandError(
1471
"Log doesn't accept two revisions in different branches.")
1472
if revision[0].spec is None:
1473
# missing begin-range means first revision
1476
rev1 = revision[0].in_history(b).revno
1478
if revision[1].spec is None:
1479
# missing end-range means last known revision
1482
rev2 = revision[1].in_history(b).revno
1484
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1486
# By this point, the revision numbers are converted to the +ve
1487
# form if they were supplied in the -ve form, so we can do
1488
# this comparison in relative safety
1490
(rev2, rev1) = (rev1, rev2)
1492
if log_format is None:
1493
log_format = log.log_formatter_registry.get_default(b)
1495
lf = log_format(show_ids=show_ids, to_file=self.outf,
1496
show_timezone=timezone)
1502
direction=direction,
1503
start_revision=rev1,
1508
def get_log_format(long=False, short=False, line=False, default='long'):
1509
log_format = default
1513
log_format = 'short'
1519
class cmd_touching_revisions(Command):
1520
"""Return revision-ids which affected a particular file.
1522
A more user-friendly interface is "bzr log FILE".
1526
takes_args = ["filename"]
1529
def run(self, filename):
1530
tree, relpath = WorkingTree.open_containing(filename)
1532
inv = tree.read_working_inventory()
1533
file_id = inv.path2id(relpath)
1534
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1535
self.outf.write("%6d %s\n" % (revno, what))
1538
class cmd_ls(Command):
1539
"""List files in a tree.
1542
takes_args = ['path?']
1543
# TODO: Take a revision or remote path and list that tree instead.
1544
takes_options = ['verbose', 'revision',
1545
Option('non-recursive',
1546
help='don\'t recurse into sub-directories'),
1548
help='Print all paths from the root of the branch.'),
1549
Option('unknown', help='Print unknown files'),
1550
Option('versioned', help='Print versioned files'),
1551
Option('ignored', help='Print ignored files'),
1553
Option('null', help='Null separate the files'),
1557
def run(self, revision=None, verbose=False,
1558
non_recursive=False, from_root=False,
1559
unknown=False, versioned=False, ignored=False,
1560
null=False, kind=None, show_ids=False, path=None):
1562
if kind and kind not in ('file', 'directory', 'symlink'):
1563
raise errors.BzrCommandError('invalid kind specified')
1565
if verbose and null:
1566
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1567
all = not (unknown or versioned or ignored)
1569
selection = {'I':ignored, '?':unknown, 'V':versioned}
1576
raise errors.BzrCommandError('cannot specify both --from-root'
1580
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1586
if revision is not None:
1587
tree = branch.repository.revision_tree(
1588
revision[0].in_history(branch).rev_id)
1590
tree = branch.basis_tree()
1592
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1593
if fp.startswith(relpath):
1594
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1595
if non_recursive and '/' in fp:
1597
if not all and not selection[fc]:
1599
if kind is not None and fkind != kind:
1602
kindch = entry.kind_character()
1603
outstring = '%-8s %s%s' % (fc, fp, kindch)
1604
if show_ids and fid is not None:
1605
outstring = "%-50s %s" % (outstring, fid)
1606
self.outf.write(outstring + '\n')
1608
self.outf.write(fp + '\0')
1611
self.outf.write(fid)
1612
self.outf.write('\0')
1620
self.outf.write('%-50s %s\n' % (fp, my_id))
1622
self.outf.write(fp + '\n')
1625
class cmd_unknowns(Command):
1626
"""List unknown files."""
1629
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1630
self.outf.write(osutils.quotefn(f) + '\n')
1633
class cmd_ignore(Command):
1634
"""Ignore specified files or patterns.
1636
To remove patterns from the ignore list, edit the .bzrignore file.
1638
Trailing slashes on patterns are ignored.
1639
If the pattern contains a slash or is a regular expression, it is compared
1640
to the whole path from the branch root. Otherwise, it is compared to only
1641
the last component of the path. To match a file only in the root
1642
directory, prepend './'.
1644
Ignore patterns specifying absolute paths are not allowed.
1646
Ignore patterns may include globbing wildcards such as:
1647
? - Matches any single character except '/'
1648
* - Matches 0 or more characters except '/'
1649
/**/ - Matches 0 or more directories in a path
1650
[a-z] - Matches a single character from within a group of characters
1652
Ignore patterns may also be Python regular expressions.
1653
Regular expression ignore patterns are identified by a 'RE:' prefix
1654
followed by the regular expression. Regular expression ignore patterns
1655
may not include named or numbered groups.
1657
Note: ignore patterns containing shell wildcards must be quoted from
1661
bzr ignore ./Makefile
1662
bzr ignore '*.class'
1663
bzr ignore 'lib/**/*.o'
1664
bzr ignore 'RE:lib/.*\.o'
1666
takes_args = ['name_pattern*']
1668
Option('old-default-rules',
1669
help='Out the ignore rules bzr < 0.9 always used.')
1672
def run(self, name_pattern_list=None, old_default_rules=None):
1673
from bzrlib.atomicfile import AtomicFile
1674
if old_default_rules is not None:
1675
# dump the rules and exit
1676
for pattern in ignores.OLD_DEFAULTS:
1679
if not name_pattern_list:
1680
raise errors.BzrCommandError("ignore requires at least one "
1681
"NAME_PATTERN or --old-default-rules")
1682
for name_pattern in name_pattern_list:
1683
if name_pattern[0] == '/':
1684
raise errors.BzrCommandError(
1685
"NAME_PATTERN should not be an absolute path")
1686
tree, relpath = WorkingTree.open_containing(u'.')
1687
ifn = tree.abspath('.bzrignore')
1688
if os.path.exists(ifn):
1691
igns = f.read().decode('utf-8')
1697
# TODO: If the file already uses crlf-style termination, maybe
1698
# we should use that for the newly added lines?
1700
if igns and igns[-1] != '\n':
1702
for name_pattern in name_pattern_list:
1703
igns += name_pattern.rstrip('/') + '\n'
1705
f = AtomicFile(ifn, 'wb')
1707
f.write(igns.encode('utf-8'))
1712
inv = tree.inventory
1713
if inv.path2id('.bzrignore'):
1714
mutter('.bzrignore is already versioned')
1716
mutter('need to make new .bzrignore file versioned')
1717
tree.add(['.bzrignore'])
1720
class cmd_ignored(Command):
1721
"""List ignored files and the patterns that matched them.
1723
See also: bzr ignore"""
1726
tree = WorkingTree.open_containing(u'.')[0]
1727
for path, file_class, kind, file_id, entry in tree.list_files():
1728
if file_class != 'I':
1730
## XXX: Slightly inefficient since this was already calculated
1731
pat = tree.is_ignored(path)
1732
print '%-50s %s' % (path, pat)
1735
class cmd_lookup_revision(Command):
1736
"""Lookup the revision-id from a revision-number
1739
bzr lookup-revision 33
1742
takes_args = ['revno']
1745
def run(self, revno):
1749
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1751
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1754
class cmd_export(Command):
1755
"""Export past revision to destination directory.
1757
If no revision is specified this exports the last committed revision.
1759
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1760
given, try to find the format with the extension. If no extension
1761
is found exports to a directory (equivalent to --format=dir).
1763
Root may be the top directory for tar, tgz and tbz2 formats. If none
1764
is given, the top directory will be the root name of the file.
1766
If branch is omitted then the branch containing the CWD will be used.
1768
Note: export of tree with non-ascii filenames to zip is not supported.
1770
Supported formats Autodetected by extension
1771
----------------- -------------------------
1774
tbz2 .tar.bz2, .tbz2
1778
takes_args = ['dest', 'branch?']
1779
takes_options = ['revision', 'format', 'root']
1780
def run(self, dest, branch=None, revision=None, format=None, root=None):
1781
from bzrlib.export import export
1784
tree = WorkingTree.open_containing(u'.')[0]
1787
b = Branch.open(branch)
1789
if revision is None:
1790
# should be tree.last_revision FIXME
1791
rev_id = b.last_revision()
1793
if len(revision) != 1:
1794
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1795
rev_id = revision[0].in_history(b).rev_id
1796
t = b.repository.revision_tree(rev_id)
1798
export(t, dest, format, root)
1799
except errors.NoSuchExportFormat, e:
1800
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1803
class cmd_cat(Command):
1804
"""Write a file's text from a previous revision."""
1806
takes_options = ['revision', 'name-from-revision']
1807
takes_args = ['filename']
1808
encoding_type = 'exact'
1811
def run(self, filename, revision=None, name_from_revision=False):
1812
if revision is not None and len(revision) != 1:
1813
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1818
tree, relpath = WorkingTree.open_containing(filename)
1820
except (errors.NotBranchError, errors.NotLocalUrl):
1823
if revision is not None and revision[0].get_branch() is not None:
1824
b = Branch.open(revision[0].get_branch())
1826
b, relpath = Branch.open_containing(filename)
1827
tree = b.basis_tree()
1828
if revision is None:
1829
revision_id = b.last_revision()
1831
revision_id = revision[0].in_history(b).rev_id
1833
cur_file_id = tree.path2id(relpath)
1834
rev_tree = b.repository.revision_tree(revision_id)
1835
old_file_id = rev_tree.path2id(relpath)
1837
if name_from_revision:
1838
if old_file_id is None:
1839
raise errors.BzrCommandError("%r is not present in revision %s"
1840
% (filename, revision_id))
1842
rev_tree.print_file(old_file_id)
1843
elif cur_file_id is not None:
1844
rev_tree.print_file(cur_file_id)
1845
elif old_file_id is not None:
1846
rev_tree.print_file(old_file_id)
1848
raise errors.BzrCommandError("%r is not present in revision %s" %
1849
(filename, revision_id))
1852
class cmd_local_time_offset(Command):
1853
"""Show the offset in seconds from GMT to local time."""
1857
print osutils.local_time_offset()
1861
class cmd_commit(Command):
1862
"""Commit changes into a new revision.
1864
If no arguments are given, the entire tree is committed.
1866
If selected files are specified, only changes to those files are
1867
committed. If a directory is specified then the directory and everything
1868
within it is committed.
1870
A selected-file commit may fail in some cases where the committed
1871
tree would be invalid, such as trying to commit a file in a
1872
newly-added directory that is not itself committed.
1874
# TODO: Run hooks on tree to-be-committed, and after commit.
1876
# TODO: Strict commit that fails if there are deleted files.
1877
# (what does "deleted files" mean ??)
1879
# TODO: Give better message for -s, --summary, used by tla people
1881
# XXX: verbose currently does nothing
1883
takes_args = ['selected*']
1884
takes_options = ['message', 'verbose',
1886
help='commit even if nothing has changed'),
1887
Option('file', type=str,
1890
help='file containing commit message'),
1892
help="refuse to commit if there are unknown "
1893
"files in the working tree."),
1895
help="perform a local only commit in a bound "
1896
"branch. Such commits are not pushed to "
1897
"the master branch until a normal commit "
1901
aliases = ['ci', 'checkin']
1903
def run(self, message=None, file=None, verbose=True, selected_list=None,
1904
unchanged=False, strict=False, local=False):
1905
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1906
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1908
from bzrlib.msgeditor import edit_commit_message, \
1909
make_commit_message_template
1911
# TODO: Need a blackbox test for invoking the external editor; may be
1912
# slightly problematic to run this cross-platform.
1914
# TODO: do more checks that the commit will succeed before
1915
# spending the user's valuable time typing a commit message.
1916
tree, selected_list = tree_files(selected_list)
1917
if selected_list == ['']:
1918
# workaround - commit of root of tree should be exactly the same
1919
# as just default commit in that tree, and succeed even though
1920
# selected-file merge commit is not done yet
1923
if local and not tree.branch.get_bound_location():
1924
raise errors.LocalRequiresBoundBranch()
1926
def get_message(commit_obj):
1927
"""Callback to get commit message"""
1928
my_message = message
1929
if my_message is None and not file:
1930
template = make_commit_message_template(tree, selected_list)
1931
my_message = edit_commit_message(template)
1932
if my_message is None:
1933
raise errors.BzrCommandError("please specify a commit"
1934
" message with either --message or --file")
1935
elif my_message and file:
1936
raise errors.BzrCommandError(
1937
"please specify either --message or --file")
1939
my_message = codecs.open(file, 'rt',
1940
bzrlib.user_encoding).read()
1941
if my_message == "":
1942
raise errors.BzrCommandError("empty commit message specified")
1946
reporter = ReportCommitToLog()
1948
reporter = NullCommitReporter()
1951
tree.commit(message_callback=get_message,
1952
specific_files=selected_list,
1953
allow_pointless=unchanged, strict=strict, local=local,
1955
except PointlessCommit:
1956
# FIXME: This should really happen before the file is read in;
1957
# perhaps prepare the commit; get the message; then actually commit
1958
raise errors.BzrCommandError("no changes to commit."
1959
" use --unchanged to commit anyhow")
1960
except ConflictsInTree:
1961
raise errors.BzrCommandError('Conflicts detected in working '
1962
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
1964
except StrictCommitFailed:
1965
raise errors.BzrCommandError("Commit refused because there are"
1966
" unknown files in the working tree.")
1967
except errors.BoundBranchOutOfDate, e:
1968
raise errors.BzrCommandError(str(e) + "\n"
1969
'To commit to master branch, run update and then commit.\n'
1970
'You can also pass --local to commit to continue working '
1974
class cmd_check(Command):
1975
"""Validate consistency of branch history.
1977
This command checks various invariants about the branch storage to
1978
detect data corruption or bzr bugs.
1980
takes_args = ['branch?']
1981
takes_options = ['verbose']
1983
def run(self, branch=None, verbose=False):
1984
from bzrlib.check import check
1986
tree = WorkingTree.open_containing()[0]
1987
branch = tree.branch
1989
branch = Branch.open(branch)
1990
check(branch, verbose)
1993
class cmd_upgrade(Command):
1994
"""Upgrade branch storage to current format.
1996
The check command or bzr developers may sometimes advise you to run
1997
this command. When the default format has changed you may also be warned
1998
during other operations to upgrade.
2000
takes_args = ['url?']
2002
RegistryOption('format',
2003
help='Upgrade to a specific format. See "bzr help'
2004
' formats" for details',
2005
registry=bzrdir.format_registry,
2006
converter=bzrdir.format_registry.make_bzrdir,
2007
value_switches=True, title='Branch format'),
2011
def run(self, url='.', format=None):
2012
from bzrlib.upgrade import upgrade
2014
format = bzrdir.format_registry.make_bzrdir('default')
2015
upgrade(url, format)
2018
class cmd_whoami(Command):
2019
"""Show or set bzr user id.
2023
bzr whoami 'Frank Chu <fchu@example.com>'
2025
takes_options = [ Option('email',
2026
help='display email address only'),
2028
help='set identity for the current branch instead of '
2031
takes_args = ['name?']
2032
encoding_type = 'replace'
2035
def run(self, email=False, branch=False, name=None):
2037
# use branch if we're inside one; otherwise global config
2039
c = Branch.open_containing('.')[0].get_config()
2040
except errors.NotBranchError:
2041
c = config.GlobalConfig()
2043
self.outf.write(c.user_email() + '\n')
2045
self.outf.write(c.username() + '\n')
2048
# display a warning if an email address isn't included in the given name.
2050
config.extract_email_address(name)
2051
except errors.NoEmailInUsername, e:
2052
warning('"%s" does not seem to contain an email address. '
2053
'This is allowed, but not recommended.', name)
2055
# use global config unless --branch given
2057
c = Branch.open_containing('.')[0].get_config()
2059
c = config.GlobalConfig()
2060
c.set_user_option('email', name)
2063
class cmd_nick(Command):
2064
"""Print or set the branch nickname.
2066
If unset, the tree root directory name is used as the nickname
2067
To print the current nickname, execute with no argument.
2069
takes_args = ['nickname?']
2070
def run(self, nickname=None):
2071
branch = Branch.open_containing(u'.')[0]
2072
if nickname is None:
2073
self.printme(branch)
2075
branch.nick = nickname
2078
def printme(self, branch):
2082
class cmd_selftest(Command):
2083
"""Run internal test suite.
2085
This creates temporary test directories in the working directory, but not
2086
existing data is affected. These directories are deleted if the tests
2087
pass, or left behind to help in debugging if they fail and --keep-output
2090
If arguments are given, they are regular expressions that say which tests
2091
should run. Tests matching any expression are run, and other tests are
2094
Alternatively if --first is given, matching tests are run first and then
2095
all other tests are run. This is useful if you have been working in a
2096
particular area, but want to make sure nothing else was broken.
2098
If the global option '--no-plugins' is given, plugins are not loaded
2099
before running the selftests. This has two effects: features provided or
2100
modified by plugins will not be tested, and tests provided by plugins will
2105
run only tests relating to 'ignore'
2106
bzr --no-plugins selftest -v
2107
disable plugins and list tests as they're run
2109
# TODO: --list should give a list of all available tests
2111
# NB: this is used from the class without creating an instance, which is
2112
# why it does not have a self parameter.
2113
def get_transport_type(typestring):
2114
"""Parse and return a transport specifier."""
2115
if typestring == "sftp":
2116
from bzrlib.transport.sftp import SFTPAbsoluteServer
2117
return SFTPAbsoluteServer
2118
if typestring == "memory":
2119
from bzrlib.transport.memory import MemoryServer
2121
if typestring == "fakenfs":
2122
from bzrlib.transport.fakenfs import FakeNFSServer
2123
return FakeNFSServer
2124
msg = "No known transport type %s. Supported types are: sftp\n" %\
2126
raise errors.BzrCommandError(msg)
2129
takes_args = ['testspecs*']
2130
takes_options = ['verbose',
2131
Option('one', help='stop when one test fails'),
2132
Option('keep-output',
2133
help='keep output directories when tests fail'),
2135
help='Use a different transport by default '
2136
'throughout the test suite.',
2137
type=get_transport_type),
2138
Option('benchmark', help='run the bzr bencharks.'),
2139
Option('lsprof-timed',
2140
help='generate lsprof output for benchmarked'
2141
' sections of code.'),
2142
Option('cache-dir', type=str,
2143
help='a directory to cache intermediate'
2144
' benchmark steps'),
2145
Option('clean-output',
2146
help='clean temporary tests directories'
2147
' without running tests'),
2149
help='run all tests, but run specified tests first',
2152
encoding_type = 'replace'
2154
def run(self, testspecs_list=None, verbose=None, one=False,
2155
keep_output=False, transport=None, benchmark=None,
2156
lsprof_timed=None, cache_dir=None, clean_output=False,
2159
from bzrlib.tests import selftest
2160
import bzrlib.benchmarks as benchmarks
2161
from bzrlib.benchmarks import tree_creator
2164
from bzrlib.tests import clean_selftest_output
2165
clean_selftest_output()
2168
if cache_dir is not None:
2169
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2170
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2171
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2173
if testspecs_list is not None:
2174
pattern = '|'.join(testspecs_list)
2178
test_suite_factory = benchmarks.test_suite
2181
# TODO: should possibly lock the history file...
2182
benchfile = open(".perf_history", "at", buffering=1)
2184
test_suite_factory = None
2189
result = selftest(verbose=verbose,
2191
stop_on_failure=one,
2192
keep_output=keep_output,
2193
transport=transport,
2194
test_suite_factory=test_suite_factory,
2195
lsprof_timed=lsprof_timed,
2196
bench_history=benchfile,
2197
matching_tests_first=first,
2200
if benchfile is not None:
2203
info('tests passed')
2205
info('tests failed')
2206
return int(not result)
2209
class cmd_version(Command):
2210
"""Show version of bzr."""
2214
from bzrlib.version import show_version
2218
class cmd_rocks(Command):
2219
"""Statement of optimism."""
2225
print "it sure does!"
2228
class cmd_find_merge_base(Command):
2229
"""Find and print a base revision for merging two branches."""
2230
# TODO: Options to specify revisions on either side, as if
2231
# merging only part of the history.
2232
takes_args = ['branch', 'other']
2236
def run(self, branch, other):
2237
from bzrlib.revision import MultipleRevisionSources
2239
branch1 = Branch.open_containing(branch)[0]
2240
branch2 = Branch.open_containing(other)[0]
2242
last1 = branch1.last_revision()
2243
last2 = branch2.last_revision()
2245
source = MultipleRevisionSources(branch1.repository,
2248
base_rev_id = common_ancestor(last1, last2, source)
2250
print 'merge base is revision %s' % base_rev_id
2253
class cmd_merge(Command):
2254
"""Perform a three-way merge.
2256
The branch is the branch you will merge from. By default, it will merge
2257
the latest revision. If you specify a revision, that revision will be
2258
merged. If you specify two revisions, the first will be used as a BASE,
2259
and the second one as OTHER. Revision numbers are always relative to the
2262
By default, bzr will try to merge in all new work from the other
2263
branch, automatically determining an appropriate base. If this
2264
fails, you may need to give an explicit base.
2266
Merge will do its best to combine the changes in two branches, but there
2267
are some kinds of problems only a human can fix. When it encounters those,
2268
it will mark a conflict. A conflict means that you need to fix something,
2269
before you should commit.
2271
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2273
If there is no default branch set, the first merge will set it. After
2274
that, you can omit the branch to use the default. To change the
2275
default, use --remember. The value will only be saved if the remote
2276
location can be accessed.
2280
To merge the latest revision from bzr.dev
2281
bzr merge ../bzr.dev
2283
To merge changes up to and including revision 82 from bzr.dev
2284
bzr merge -r 82 ../bzr.dev
2286
To merge the changes introduced by 82, without previous changes:
2287
bzr merge -r 81..82 ../bzr.dev
2289
merge refuses to run if there are any uncommitted changes, unless
2292
The following merge types are available:
2294
takes_args = ['branch?']
2295
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2296
Option('show-base', help="Show base revision text in "
2298
Option('uncommitted', help='Apply uncommitted changes'
2299
' from a working copy, instead of branch changes'),
2300
Option('pull', help='If the destination is already'
2301
' completely merged into the source, pull from the'
2302
' source rather than merging. When this happens,'
2303
' you do not need to commit the result.'),
2307
from inspect import getdoc
2308
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2310
def run(self, branch=None, revision=None, force=False, merge_type=None,
2311
show_base=False, reprocess=False, remember=False,
2312
uncommitted=False, pull=False):
2313
if merge_type is None:
2314
merge_type = _mod_merge.Merge3Merger
2316
tree = WorkingTree.open_containing(u'.')[0]
2318
if branch is not None:
2320
reader = bundle.read_bundle_from_url(branch)
2321
except errors.NotABundle:
2322
pass # Continue on considering this url a Branch
2324
conflicts = merge_bundle(reader, tree, not force, merge_type,
2325
reprocess, show_base)
2331
if revision is None \
2332
or len(revision) < 1 or revision[0].needs_branch():
2333
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2335
if revision is None or len(revision) < 1:
2338
other = [branch, None]
2341
other = [branch, -1]
2342
other_branch, path = Branch.open_containing(branch)
2345
raise errors.BzrCommandError('Cannot use --uncommitted and'
2346
' --revision at the same time.')
2347
branch = revision[0].get_branch() or branch
2348
if len(revision) == 1:
2350
other_branch, path = Branch.open_containing(branch)
2351
revno = revision[0].in_history(other_branch).revno
2352
other = [branch, revno]
2354
assert len(revision) == 2
2355
if None in revision:
2356
raise errors.BzrCommandError(
2357
"Merge doesn't permit empty revision specifier.")
2358
base_branch, path = Branch.open_containing(branch)
2359
branch1 = revision[1].get_branch() or branch
2360
other_branch, path1 = Branch.open_containing(branch1)
2361
if revision[0].get_branch() is not None:
2362
# then path was obtained from it, and is None.
2365
base = [branch, revision[0].in_history(base_branch).revno]
2366
other = [branch1, revision[1].in_history(other_branch).revno]
2368
if tree.branch.get_parent() is None or remember:
2369
tree.branch.set_parent(other_branch.base)
2372
interesting_files = [path]
2374
interesting_files = None
2375
pb = ui.ui_factory.nested_progress_bar()
2378
conflict_count = _merge_helper(
2379
other, base, check_clean=(not force),
2380
merge_type=merge_type,
2381
reprocess=reprocess,
2382
show_base=show_base,
2384
pb=pb, file_list=interesting_files)
2387
if conflict_count != 0:
2391
except errors.AmbiguousBase, e:
2392
m = ("sorry, bzr can't determine the right merge base yet\n"
2393
"candidates are:\n "
2394
+ "\n ".join(e.bases)
2396
"please specify an explicit base with -r,\n"
2397
"and (if you want) report this to the bzr developers\n")
2400
# TODO: move up to common parent; this isn't merge-specific anymore.
2401
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2402
"""Use tree.branch's parent if none was supplied.
2404
Report if the remembered location was used.
2406
if supplied_location is not None:
2407
return supplied_location
2408
stored_location = tree.branch.get_parent()
2409
mutter("%s", stored_location)
2410
if stored_location is None:
2411
raise errors.BzrCommandError("No location specified or remembered")
2412
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2413
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2414
return stored_location
2417
class cmd_remerge(Command):
2420
Use this if you want to try a different merge technique while resolving
2421
conflicts. Some merge techniques are better than others, and remerge
2422
lets you try different ones on different files.
2424
The options for remerge have the same meaning and defaults as the ones for
2425
merge. The difference is that remerge can (only) be run when there is a
2426
pending merge, and it lets you specify particular files.
2429
$ bzr remerge --show-base
2430
Re-do the merge of all conflicted files, and show the base text in
2431
conflict regions, in addition to the usual THIS and OTHER texts.
2433
$ bzr remerge --merge-type weave --reprocess foobar
2434
Re-do the merge of "foobar", using the weave merge algorithm, with
2435
additional processing to reduce the size of conflict regions.
2437
The following merge types are available:"""
2438
takes_args = ['file*']
2439
takes_options = ['merge-type', 'reprocess',
2440
Option('show-base', help="Show base revision text in "
2444
from inspect import getdoc
2445
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2447
def run(self, file_list=None, merge_type=None, show_base=False,
2449
if merge_type is None:
2450
merge_type = _mod_merge.Merge3Merger
2451
tree, file_list = tree_files(file_list)
2454
parents = tree.get_parent_ids()
2455
if len(parents) != 2:
2456
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2457
" merges. Not cherrypicking or"
2459
repository = tree.branch.repository
2460
base_revision = common_ancestor(parents[0],
2461
parents[1], repository)
2462
base_tree = repository.revision_tree(base_revision)
2463
other_tree = repository.revision_tree(parents[1])
2464
interesting_ids = None
2466
conflicts = tree.conflicts()
2467
if file_list is not None:
2468
interesting_ids = set()
2469
for filename in file_list:
2470
file_id = tree.path2id(filename)
2472
raise errors.NotVersionedError(filename)
2473
interesting_ids.add(file_id)
2474
if tree.kind(file_id) != "directory":
2477
for name, ie in tree.inventory.iter_entries(file_id):
2478
interesting_ids.add(ie.file_id)
2479
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2481
# Remerge only supports resolving contents conflicts
2482
allowed_conflicts = ('text conflict', 'contents conflict')
2483
restore_files = [c.path for c in conflicts
2484
if c.typestring in allowed_conflicts]
2485
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2486
tree.set_conflicts(ConflictList(new_conflicts))
2487
if file_list is not None:
2488
restore_files = file_list
2489
for filename in restore_files:
2491
restore(tree.abspath(filename))
2492
except errors.NotConflicted:
2494
conflicts = _mod_merge.merge_inner(
2495
tree.branch, other_tree, base_tree,
2497
interesting_ids=interesting_ids,
2498
other_rev_id=parents[1],
2499
merge_type=merge_type,
2500
show_base=show_base,
2501
reprocess=reprocess)
2510
class cmd_revert(Command):
2511
"""Revert files to a previous revision.
2513
Giving a list of files will revert only those files. Otherwise, all files
2514
will be reverted. If the revision is not specified with '--revision', the
2515
last committed revision is used.
2517
To remove only some changes, without reverting to a prior version, use
2518
merge instead. For example, "merge . --r-2..-3" will remove the changes
2519
introduced by -2, without affecting the changes introduced by -1. Or
2520
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2522
By default, any files that have been manually changed will be backed up
2523
first. (Files changed only by merge are not backed up.) Backup files have
2524
'.~#~' appended to their name, where # is a number.
2526
When you provide files, you can use their current pathname or the pathname
2527
from the target revision. So you can use revert to "undelete" a file by
2528
name. If you name a directory, all the contents of that directory will be
2531
takes_options = ['revision', 'no-backup']
2532
takes_args = ['file*']
2533
aliases = ['merge-revert']
2535
def run(self, revision=None, no_backup=False, file_list=None):
2536
if file_list is not None:
2537
if len(file_list) == 0:
2538
raise errors.BzrCommandError("No files specified")
2542
tree, file_list = tree_files(file_list)
2543
if revision is None:
2544
# FIXME should be tree.last_revision
2545
rev_id = tree.last_revision()
2546
elif len(revision) != 1:
2547
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2549
rev_id = revision[0].in_history(tree.branch).rev_id
2550
pb = ui.ui_factory.nested_progress_bar()
2552
tree.revert(file_list,
2553
tree.branch.repository.revision_tree(rev_id),
2554
not no_backup, pb, report_changes=True)
2559
class cmd_assert_fail(Command):
2560
"""Test reporting of assertion failures"""
2561
# intended just for use in testing
2566
raise AssertionError("always fails")
2569
class cmd_help(Command):
2570
"""Show help on a command or other topic.
2572
For a list of all available commands, say 'bzr help commands'.
2574
takes_options = [Option('long', 'show help on all commands')]
2575
takes_args = ['topic?']
2576
aliases = ['?', '--help', '-?', '-h']
2579
def run(self, topic=None, long=False):
2581
if topic is None and long:
2583
bzrlib.help.help(topic)
2586
class cmd_shell_complete(Command):
2587
"""Show appropriate completions for context.
2589
For a list of all available commands, say 'bzr shell-complete'.
2591
takes_args = ['context?']
2596
def run(self, context=None):
2597
import shellcomplete
2598
shellcomplete.shellcomplete(context)
2601
class cmd_fetch(Command):
2602
"""Copy in history from another branch but don't merge it.
2604
This is an internal method used for pull and merge.
2607
takes_args = ['from_branch', 'to_branch']
2608
def run(self, from_branch, to_branch):
2609
from bzrlib.fetch import Fetcher
2610
from_b = Branch.open(from_branch)
2611
to_b = Branch.open(to_branch)
2612
Fetcher(to_b, from_b)
2615
class cmd_missing(Command):
2616
"""Show unmerged/unpulled revisions between two branches.
2618
OTHER_BRANCH may be local or remote.
2620
takes_args = ['other_branch?']
2621
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2623
'Display changes in the local branch only'),
2624
Option('theirs-only',
2625
'Display changes in the remote branch only'),
2630
encoding_type = 'replace'
2633
def run(self, other_branch=None, reverse=False, mine_only=False,
2634
theirs_only=False, log_format=None, long=False, short=False, line=False,
2635
show_ids=False, verbose=False):
2636
from bzrlib.missing import find_unmerged, iter_log_data
2637
from bzrlib.log import log_formatter
2638
local_branch = Branch.open_containing(u".")[0]
2639
parent = local_branch.get_parent()
2640
if other_branch is None:
2641
other_branch = parent
2642
if other_branch is None:
2643
raise errors.BzrCommandError("No peer location known or specified.")
2644
display_url = urlutils.unescape_for_display(parent,
2646
print "Using last location: " + display_url
2648
remote_branch = Branch.open(other_branch)
2649
if remote_branch.base == local_branch.base:
2650
remote_branch = local_branch
2651
local_branch.lock_read()
2653
remote_branch.lock_read()
2655
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2656
if (log_format is None):
2657
log_format = log.log_formatter_registry.get_default(
2659
lf = log_format(to_file=self.outf,
2661
show_timezone='original')
2662
if reverse is False:
2663
local_extra.reverse()
2664
remote_extra.reverse()
2665
if local_extra and not theirs_only:
2666
print "You have %d extra revision(s):" % len(local_extra)
2667
for data in iter_log_data(local_extra, local_branch.repository,
2670
printed_local = True
2672
printed_local = False
2673
if remote_extra and not mine_only:
2674
if printed_local is True:
2676
print "You are missing %d revision(s):" % len(remote_extra)
2677
for data in iter_log_data(remote_extra, remote_branch.repository,
2680
if not remote_extra and not local_extra:
2682
print "Branches are up to date."
2686
remote_branch.unlock()
2688
local_branch.unlock()
2689
if not status_code and parent is None and other_branch is not None:
2690
local_branch.lock_write()
2692
# handle race conditions - a parent might be set while we run.
2693
if local_branch.get_parent() is None:
2694
local_branch.set_parent(remote_branch.base)
2696
local_branch.unlock()
2700
class cmd_plugins(Command):
2705
import bzrlib.plugin
2706
from inspect import getdoc
2707
for name, plugin in bzrlib.plugin.all_plugins().items():
2708
if getattr(plugin, '__path__', None) is not None:
2709
print plugin.__path__[0]
2710
elif getattr(plugin, '__file__', None) is not None:
2711
print plugin.__file__
2717
print '\t', d.split('\n')[0]
2720
class cmd_testament(Command):
2721
"""Show testament (signing-form) of a revision."""
2722
takes_options = ['revision',
2723
Option('long', help='Produce long-format testament'),
2724
Option('strict', help='Produce a strict-format'
2726
takes_args = ['branch?']
2728
def run(self, branch=u'.', revision=None, long=False, strict=False):
2729
from bzrlib.testament import Testament, StrictTestament
2731
testament_class = StrictTestament
2733
testament_class = Testament
2734
b = WorkingTree.open_containing(branch)[0].branch
2737
if revision is None:
2738
rev_id = b.last_revision()
2740
rev_id = revision[0].in_history(b).rev_id
2741
t = testament_class.from_revision(b.repository, rev_id)
2743
sys.stdout.writelines(t.as_text_lines())
2745
sys.stdout.write(t.as_short_text())
2750
class cmd_annotate(Command):
2751
"""Show the origin of each line in a file.
2753
This prints out the given file with an annotation on the left side
2754
indicating which revision, author and date introduced the change.
2756
If the origin is the same for a run of consecutive lines, it is
2757
shown only at the top, unless the --all option is given.
2759
# TODO: annotate directories; showing when each file was last changed
2760
# TODO: if the working copy is modified, show annotations on that
2761
# with new uncommitted lines marked
2762
aliases = ['ann', 'blame', 'praise']
2763
takes_args = ['filename']
2764
takes_options = [Option('all', help='show annotations on all lines'),
2765
Option('long', help='show date in annotations'),
2771
def run(self, filename, all=False, long=False, revision=None,
2773
from bzrlib.annotate import annotate_file
2774
tree, relpath = WorkingTree.open_containing(filename)
2775
branch = tree.branch
2778
if revision is None:
2779
revision_id = branch.last_revision()
2780
elif len(revision) != 1:
2781
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2783
revision_id = revision[0].in_history(branch).rev_id
2784
file_id = tree.inventory.path2id(relpath)
2785
tree = branch.repository.revision_tree(revision_id)
2786
file_version = tree.inventory[file_id].revision
2787
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2793
class cmd_re_sign(Command):
2794
"""Create a digital signature for an existing revision."""
2795
# TODO be able to replace existing ones.
2797
hidden = True # is this right ?
2798
takes_args = ['revision_id*']
2799
takes_options = ['revision']
2801
def run(self, revision_id_list=None, revision=None):
2802
import bzrlib.gpg as gpg
2803
if revision_id_list is not None and revision is not None:
2804
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2805
if revision_id_list is None and revision is None:
2806
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2807
b = WorkingTree.open_containing(u'.')[0].branch
2808
gpg_strategy = gpg.GPGStrategy(b.get_config())
2809
if revision_id_list is not None:
2810
for revision_id in revision_id_list:
2811
b.repository.sign_revision(revision_id, gpg_strategy)
2812
elif revision is not None:
2813
if len(revision) == 1:
2814
revno, rev_id = revision[0].in_history(b)
2815
b.repository.sign_revision(rev_id, gpg_strategy)
2816
elif len(revision) == 2:
2817
# are they both on rh- if so we can walk between them
2818
# might be nice to have a range helper for arbitrary
2819
# revision paths. hmm.
2820
from_revno, from_revid = revision[0].in_history(b)
2821
to_revno, to_revid = revision[1].in_history(b)
2822
if to_revid is None:
2823
to_revno = b.revno()
2824
if from_revno is None or to_revno is None:
2825
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2826
for revno in range(from_revno, to_revno + 1):
2827
b.repository.sign_revision(b.get_rev_id(revno),
2830
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2833
class cmd_bind(Command):
2834
"""Bind the current branch to a master branch.
2836
After binding, commits must succeed on the master branch
2837
before they are executed on the local one, turning the current branch
2838
in to a checkout of the master.
2840
See "help checkouts" for more information on checkouts.
2843
takes_args = ['location']
2846
def run(self, location=None):
2847
b, relpath = Branch.open_containing(u'.')
2848
b_other = Branch.open(location)
2851
except errors.DivergedBranches:
2852
raise errors.BzrCommandError('These branches have diverged.'
2853
' Try merging, and then bind again.')
2856
class cmd_unbind(Command):
2857
"""Unbind the current branch from its master branch.
2859
After unbinding, the local branch is considered independent.
2860
All subsequent commits will be local. This turns a heavy checkout into
2863
See "help checkouts" for more information on checkouts.
2870
b, relpath = Branch.open_containing(u'.')
2872
raise errors.BzrCommandError('Local branch is not bound')
2875
class cmd_uncommit(Command):
2876
"""Remove the last committed revision.
2878
--verbose will print out what is being removed.
2879
--dry-run will go through all the motions, but not actually
2882
In the future, uncommit will create a revision bundle, which can then
2886
# TODO: jam 20060108 Add an option to allow uncommit to remove
2887
# unreferenced information in 'branch-as-repository' branches.
2888
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2889
# information in shared branches as well.
2890
takes_options = ['verbose', 'revision',
2891
Option('dry-run', help='Don\'t actually make changes'),
2892
Option('force', help='Say yes to all questions.')]
2893
takes_args = ['location?']
2896
def run(self, location=None,
2897
dry_run=False, verbose=False,
2898
revision=None, force=False):
2899
from bzrlib.log import log_formatter, show_log
2901
from bzrlib.uncommit import uncommit
2903
if location is None:
2905
control, relpath = bzrdir.BzrDir.open_containing(location)
2907
tree = control.open_workingtree()
2909
except (errors.NoWorkingTree, errors.NotLocalUrl):
2911
b = control.open_branch()
2914
if revision is None:
2917
# 'bzr uncommit -r 10' actually means uncommit
2918
# so that the final tree is at revno 10.
2919
# but bzrlib.uncommit.uncommit() actually uncommits
2920
# the revisions that are supplied.
2921
# So we need to offset it by one
2922
revno = revision[0].in_history(b).revno+1
2924
if revno <= b.revno():
2925
rev_id = b.get_rev_id(revno)
2927
self.outf.write('No revisions to uncommit.\n')
2930
lf = log_formatter('short',
2932
show_timezone='original')
2937
direction='forward',
2938
start_revision=revno,
2939
end_revision=b.revno())
2942
print 'Dry-run, pretending to remove the above revisions.'
2944
val = raw_input('Press <enter> to continue')
2946
print 'The above revision(s) will be removed.'
2948
val = raw_input('Are you sure [y/N]? ')
2949
if val.lower() not in ('y', 'yes'):
2953
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2957
class cmd_break_lock(Command):
2958
"""Break a dead lock on a repository, branch or working directory.
2960
CAUTION: Locks should only be broken when you are sure that the process
2961
holding the lock has been stopped.
2963
You can get information on what locks are open via the 'bzr info' command.
2968
takes_args = ['location?']
2970
def run(self, location=None, show=False):
2971
if location is None:
2973
control, relpath = bzrdir.BzrDir.open_containing(location)
2975
control.break_lock()
2976
except NotImplementedError:
2980
class cmd_wait_until_signalled(Command):
2981
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
2983
This just prints a line to signal when it is ready, then blocks on stdin.
2989
sys.stdout.write("running\n")
2991
sys.stdin.readline()
2994
class cmd_serve(Command):
2995
"""Run the bzr server."""
2997
aliases = ['server']
3001
help='serve on stdin/out for use from inetd or sshd'),
3003
help='listen for connections on nominated port of the form '
3004
'[hostname:]portnumber. Passing 0 as the port number will '
3005
'result in a dynamically allocated port.',
3008
help='serve contents of directory',
3010
Option('allow-writes',
3011
help='By default the server is a readonly server. Supplying '
3012
'--allow-writes enables write access to the contents of '
3013
'the served directory and below. '
3017
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3018
from bzrlib.transport import smart
3019
from bzrlib.transport import get_transport
3020
if directory is None:
3021
directory = os.getcwd()
3022
url = urlutils.local_path_to_url(directory)
3023
if not allow_writes:
3024
url = 'readonly+' + url
3025
t = get_transport(url)
3027
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3028
elif port is not None:
3030
host, port = port.split(':')
3033
server = smart.SmartTCPServer(t, host=host, port=int(port))
3034
print 'listening on port: ', server.port
3037
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3041
# command-line interpretation helper for merge-related commands
3042
def _merge_helper(other_revision, base_revision,
3043
check_clean=True, ignore_zero=False,
3044
this_dir=None, backup_files=False,
3046
file_list=None, show_base=False, reprocess=False,
3048
pb=DummyProgress()):
3049
"""Merge changes into a tree.
3052
list(path, revno) Base for three-way merge.
3053
If [None, None] then a base will be automatically determined.
3055
list(path, revno) Other revision for three-way merge.
3057
Directory to merge changes into; '.' by default.
3059
If true, this_dir must have no uncommitted changes before the
3061
ignore_zero - If true, suppress the "zero conflicts" message when
3062
there are no conflicts; should be set when doing something we expect
3063
to complete perfectly.
3064
file_list - If supplied, merge only changes to selected files.
3066
All available ancestors of other_revision and base_revision are
3067
automatically pulled into the branch.
3069
The revno may be -1 to indicate the last revision on the branch, which is
3072
This function is intended for use from the command line; programmatic
3073
clients might prefer to call merge.merge_inner(), which has less magic
3076
# Loading it late, so that we don't always have to import bzrlib.merge
3077
if merge_type is None:
3078
merge_type = _mod_merge.Merge3Merger
3079
if this_dir is None:
3081
this_tree = WorkingTree.open_containing(this_dir)[0]
3082
if show_base and not merge_type is _mod_merge.Merge3Merger:
3083
raise errors.BzrCommandError("Show-base is not supported for this merge"
3084
" type. %s" % merge_type)
3085
if reprocess and not merge_type.supports_reprocess:
3086
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3087
" type %s." % merge_type)
3088
if reprocess and show_base:
3089
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3091
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3093
merger.pp = ProgressPhase("Merge phase", 5, pb)
3094
merger.pp.next_phase()
3095
merger.check_basis(check_clean)
3096
merger.set_other(other_revision)
3097
merger.pp.next_phase()
3098
merger.set_base(base_revision)
3099
if merger.base_rev_id == merger.other_rev_id:
3100
note('Nothing to do.')
3102
if file_list is None:
3103
if pull and merger.base_rev_id == merger.this_rev_id:
3104
count = merger.this_tree.pull(merger.this_branch,
3105
False, merger.other_rev_id)
3106
note('%d revision(s) pulled.' % (count,))
3108
merger.backup_files = backup_files
3109
merger.merge_type = merge_type
3110
merger.set_interesting_files(file_list)
3111
merger.show_base = show_base
3112
merger.reprocess = reprocess
3113
conflicts = merger.do_merge()
3114
if file_list is None:
3115
merger.set_pending()
3122
merge = _merge_helper
3125
# these get imported and then picked up by the scan for cmd_*
3126
# TODO: Some more consistent way to split command definitions across files;
3127
# we do need to load at least some information about them to know of
3128
# aliases. ideally we would avoid loading the implementation until the
3129
# details were needed.
3130
from bzrlib.cmd_version_info import cmd_version_info
3131
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3132
from bzrlib.bundle.commands import cmd_bundle_revisions
3133
from bzrlib.sign_my_commits import cmd_sign_my_commits
3134
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3135
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
