1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
47
from bzrlib.branch import Branch
48
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
49
from bzrlib.conflicts import ConflictList
50
from bzrlib.revision import common_ancestor
51
from bzrlib.revisionspec import RevisionSpec
52
from bzrlib.workingtree import WorkingTree
55
from bzrlib.commands import Command, display_command
56
from bzrlib.option import Option, RegistryOption
57
from bzrlib.progress import DummyProgress, ProgressPhase
58
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
61
def tree_files(file_list, default_branch=u'.'):
63
return internal_tree_files(file_list, default_branch)
64
except errors.FileInWrongBranch, e:
65
raise errors.BzrCommandError("%s is not in the same branch as %s" %
66
(e.path, file_list[0]))
69
# XXX: Bad function name; should possibly also be a class method of
70
# WorkingTree rather than a function.
71
def internal_tree_files(file_list, default_branch=u'.'):
72
"""Convert command-line paths to a WorkingTree and relative paths.
74
This is typically used for command-line processors that take one or
75
more filenames, and infer the workingtree that contains them.
77
The filenames given are not required to exist.
79
:param file_list: Filenames to convert.
81
:param default_branch: Fallback tree path to use if file_list is empty or
84
:return: workingtree, [relative_paths]
86
if file_list is None or len(file_list) == 0:
87
return WorkingTree.open_containing(default_branch)[0], file_list
88
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
90
for filename in file_list:
92
new_list.append(tree.relpath(osutils.dereference_path(filename)))
93
except errors.PathNotChild:
94
raise errors.FileInWrongBranch(tree.branch, filename)
98
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
99
def get_format_type(typestring):
100
"""Parse and return a format specifier."""
101
# Have to use BzrDirMetaFormat1 directly, so that
102
# RepositoryFormat.set_default_format works
103
if typestring == "default":
104
return bzrdir.BzrDirMetaFormat1()
106
return bzrdir.format_registry.make_bzrdir(typestring)
108
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
109
raise errors.BzrCommandError(msg)
112
# TODO: Make sure no commands unconditionally use the working directory as a
113
# branch. If a filename argument is used, the first of them should be used to
114
# specify the branch. (Perhaps this can be factored out into some kind of
115
# Argument class, representing a file in a branch, where the first occurrence
118
class cmd_status(Command):
119
"""Display status summary.
121
This reports on versioned and unknown files, reporting them
122
grouped by state. Possible states are:
125
Versioned in the working copy but not in the previous revision.
128
Versioned in the previous revision but removed or deleted
132
Path of this file changed from the previous revision;
133
the text may also have changed. This includes files whose
134
parent directory was renamed.
137
Text has changed since the previous revision.
140
File kind has been changed (e.g. from file to directory).
143
Not versioned and not matching an ignore pattern.
145
To see ignored files use 'bzr ignored'. For details in the
146
changes to file texts, use 'bzr diff'.
148
--short gives a status flags for each item, similar to the SVN's status
151
Column 1: versioning / renames
157
P Entry for a pending merge (not a file)
166
* The execute bit was changed
168
If no arguments are specified, the status of the entire working
169
directory is shown. Otherwise, only the status of the specified
170
files or directories is reported. If a directory is given, status
171
is reported for everything inside that directory.
173
If a revision argument is given, the status is calculated against
174
that revision, or between two revisions if two are provided.
177
# TODO: --no-recurse, --recurse options
179
takes_args = ['file*']
180
takes_options = ['show-ids', 'revision', 'short']
181
aliases = ['st', 'stat']
183
encoding_type = 'replace'
186
def run(self, show_ids=False, file_list=None, revision=None, short=False):
187
from bzrlib.status import show_tree_status
189
tree, file_list = tree_files(file_list)
191
show_tree_status(tree, show_ids=show_ids,
192
specific_files=file_list, revision=revision,
197
class cmd_cat_revision(Command):
198
"""Write out metadata for a revision.
200
The revision to print can either be specified by a specific
201
revision identifier, or you can use --revision.
205
takes_args = ['revision_id?']
206
takes_options = ['revision']
207
# cat-revision is more for frontends so should be exact
211
def run(self, revision_id=None, revision=None):
213
if revision_id is not None and revision is not None:
214
raise errors.BzrCommandError('You can only supply one of'
215
' revision_id or --revision')
216
if revision_id is None and revision is None:
217
raise errors.BzrCommandError('You must supply either'
218
' --revision or a revision_id')
219
b = WorkingTree.open_containing(u'.')[0].branch
221
# TODO: jam 20060112 should cat-revision always output utf-8?
222
if revision_id is not None:
223
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
224
elif revision is not None:
227
raise errors.BzrCommandError('You cannot specify a NULL'
229
revno, rev_id = rev.in_history(b)
230
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
233
class cmd_remove_tree(Command):
234
"""Remove the working tree from a given branch/checkout.
236
Since a lightweight checkout is little more than a working tree
237
this will refuse to run against one.
242
takes_args = ['location?']
244
def run(self, location='.'):
245
d = bzrdir.BzrDir.open(location)
248
working = d.open_workingtree()
249
except errors.NoWorkingTree:
250
raise errors.BzrCommandError("No working tree to remove")
251
except errors.NotLocalUrl:
252
raise errors.BzrCommandError("You cannot remove the working tree of a "
255
working_path = working.bzrdir.root_transport.base
256
branch_path = working.branch.bzrdir.root_transport.base
257
if working_path != branch_path:
258
raise errors.BzrCommandError("You cannot remove the working tree from "
259
"a lightweight checkout")
261
d.destroy_workingtree()
264
class cmd_revno(Command):
265
"""Show current revision number.
267
This is equal to the number of revisions on this branch.
270
takes_args = ['location?']
273
def run(self, location=u'.'):
274
self.outf.write(str(Branch.open_containing(location)[0].revno()))
275
self.outf.write('\n')
278
class cmd_revision_info(Command):
279
"""Show revision number and revision id for a given revision identifier.
282
takes_args = ['revision_info*']
283
takes_options = ['revision']
286
def run(self, revision=None, revision_info_list=[]):
289
if revision is not None:
290
revs.extend(revision)
291
if revision_info_list is not None:
292
for rev in revision_info_list:
293
revs.append(RevisionSpec.from_string(rev))
295
raise errors.BzrCommandError('You must supply a revision identifier')
297
b = WorkingTree.open_containing(u'.')[0].branch
300
revinfo = rev.in_history(b)
301
if revinfo.revno is None:
302
print ' %s' % revinfo.rev_id
304
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
307
class cmd_add(Command):
308
"""Add specified files or directories.
310
In non-recursive mode, all the named items are added, regardless
311
of whether they were previously ignored. A warning is given if
312
any of the named files are already versioned.
314
In recursive mode (the default), files are treated the same way
315
but the behaviour for directories is different. Directories that
316
are already versioned do not give a warning. All directories,
317
whether already versioned or not, are searched for files or
318
subdirectories that are neither versioned or ignored, and these
319
are added. This search proceeds recursively into versioned
320
directories. If no names are given '.' is assumed.
322
Therefore simply saying 'bzr add' will version all files that
323
are currently unknown.
325
Adding a file whose parent directory is not versioned will
326
implicitly add the parent, and so on up to the root. This means
327
you should never need to explicitly add a directory, they'll just
328
get added when you add a file in the directory.
330
--dry-run will show which files would be added, but not actually
333
--file-ids-from will try to use the file ids from the supplied path.
334
It looks up ids trying to find a matching parent directory with the
335
same filename, and then by pure path.
337
takes_args = ['file*']
338
takes_options = ['no-recurse', 'dry-run', 'verbose',
339
Option('file-ids-from', type=unicode,
340
help='Lookup file ids from here')]
341
encoding_type = 'replace'
343
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
347
if file_ids_from is not None:
349
base_tree, base_path = WorkingTree.open_containing(
351
except errors.NoWorkingTree:
352
base_branch, base_path = Branch.open_containing(
354
base_tree = base_branch.basis_tree()
356
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
357
to_file=self.outf, should_print=(not is_quiet()))
359
action = bzrlib.add.AddAction(to_file=self.outf,
360
should_print=(not is_quiet()))
362
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
363
action=action, save=not dry_run)
366
for glob in sorted(ignored.keys()):
367
for path in ignored[glob]:
368
self.outf.write("ignored %s matching \"%s\"\n"
372
for glob, paths in ignored.items():
373
match_len += len(paths)
374
self.outf.write("ignored %d file(s).\n" % match_len)
375
self.outf.write("If you wish to add some of these files,"
376
" please add them by name.\n")
379
class cmd_mkdir(Command):
380
"""Create a new versioned directory.
382
This is equivalent to creating the directory and then adding it.
385
takes_args = ['dir+']
386
encoding_type = 'replace'
388
def run(self, dir_list):
391
wt, dd = WorkingTree.open_containing(d)
393
self.outf.write('added %s\n' % d)
396
class cmd_relpath(Command):
397
"""Show path of a file relative to root"""
399
takes_args = ['filename']
403
def run(self, filename):
404
# TODO: jam 20050106 Can relpath return a munged path if
405
# sys.stdout encoding cannot represent it?
406
tree, relpath = WorkingTree.open_containing(filename)
407
self.outf.write(relpath)
408
self.outf.write('\n')
411
class cmd_inventory(Command):
412
"""Show inventory of the current working copy or a revision.
414
It is possible to limit the output to a particular entry
415
type using the --kind option. For example: --kind file.
417
It is also possible to restrict the list of files to a specific
418
set. For example: bzr inventory --show-ids this/file
425
takes_options = ['revision', 'show-ids', 'kind']
427
takes_args = ['file*']
430
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
431
if kind and kind not in ['file', 'directory', 'symlink']:
432
raise errors.BzrCommandError('invalid kind specified')
434
work_tree, file_list = tree_files(file_list)
436
if revision is not None:
437
if len(revision) > 1:
438
raise errors.BzrCommandError('bzr inventory --revision takes'
439
' exactly one revision identifier')
440
revision_id = revision[0].in_history(work_tree.branch).rev_id
441
tree = work_tree.branch.repository.revision_tree(revision_id)
443
# We include work_tree as well as 'tree' here
444
# So that doing '-r 10 path/foo' will lookup whatever file
445
# exists now at 'path/foo' even if it has been renamed, as
446
# well as whatever files existed in revision 10 at path/foo
447
trees = [tree, work_tree]
452
if file_list is not None:
453
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
454
require_versioned=True)
455
# find_ids_across_trees may include some paths that don't
457
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
458
for file_id in file_ids if file_id in tree)
460
entries = tree.inventory.entries()
462
for path, entry in entries:
463
if kind and kind != entry.kind:
466
self.outf.write('%-50s %s\n' % (path, entry.file_id))
468
self.outf.write(path)
469
self.outf.write('\n')
472
class cmd_mv(Command):
473
"""Move or rename a file.
476
bzr mv OLDNAME NEWNAME
477
bzr mv SOURCE... DESTINATION
479
If the last argument is a versioned directory, all the other names
480
are moved into it. Otherwise, there must be exactly two arguments
481
and the file is changed to a new name.
483
If OLDNAME does not exist on the filesystem but is versioned and
484
NEWNAME does exist on the filesystem but is not versioned, mv
485
assumes that the file has been manually moved and only updates
486
its internal inventory to reflect that change.
487
The same is valid when moving many SOURCE files to a DESTINATION.
489
Files cannot be moved between branches.
492
takes_args = ['names*']
493
takes_options = [Option("after", help="move only the bzr identifier"
494
" of the file (file has already been moved). Use this flag if"
495
" bzr is not able to detect this itself.")]
496
aliases = ['move', 'rename']
497
encoding_type = 'replace'
499
def run(self, names_list, after=False):
500
if names_list is None:
503
if len(names_list) < 2:
504
raise errors.BzrCommandError("missing file argument")
505
tree, rel_names = tree_files(names_list)
507
if os.path.isdir(names_list[-1]):
508
# move into existing directory
509
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
510
self.outf.write("%s => %s\n" % pair)
512
if len(names_list) != 2:
513
raise errors.BzrCommandError('to mv multiple files the'
514
' destination must be a versioned'
516
tree.rename_one(rel_names[0], rel_names[1], after=after)
517
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
520
class cmd_pull(Command):
521
"""Turn this branch into a mirror of another branch.
523
This command only works on branches that have not diverged. Branches are
524
considered diverged if the destination branch's most recent commit is one
525
that has not been merged (directly or indirectly) into the parent.
527
If branches have diverged, you can use 'bzr merge' to integrate the changes
528
from one into the other. Once one branch has merged, the other should
529
be able to pull it again.
531
If you want to forget your local changes and just update your branch to
532
match the remote one, use pull --overwrite.
534
If there is no default location set, the first pull will set it. After
535
that, you can omit the location to use the default. To change the
536
default, use --remember. The value will only be saved if the remote
537
location can be accessed.
540
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
541
takes_args = ['location?']
542
encoding_type = 'replace'
544
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
545
# FIXME: too much stuff is in the command class
547
tree_to = WorkingTree.open_containing(u'.')[0]
548
branch_to = tree_to.branch
549
except errors.NoWorkingTree:
551
branch_to = Branch.open_containing(u'.')[0]
554
if location is not None:
556
reader = bundle.read_bundle_from_url(location)
557
except errors.NotABundle:
558
pass # Continue on considering this url a Branch
560
stored_loc = branch_to.get_parent()
562
if stored_loc is None:
563
raise errors.BzrCommandError("No pull location known or"
566
display_url = urlutils.unescape_for_display(stored_loc,
568
self.outf.write("Using saved location: %s\n" % display_url)
569
location = stored_loc
572
if reader is not None:
573
install_bundle(branch_to.repository, reader)
574
branch_from = branch_to
576
branch_from = Branch.open(location)
578
if branch_to.get_parent() is None or remember:
579
branch_to.set_parent(branch_from.base)
583
if reader is not None:
584
rev_id = reader.target
585
elif len(revision) == 1:
586
rev_id = revision[0].in_history(branch_from).rev_id
588
raise errors.BzrCommandError('bzr pull --revision takes one value.')
590
old_rh = branch_to.revision_history()
591
if tree_to is not None:
592
count = tree_to.pull(branch_from, overwrite, rev_id)
594
count = branch_to.pull(branch_from, overwrite, rev_id)
595
note('%d revision(s) pulled.' % (count,))
598
new_rh = branch_to.revision_history()
601
from bzrlib.log import show_changed_revisions
602
show_changed_revisions(branch_to, old_rh, new_rh,
606
class cmd_push(Command):
607
"""Update a mirror of this branch.
609
The target branch will not have its working tree populated because this
610
is both expensive, and is not supported on remote file systems.
612
Some smart servers or protocols *may* put the working tree in place in
615
This command only works on branches that have not diverged. Branches are
616
considered diverged if the destination branch's most recent commit is one
617
that has not been merged (directly or indirectly) by the source branch.
619
If branches have diverged, you can use 'bzr push --overwrite' to replace
620
the other branch completely, discarding its unmerged changes.
622
If you want to ensure you have the different changes in the other branch,
623
do a merge (see bzr help merge) from the other branch, and commit that.
624
After that you will be able to do a push without '--overwrite'.
626
If there is no default push location set, the first push will set it.
627
After that, you can omit the location to use the default. To change the
628
default, use --remember. The value will only be saved if the remote
629
location can be accessed.
632
takes_options = ['remember', 'overwrite', 'verbose',
633
Option('create-prefix',
634
help='Create the path leading up to the branch '
635
'if it does not already exist'),
636
Option('use-existing-dir',
637
help='By default push will fail if the target'
638
' directory exists, but does not already'
639
' have a control directory. This flag will'
640
' allow push to proceed.'),
642
takes_args = ['location?']
643
encoding_type = 'replace'
645
def run(self, location=None, remember=False, overwrite=False,
646
create_prefix=False, verbose=False, use_existing_dir=False):
647
# FIXME: Way too big! Put this into a function called from the
650
br_from = Branch.open_containing('.')[0]
651
stored_loc = br_from.get_push_location()
653
if stored_loc is None:
654
raise errors.BzrCommandError("No push location known or specified.")
656
display_url = urlutils.unescape_for_display(stored_loc,
658
self.outf.write("Using saved location: %s\n" % display_url)
659
location = stored_loc
661
to_transport = transport.get_transport(location)
662
location_url = to_transport.base
667
br_to = repository_to = dir_to = None
669
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
670
except errors.NotBranchError:
671
pass # Didn't find anything
673
# If we can open a branch, use its direct repository, otherwise see
674
# if there is a repository without a branch.
676
br_to = dir_to.open_branch()
677
except errors.NotBranchError:
678
# Didn't find a branch, can we find a repository?
680
repository_to = dir_to.find_repository()
681
except errors.NoRepositoryPresent:
684
# Found a branch, so we must have found a repository
685
repository_to = br_to.repository
689
# XXX: Refactor the create_prefix/no_create_prefix code into a
690
# common helper function
692
to_transport.mkdir('.')
693
except errors.FileExists:
694
if not use_existing_dir:
695
raise errors.BzrCommandError("Target directory %s"
696
" already exists, but does not have a valid .bzr"
697
" directory. Supply --use-existing-dir to push"
698
" there anyway." % location)
699
except errors.NoSuchFile:
700
if not create_prefix:
701
raise errors.BzrCommandError("Parent directory of %s"
703
"\nYou may supply --create-prefix to create all"
704
" leading parent directories."
707
cur_transport = to_transport
708
needed = [cur_transport]
709
# Recurse upwards until we can create a directory successfully
711
new_transport = cur_transport.clone('..')
712
if new_transport.base == cur_transport.base:
713
raise errors.BzrCommandError("Failed to create path"
717
new_transport.mkdir('.')
718
except errors.NoSuchFile:
719
needed.append(new_transport)
720
cur_transport = new_transport
724
# Now we only need to create child directories
726
cur_transport = needed.pop()
727
cur_transport.mkdir('.')
729
# Now the target directory exists, but doesn't have a .bzr
730
# directory. So we need to create it, along with any work to create
731
# all of the dependent branches, etc.
732
dir_to = br_from.bzrdir.clone(location_url,
733
revision_id=br_from.last_revision())
734
br_to = dir_to.open_branch()
735
count = br_to.last_revision_info()[0]
736
# We successfully created the target, remember it
737
if br_from.get_push_location() is None or remember:
738
br_from.set_push_location(br_to.base)
739
elif repository_to is None:
740
# we have a bzrdir but no branch or repository
741
# XXX: Figure out what to do other than complain.
742
raise errors.BzrCommandError("At %s you have a valid .bzr control"
743
" directory, but not a branch or repository. This is an"
744
" unsupported configuration. Please move the target directory"
745
" out of the way and try again."
748
# We have a repository but no branch, copy the revisions, and then
750
last_revision_id = br_from.last_revision()
751
repository_to.fetch(br_from.repository,
752
revision_id=last_revision_id)
753
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
754
count = len(br_to.revision_history())
755
if br_from.get_push_location() is None or remember:
756
br_from.set_push_location(br_to.base)
757
else: # We have a valid to branch
758
# We were able to connect to the remote location, so remember it
759
# we don't need to successfully push because of possible divergence.
760
if br_from.get_push_location() is None or remember:
761
br_from.set_push_location(br_to.base)
762
old_rh = br_to.revision_history()
765
tree_to = dir_to.open_workingtree()
766
except errors.NotLocalUrl:
767
warning('This transport does not update the working '
768
'tree of: %s' % (br_to.base,))
769
count = br_from.push(br_to, overwrite)
770
except errors.NoWorkingTree:
771
count = br_from.push(br_to, overwrite)
775
count = br_from.push(tree_to.branch, overwrite)
779
except errors.DivergedBranches:
780
raise errors.BzrCommandError('These branches have diverged.'
781
' Try using "merge" and then "push".')
782
note('%d revision(s) pushed.' % (count,))
785
new_rh = br_to.revision_history()
788
from bzrlib.log import show_changed_revisions
789
show_changed_revisions(br_to, old_rh, new_rh,
793
class cmd_branch(Command):
794
"""Create a new copy of a branch.
796
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
797
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
799
To retrieve the branch as of a particular revision, supply the --revision
800
parameter, as in "branch foo/bar -r 5".
802
--basis is to speed up branching from remote branches. When specified, it
803
copies all the file-contents, inventory and revision data from the basis
804
branch before copying anything from the remote branch.
806
takes_args = ['from_location', 'to_location?']
807
takes_options = ['revision', 'basis']
808
aliases = ['get', 'clone']
810
def run(self, from_location, to_location=None, revision=None, basis=None):
813
elif len(revision) > 1:
814
raise errors.BzrCommandError(
815
'bzr branch --revision takes exactly 1 revision value')
817
br_from = Branch.open(from_location)
819
if e.errno == errno.ENOENT:
820
raise errors.BzrCommandError('Source location "%s" does not'
821
' exist.' % to_location)
826
if basis is not None:
827
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
830
if len(revision) == 1 and revision[0] is not None:
831
revision_id = revision[0].in_history(br_from)[1]
833
# FIXME - wt.last_revision, fallback to branch, fall back to
834
# None or perhaps NULL_REVISION to mean copy nothing
836
revision_id = br_from.last_revision()
837
if to_location is None:
838
to_location = os.path.basename(from_location.rstrip("/\\"))
841
name = os.path.basename(to_location) + '\n'
843
to_transport = transport.get_transport(to_location)
845
to_transport.mkdir('.')
846
except errors.FileExists:
847
raise errors.BzrCommandError('Target directory "%s" already'
848
' exists.' % to_location)
849
except errors.NoSuchFile:
850
raise errors.BzrCommandError('Parent of "%s" does not exist.'
853
# preserve whatever source format we have.
854
dir = br_from.bzrdir.sprout(to_transport.base,
855
revision_id, basis_dir)
856
branch = dir.open_branch()
857
except errors.NoSuchRevision:
858
to_transport.delete_tree('.')
859
msg = "The branch %s has no revision %s." % (from_location, revision[0])
860
raise errors.BzrCommandError(msg)
861
except errors.UnlistableBranch:
862
osutils.rmtree(to_location)
863
msg = "The branch %s cannot be used as a --basis" % (basis,)
864
raise errors.BzrCommandError(msg)
866
branch.control_files.put_utf8('branch-name', name)
867
note('Branched %d revision(s).' % branch.revno())
872
class cmd_checkout(Command):
873
"""Create a new checkout of an existing branch.
875
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
876
the branch found in '.'. This is useful if you have removed the working tree
877
or if it was never created - i.e. if you pushed the branch to its current
880
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
881
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
883
To retrieve the branch as of a particular revision, supply the --revision
884
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
885
out of date [so you cannot commit] but it may be useful (i.e. to examine old
888
--basis is to speed up checking out from remote branches. When specified, it
889
uses the inventory and file contents from the basis branch in preference to the
890
branch being checked out.
892
See "help checkouts" for more information on checkouts.
894
takes_args = ['branch_location?', 'to_location?']
895
takes_options = ['revision', # , 'basis']
896
Option('lightweight',
897
help="perform a lightweight checkout. Lightweight "
898
"checkouts depend on access to the branch for "
899
"every operation. Normal checkouts can perform "
900
"common operations like diff and status without "
901
"such access, and also support local commits."
906
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
910
elif len(revision) > 1:
911
raise errors.BzrCommandError(
912
'bzr checkout --revision takes exactly 1 revision value')
913
if branch_location is None:
914
branch_location = osutils.getcwd()
915
to_location = branch_location
916
source = Branch.open(branch_location)
917
if len(revision) == 1 and revision[0] is not None:
918
revision_id = revision[0].in_history(source)[1]
921
if to_location is None:
922
to_location = os.path.basename(branch_location.rstrip("/\\"))
923
# if the source and to_location are the same,
924
# and there is no working tree,
925
# then reconstitute a branch
926
if (osutils.abspath(to_location) ==
927
osutils.abspath(branch_location)):
929
source.bzrdir.open_workingtree()
930
except errors.NoWorkingTree:
931
source.bzrdir.create_workingtree()
934
os.mkdir(to_location)
936
if e.errno == errno.EEXIST:
937
raise errors.BzrCommandError('Target directory "%s" already'
938
' exists.' % to_location)
939
if e.errno == errno.ENOENT:
940
raise errors.BzrCommandError('Parent of "%s" does not exist.'
944
source.create_checkout(to_location, revision_id, lightweight)
947
class cmd_renames(Command):
948
"""Show list of renamed files.
950
# TODO: Option to show renames between two historical versions.
952
# TODO: Only show renames under dir, rather than in the whole branch.
953
takes_args = ['dir?']
956
def run(self, dir=u'.'):
957
tree = WorkingTree.open_containing(dir)[0]
958
old_inv = tree.basis_tree().inventory
959
new_inv = tree.read_working_inventory()
960
renames = list(_mod_tree.find_renames(old_inv, new_inv))
962
for old_name, new_name in renames:
963
self.outf.write("%s => %s\n" % (old_name, new_name))
966
class cmd_update(Command):
967
"""Update a tree to have the latest code committed to its branch.
969
This will perform a merge into the working tree, and may generate
970
conflicts. If you have any local changes, you will still
971
need to commit them after the update for the update to be complete.
973
If you want to discard your local changes, you can just do a
974
'bzr revert' instead of 'bzr commit' after the update.
976
takes_args = ['dir?']
979
def run(self, dir='.'):
980
tree = WorkingTree.open_containing(dir)[0]
981
master = tree.branch.get_master_branch()
982
if master is not None:
985
tree.lock_tree_write()
987
existing_pending_merges = tree.get_parent_ids()[1:]
988
last_rev = tree.last_revision()
989
if last_rev == tree.branch.last_revision():
990
# may be up to date, check master too.
991
master = tree.branch.get_master_branch()
992
if master is None or last_rev == master.last_revision():
993
revno = tree.branch.revision_id_to_revno(last_rev)
994
note("Tree is up to date at revision %d." % (revno,))
996
conflicts = tree.update()
997
revno = tree.branch.revision_id_to_revno(tree.last_revision())
998
note('Updated to revision %d.' % (revno,))
999
if tree.get_parent_ids()[1:] != existing_pending_merges:
1000
note('Your local commits will now show as pending merges with '
1001
"'bzr status', and can be committed with 'bzr commit'.")
1010
class cmd_info(Command):
1011
"""Show information about a working tree, branch or repository.
1013
This command will show all known locations and formats associated to the
1014
tree, branch or repository. Statistical information is included with
1017
Branches and working trees will also report any missing revisions.
1019
takes_args = ['location?']
1020
takes_options = ['verbose']
1023
def run(self, location=None, verbose=False):
1024
from bzrlib.info import show_bzrdir_info
1025
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1029
class cmd_remove(Command):
1030
"""Make a file unversioned.
1032
This makes bzr stop tracking changes to a versioned file. It does
1033
not delete the working copy.
1035
You can specify one or more files, and/or --new. If you specify --new,
1036
only 'added' files will be removed. If you specify both, then new files
1037
in the specified directories will be removed. If the directories are
1038
also new, they will also be removed.
1040
takes_args = ['file*']
1041
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1043
encoding_type = 'replace'
1045
def run(self, file_list, verbose=False, new=False):
1046
tree, file_list = tree_files(file_list)
1048
if file_list is None:
1049
raise errors.BzrCommandError('Specify one or more files to'
1050
' remove, or use --new.')
1052
added = tree.changes_from(tree.basis_tree(),
1053
specific_files=file_list).added
1054
file_list = sorted([f[0] for f in added], reverse=True)
1055
if len(file_list) == 0:
1056
raise errors.BzrCommandError('No matching files.')
1057
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1060
class cmd_file_id(Command):
1061
"""Print file_id of a particular file or directory.
1063
The file_id is assigned when the file is first added and remains the
1064
same through all revisions where the file exists, even when it is
1069
takes_args = ['filename']
1072
def run(self, filename):
1073
tree, relpath = WorkingTree.open_containing(filename)
1074
i = tree.inventory.path2id(relpath)
1076
raise errors.NotVersionedError(filename)
1078
self.outf.write(i + '\n')
1081
class cmd_file_path(Command):
1082
"""Print path of file_ids to a file or directory.
1084
This prints one line for each directory down to the target,
1085
starting at the branch root.
1089
takes_args = ['filename']
1092
def run(self, filename):
1093
tree, relpath = WorkingTree.open_containing(filename)
1094
inv = tree.inventory
1095
fid = inv.path2id(relpath)
1097
raise errors.NotVersionedError(filename)
1098
for fip in inv.get_idpath(fid):
1099
self.outf.write(fip + '\n')
1102
class cmd_reconcile(Command):
1103
"""Reconcile bzr metadata in a branch.
1105
This can correct data mismatches that may have been caused by
1106
previous ghost operations or bzr upgrades. You should only
1107
need to run this command if 'bzr check' or a bzr developer
1108
advises you to run it.
1110
If a second branch is provided, cross-branch reconciliation is
1111
also attempted, which will check that data like the tree root
1112
id which was not present in very early bzr versions is represented
1113
correctly in both branches.
1115
At the same time it is run it may recompress data resulting in
1116
a potential saving in disk space or performance gain.
1118
The branch *MUST* be on a listable system such as local disk or sftp.
1120
takes_args = ['branch?']
1122
def run(self, branch="."):
1123
from bzrlib.reconcile import reconcile
1124
dir = bzrdir.BzrDir.open(branch)
1128
class cmd_revision_history(Command):
1129
"""Display the list of revision ids on a branch."""
1130
takes_args = ['location?']
1135
def run(self, location="."):
1136
branch = Branch.open_containing(location)[0]
1137
for revid in branch.revision_history():
1138
self.outf.write(revid)
1139
self.outf.write('\n')
1142
class cmd_ancestry(Command):
1143
"""List all revisions merged into this branch."""
1144
takes_args = ['location?']
1149
def run(self, location="."):
1151
wt = WorkingTree.open_containing(location)[0]
1152
except errors.NoWorkingTree:
1153
b = Branch.open(location)
1154
last_revision = b.last_revision()
1157
last_revision = wt.last_revision()
1159
revision_ids = b.repository.get_ancestry(last_revision)
1160
assert revision_ids[0] is None
1162
for revision_id in revision_ids:
1163
self.outf.write(revision_id + '\n')
1166
class cmd_init(Command):
1167
"""Make a directory into a versioned branch.
1169
Use this to create an empty branch, or before importing an
1172
If there is a repository in a parent directory of the location, then
1173
the history of the branch will be stored in the repository. Otherwise
1174
init creates a standalone branch which carries its own history in
1177
If there is already a branch at the location but it has no working tree,
1178
the tree can be populated with 'bzr checkout'.
1180
Recipe for importing a tree of files:
1185
bzr commit -m 'imported project'
1187
takes_args = ['location?']
1189
RegistryOption('format',
1190
help='Specify a format for this branch. '
1191
'See "help formats".',
1192
registry=bzrdir.format_registry,
1193
converter=bzrdir.format_registry.make_bzrdir,
1194
value_switches=True,
1195
title="Branch Format",
1198
def run(self, location=None, format=None):
1200
format = bzrdir.format_registry.make_bzrdir('default')
1201
if location is None:
1204
to_transport = transport.get_transport(location)
1206
# The path has to exist to initialize a
1207
# branch inside of it.
1208
# Just using os.mkdir, since I don't
1209
# believe that we want to create a bunch of
1210
# locations if the user supplies an extended path
1211
# TODO: create-prefix
1213
to_transport.mkdir('.')
1214
except errors.FileExists:
1218
existing_bzrdir = bzrdir.BzrDir.open(location)
1219
except errors.NotBranchError:
1220
# really a NotBzrDir error...
1221
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1223
from bzrlib.transport.local import LocalTransport
1224
if existing_bzrdir.has_branch():
1225
if (isinstance(to_transport, LocalTransport)
1226
and not existing_bzrdir.has_workingtree()):
1227
raise errors.BranchExistsWithoutWorkingTree(location)
1228
raise errors.AlreadyBranchError(location)
1230
existing_bzrdir.create_branch()
1231
existing_bzrdir.create_workingtree()
1234
class cmd_init_repository(Command):
1235
"""Create a shared repository to hold branches.
1237
New branches created under the repository directory will store their revisions
1238
in the repository, not in the branch directory, if the branch format supports
1244
bzr checkout --lightweight repo/trunk trunk-checkout
1248
takes_args = ["location"]
1249
takes_options = [RegistryOption('format',
1250
help='Specify a format for this repository. See'
1251
' "bzr help formats" for details',
1252
registry=bzrdir.format_registry,
1253
converter=bzrdir.format_registry.make_bzrdir,
1254
value_switches=True, title='Repository format'),
1256
help='Allows branches in repository to have'
1258
aliases = ["init-repo"]
1259
def run(self, location, format=None, trees=False):
1261
format = bzrdir.format_registry.make_bzrdir('default')
1263
if location is None:
1266
to_transport = transport.get_transport(location)
1268
to_transport.mkdir('.')
1269
except errors.FileExists:
1272
newdir = format.initialize_on_transport(to_transport)
1273
repo = newdir.create_repository(shared=True)
1274
repo.set_make_working_trees(trees)
1277
class cmd_diff(Command):
1278
"""Show differences in the working tree or between revisions.
1280
If files are listed, only the changes in those files are listed.
1281
Otherwise, all changes for the tree are listed.
1283
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1284
produces patches suitable for "patch -p1".
1288
Shows the difference in the working tree versus the last commit
1290
Difference between the working tree and revision 1
1292
Difference between revision 2 and revision 1
1293
bzr diff --diff-prefix old/:new/
1294
Same as 'bzr diff' but prefix paths with old/ and new/
1295
bzr diff bzr.mine bzr.dev
1296
Show the differences between the two working trees
1298
Show just the differences for 'foo.c'
1300
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1301
# or a graphical diff.
1303
# TODO: Python difflib is not exactly the same as unidiff; should
1304
# either fix it up or prefer to use an external diff.
1306
# TODO: Selected-file diff is inefficient and doesn't show you
1309
# TODO: This probably handles non-Unix newlines poorly.
1311
takes_args = ['file*']
1312
takes_options = ['revision', 'diff-options',
1313
Option('prefix', type=str,
1315
help='Set prefixes to added to old and new filenames, as '
1316
'two values separated by a colon.'),
1318
aliases = ['di', 'dif']
1319
encoding_type = 'exact'
1322
def run(self, revision=None, file_list=None, diff_options=None,
1324
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1326
if (prefix is None) or (prefix == '0'):
1334
old_label, new_label = prefix.split(":")
1336
raise BzrCommandError(
1337
"--prefix expects two values separated by a colon")
1339
if revision and len(revision) > 2:
1340
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1341
' one or two revision specifiers')
1344
tree1, file_list = internal_tree_files(file_list)
1348
except errors.FileInWrongBranch:
1349
if len(file_list) != 2:
1350
raise errors.BzrCommandError("Files are in different branches")
1352
tree1, file1 = WorkingTree.open_containing(file_list[0])
1353
tree2, file2 = WorkingTree.open_containing(file_list[1])
1354
if file1 != "" or file2 != "":
1355
# FIXME diff those two files. rbc 20051123
1356
raise errors.BzrCommandError("Files are in different branches")
1358
except errors.NotBranchError:
1359
if (revision is not None and len(revision) == 2
1360
and not revision[0].needs_branch()
1361
and not revision[1].needs_branch()):
1362
# If both revision specs include a branch, we can
1363
# diff them without needing a local working tree
1364
tree1, tree2 = None, None
1368
if tree2 is not None:
1369
if revision is not None:
1370
# FIXME: but there should be a clean way to diff between
1371
# non-default versions of two trees, it's not hard to do
1373
raise errors.BzrCommandError(
1374
"Sorry, diffing arbitrary revisions across branches "
1375
"is not implemented yet")
1376
return show_diff_trees(tree1, tree2, sys.stdout,
1377
specific_files=file_list,
1378
external_diff_options=diff_options,
1379
old_label=old_label, new_label=new_label)
1381
return diff_cmd_helper(tree1, file_list, diff_options,
1382
revision_specs=revision,
1383
old_label=old_label, new_label=new_label)
1386
class cmd_deleted(Command):
1387
"""List files deleted in the working tree.
1389
# TODO: Show files deleted since a previous revision, or
1390
# between two revisions.
1391
# TODO: Much more efficient way to do this: read in new
1392
# directories with readdir, rather than stating each one. Same
1393
# level of effort but possibly much less IO. (Or possibly not,
1394
# if the directories are very large...)
1395
takes_options = ['show-ids']
1398
def run(self, show_ids=False):
1399
tree = WorkingTree.open_containing(u'.')[0]
1400
old = tree.basis_tree()
1401
for path, ie in old.inventory.iter_entries():
1402
if not tree.has_id(ie.file_id):
1403
self.outf.write(path)
1405
self.outf.write(' ')
1406
self.outf.write(ie.file_id)
1407
self.outf.write('\n')
1410
class cmd_modified(Command):
1411
"""List files modified in working tree.
1413
See also: "bzr status".
1420
tree = WorkingTree.open_containing(u'.')[0]
1421
td = tree.changes_from(tree.basis_tree())
1422
for path, id, kind, text_modified, meta_modified in td.modified:
1423
self.outf.write(path + '\n')
1426
class cmd_added(Command):
1427
"""List files added in working tree.
1429
See also: "bzr status".
1436
wt = WorkingTree.open_containing(u'.')[0]
1437
basis_inv = wt.basis_tree().inventory
1440
if file_id in basis_inv:
1442
if inv.is_root(file_id) and len(basis_inv) == 0:
1444
path = inv.id2path(file_id)
1445
if not os.access(osutils.abspath(path), os.F_OK):
1447
self.outf.write(path + '\n')
1450
class cmd_root(Command):
1451
"""Show the tree root directory.
1453
The root is the nearest enclosing directory with a .bzr control
1455
takes_args = ['filename?']
1457
def run(self, filename=None):
1458
"""Print the branch root."""
1459
tree = WorkingTree.open_containing(filename)[0]
1460
self.outf.write(tree.basedir + '\n')
1463
class cmd_log(Command):
1464
"""Show log of a branch, file, or directory.
1466
By default show the log of the branch containing the working directory.
1468
To request a range of logs, you can use the command -r begin..end
1469
-r revision requests a specific revision, -r ..end or -r begin.. are
1475
bzr log -r -10.. http://server/branch
1478
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1480
takes_args = ['location?']
1481
takes_options = [Option('forward',
1482
help='show from oldest to newest'),
1486
help='show files changed in each revision'),
1487
'show-ids', 'revision',
1491
help='show revisions whose message matches this regexp',
1494
encoding_type = 'replace'
1497
def run(self, location=None, timezone='original',
1504
from bzrlib.log import show_log
1505
assert message is None or isinstance(message, basestring), \
1506
"invalid message argument %r" % message
1507
direction = (forward and 'forward') or 'reverse'
1512
# find the file id to log:
1514
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1518
tree = b.basis_tree()
1519
inv = tree.inventory
1520
file_id = inv.path2id(fp)
1522
raise errors.BzrCommandError(
1523
"Path does not have any revision history: %s" %
1527
# FIXME ? log the current subdir only RBC 20060203
1528
if revision is not None \
1529
and len(revision) > 0 and revision[0].get_branch():
1530
location = revision[0].get_branch()
1533
dir, relpath = bzrdir.BzrDir.open_containing(location)
1534
b = dir.open_branch()
1536
if revision is None:
1539
elif len(revision) == 1:
1540
rev1 = rev2 = revision[0].in_history(b).revno
1541
elif len(revision) == 2:
1542
if revision[1].get_branch() != revision[0].get_branch():
1543
# b is taken from revision[0].get_branch(), and
1544
# show_log will use its revision_history. Having
1545
# different branches will lead to weird behaviors.
1546
raise errors.BzrCommandError(
1547
"Log doesn't accept two revisions in different branches.")
1548
if revision[0].spec is None:
1549
# missing begin-range means first revision
1552
rev1 = revision[0].in_history(b).revno
1554
if revision[1].spec is None:
1555
# missing end-range means last known revision
1558
rev2 = revision[1].in_history(b).revno
1560
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1562
# By this point, the revision numbers are converted to the +ve
1563
# form if they were supplied in the -ve form, so we can do
1564
# this comparison in relative safety
1566
(rev2, rev1) = (rev1, rev2)
1568
if log_format is None:
1569
log_format = log.log_formatter_registry.get_default(b)
1571
lf = log_format(show_ids=show_ids, to_file=self.outf,
1572
show_timezone=timezone)
1578
direction=direction,
1579
start_revision=rev1,
1584
def get_log_format(long=False, short=False, line=False, default='long'):
1585
log_format = default
1589
log_format = 'short'
1595
class cmd_touching_revisions(Command):
1596
"""Return revision-ids which affected a particular file.
1598
A more user-friendly interface is "bzr log FILE".
1602
takes_args = ["filename"]
1605
def run(self, filename):
1606
tree, relpath = WorkingTree.open_containing(filename)
1608
inv = tree.read_working_inventory()
1609
file_id = inv.path2id(relpath)
1610
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1611
self.outf.write("%6d %s\n" % (revno, what))
1614
class cmd_ls(Command):
1615
"""List files in a tree.
1618
takes_args = ['path?']
1619
# TODO: Take a revision or remote path and list that tree instead.
1620
takes_options = ['verbose', 'revision',
1621
Option('non-recursive',
1622
help='don\'t recurse into sub-directories'),
1624
help='Print all paths from the root of the branch.'),
1625
Option('unknown', help='Print unknown files'),
1626
Option('versioned', help='Print versioned files'),
1627
Option('ignored', help='Print ignored files'),
1629
Option('null', help='Null separate the files'),
1633
def run(self, revision=None, verbose=False,
1634
non_recursive=False, from_root=False,
1635
unknown=False, versioned=False, ignored=False,
1636
null=False, kind=None, show_ids=False, path=None):
1638
if kind and kind not in ('file', 'directory', 'symlink'):
1639
raise errors.BzrCommandError('invalid kind specified')
1641
if verbose and null:
1642
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1643
all = not (unknown or versioned or ignored)
1645
selection = {'I':ignored, '?':unknown, 'V':versioned}
1652
raise errors.BzrCommandError('cannot specify both --from-root'
1656
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1662
if revision is not None:
1663
tree = branch.repository.revision_tree(
1664
revision[0].in_history(branch).rev_id)
1666
tree = branch.basis_tree()
1668
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1669
if fp.startswith(relpath):
1670
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1671
if non_recursive and '/' in fp:
1673
if not all and not selection[fc]:
1675
if kind is not None and fkind != kind:
1678
kindch = entry.kind_character()
1679
outstring = '%-8s %s%s' % (fc, fp, kindch)
1680
if show_ids and fid is not None:
1681
outstring = "%-50s %s" % (outstring, fid)
1682
self.outf.write(outstring + '\n')
1684
self.outf.write(fp + '\0')
1687
self.outf.write(fid)
1688
self.outf.write('\0')
1696
self.outf.write('%-50s %s\n' % (fp, my_id))
1698
self.outf.write(fp + '\n')
1701
class cmd_unknowns(Command):
1702
"""List unknown files.
1704
See also: "bzr ls --unknown".
1711
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1712
self.outf.write(osutils.quotefn(f) + '\n')
1715
class cmd_ignore(Command):
1716
"""Ignore specified files or patterns.
1718
To remove patterns from the ignore list, edit the .bzrignore file.
1720
Trailing slashes on patterns are ignored.
1721
If the pattern contains a slash or is a regular expression, it is compared
1722
to the whole path from the branch root. Otherwise, it is compared to only
1723
the last component of the path. To match a file only in the root
1724
directory, prepend './'.
1726
Ignore patterns specifying absolute paths are not allowed.
1728
Ignore patterns may include globbing wildcards such as:
1729
? - Matches any single character except '/'
1730
* - Matches 0 or more characters except '/'
1731
/**/ - Matches 0 or more directories in a path
1732
[a-z] - Matches a single character from within a group of characters
1734
Ignore patterns may also be Python regular expressions.
1735
Regular expression ignore patterns are identified by a 'RE:' prefix
1736
followed by the regular expression. Regular expression ignore patterns
1737
may not include named or numbered groups.
1739
Note: ignore patterns containing shell wildcards must be quoted from
1743
bzr ignore ./Makefile
1744
bzr ignore '*.class'
1745
bzr ignore 'lib/**/*.o'
1746
bzr ignore 'RE:lib/.*\.o'
1748
takes_args = ['name_pattern*']
1750
Option('old-default-rules',
1751
help='Out the ignore rules bzr < 0.9 always used.')
1754
def run(self, name_pattern_list=None, old_default_rules=None):
1755
from bzrlib.atomicfile import AtomicFile
1756
if old_default_rules is not None:
1757
# dump the rules and exit
1758
for pattern in ignores.OLD_DEFAULTS:
1761
if not name_pattern_list:
1762
raise errors.BzrCommandError("ignore requires at least one "
1763
"NAME_PATTERN or --old-default-rules")
1764
for name_pattern in name_pattern_list:
1765
if name_pattern[0] == '/':
1766
raise errors.BzrCommandError(
1767
"NAME_PATTERN should not be an absolute path")
1768
tree, relpath = WorkingTree.open_containing(u'.')
1769
ifn = tree.abspath('.bzrignore')
1770
if os.path.exists(ifn):
1773
igns = f.read().decode('utf-8')
1779
# TODO: If the file already uses crlf-style termination, maybe
1780
# we should use that for the newly added lines?
1782
if igns and igns[-1] != '\n':
1784
for name_pattern in name_pattern_list:
1785
igns += name_pattern.rstrip('/') + '\n'
1787
f = AtomicFile(ifn, 'wb')
1789
f.write(igns.encode('utf-8'))
1794
inv = tree.inventory
1795
if inv.path2id('.bzrignore'):
1796
mutter('.bzrignore is already versioned')
1798
mutter('need to make new .bzrignore file versioned')
1799
tree.add(['.bzrignore'])
1802
class cmd_ignored(Command):
1803
"""List ignored files and the patterns that matched them.
1805
See also: bzr ignore"""
1808
tree = WorkingTree.open_containing(u'.')[0]
1809
for path, file_class, kind, file_id, entry in tree.list_files():
1810
if file_class != 'I':
1812
## XXX: Slightly inefficient since this was already calculated
1813
pat = tree.is_ignored(path)
1814
print '%-50s %s' % (path, pat)
1817
class cmd_lookup_revision(Command):
1818
"""Lookup the revision-id from a revision-number
1821
bzr lookup-revision 33
1824
takes_args = ['revno']
1827
def run(self, revno):
1831
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1833
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1836
class cmd_export(Command):
1837
"""Export past revision to destination directory.
1839
If no revision is specified this exports the last committed revision.
1841
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1842
given, try to find the format with the extension. If no extension
1843
is found exports to a directory (equivalent to --format=dir).
1845
Root may be the top directory for tar, tgz and tbz2 formats. If none
1846
is given, the top directory will be the root name of the file.
1848
If branch is omitted then the branch containing the CWD will be used.
1850
Note: export of tree with non-ascii filenames to zip is not supported.
1852
Supported formats Autodetected by extension
1853
----------------- -------------------------
1856
tbz2 .tar.bz2, .tbz2
1860
takes_args = ['dest', 'branch?']
1861
takes_options = ['revision', 'format', 'root']
1862
def run(self, dest, branch=None, revision=None, format=None, root=None):
1863
from bzrlib.export import export
1866
tree = WorkingTree.open_containing(u'.')[0]
1869
b = Branch.open(branch)
1871
if revision is None:
1872
# should be tree.last_revision FIXME
1873
rev_id = b.last_revision()
1875
if len(revision) != 1:
1876
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1877
rev_id = revision[0].in_history(b).rev_id
1878
t = b.repository.revision_tree(rev_id)
1880
export(t, dest, format, root)
1881
except errors.NoSuchExportFormat, e:
1882
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1885
class cmd_cat(Command):
1886
"""Write a file's text from a previous revision."""
1888
takes_options = ['revision', 'name-from-revision']
1889
takes_args = ['filename']
1890
encoding_type = 'exact'
1893
def run(self, filename, revision=None, name_from_revision=False):
1894
if revision is not None and len(revision) != 1:
1895
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1900
tree, relpath = WorkingTree.open_containing(filename)
1902
except (errors.NotBranchError, errors.NotLocalUrl):
1905
if revision is not None and revision[0].get_branch() is not None:
1906
b = Branch.open(revision[0].get_branch())
1908
b, relpath = Branch.open_containing(filename)
1909
tree = b.basis_tree()
1910
if revision is None:
1911
revision_id = b.last_revision()
1913
revision_id = revision[0].in_history(b).rev_id
1915
cur_file_id = tree.path2id(relpath)
1916
rev_tree = b.repository.revision_tree(revision_id)
1917
old_file_id = rev_tree.path2id(relpath)
1919
if name_from_revision:
1920
if old_file_id is None:
1921
raise errors.BzrCommandError("%r is not present in revision %s"
1922
% (filename, revision_id))
1924
rev_tree.print_file(old_file_id)
1925
elif cur_file_id is not None:
1926
rev_tree.print_file(cur_file_id)
1927
elif old_file_id is not None:
1928
rev_tree.print_file(old_file_id)
1930
raise errors.BzrCommandError("%r is not present in revision %s" %
1931
(filename, revision_id))
1934
class cmd_local_time_offset(Command):
1935
"""Show the offset in seconds from GMT to local time."""
1939
print osutils.local_time_offset()
1943
class cmd_commit(Command):
1944
"""Commit changes into a new revision.
1946
If no arguments are given, the entire tree is committed.
1948
If selected files are specified, only changes to those files are
1949
committed. If a directory is specified then the directory and everything
1950
within it is committed.
1952
A selected-file commit may fail in some cases where the committed
1953
tree would be invalid, such as trying to commit a file in a
1954
newly-added directory that is not itself committed.
1956
# TODO: Run hooks on tree to-be-committed, and after commit.
1958
# TODO: Strict commit that fails if there are deleted files.
1959
# (what does "deleted files" mean ??)
1961
# TODO: Give better message for -s, --summary, used by tla people
1963
# XXX: verbose currently does nothing
1965
takes_args = ['selected*']
1966
takes_options = ['message', 'verbose',
1968
help='commit even if nothing has changed'),
1969
Option('file', type=str,
1972
help='file containing commit message'),
1974
help="refuse to commit if there are unknown "
1975
"files in the working tree."),
1977
help="perform a local only commit in a bound "
1978
"branch. Such commits are not pushed to "
1979
"the master branch until a normal commit "
1983
aliases = ['ci', 'checkin']
1985
def run(self, message=None, file=None, verbose=True, selected_list=None,
1986
unchanged=False, strict=False, local=False):
1987
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1988
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1990
from bzrlib.msgeditor import edit_commit_message, \
1991
make_commit_message_template
1993
# TODO: Need a blackbox test for invoking the external editor; may be
1994
# slightly problematic to run this cross-platform.
1996
# TODO: do more checks that the commit will succeed before
1997
# spending the user's valuable time typing a commit message.
1998
tree, selected_list = tree_files(selected_list)
1999
if selected_list == ['']:
2000
# workaround - commit of root of tree should be exactly the same
2001
# as just default commit in that tree, and succeed even though
2002
# selected-file merge commit is not done yet
2005
if local and not tree.branch.get_bound_location():
2006
raise errors.LocalRequiresBoundBranch()
2008
def get_message(commit_obj):
2009
"""Callback to get commit message"""
2010
my_message = message
2011
if my_message is None and not file:
2012
template = make_commit_message_template(tree, selected_list)
2013
my_message = edit_commit_message(template)
2014
if my_message is None:
2015
raise errors.BzrCommandError("please specify a commit"
2016
" message with either --message or --file")
2017
elif my_message and file:
2018
raise errors.BzrCommandError(
2019
"please specify either --message or --file")
2021
my_message = codecs.open(file, 'rt',
2022
bzrlib.user_encoding).read()
2023
if my_message == "":
2024
raise errors.BzrCommandError("empty commit message specified")
2028
reporter = ReportCommitToLog()
2030
reporter = NullCommitReporter()
2033
tree.commit(message_callback=get_message,
2034
specific_files=selected_list,
2035
allow_pointless=unchanged, strict=strict, local=local,
2037
except PointlessCommit:
2038
# FIXME: This should really happen before the file is read in;
2039
# perhaps prepare the commit; get the message; then actually commit
2040
raise errors.BzrCommandError("no changes to commit."
2041
" use --unchanged to commit anyhow")
2042
except ConflictsInTree:
2043
raise errors.BzrCommandError('Conflicts detected in working '
2044
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2046
except StrictCommitFailed:
2047
raise errors.BzrCommandError("Commit refused because there are"
2048
" unknown files in the working tree.")
2049
except errors.BoundBranchOutOfDate, e:
2050
raise errors.BzrCommandError(str(e) + "\n"
2051
'To commit to master branch, run update and then commit.\n'
2052
'You can also pass --local to commit to continue working '
2056
class cmd_check(Command):
2057
"""Validate consistency of branch history.
2059
This command checks various invariants about the branch storage to
2060
detect data corruption or bzr bugs.
2062
takes_args = ['branch?']
2063
takes_options = ['verbose']
2065
def run(self, branch=None, verbose=False):
2066
from bzrlib.check import check
2068
tree = WorkingTree.open_containing()[0]
2069
branch = tree.branch
2071
branch = Branch.open(branch)
2072
check(branch, verbose)
2075
class cmd_upgrade(Command):
2076
"""Upgrade branch storage to current format.
2078
The check command or bzr developers may sometimes advise you to run
2079
this command. When the default format has changed you may also be warned
2080
during other operations to upgrade.
2082
takes_args = ['url?']
2084
RegistryOption('format',
2085
help='Upgrade to a specific format. See "bzr help'
2086
' formats" for details',
2087
registry=bzrdir.format_registry,
2088
converter=bzrdir.format_registry.make_bzrdir,
2089
value_switches=True, title='Branch format'),
2093
def run(self, url='.', format=None):
2094
from bzrlib.upgrade import upgrade
2096
format = bzrdir.format_registry.make_bzrdir('default')
2097
upgrade(url, format)
2100
class cmd_whoami(Command):
2101
"""Show or set bzr user id.
2105
bzr whoami 'Frank Chu <fchu@example.com>'
2107
takes_options = [ Option('email',
2108
help='display email address only'),
2110
help='set identity for the current branch instead of '
2113
takes_args = ['name?']
2114
encoding_type = 'replace'
2117
def run(self, email=False, branch=False, name=None):
2119
# use branch if we're inside one; otherwise global config
2121
c = Branch.open_containing('.')[0].get_config()
2122
except errors.NotBranchError:
2123
c = config.GlobalConfig()
2125
self.outf.write(c.user_email() + '\n')
2127
self.outf.write(c.username() + '\n')
2130
# display a warning if an email address isn't included in the given name.
2132
config.extract_email_address(name)
2133
except errors.NoEmailInUsername, e:
2134
warning('"%s" does not seem to contain an email address. '
2135
'This is allowed, but not recommended.', name)
2137
# use global config unless --branch given
2139
c = Branch.open_containing('.')[0].get_config()
2141
c = config.GlobalConfig()
2142
c.set_user_option('email', name)
2145
class cmd_nick(Command):
2146
"""Print or set the branch nickname.
2148
If unset, the tree root directory name is used as the nickname
2149
To print the current nickname, execute with no argument.
2151
takes_args = ['nickname?']
2152
def run(self, nickname=None):
2153
branch = Branch.open_containing(u'.')[0]
2154
if nickname is None:
2155
self.printme(branch)
2157
branch.nick = nickname
2160
def printme(self, branch):
2164
class cmd_selftest(Command):
2165
"""Run internal test suite.
2167
This creates temporary test directories in the working directory, but not
2168
existing data is affected. These directories are deleted if the tests
2169
pass, or left behind to help in debugging if they fail and --keep-output
2172
If arguments are given, they are regular expressions that say which tests
2173
should run. Tests matching any expression are run, and other tests are
2176
Alternatively if --first is given, matching tests are run first and then
2177
all other tests are run. This is useful if you have been working in a
2178
particular area, but want to make sure nothing else was broken.
2180
If the global option '--no-plugins' is given, plugins are not loaded
2181
before running the selftests. This has two effects: features provided or
2182
modified by plugins will not be tested, and tests provided by plugins will
2187
run only tests relating to 'ignore'
2188
bzr --no-plugins selftest -v
2189
disable plugins and list tests as they're run
2191
# TODO: --list should give a list of all available tests
2193
# NB: this is used from the class without creating an instance, which is
2194
# why it does not have a self parameter.
2195
def get_transport_type(typestring):
2196
"""Parse and return a transport specifier."""
2197
if typestring == "sftp":
2198
from bzrlib.transport.sftp import SFTPAbsoluteServer
2199
return SFTPAbsoluteServer
2200
if typestring == "memory":
2201
from bzrlib.transport.memory import MemoryServer
2203
if typestring == "fakenfs":
2204
from bzrlib.transport.fakenfs import FakeNFSServer
2205
return FakeNFSServer
2206
msg = "No known transport type %s. Supported types are: sftp\n" %\
2208
raise errors.BzrCommandError(msg)
2211
takes_args = ['testspecs*']
2212
takes_options = ['verbose',
2213
Option('one', help='stop when one test fails'),
2214
Option('keep-output',
2215
help='keep output directories when tests fail'),
2217
help='Use a different transport by default '
2218
'throughout the test suite.',
2219
type=get_transport_type),
2220
Option('benchmark', help='run the bzr bencharks.'),
2221
Option('lsprof-timed',
2222
help='generate lsprof output for benchmarked'
2223
' sections of code.'),
2224
Option('cache-dir', type=str,
2225
help='a directory to cache intermediate'
2226
' benchmark steps'),
2227
Option('clean-output',
2228
help='clean temporary tests directories'
2229
' without running tests'),
2231
help='run all tests, but run specified tests first',
2234
encoding_type = 'replace'
2236
def run(self, testspecs_list=None, verbose=None, one=False,
2237
keep_output=False, transport=None, benchmark=None,
2238
lsprof_timed=None, cache_dir=None, clean_output=False,
2241
from bzrlib.tests import selftest
2242
import bzrlib.benchmarks as benchmarks
2243
from bzrlib.benchmarks import tree_creator
2246
from bzrlib.tests import clean_selftest_output
2247
clean_selftest_output()
2250
if cache_dir is not None:
2251
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2252
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2253
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2255
if testspecs_list is not None:
2256
pattern = '|'.join(testspecs_list)
2260
test_suite_factory = benchmarks.test_suite
2263
# TODO: should possibly lock the history file...
2264
benchfile = open(".perf_history", "at", buffering=1)
2266
test_suite_factory = None
2271
result = selftest(verbose=verbose,
2273
stop_on_failure=one,
2274
keep_output=keep_output,
2275
transport=transport,
2276
test_suite_factory=test_suite_factory,
2277
lsprof_timed=lsprof_timed,
2278
bench_history=benchfile,
2279
matching_tests_first=first,
2282
if benchfile is not None:
2285
info('tests passed')
2287
info('tests failed')
2288
return int(not result)
2291
class cmd_version(Command):
2292
"""Show version of bzr."""
2296
from bzrlib.version import show_version
2300
class cmd_rocks(Command):
2301
"""Statement of optimism."""
2307
print "it sure does!"
2310
class cmd_find_merge_base(Command):
2311
"""Find and print a base revision for merging two branches."""
2312
# TODO: Options to specify revisions on either side, as if
2313
# merging only part of the history.
2314
takes_args = ['branch', 'other']
2318
def run(self, branch, other):
2319
from bzrlib.revision import MultipleRevisionSources
2321
branch1 = Branch.open_containing(branch)[0]
2322
branch2 = Branch.open_containing(other)[0]
2324
last1 = branch1.last_revision()
2325
last2 = branch2.last_revision()
2327
source = MultipleRevisionSources(branch1.repository,
2330
base_rev_id = common_ancestor(last1, last2, source)
2332
print 'merge base is revision %s' % base_rev_id
2335
class cmd_merge(Command):
2336
"""Perform a three-way merge.
2338
The branch is the branch you will merge from. By default, it will merge
2339
the latest revision. If you specify a revision, that revision will be
2340
merged. If you specify two revisions, the first will be used as a BASE,
2341
and the second one as OTHER. Revision numbers are always relative to the
2344
By default, bzr will try to merge in all new work from the other
2345
branch, automatically determining an appropriate base. If this
2346
fails, you may need to give an explicit base.
2348
Merge will do its best to combine the changes in two branches, but there
2349
are some kinds of problems only a human can fix. When it encounters those,
2350
it will mark a conflict. A conflict means that you need to fix something,
2351
before you should commit.
2353
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2355
If there is no default branch set, the first merge will set it. After
2356
that, you can omit the branch to use the default. To change the
2357
default, use --remember. The value will only be saved if the remote
2358
location can be accessed.
2362
To merge the latest revision from bzr.dev
2363
bzr merge ../bzr.dev
2365
To merge changes up to and including revision 82 from bzr.dev
2366
bzr merge -r 82 ../bzr.dev
2368
To merge the changes introduced by 82, without previous changes:
2369
bzr merge -r 81..82 ../bzr.dev
2371
merge refuses to run if there are any uncommitted changes, unless
2374
The following merge types are available:
2376
takes_args = ['branch?']
2377
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2378
Option('show-base', help="Show base revision text in "
2380
Option('uncommitted', help='Apply uncommitted changes'
2381
' from a working copy, instead of branch changes'),
2382
Option('pull', help='If the destination is already'
2383
' completely merged into the source, pull from the'
2384
' source rather than merging. When this happens,'
2385
' you do not need to commit the result.'),
2388
def run(self, branch=None, revision=None, force=False, merge_type=None,
2389
show_base=False, reprocess=False, remember=False,
2390
uncommitted=False, pull=False):
2391
if merge_type is None:
2392
merge_type = _mod_merge.Merge3Merger
2394
tree = WorkingTree.open_containing(u'.')[0]
2396
if branch is not None:
2398
reader = bundle.read_bundle_from_url(branch)
2399
except errors.NotABundle:
2400
pass # Continue on considering this url a Branch
2402
conflicts = merge_bundle(reader, tree, not force, merge_type,
2403
reprocess, show_base)
2409
if revision is None \
2410
or len(revision) < 1 or revision[0].needs_branch():
2411
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2413
if revision is None or len(revision) < 1:
2416
other = [branch, None]
2419
other = [branch, -1]
2420
other_branch, path = Branch.open_containing(branch)
2423
raise errors.BzrCommandError('Cannot use --uncommitted and'
2424
' --revision at the same time.')
2425
branch = revision[0].get_branch() or branch
2426
if len(revision) == 1:
2428
other_branch, path = Branch.open_containing(branch)
2429
revno = revision[0].in_history(other_branch).revno
2430
other = [branch, revno]
2432
assert len(revision) == 2
2433
if None in revision:
2434
raise errors.BzrCommandError(
2435
"Merge doesn't permit empty revision specifier.")
2436
base_branch, path = Branch.open_containing(branch)
2437
branch1 = revision[1].get_branch() or branch
2438
other_branch, path1 = Branch.open_containing(branch1)
2439
if revision[0].get_branch() is not None:
2440
# then path was obtained from it, and is None.
2443
base = [branch, revision[0].in_history(base_branch).revno]
2444
other = [branch1, revision[1].in_history(other_branch).revno]
2446
if tree.branch.get_parent() is None or remember:
2447
tree.branch.set_parent(other_branch.base)
2450
interesting_files = [path]
2452
interesting_files = None
2453
pb = ui.ui_factory.nested_progress_bar()
2456
conflict_count = _merge_helper(
2457
other, base, check_clean=(not force),
2458
merge_type=merge_type,
2459
reprocess=reprocess,
2460
show_base=show_base,
2462
pb=pb, file_list=interesting_files)
2465
if conflict_count != 0:
2469
except errors.AmbiguousBase, e:
2470
m = ("sorry, bzr can't determine the right merge base yet\n"
2471
"candidates are:\n "
2472
+ "\n ".join(e.bases)
2474
"please specify an explicit base with -r,\n"
2475
"and (if you want) report this to the bzr developers\n")
2478
# TODO: move up to common parent; this isn't merge-specific anymore.
2479
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2480
"""Use tree.branch's parent if none was supplied.
2482
Report if the remembered location was used.
2484
if supplied_location is not None:
2485
return supplied_location
2486
stored_location = tree.branch.get_parent()
2487
mutter("%s", stored_location)
2488
if stored_location is None:
2489
raise errors.BzrCommandError("No location specified or remembered")
2490
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2491
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2492
return stored_location
2495
class cmd_remerge(Command):
2498
Use this if you want to try a different merge technique while resolving
2499
conflicts. Some merge techniques are better than others, and remerge
2500
lets you try different ones on different files.
2502
The options for remerge have the same meaning and defaults as the ones for
2503
merge. The difference is that remerge can (only) be run when there is a
2504
pending merge, and it lets you specify particular files.
2507
$ bzr remerge --show-base
2508
Re-do the merge of all conflicted files, and show the base text in
2509
conflict regions, in addition to the usual THIS and OTHER texts.
2511
$ bzr remerge --merge-type weave --reprocess foobar
2512
Re-do the merge of "foobar", using the weave merge algorithm, with
2513
additional processing to reduce the size of conflict regions.
2515
The following merge types are available:"""
2516
takes_args = ['file*']
2517
takes_options = ['merge-type', 'reprocess',
2518
Option('show-base', help="Show base revision text in "
2521
def run(self, file_list=None, merge_type=None, show_base=False,
2523
if merge_type is None:
2524
merge_type = _mod_merge.Merge3Merger
2525
tree, file_list = tree_files(file_list)
2528
parents = tree.get_parent_ids()
2529
if len(parents) != 2:
2530
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2531
" merges. Not cherrypicking or"
2533
repository = tree.branch.repository
2534
base_revision = common_ancestor(parents[0],
2535
parents[1], repository)
2536
base_tree = repository.revision_tree(base_revision)
2537
other_tree = repository.revision_tree(parents[1])
2538
interesting_ids = None
2540
conflicts = tree.conflicts()
2541
if file_list is not None:
2542
interesting_ids = set()
2543
for filename in file_list:
2544
file_id = tree.path2id(filename)
2546
raise errors.NotVersionedError(filename)
2547
interesting_ids.add(file_id)
2548
if tree.kind(file_id) != "directory":
2551
for name, ie in tree.inventory.iter_entries(file_id):
2552
interesting_ids.add(ie.file_id)
2553
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2555
# Remerge only supports resolving contents conflicts
2556
allowed_conflicts = ('text conflict', 'contents conflict')
2557
restore_files = [c.path for c in conflicts
2558
if c.typestring in allowed_conflicts]
2559
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2560
tree.set_conflicts(ConflictList(new_conflicts))
2561
if file_list is not None:
2562
restore_files = file_list
2563
for filename in restore_files:
2565
restore(tree.abspath(filename))
2566
except errors.NotConflicted:
2568
conflicts = _mod_merge.merge_inner(
2569
tree.branch, other_tree, base_tree,
2571
interesting_ids=interesting_ids,
2572
other_rev_id=parents[1],
2573
merge_type=merge_type,
2574
show_base=show_base,
2575
reprocess=reprocess)
2584
class cmd_revert(Command):
2585
"""Revert files to a previous revision.
2587
Giving a list of files will revert only those files. Otherwise, all files
2588
will be reverted. If the revision is not specified with '--revision', the
2589
last committed revision is used.
2591
To remove only some changes, without reverting to a prior version, use
2592
merge instead. For example, "merge . --r-2..-3" will remove the changes
2593
introduced by -2, without affecting the changes introduced by -1. Or
2594
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2596
By default, any files that have been manually changed will be backed up
2597
first. (Files changed only by merge are not backed up.) Backup files have
2598
'.~#~' appended to their name, where # is a number.
2600
When you provide files, you can use their current pathname or the pathname
2601
from the target revision. So you can use revert to "undelete" a file by
2602
name. If you name a directory, all the contents of that directory will be
2605
takes_options = ['revision', 'no-backup']
2606
takes_args = ['file*']
2607
aliases = ['merge-revert']
2609
def run(self, revision=None, no_backup=False, file_list=None):
2610
if file_list is not None:
2611
if len(file_list) == 0:
2612
raise errors.BzrCommandError("No files specified")
2616
tree, file_list = tree_files(file_list)
2617
if revision is None:
2618
# FIXME should be tree.last_revision
2619
rev_id = tree.last_revision()
2620
elif len(revision) != 1:
2621
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2623
rev_id = revision[0].in_history(tree.branch).rev_id
2624
pb = ui.ui_factory.nested_progress_bar()
2626
tree.revert(file_list,
2627
tree.branch.repository.revision_tree(rev_id),
2628
not no_backup, pb, report_changes=True)
2633
class cmd_assert_fail(Command):
2634
"""Test reporting of assertion failures"""
2635
# intended just for use in testing
2640
raise AssertionError("always fails")
2643
class cmd_help(Command):
2644
"""Show help on a command or other topic.
2646
For a list of all available commands, say 'bzr help commands'.
2648
takes_options = [Option('long', 'show help on all commands')]
2649
takes_args = ['topic?']
2650
aliases = ['?', '--help', '-?', '-h']
2653
def run(self, topic=None, long=False):
2655
if topic is None and long:
2657
bzrlib.help.help(topic)
2660
class cmd_shell_complete(Command):
2661
"""Show appropriate completions for context.
2663
For a list of all available commands, say 'bzr shell-complete'.
2665
takes_args = ['context?']
2670
def run(self, context=None):
2671
import shellcomplete
2672
shellcomplete.shellcomplete(context)
2675
class cmd_fetch(Command):
2676
"""Copy in history from another branch but don't merge it.
2678
This is an internal method used for pull and merge.
2681
takes_args = ['from_branch', 'to_branch']
2682
def run(self, from_branch, to_branch):
2683
from bzrlib.fetch import Fetcher
2684
from_b = Branch.open(from_branch)
2685
to_b = Branch.open(to_branch)
2686
Fetcher(to_b, from_b)
2689
class cmd_missing(Command):
2690
"""Show unmerged/unpulled revisions between two branches.
2692
OTHER_BRANCH may be local or remote.
2694
takes_args = ['other_branch?']
2695
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2697
'Display changes in the local branch only'),
2698
Option('theirs-only',
2699
'Display changes in the remote branch only'),
2704
encoding_type = 'replace'
2707
def run(self, other_branch=None, reverse=False, mine_only=False,
2708
theirs_only=False, log_format=None, long=False, short=False, line=False,
2709
show_ids=False, verbose=False):
2710
from bzrlib.missing import find_unmerged, iter_log_data
2711
from bzrlib.log import log_formatter
2712
local_branch = Branch.open_containing(u".")[0]
2713
parent = local_branch.get_parent()
2714
if other_branch is None:
2715
other_branch = parent
2716
if other_branch is None:
2717
raise errors.BzrCommandError("No peer location known or specified.")
2718
display_url = urlutils.unescape_for_display(parent,
2720
print "Using last location: " + display_url
2722
remote_branch = Branch.open(other_branch)
2723
if remote_branch.base == local_branch.base:
2724
remote_branch = local_branch
2725
local_branch.lock_read()
2727
remote_branch.lock_read()
2729
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2730
if (log_format is None):
2731
log_format = log.log_formatter_registry.get_default(
2733
lf = log_format(to_file=self.outf,
2735
show_timezone='original')
2736
if reverse is False:
2737
local_extra.reverse()
2738
remote_extra.reverse()
2739
if local_extra and not theirs_only:
2740
print "You have %d extra revision(s):" % len(local_extra)
2741
for data in iter_log_data(local_extra, local_branch.repository,
2744
printed_local = True
2746
printed_local = False
2747
if remote_extra and not mine_only:
2748
if printed_local is True:
2750
print "You are missing %d revision(s):" % len(remote_extra)
2751
for data in iter_log_data(remote_extra, remote_branch.repository,
2754
if not remote_extra and not local_extra:
2756
print "Branches are up to date."
2760
remote_branch.unlock()
2762
local_branch.unlock()
2763
if not status_code and parent is None and other_branch is not None:
2764
local_branch.lock_write()
2766
# handle race conditions - a parent might be set while we run.
2767
if local_branch.get_parent() is None:
2768
local_branch.set_parent(remote_branch.base)
2770
local_branch.unlock()
2774
class cmd_plugins(Command):
2779
import bzrlib.plugin
2780
from inspect import getdoc
2781
for name, plugin in bzrlib.plugin.all_plugins().items():
2782
if getattr(plugin, '__path__', None) is not None:
2783
print plugin.__path__[0]
2784
elif getattr(plugin, '__file__', None) is not None:
2785
print plugin.__file__
2791
print '\t', d.split('\n')[0]
2794
class cmd_testament(Command):
2795
"""Show testament (signing-form) of a revision."""
2796
takes_options = ['revision',
2797
Option('long', help='Produce long-format testament'),
2798
Option('strict', help='Produce a strict-format'
2800
takes_args = ['branch?']
2802
def run(self, branch=u'.', revision=None, long=False, strict=False):
2803
from bzrlib.testament import Testament, StrictTestament
2805
testament_class = StrictTestament
2807
testament_class = Testament
2808
b = WorkingTree.open_containing(branch)[0].branch
2811
if revision is None:
2812
rev_id = b.last_revision()
2814
rev_id = revision[0].in_history(b).rev_id
2815
t = testament_class.from_revision(b.repository, rev_id)
2817
sys.stdout.writelines(t.as_text_lines())
2819
sys.stdout.write(t.as_short_text())
2824
class cmd_annotate(Command):
2825
"""Show the origin of each line in a file.
2827
This prints out the given file with an annotation on the left side
2828
indicating which revision, author and date introduced the change.
2830
If the origin is the same for a run of consecutive lines, it is
2831
shown only at the top, unless the --all option is given.
2833
# TODO: annotate directories; showing when each file was last changed
2834
# TODO: if the working copy is modified, show annotations on that
2835
# with new uncommitted lines marked
2836
aliases = ['ann', 'blame', 'praise']
2837
takes_args = ['filename']
2838
takes_options = [Option('all', help='show annotations on all lines'),
2839
Option('long', help='show date in annotations'),
2845
def run(self, filename, all=False, long=False, revision=None,
2847
from bzrlib.annotate import annotate_file
2848
tree, relpath = WorkingTree.open_containing(filename)
2849
branch = tree.branch
2852
if revision is None:
2853
revision_id = branch.last_revision()
2854
elif len(revision) != 1:
2855
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2857
revision_id = revision[0].in_history(branch).rev_id
2858
file_id = tree.inventory.path2id(relpath)
2859
tree = branch.repository.revision_tree(revision_id)
2860
file_version = tree.inventory[file_id].revision
2861
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2867
class cmd_re_sign(Command):
2868
"""Create a digital signature for an existing revision."""
2869
# TODO be able to replace existing ones.
2871
hidden = True # is this right ?
2872
takes_args = ['revision_id*']
2873
takes_options = ['revision']
2875
def run(self, revision_id_list=None, revision=None):
2876
import bzrlib.gpg as gpg
2877
if revision_id_list is not None and revision is not None:
2878
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2879
if revision_id_list is None and revision is None:
2880
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2881
b = WorkingTree.open_containing(u'.')[0].branch
2882
gpg_strategy = gpg.GPGStrategy(b.get_config())
2883
if revision_id_list is not None:
2884
for revision_id in revision_id_list:
2885
b.repository.sign_revision(revision_id, gpg_strategy)
2886
elif revision is not None:
2887
if len(revision) == 1:
2888
revno, rev_id = revision[0].in_history(b)
2889
b.repository.sign_revision(rev_id, gpg_strategy)
2890
elif len(revision) == 2:
2891
# are they both on rh- if so we can walk between them
2892
# might be nice to have a range helper for arbitrary
2893
# revision paths. hmm.
2894
from_revno, from_revid = revision[0].in_history(b)
2895
to_revno, to_revid = revision[1].in_history(b)
2896
if to_revid is None:
2897
to_revno = b.revno()
2898
if from_revno is None or to_revno is None:
2899
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2900
for revno in range(from_revno, to_revno + 1):
2901
b.repository.sign_revision(b.get_rev_id(revno),
2904
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2907
class cmd_bind(Command):
2908
"""Convert the current branch into a checkout of the supplied branch.
2910
Once converted into a checkout, commits must succeed on the master branch
2911
before they will be applied to the local branch.
2913
See "help checkouts" for more information on checkouts.
2916
takes_args = ['location?']
2919
def run(self, location=None):
2920
b, relpath = Branch.open_containing(u'.')
2921
if location is None:
2923
location = b.get_old_bound_location()
2924
except errors.UpgradeRequired:
2925
raise errors.BzrCommandError('No location supplied. '
2926
'This format does not remember old locations.')
2928
if location is None:
2929
raise errors.BzrCommandError('No location supplied. '
2930
'No previous location known')
2931
b_other = Branch.open(location)
2934
except errors.DivergedBranches:
2935
raise errors.BzrCommandError('These branches have diverged.'
2936
' Try merging, and then bind again.')
2939
class cmd_unbind(Command):
2940
"""Convert the current checkout into a regular branch.
2942
After unbinding, the local branch is considered independent and subsequent
2943
commits will be local only.
2945
See "help checkouts" for more information on checkouts.
2952
b, relpath = Branch.open_containing(u'.')
2954
raise errors.BzrCommandError('Local branch is not bound')
2957
class cmd_uncommit(Command):
2958
"""Remove the last committed revision.
2960
--verbose will print out what is being removed.
2961
--dry-run will go through all the motions, but not actually
2964
In the future, uncommit will create a revision bundle, which can then
2968
# TODO: jam 20060108 Add an option to allow uncommit to remove
2969
# unreferenced information in 'branch-as-repository' branches.
2970
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2971
# information in shared branches as well.
2972
takes_options = ['verbose', 'revision',
2973
Option('dry-run', help='Don\'t actually make changes'),
2974
Option('force', help='Say yes to all questions.')]
2975
takes_args = ['location?']
2978
def run(self, location=None,
2979
dry_run=False, verbose=False,
2980
revision=None, force=False):
2981
from bzrlib.log import log_formatter, show_log
2983
from bzrlib.uncommit import uncommit
2985
if location is None:
2987
control, relpath = bzrdir.BzrDir.open_containing(location)
2989
tree = control.open_workingtree()
2991
except (errors.NoWorkingTree, errors.NotLocalUrl):
2993
b = control.open_branch()
2996
if revision is None:
2999
# 'bzr uncommit -r 10' actually means uncommit
3000
# so that the final tree is at revno 10.
3001
# but bzrlib.uncommit.uncommit() actually uncommits
3002
# the revisions that are supplied.
3003
# So we need to offset it by one
3004
revno = revision[0].in_history(b).revno+1
3006
if revno <= b.revno():
3007
rev_id = b.get_rev_id(revno)
3009
self.outf.write('No revisions to uncommit.\n')
3012
lf = log_formatter('short',
3014
show_timezone='original')
3019
direction='forward',
3020
start_revision=revno,
3021
end_revision=b.revno())
3024
print 'Dry-run, pretending to remove the above revisions.'
3026
val = raw_input('Press <enter> to continue')
3028
print 'The above revision(s) will be removed.'
3030
val = raw_input('Are you sure [y/N]? ')
3031
if val.lower() not in ('y', 'yes'):
3035
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3039
class cmd_break_lock(Command):
3040
"""Break a dead lock on a repository, branch or working directory.
3042
CAUTION: Locks should only be broken when you are sure that the process
3043
holding the lock has been stopped.
3045
You can get information on what locks are open via the 'bzr info' command.
3050
takes_args = ['location?']
3052
def run(self, location=None, show=False):
3053
if location is None:
3055
control, relpath = bzrdir.BzrDir.open_containing(location)
3057
control.break_lock()
3058
except NotImplementedError:
3062
class cmd_wait_until_signalled(Command):
3063
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3065
This just prints a line to signal when it is ready, then blocks on stdin.
3071
sys.stdout.write("running\n")
3073
sys.stdin.readline()
3076
class cmd_serve(Command):
3077
"""Run the bzr server."""
3079
aliases = ['server']
3083
help='serve on stdin/out for use from inetd or sshd'),
3085
help='listen for connections on nominated port of the form '
3086
'[hostname:]portnumber. Passing 0 as the port number will '
3087
'result in a dynamically allocated port.',
3090
help='serve contents of directory',
3092
Option('allow-writes',
3093
help='By default the server is a readonly server. Supplying '
3094
'--allow-writes enables write access to the contents of '
3095
'the served directory and below. '
3099
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3100
from bzrlib.transport import smart
3101
from bzrlib.transport import get_transport
3102
if directory is None:
3103
directory = os.getcwd()
3104
url = urlutils.local_path_to_url(directory)
3105
if not allow_writes:
3106
url = 'readonly+' + url
3107
t = get_transport(url)
3109
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3110
elif port is not None:
3112
host, port = port.split(':')
3115
server = smart.SmartTCPServer(t, host=host, port=int(port))
3116
print 'listening on port: ', server.port
3119
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3123
# command-line interpretation helper for merge-related commands
3124
def _merge_helper(other_revision, base_revision,
3125
check_clean=True, ignore_zero=False,
3126
this_dir=None, backup_files=False,
3128
file_list=None, show_base=False, reprocess=False,
3130
pb=DummyProgress()):
3131
"""Merge changes into a tree.
3134
list(path, revno) Base for three-way merge.
3135
If [None, None] then a base will be automatically determined.
3137
list(path, revno) Other revision for three-way merge.
3139
Directory to merge changes into; '.' by default.
3141
If true, this_dir must have no uncommitted changes before the
3143
ignore_zero - If true, suppress the "zero conflicts" message when
3144
there are no conflicts; should be set when doing something we expect
3145
to complete perfectly.
3146
file_list - If supplied, merge only changes to selected files.
3148
All available ancestors of other_revision and base_revision are
3149
automatically pulled into the branch.
3151
The revno may be -1 to indicate the last revision on the branch, which is
3154
This function is intended for use from the command line; programmatic
3155
clients might prefer to call merge.merge_inner(), which has less magic
3158
# Loading it late, so that we don't always have to import bzrlib.merge
3159
if merge_type is None:
3160
merge_type = _mod_merge.Merge3Merger
3161
if this_dir is None:
3163
this_tree = WorkingTree.open_containing(this_dir)[0]
3164
if show_base and not merge_type is _mod_merge.Merge3Merger:
3165
raise errors.BzrCommandError("Show-base is not supported for this merge"
3166
" type. %s" % merge_type)
3167
if reprocess and not merge_type.supports_reprocess:
3168
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3169
" type %s." % merge_type)
3170
if reprocess and show_base:
3171
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3173
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3175
merger.pp = ProgressPhase("Merge phase", 5, pb)
3176
merger.pp.next_phase()
3177
merger.check_basis(check_clean)
3178
merger.set_other(other_revision)
3179
merger.pp.next_phase()
3180
merger.set_base(base_revision)
3181
if merger.base_rev_id == merger.other_rev_id:
3182
note('Nothing to do.')
3184
if file_list is None:
3185
if pull and merger.base_rev_id == merger.this_rev_id:
3186
count = merger.this_tree.pull(merger.this_branch,
3187
False, merger.other_rev_id)
3188
note('%d revision(s) pulled.' % (count,))
3190
merger.backup_files = backup_files
3191
merger.merge_type = merge_type
3192
merger.set_interesting_files(file_list)
3193
merger.show_base = show_base
3194
merger.reprocess = reprocess
3195
conflicts = merger.do_merge()
3196
if file_list is None:
3197
merger.set_pending()
3204
merge = _merge_helper
3207
# these get imported and then picked up by the scan for cmd_*
3208
# TODO: Some more consistent way to split command definitions across files;
3209
# we do need to load at least some information about them to know of
3210
# aliases. ideally we would avoid loading the implementation until the
3211
# details were needed.
3212
from bzrlib.cmd_version_info import cmd_version_info
3213
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3214
from bzrlib.bundle.commands import cmd_bundle_revisions
3215
from bzrlib.sign_my_commits import cmd_sign_my_commits
3216
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3217
cmd_weave_plan_merge, cmd_weave_merge_text