1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
47
from bzrlib.branch import Branch
48
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
49
from bzrlib.conflicts import ConflictList
50
from bzrlib.revision import common_ancestor
51
from bzrlib.revisionspec import RevisionSpec
52
from bzrlib.workingtree import WorkingTree
55
from bzrlib.commands import Command, display_command
56
from bzrlib.option import Option, RegistryOption
57
from bzrlib.progress import DummyProgress, ProgressPhase
58
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
61
def tree_files(file_list, default_branch=u'.'):
63
return internal_tree_files(file_list, default_branch)
64
except errors.FileInWrongBranch, e:
65
raise errors.BzrCommandError("%s is not in the same branch as %s" %
66
(e.path, file_list[0]))
69
# XXX: Bad function name; should possibly also be a class method of
70
# WorkingTree rather than a function.
71
def internal_tree_files(file_list, default_branch=u'.'):
72
"""Convert command-line paths to a WorkingTree and relative paths.
74
This is typically used for command-line processors that take one or
75
more filenames, and infer the workingtree that contains them.
77
The filenames given are not required to exist.
79
:param file_list: Filenames to convert.
81
:param default_branch: Fallback tree path to use if file_list is empty or
84
:return: workingtree, [relative_paths]
86
if file_list is None or len(file_list) == 0:
87
return WorkingTree.open_containing(default_branch)[0], file_list
88
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
90
for filename in file_list:
92
new_list.append(tree.relpath(osutils.dereference_path(filename)))
93
except errors.PathNotChild:
94
raise errors.FileInWrongBranch(tree.branch, filename)
98
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
99
def get_format_type(typestring):
100
"""Parse and return a format specifier."""
101
# Have to use BzrDirMetaFormat1 directly, so that
102
# RepositoryFormat.set_default_format works
103
if typestring == "default":
104
return bzrdir.BzrDirMetaFormat1()
106
return bzrdir.format_registry.make_bzrdir(typestring)
108
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
109
raise errors.BzrCommandError(msg)
112
# TODO: Make sure no commands unconditionally use the working directory as a
113
# branch. If a filename argument is used, the first of them should be used to
114
# specify the branch. (Perhaps this can be factored out into some kind of
115
# Argument class, representing a file in a branch, where the first occurrence
118
class cmd_status(Command):
119
"""Display status summary.
121
This reports on versioned and unknown files, reporting them
122
grouped by state. Possible states are:
125
Versioned in the working copy but not in the previous revision.
128
Versioned in the previous revision but removed or deleted
132
Path of this file changed from the previous revision;
133
the text may also have changed. This includes files whose
134
parent directory was renamed.
137
Text has changed since the previous revision.
140
File kind has been changed (e.g. from file to directory).
143
Not versioned and not matching an ignore pattern.
145
To see ignored files use 'bzr ignored'. For details in the
146
changes to file texts, use 'bzr diff'.
148
--short gives a status flags for each item, similar to the SVN's status
151
Column 1: versioning / renames
157
P Entry for a pending merge (not a file)
166
* The execute bit was changed
168
If no arguments are specified, the status of the entire working
169
directory is shown. Otherwise, only the status of the specified
170
files or directories is reported. If a directory is given, status
171
is reported for everything inside that directory.
173
If a revision argument is given, the status is calculated against
174
that revision, or between two revisions if two are provided.
177
# TODO: --no-recurse, --recurse options
179
takes_args = ['file*']
180
takes_options = ['show-ids', 'revision', 'short']
181
aliases = ['st', 'stat']
183
encoding_type = 'replace'
186
def run(self, show_ids=False, file_list=None, revision=None, short=False):
187
from bzrlib.status import show_tree_status
189
tree, file_list = tree_files(file_list)
191
show_tree_status(tree, show_ids=show_ids,
192
specific_files=file_list, revision=revision,
197
class cmd_cat_revision(Command):
198
"""Write out metadata for a revision.
200
The revision to print can either be specified by a specific
201
revision identifier, or you can use --revision.
205
takes_args = ['revision_id?']
206
takes_options = ['revision']
207
# cat-revision is more for frontends so should be exact
211
def run(self, revision_id=None, revision=None):
213
if revision_id is not None and revision is not None:
214
raise errors.BzrCommandError('You can only supply one of'
215
' revision_id or --revision')
216
if revision_id is None and revision is None:
217
raise errors.BzrCommandError('You must supply either'
218
' --revision or a revision_id')
219
b = WorkingTree.open_containing(u'.')[0].branch
221
# TODO: jam 20060112 should cat-revision always output utf-8?
222
if revision_id is not None:
223
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
224
elif revision is not None:
227
raise errors.BzrCommandError('You cannot specify a NULL'
229
revno, rev_id = rev.in_history(b)
230
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
233
class cmd_remove_tree(Command):
234
"""Remove the working tree from a given branch/checkout.
236
Since a lightweight checkout is little more than a working tree
237
this will refuse to run against one.
242
takes_args = ['location?']
244
def run(self, location='.'):
245
d = bzrdir.BzrDir.open(location)
248
working = d.open_workingtree()
249
except errors.NoWorkingTree:
250
raise errors.BzrCommandError("No working tree to remove")
251
except errors.NotLocalUrl:
252
raise errors.BzrCommandError("You cannot remove the working tree of a "
255
working_path = working.bzrdir.root_transport.base
256
branch_path = working.branch.bzrdir.root_transport.base
257
if working_path != branch_path:
258
raise errors.BzrCommandError("You cannot remove the working tree from "
259
"a lightweight checkout")
261
d.destroy_workingtree()
264
class cmd_revno(Command):
265
"""Show current revision number.
267
This is equal to the number of revisions on this branch.
270
takes_args = ['location?']
273
def run(self, location=u'.'):
274
self.outf.write(str(Branch.open_containing(location)[0].revno()))
275
self.outf.write('\n')
278
class cmd_revision_info(Command):
279
"""Show revision number and revision id for a given revision identifier.
282
takes_args = ['revision_info*']
283
takes_options = ['revision']
286
def run(self, revision=None, revision_info_list=[]):
289
if revision is not None:
290
revs.extend(revision)
291
if revision_info_list is not None:
292
for rev in revision_info_list:
293
revs.append(RevisionSpec.from_string(rev))
295
raise errors.BzrCommandError('You must supply a revision identifier')
297
b = WorkingTree.open_containing(u'.')[0].branch
300
revinfo = rev.in_history(b)
301
if revinfo.revno is None:
302
print ' %s' % revinfo.rev_id
304
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
307
class cmd_add(Command):
308
"""Add specified files or directories.
310
In non-recursive mode, all the named items are added, regardless
311
of whether they were previously ignored. A warning is given if
312
any of the named files are already versioned.
314
In recursive mode (the default), files are treated the same way
315
but the behaviour for directories is different. Directories that
316
are already versioned do not give a warning. All directories,
317
whether already versioned or not, are searched for files or
318
subdirectories that are neither versioned or ignored, and these
319
are added. This search proceeds recursively into versioned
320
directories. If no names are given '.' is assumed.
322
Therefore simply saying 'bzr add' will version all files that
323
are currently unknown.
325
Adding a file whose parent directory is not versioned will
326
implicitly add the parent, and so on up to the root. This means
327
you should never need to explicitly add a directory, they'll just
328
get added when you add a file in the directory.
330
--dry-run will show which files would be added, but not actually
333
--file-ids-from will try to use the file ids from the supplied path.
334
It looks up ids trying to find a matching parent directory with the
335
same filename, and then by pure path.
337
takes_args = ['file*']
338
takes_options = ['no-recurse', 'dry-run', 'verbose',
339
Option('file-ids-from', type=unicode,
340
help='Lookup file ids from here')]
341
encoding_type = 'replace'
343
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
347
if file_ids_from is not None:
349
base_tree, base_path = WorkingTree.open_containing(
351
except errors.NoWorkingTree:
352
base_branch, base_path = Branch.open_containing(
354
base_tree = base_branch.basis_tree()
356
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
357
to_file=self.outf, should_print=(not is_quiet()))
359
action = bzrlib.add.AddAction(to_file=self.outf,
360
should_print=(not is_quiet()))
362
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
363
action=action, save=not dry_run)
366
for glob in sorted(ignored.keys()):
367
for path in ignored[glob]:
368
self.outf.write("ignored %s matching \"%s\"\n"
372
for glob, paths in ignored.items():
373
match_len += len(paths)
374
self.outf.write("ignored %d file(s).\n" % match_len)
375
self.outf.write("If you wish to add some of these files,"
376
" please add them by name.\n")
379
class cmd_mkdir(Command):
380
"""Create a new versioned directory.
382
This is equivalent to creating the directory and then adding it.
385
takes_args = ['dir+']
386
encoding_type = 'replace'
388
def run(self, dir_list):
391
wt, dd = WorkingTree.open_containing(d)
393
self.outf.write('added %s\n' % d)
396
class cmd_relpath(Command):
397
"""Show path of a file relative to root"""
399
takes_args = ['filename']
403
def run(self, filename):
404
# TODO: jam 20050106 Can relpath return a munged path if
405
# sys.stdout encoding cannot represent it?
406
tree, relpath = WorkingTree.open_containing(filename)
407
self.outf.write(relpath)
408
self.outf.write('\n')
411
class cmd_inventory(Command):
412
"""Show inventory of the current working copy or a revision.
414
It is possible to limit the output to a particular entry
415
type using the --kind option. For example: --kind file.
417
It is also possible to restrict the list of files to a specific
418
set. For example: bzr inventory --show-ids this/file
425
takes_options = ['revision', 'show-ids', 'kind']
427
takes_args = ['file*']
430
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
431
if kind and kind not in ['file', 'directory', 'symlink']:
432
raise errors.BzrCommandError('invalid kind specified')
434
work_tree, file_list = tree_files(file_list)
436
if revision is not None:
437
if len(revision) > 1:
438
raise errors.BzrCommandError('bzr inventory --revision takes'
439
' exactly one revision identifier')
440
revision_id = revision[0].in_history(work_tree.branch).rev_id
441
tree = work_tree.branch.repository.revision_tree(revision_id)
443
# We include work_tree as well as 'tree' here
444
# So that doing '-r 10 path/foo' will lookup whatever file
445
# exists now at 'path/foo' even if it has been renamed, as
446
# well as whatever files existed in revision 10 at path/foo
447
trees = [tree, work_tree]
452
if file_list is not None:
453
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
454
require_versioned=True)
455
# find_ids_across_trees may include some paths that don't
457
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
458
for file_id in file_ids if file_id in tree)
460
entries = tree.inventory.entries()
462
for path, entry in entries:
463
if kind and kind != entry.kind:
466
self.outf.write('%-50s %s\n' % (path, entry.file_id))
468
self.outf.write(path)
469
self.outf.write('\n')
472
class cmd_mv(Command):
473
"""Move or rename a file.
476
bzr mv OLDNAME NEWNAME
477
bzr mv SOURCE... DESTINATION
479
If the last argument is a versioned directory, all the other names
480
are moved into it. Otherwise, there must be exactly two arguments
481
and the file is changed to a new name.
483
If OLDNAME does not exist on the filesystem but is versioned and
484
NEWNAME does exist on the filesystem but is not versioned, mv
485
assumes that the file has been manually moved and only updates
486
its internal inventory to reflect that change.
487
The same is valid when moving many SOURCE files to a DESTINATION.
489
Files cannot be moved between branches.
492
takes_args = ['names*']
493
takes_options = [Option("after", help="move only the bzr identifier"
494
" of the file (file has already been moved). Use this flag if"
495
" bzr is not able to detect this itself.")]
496
aliases = ['move', 'rename']
497
encoding_type = 'replace'
499
def run(self, names_list, after=False):
500
if names_list is None:
503
if len(names_list) < 2:
504
raise errors.BzrCommandError("missing file argument")
505
tree, rel_names = tree_files(names_list)
507
if os.path.isdir(names_list[-1]):
508
# move into existing directory
509
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
510
self.outf.write("%s => %s\n" % pair)
512
if len(names_list) != 2:
513
raise errors.BzrCommandError('to mv multiple files the'
514
' destination must be a versioned'
516
tree.rename_one(rel_names[0], rel_names[1], after=after)
517
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
520
class cmd_pull(Command):
521
"""Turn this branch into a mirror of another branch.
523
This command only works on branches that have not diverged. Branches are
524
considered diverged if the destination branch's most recent commit is one
525
that has not been merged (directly or indirectly) into the parent.
527
If branches have diverged, you can use 'bzr merge' to integrate the changes
528
from one into the other. Once one branch has merged, the other should
529
be able to pull it again.
531
If you want to forget your local changes and just update your branch to
532
match the remote one, use pull --overwrite.
534
If there is no default location set, the first pull will set it. After
535
that, you can omit the location to use the default. To change the
536
default, use --remember. The value will only be saved if the remote
537
location can be accessed.
540
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
541
takes_args = ['location?']
542
encoding_type = 'replace'
544
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
545
# FIXME: too much stuff is in the command class
547
tree_to = WorkingTree.open_containing(u'.')[0]
548
branch_to = tree_to.branch
549
except errors.NoWorkingTree:
551
branch_to = Branch.open_containing(u'.')[0]
554
if location is not None:
556
reader = bundle.read_bundle_from_url(location)
557
except errors.NotABundle:
558
pass # Continue on considering this url a Branch
560
stored_loc = branch_to.get_parent()
562
if stored_loc is None:
563
raise errors.BzrCommandError("No pull location known or"
566
display_url = urlutils.unescape_for_display(stored_loc,
568
self.outf.write("Using saved location: %s\n" % display_url)
569
location = stored_loc
572
if reader is not None:
573
install_bundle(branch_to.repository, reader)
574
branch_from = branch_to
576
branch_from = Branch.open(location)
578
if branch_to.get_parent() is None or remember:
579
branch_to.set_parent(branch_from.base)
583
if reader is not None:
584
rev_id = reader.target
585
elif len(revision) == 1:
586
rev_id = revision[0].in_history(branch_from).rev_id
588
raise errors.BzrCommandError('bzr pull --revision takes one value.')
590
old_rh = branch_to.revision_history()
591
if tree_to is not None:
592
count = tree_to.pull(branch_from, overwrite, rev_id)
594
count = branch_to.pull(branch_from, overwrite, rev_id)
595
note('%d revision(s) pulled.' % (count,))
598
new_rh = branch_to.revision_history()
601
from bzrlib.log import show_changed_revisions
602
show_changed_revisions(branch_to, old_rh, new_rh,
606
class cmd_push(Command):
607
"""Update a mirror of this branch.
609
The target branch will not have its working tree populated because this
610
is both expensive, and is not supported on remote file systems.
612
Some smart servers or protocols *may* put the working tree in place in
615
This command only works on branches that have not diverged. Branches are
616
considered diverged if the destination branch's most recent commit is one
617
that has not been merged (directly or indirectly) by the source branch.
619
If branches have diverged, you can use 'bzr push --overwrite' to replace
620
the other branch completely, discarding its unmerged changes.
622
If you want to ensure you have the different changes in the other branch,
623
do a merge (see bzr help merge) from the other branch, and commit that.
624
After that you will be able to do a push without '--overwrite'.
626
If there is no default push location set, the first push will set it.
627
After that, you can omit the location to use the default. To change the
628
default, use --remember. The value will only be saved if the remote
629
location can be accessed.
632
takes_options = ['remember', 'overwrite', 'verbose',
633
Option('create-prefix',
634
help='Create the path leading up to the branch '
635
'if it does not already exist'),
636
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. See "bzr '
1191
'help formats" for details',
1192
converter=bzrdir.format_registry.make_bzrdir,
1193
registry=bzrdir.format_registry,
1194
value_switches=True, title="Branch Format"),
1196
def run(self, location=None, format=None):
1198
format = bzrdir.format_registry.make_bzrdir('default')
1199
if location is None:
1202
to_transport = transport.get_transport(location)
1204
# The path has to exist to initialize a
1205
# branch inside of it.
1206
# Just using os.mkdir, since I don't
1207
# believe that we want to create a bunch of
1208
# locations if the user supplies an extended path
1209
# TODO: create-prefix
1211
to_transport.mkdir('.')
1212
except errors.FileExists:
1216
existing_bzrdir = bzrdir.BzrDir.open(location)
1217
except errors.NotBranchError:
1218
# really a NotBzrDir error...
1219
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1221
from bzrlib.transport.local import LocalTransport
1222
if existing_bzrdir.has_branch():
1223
if (isinstance(to_transport, LocalTransport)
1224
and not existing_bzrdir.has_workingtree()):
1225
raise errors.BranchExistsWithoutWorkingTree(location)
1226
raise errors.AlreadyBranchError(location)
1228
existing_bzrdir.create_branch()
1229
existing_bzrdir.create_workingtree()
1232
class cmd_init_repository(Command):
1233
"""Create a shared repository to hold branches.
1235
New branches created under the repository directory will store their revisions
1236
in the repository, not in the branch directory, if the branch format supports
1242
bzr checkout --lightweight repo/trunk trunk-checkout
1246
takes_args = ["location"]
1247
takes_options = [RegistryOption('format',
1248
help='Specify a format for this repository. See'
1249
' "bzr help formats" for details',
1250
registry=bzrdir.format_registry,
1251
converter=bzrdir.format_registry.make_bzrdir,
1252
value_switches=True, title='Repository format'),
1254
help='Allows branches in repository to have'
1256
aliases = ["init-repo"]
1257
def run(self, location, format=None, trees=False):
1259
format = bzrdir.format_registry.make_bzrdir('default')
1261
if location is None:
1264
to_transport = transport.get_transport(location)
1266
to_transport.mkdir('.')
1267
except errors.FileExists:
1270
newdir = format.initialize_on_transport(to_transport)
1271
repo = newdir.create_repository(shared=True)
1272
repo.set_make_working_trees(trees)
1275
class cmd_diff(Command):
1276
"""Show differences in the working tree or between revisions.
1278
If files are listed, only the changes in those files are listed.
1279
Otherwise, all changes for the tree are listed.
1281
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1282
produces patches suitable for "patch -p1".
1286
Shows the difference in the working tree versus the last commit
1288
Difference between the working tree and revision 1
1290
Difference between revision 2 and revision 1
1291
bzr diff --diff-prefix old/:new/
1292
Same as 'bzr diff' but prefix paths with old/ and new/
1293
bzr diff bzr.mine bzr.dev
1294
Show the differences between the two working trees
1296
Show just the differences for 'foo.c'
1298
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1299
# or a graphical diff.
1301
# TODO: Python difflib is not exactly the same as unidiff; should
1302
# either fix it up or prefer to use an external diff.
1304
# TODO: Selected-file diff is inefficient and doesn't show you
1307
# TODO: This probably handles non-Unix newlines poorly.
1309
takes_args = ['file*']
1310
takes_options = ['revision', 'diff-options',
1311
Option('prefix', type=str,
1313
help='Set prefixes to added to old and new filenames, as '
1314
'two values separated by a colon.'),
1316
aliases = ['di', 'dif']
1317
encoding_type = 'exact'
1320
def run(self, revision=None, file_list=None, diff_options=None,
1322
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1324
if (prefix is None) or (prefix == '0'):
1332
old_label, new_label = prefix.split(":")
1334
raise BzrCommandError(
1335
"--prefix expects two values separated by a colon")
1337
if revision and len(revision) > 2:
1338
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1339
' one or two revision specifiers')
1342
tree1, file_list = internal_tree_files(file_list)
1346
except errors.FileInWrongBranch:
1347
if len(file_list) != 2:
1348
raise errors.BzrCommandError("Files are in different branches")
1350
tree1, file1 = WorkingTree.open_containing(file_list[0])
1351
tree2, file2 = WorkingTree.open_containing(file_list[1])
1352
if file1 != "" or file2 != "":
1353
# FIXME diff those two files. rbc 20051123
1354
raise errors.BzrCommandError("Files are in different branches")
1356
except errors.NotBranchError:
1357
if (revision is not None and len(revision) == 2
1358
and not revision[0].needs_branch()
1359
and not revision[1].needs_branch()):
1360
# If both revision specs include a branch, we can
1361
# diff them without needing a local working tree
1362
tree1, tree2 = None, None
1366
if tree2 is not None:
1367
if revision is not None:
1368
# FIXME: but there should be a clean way to diff between
1369
# non-default versions of two trees, it's not hard to do
1371
raise errors.BzrCommandError(
1372
"Sorry, diffing arbitrary revisions across branches "
1373
"is not implemented yet")
1374
return show_diff_trees(tree1, tree2, sys.stdout,
1375
specific_files=file_list,
1376
external_diff_options=diff_options,
1377
old_label=old_label, new_label=new_label)
1379
return diff_cmd_helper(tree1, file_list, diff_options,
1380
revision_specs=revision,
1381
old_label=old_label, new_label=new_label)
1384
class cmd_deleted(Command):
1385
"""List files deleted in the working tree.
1387
# TODO: Show files deleted since a previous revision, or
1388
# between two revisions.
1389
# TODO: Much more efficient way to do this: read in new
1390
# directories with readdir, rather than stating each one. Same
1391
# level of effort but possibly much less IO. (Or possibly not,
1392
# if the directories are very large...)
1393
takes_options = ['show-ids']
1396
def run(self, show_ids=False):
1397
tree = WorkingTree.open_containing(u'.')[0]
1398
old = tree.basis_tree()
1399
for path, ie in old.inventory.iter_entries():
1400
if not tree.has_id(ie.file_id):
1401
self.outf.write(path)
1403
self.outf.write(' ')
1404
self.outf.write(ie.file_id)
1405
self.outf.write('\n')
1408
class cmd_modified(Command):
1409
"""List files modified in working tree.
1411
See also: "bzr status".
1418
tree = WorkingTree.open_containing(u'.')[0]
1419
td = tree.changes_from(tree.basis_tree())
1420
for path, id, kind, text_modified, meta_modified in td.modified:
1421
self.outf.write(path + '\n')
1424
class cmd_added(Command):
1425
"""List files added in working tree.
1427
See also: "bzr status".
1434
wt = WorkingTree.open_containing(u'.')[0]
1435
basis_inv = wt.basis_tree().inventory
1438
if file_id in basis_inv:
1440
if inv.is_root(file_id) and len(basis_inv) == 0:
1442
path = inv.id2path(file_id)
1443
if not os.access(osutils.abspath(path), os.F_OK):
1445
self.outf.write(path + '\n')
1448
class cmd_root(Command):
1449
"""Show the tree root directory.
1451
The root is the nearest enclosing directory with a .bzr control
1453
takes_args = ['filename?']
1455
def run(self, filename=None):
1456
"""Print the branch root."""
1457
tree = WorkingTree.open_containing(filename)[0]
1458
self.outf.write(tree.basedir + '\n')
1461
class cmd_log(Command):
1462
"""Show log of a branch, file, or directory.
1464
By default show the log of the branch containing the working directory.
1466
To request a range of logs, you can use the command -r begin..end
1467
-r revision requests a specific revision, -r ..end or -r begin.. are
1473
bzr log -r -10.. http://server/branch
1476
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1478
takes_args = ['location?']
1479
takes_options = [Option('forward',
1480
help='show from oldest to newest'),
1484
help='show files changed in each revision'),
1485
'show-ids', 'revision',
1489
help='show revisions whose message matches this regexp',
1492
encoding_type = 'replace'
1495
def run(self, location=None, timezone='original',
1502
from bzrlib.log import show_log
1503
assert message is None or isinstance(message, basestring), \
1504
"invalid message argument %r" % message
1505
direction = (forward and 'forward') or 'reverse'
1510
# find the file id to log:
1512
dir, fp = bzrdir.BzrDir.open_containing(location)
1513
b = dir.open_branch()
1517
inv = dir.open_workingtree().inventory
1518
except (errors.NotBranchError, errors.NotLocalUrl):
1519
# either no tree, or is remote.
1520
inv = b.basis_tree().inventory
1521
file_id = inv.path2id(fp)
1523
raise errors.BzrCommandError(
1524
"Path does not have any revision history: %s" %
1528
# FIXME ? log the current subdir only RBC 20060203
1529
if revision is not None \
1530
and len(revision) > 0 and revision[0].get_branch():
1531
location = revision[0].get_branch()
1534
dir, relpath = bzrdir.BzrDir.open_containing(location)
1535
b = dir.open_branch()
1537
if revision is None:
1540
elif len(revision) == 1:
1541
rev1 = rev2 = revision[0].in_history(b).revno
1542
elif len(revision) == 2:
1543
if revision[1].get_branch() != revision[0].get_branch():
1544
# b is taken from revision[0].get_branch(), and
1545
# show_log will use its revision_history. Having
1546
# different branches will lead to weird behaviors.
1547
raise errors.BzrCommandError(
1548
"Log doesn't accept two revisions in different branches.")
1549
if revision[0].spec is None:
1550
# missing begin-range means first revision
1553
rev1 = revision[0].in_history(b).revno
1555
if revision[1].spec is None:
1556
# missing end-range means last known revision
1559
rev2 = revision[1].in_history(b).revno
1561
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1563
# By this point, the revision numbers are converted to the +ve
1564
# form if they were supplied in the -ve form, so we can do
1565
# this comparison in relative safety
1567
(rev2, rev1) = (rev1, rev2)
1569
if log_format is None:
1570
log_format = log.log_formatter_registry.get_default(b)
1572
lf = log_format(show_ids=show_ids, to_file=self.outf,
1573
show_timezone=timezone)
1579
direction=direction,
1580
start_revision=rev1,
1585
def get_log_format(long=False, short=False, line=False, default='long'):
1586
log_format = default
1590
log_format = 'short'
1596
class cmd_touching_revisions(Command):
1597
"""Return revision-ids which affected a particular file.
1599
A more user-friendly interface is "bzr log FILE".
1603
takes_args = ["filename"]
1606
def run(self, filename):
1607
tree, relpath = WorkingTree.open_containing(filename)
1609
inv = tree.read_working_inventory()
1610
file_id = inv.path2id(relpath)
1611
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1612
self.outf.write("%6d %s\n" % (revno, what))
1615
class cmd_ls(Command):
1616
"""List files in a tree.
1619
takes_args = ['path?']
1620
# TODO: Take a revision or remote path and list that tree instead.
1621
takes_options = ['verbose', 'revision',
1622
Option('non-recursive',
1623
help='don\'t recurse into sub-directories'),
1625
help='Print all paths from the root of the branch.'),
1626
Option('unknown', help='Print unknown files'),
1627
Option('versioned', help='Print versioned files'),
1628
Option('ignored', help='Print ignored files'),
1630
Option('null', help='Null separate the files'),
1634
def run(self, revision=None, verbose=False,
1635
non_recursive=False, from_root=False,
1636
unknown=False, versioned=False, ignored=False,
1637
null=False, kind=None, show_ids=False, path=None):
1639
if kind and kind not in ('file', 'directory', 'symlink'):
1640
raise errors.BzrCommandError('invalid kind specified')
1642
if verbose and null:
1643
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1644
all = not (unknown or versioned or ignored)
1646
selection = {'I':ignored, '?':unknown, 'V':versioned}
1653
raise errors.BzrCommandError('cannot specify both --from-root'
1657
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1663
if revision is not None:
1664
tree = branch.repository.revision_tree(
1665
revision[0].in_history(branch).rev_id)
1667
tree = branch.basis_tree()
1669
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1670
if fp.startswith(relpath):
1671
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1672
if non_recursive and '/' in fp:
1674
if not all and not selection[fc]:
1676
if kind is not None and fkind != kind:
1679
kindch = entry.kind_character()
1680
outstring = '%-8s %s%s' % (fc, fp, kindch)
1681
if show_ids and fid is not None:
1682
outstring = "%-50s %s" % (outstring, fid)
1683
self.outf.write(outstring + '\n')
1685
self.outf.write(fp + '\0')
1688
self.outf.write(fid)
1689
self.outf.write('\0')
1697
self.outf.write('%-50s %s\n' % (fp, my_id))
1699
self.outf.write(fp + '\n')
1702
class cmd_unknowns(Command):
1703
"""List unknown files.
1705
See also: "bzr ls --unknown".
1712
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1713
self.outf.write(osutils.quotefn(f) + '\n')
1716
class cmd_ignore(Command):
1717
"""Ignore specified files or patterns.
1719
To remove patterns from the ignore list, edit the .bzrignore file.
1721
Trailing slashes on patterns are ignored.
1722
If the pattern contains a slash or is a regular expression, it is compared
1723
to the whole path from the branch root. Otherwise, it is compared to only
1724
the last component of the path. To match a file only in the root
1725
directory, prepend './'.
1727
Ignore patterns specifying absolute paths are not allowed.
1729
Ignore patterns may include globbing wildcards such as:
1730
? - Matches any single character except '/'
1731
* - Matches 0 or more characters except '/'
1732
/**/ - Matches 0 or more directories in a path
1733
[a-z] - Matches a single character from within a group of characters
1735
Ignore patterns may also be Python regular expressions.
1736
Regular expression ignore patterns are identified by a 'RE:' prefix
1737
followed by the regular expression. Regular expression ignore patterns
1738
may not include named or numbered groups.
1740
Note: ignore patterns containing shell wildcards must be quoted from
1744
bzr ignore ./Makefile
1745
bzr ignore '*.class'
1746
bzr ignore 'lib/**/*.o'
1747
bzr ignore 'RE:lib/.*\.o'
1749
takes_args = ['name_pattern*']
1751
Option('old-default-rules',
1752
help='Out the ignore rules bzr < 0.9 always used.')
1755
def run(self, name_pattern_list=None, old_default_rules=None):
1756
from bzrlib.atomicfile import AtomicFile
1757
if old_default_rules is not None:
1758
# dump the rules and exit
1759
for pattern in ignores.OLD_DEFAULTS:
1762
if not name_pattern_list:
1763
raise errors.BzrCommandError("ignore requires at least one "
1764
"NAME_PATTERN or --old-default-rules")
1765
for name_pattern in name_pattern_list:
1766
if name_pattern[0] == '/':
1767
raise errors.BzrCommandError(
1768
"NAME_PATTERN should not be an absolute path")
1769
tree, relpath = WorkingTree.open_containing(u'.')
1770
ifn = tree.abspath('.bzrignore')
1771
if os.path.exists(ifn):
1774
igns = f.read().decode('utf-8')
1780
# TODO: If the file already uses crlf-style termination, maybe
1781
# we should use that for the newly added lines?
1783
if igns and igns[-1] != '\n':
1785
for name_pattern in name_pattern_list:
1786
igns += name_pattern.rstrip('/') + '\n'
1788
f = AtomicFile(ifn, 'wb')
1790
f.write(igns.encode('utf-8'))
1795
inv = tree.inventory
1796
if inv.path2id('.bzrignore'):
1797
mutter('.bzrignore is already versioned')
1799
mutter('need to make new .bzrignore file versioned')
1800
tree.add(['.bzrignore'])
1803
class cmd_ignored(Command):
1804
"""List ignored files and the patterns that matched them.
1806
See also: bzr ignore"""
1809
tree = WorkingTree.open_containing(u'.')[0]
1810
for path, file_class, kind, file_id, entry in tree.list_files():
1811
if file_class != 'I':
1813
## XXX: Slightly inefficient since this was already calculated
1814
pat = tree.is_ignored(path)
1815
print '%-50s %s' % (path, pat)
1818
class cmd_lookup_revision(Command):
1819
"""Lookup the revision-id from a revision-number
1822
bzr lookup-revision 33
1825
takes_args = ['revno']
1828
def run(self, revno):
1832
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1834
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1837
class cmd_export(Command):
1838
"""Export past revision to destination directory.
1840
If no revision is specified this exports the last committed revision.
1842
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1843
given, try to find the format with the extension. If no extension
1844
is found exports to a directory (equivalent to --format=dir).
1846
Root may be the top directory for tar, tgz and tbz2 formats. If none
1847
is given, the top directory will be the root name of the file.
1849
If branch is omitted then the branch containing the CWD will be used.
1851
Note: export of tree with non-ascii filenames to zip is not supported.
1853
Supported formats Autodetected by extension
1854
----------------- -------------------------
1857
tbz2 .tar.bz2, .tbz2
1861
takes_args = ['dest', 'branch?']
1862
takes_options = ['revision', 'format', 'root']
1863
def run(self, dest, branch=None, revision=None, format=None, root=None):
1864
from bzrlib.export import export
1867
tree = WorkingTree.open_containing(u'.')[0]
1870
b = Branch.open(branch)
1872
if revision is None:
1873
# should be tree.last_revision FIXME
1874
rev_id = b.last_revision()
1876
if len(revision) != 1:
1877
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1878
rev_id = revision[0].in_history(b).rev_id
1879
t = b.repository.revision_tree(rev_id)
1881
export(t, dest, format, root)
1882
except errors.NoSuchExportFormat, e:
1883
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1886
class cmd_cat(Command):
1887
"""Write a file's text from a previous revision."""
1889
takes_options = ['revision', 'name-from-revision']
1890
takes_args = ['filename']
1891
encoding_type = 'exact'
1894
def run(self, filename, revision=None, name_from_revision=False):
1895
if revision is not None and len(revision) != 1:
1896
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1901
tree, relpath = WorkingTree.open_containing(filename)
1903
except (errors.NotBranchError, errors.NotLocalUrl):
1906
if revision is not None and revision[0].get_branch() is not None:
1907
b = Branch.open(revision[0].get_branch())
1909
b, relpath = Branch.open_containing(filename)
1910
tree = b.basis_tree()
1911
if revision is None:
1912
revision_id = b.last_revision()
1914
revision_id = revision[0].in_history(b).rev_id
1916
cur_file_id = tree.path2id(relpath)
1917
rev_tree = b.repository.revision_tree(revision_id)
1918
old_file_id = rev_tree.path2id(relpath)
1920
if name_from_revision:
1921
if old_file_id is None:
1922
raise errors.BzrCommandError("%r is not present in revision %s"
1923
% (filename, revision_id))
1925
rev_tree.print_file(old_file_id)
1926
elif cur_file_id is not None:
1927
rev_tree.print_file(cur_file_id)
1928
elif old_file_id is not None:
1929
rev_tree.print_file(old_file_id)
1931
raise errors.BzrCommandError("%r is not present in revision %s" %
1932
(filename, revision_id))
1935
class cmd_local_time_offset(Command):
1936
"""Show the offset in seconds from GMT to local time."""
1940
print osutils.local_time_offset()
1944
class cmd_commit(Command):
1945
"""Commit changes into a new revision.
1947
If no arguments are given, the entire tree is committed.
1949
If selected files are specified, only changes to those files are
1950
committed. If a directory is specified then the directory and everything
1951
within it is committed.
1953
A selected-file commit may fail in some cases where the committed
1954
tree would be invalid, such as trying to commit a file in a
1955
newly-added directory that is not itself committed.
1957
# TODO: Run hooks on tree to-be-committed, and after commit.
1959
# TODO: Strict commit that fails if there are deleted files.
1960
# (what does "deleted files" mean ??)
1962
# TODO: Give better message for -s, --summary, used by tla people
1964
# XXX: verbose currently does nothing
1966
takes_args = ['selected*']
1967
takes_options = ['message', 'verbose',
1969
help='commit even if nothing has changed'),
1970
Option('file', type=str,
1973
help='file containing commit message'),
1975
help="refuse to commit if there are unknown "
1976
"files in the working tree."),
1978
help="perform a local only commit in a bound "
1979
"branch. Such commits are not pushed to "
1980
"the master branch until a normal commit "
1984
aliases = ['ci', 'checkin']
1986
def run(self, message=None, file=None, verbose=True, selected_list=None,
1987
unchanged=False, strict=False, local=False):
1988
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1989
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1991
from bzrlib.msgeditor import edit_commit_message, \
1992
make_commit_message_template
1994
# TODO: Need a blackbox test for invoking the external editor; may be
1995
# slightly problematic to run this cross-platform.
1997
# TODO: do more checks that the commit will succeed before
1998
# spending the user's valuable time typing a commit message.
1999
tree, selected_list = tree_files(selected_list)
2000
if selected_list == ['']:
2001
# workaround - commit of root of tree should be exactly the same
2002
# as just default commit in that tree, and succeed even though
2003
# selected-file merge commit is not done yet
2006
if local and not tree.branch.get_bound_location():
2007
raise errors.LocalRequiresBoundBranch()
2009
def get_message(commit_obj):
2010
"""Callback to get commit message"""
2011
my_message = message
2012
if my_message is None and not file:
2013
template = make_commit_message_template(tree, selected_list)
2014
my_message = edit_commit_message(template)
2015
if my_message is None:
2016
raise errors.BzrCommandError("please specify a commit"
2017
" message with either --message or --file")
2018
elif my_message and file:
2019
raise errors.BzrCommandError(
2020
"please specify either --message or --file")
2022
my_message = codecs.open(file, 'rt',
2023
bzrlib.user_encoding).read()
2024
if my_message == "":
2025
raise errors.BzrCommandError("empty commit message specified")
2029
reporter = ReportCommitToLog()
2031
reporter = NullCommitReporter()
2034
tree.commit(message_callback=get_message,
2035
specific_files=selected_list,
2036
allow_pointless=unchanged, strict=strict, local=local,
2038
except PointlessCommit:
2039
# FIXME: This should really happen before the file is read in;
2040
# perhaps prepare the commit; get the message; then actually commit
2041
raise errors.BzrCommandError("no changes to commit."
2042
" use --unchanged to commit anyhow")
2043
except ConflictsInTree:
2044
raise errors.BzrCommandError('Conflicts detected in working '
2045
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2047
except StrictCommitFailed:
2048
raise errors.BzrCommandError("Commit refused because there are"
2049
" unknown files in the working tree.")
2050
except errors.BoundBranchOutOfDate, e:
2051
raise errors.BzrCommandError(str(e) + "\n"
2052
'To commit to master branch, run update and then commit.\n'
2053
'You can also pass --local to commit to continue working '
2057
class cmd_check(Command):
2058
"""Validate consistency of branch history.
2060
This command checks various invariants about the branch storage to
2061
detect data corruption or bzr bugs.
2063
takes_args = ['branch?']
2064
takes_options = ['verbose']
2066
def run(self, branch=None, verbose=False):
2067
from bzrlib.check import check
2069
tree = WorkingTree.open_containing()[0]
2070
branch = tree.branch
2072
branch = Branch.open(branch)
2073
check(branch, verbose)
2076
class cmd_upgrade(Command):
2077
"""Upgrade branch storage to current format.
2079
The check command or bzr developers may sometimes advise you to run
2080
this command. When the default format has changed you may also be warned
2081
during other operations to upgrade.
2083
takes_args = ['url?']
2085
RegistryOption('format',
2086
help='Upgrade to a specific format. See "bzr help'
2087
' formats" for details',
2088
registry=bzrdir.format_registry,
2089
converter=bzrdir.format_registry.make_bzrdir,
2090
value_switches=True, title='Branch format'),
2094
def run(self, url='.', format=None):
2095
from bzrlib.upgrade import upgrade
2097
format = bzrdir.format_registry.make_bzrdir('default')
2098
upgrade(url, format)
2101
class cmd_whoami(Command):
2102
"""Show or set bzr user id.
2106
bzr whoami 'Frank Chu <fchu@example.com>'
2108
takes_options = [ Option('email',
2109
help='display email address only'),
2111
help='set identity for the current branch instead of '
2114
takes_args = ['name?']
2115
encoding_type = 'replace'
2118
def run(self, email=False, branch=False, name=None):
2120
# use branch if we're inside one; otherwise global config
2122
c = Branch.open_containing('.')[0].get_config()
2123
except errors.NotBranchError:
2124
c = config.GlobalConfig()
2126
self.outf.write(c.user_email() + '\n')
2128
self.outf.write(c.username() + '\n')
2131
# display a warning if an email address isn't included in the given name.
2133
config.extract_email_address(name)
2134
except errors.NoEmailInUsername, e:
2135
warning('"%s" does not seem to contain an email address. '
2136
'This is allowed, but not recommended.', name)
2138
# use global config unless --branch given
2140
c = Branch.open_containing('.')[0].get_config()
2142
c = config.GlobalConfig()
2143
c.set_user_option('email', name)
2146
class cmd_nick(Command):
2147
"""Print or set the branch nickname.
2149
If unset, the tree root directory name is used as the nickname
2150
To print the current nickname, execute with no argument.
2152
takes_args = ['nickname?']
2153
def run(self, nickname=None):
2154
branch = Branch.open_containing(u'.')[0]
2155
if nickname is None:
2156
self.printme(branch)
2158
branch.nick = nickname
2161
def printme(self, branch):
2165
class cmd_selftest(Command):
2166
"""Run internal test suite.
2168
This creates temporary test directories in the working directory, but not
2169
existing data is affected. These directories are deleted if the tests
2170
pass, or left behind to help in debugging if they fail and --keep-output
2173
If arguments are given, they are regular expressions that say which tests
2174
should run. Tests matching any expression are run, and other tests are
2177
Alternatively if --first is given, matching tests are run first and then
2178
all other tests are run. This is useful if you have been working in a
2179
particular area, but want to make sure nothing else was broken.
2181
If the global option '--no-plugins' is given, plugins are not loaded
2182
before running the selftests. This has two effects: features provided or
2183
modified by plugins will not be tested, and tests provided by plugins will
2188
run only tests relating to 'ignore'
2189
bzr --no-plugins selftest -v
2190
disable plugins and list tests as they're run
2192
# TODO: --list should give a list of all available tests
2194
# NB: this is used from the class without creating an instance, which is
2195
# why it does not have a self parameter.
2196
def get_transport_type(typestring):
2197
"""Parse and return a transport specifier."""
2198
if typestring == "sftp":
2199
from bzrlib.transport.sftp import SFTPAbsoluteServer
2200
return SFTPAbsoluteServer
2201
if typestring == "memory":
2202
from bzrlib.transport.memory import MemoryServer
2204
if typestring == "fakenfs":
2205
from bzrlib.transport.fakenfs import FakeNFSServer
2206
return FakeNFSServer
2207
msg = "No known transport type %s. Supported types are: sftp\n" %\
2209
raise errors.BzrCommandError(msg)
2212
takes_args = ['testspecs*']
2213
takes_options = ['verbose',
2214
Option('one', help='stop when one test fails'),
2215
Option('keep-output',
2216
help='keep output directories when tests fail'),
2218
help='Use a different transport by default '
2219
'throughout the test suite.',
2220
type=get_transport_type),
2221
Option('benchmark', help='run the bzr bencharks.'),
2222
Option('lsprof-timed',
2223
help='generate lsprof output for benchmarked'
2224
' sections of code.'),
2225
Option('cache-dir', type=str,
2226
help='a directory to cache intermediate'
2227
' benchmark steps'),
2228
Option('clean-output',
2229
help='clean temporary tests directories'
2230
' without running tests'),
2232
help='run all tests, but run specified tests first',
2235
encoding_type = 'replace'
2237
def run(self, testspecs_list=None, verbose=None, one=False,
2238
keep_output=False, transport=None, benchmark=None,
2239
lsprof_timed=None, cache_dir=None, clean_output=False,
2242
from bzrlib.tests import selftest
2243
import bzrlib.benchmarks as benchmarks
2244
from bzrlib.benchmarks import tree_creator
2247
from bzrlib.tests import clean_selftest_output
2248
clean_selftest_output()
2251
if cache_dir is not None:
2252
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2253
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2254
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2256
if testspecs_list is not None:
2257
pattern = '|'.join(testspecs_list)
2261
test_suite_factory = benchmarks.test_suite
2264
# TODO: should possibly lock the history file...
2265
benchfile = open(".perf_history", "at", buffering=1)
2267
test_suite_factory = None
2272
result = selftest(verbose=verbose,
2274
stop_on_failure=one,
2275
keep_output=keep_output,
2276
transport=transport,
2277
test_suite_factory=test_suite_factory,
2278
lsprof_timed=lsprof_timed,
2279
bench_history=benchfile,
2280
matching_tests_first=first,
2283
if benchfile is not None:
2286
info('tests passed')
2288
info('tests failed')
2289
return int(not result)
2292
class cmd_version(Command):
2293
"""Show version of bzr."""
2297
from bzrlib.version import show_version
2301
class cmd_rocks(Command):
2302
"""Statement of optimism."""
2308
print "it sure does!"
2311
class cmd_find_merge_base(Command):
2312
"""Find and print a base revision for merging two branches."""
2313
# TODO: Options to specify revisions on either side, as if
2314
# merging only part of the history.
2315
takes_args = ['branch', 'other']
2319
def run(self, branch, other):
2320
from bzrlib.revision import MultipleRevisionSources
2322
branch1 = Branch.open_containing(branch)[0]
2323
branch2 = Branch.open_containing(other)[0]
2325
last1 = branch1.last_revision()
2326
last2 = branch2.last_revision()
2328
source = MultipleRevisionSources(branch1.repository,
2331
base_rev_id = common_ancestor(last1, last2, source)
2333
print 'merge base is revision %s' % base_rev_id
2336
class cmd_merge(Command):
2337
"""Perform a three-way merge.
2339
The branch is the branch you will merge from. By default, it will merge
2340
the latest revision. If you specify a revision, that revision will be
2341
merged. If you specify two revisions, the first will be used as a BASE,
2342
and the second one as OTHER. Revision numbers are always relative to the
2345
By default, bzr will try to merge in all new work from the other
2346
branch, automatically determining an appropriate base. If this
2347
fails, you may need to give an explicit base.
2349
Merge will do its best to combine the changes in two branches, but there
2350
are some kinds of problems only a human can fix. When it encounters those,
2351
it will mark a conflict. A conflict means that you need to fix something,
2352
before you should commit.
2354
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2356
If there is no default branch set, the first merge will set it. After
2357
that, you can omit the branch to use the default. To change the
2358
default, use --remember. The value will only be saved if the remote
2359
location can be accessed.
2363
To merge the latest revision from bzr.dev
2364
bzr merge ../bzr.dev
2366
To merge changes up to and including revision 82 from bzr.dev
2367
bzr merge -r 82 ../bzr.dev
2369
To merge the changes introduced by 82, without previous changes:
2370
bzr merge -r 81..82 ../bzr.dev
2372
merge refuses to run if there are any uncommitted changes, unless
2375
The following merge types are available:
2377
takes_args = ['branch?']
2378
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2379
Option('show-base', help="Show base revision text in "
2381
Option('uncommitted', help='Apply uncommitted changes'
2382
' from a working copy, instead of branch changes'),
2383
Option('pull', help='If the destination is already'
2384
' completely merged into the source, pull from the'
2385
' source rather than merging. When this happens,'
2386
' you do not need to commit the result.'),
2389
def run(self, branch=None, revision=None, force=False, merge_type=None,
2390
show_base=False, reprocess=False, remember=False,
2391
uncommitted=False, pull=False):
2392
if merge_type is None:
2393
merge_type = _mod_merge.Merge3Merger
2395
tree = WorkingTree.open_containing(u'.')[0]
2397
if branch is not None:
2399
reader = bundle.read_bundle_from_url(branch)
2400
except errors.NotABundle:
2401
pass # Continue on considering this url a Branch
2403
conflicts = merge_bundle(reader, tree, not force, merge_type,
2404
reprocess, show_base)
2410
if revision is None \
2411
or len(revision) < 1 or revision[0].needs_branch():
2412
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2414
if revision is None or len(revision) < 1:
2417
other = [branch, None]
2420
other = [branch, -1]
2421
other_branch, path = Branch.open_containing(branch)
2424
raise errors.BzrCommandError('Cannot use --uncommitted and'
2425
' --revision at the same time.')
2426
branch = revision[0].get_branch() or branch
2427
if len(revision) == 1:
2429
other_branch, path = Branch.open_containing(branch)
2430
revno = revision[0].in_history(other_branch).revno
2431
other = [branch, revno]
2433
assert len(revision) == 2
2434
if None in revision:
2435
raise errors.BzrCommandError(
2436
"Merge doesn't permit empty revision specifier.")
2437
base_branch, path = Branch.open_containing(branch)
2438
branch1 = revision[1].get_branch() or branch
2439
other_branch, path1 = Branch.open_containing(branch1)
2440
if revision[0].get_branch() is not None:
2441
# then path was obtained from it, and is None.
2444
base = [branch, revision[0].in_history(base_branch).revno]
2445
other = [branch1, revision[1].in_history(other_branch).revno]
2447
if tree.branch.get_parent() is None or remember:
2448
tree.branch.set_parent(other_branch.base)
2451
interesting_files = [path]
2453
interesting_files = None
2454
pb = ui.ui_factory.nested_progress_bar()
2457
conflict_count = _merge_helper(
2458
other, base, check_clean=(not force),
2459
merge_type=merge_type,
2460
reprocess=reprocess,
2461
show_base=show_base,
2463
pb=pb, file_list=interesting_files)
2466
if conflict_count != 0:
2470
except errors.AmbiguousBase, e:
2471
m = ("sorry, bzr can't determine the right merge base yet\n"
2472
"candidates are:\n "
2473
+ "\n ".join(e.bases)
2475
"please specify an explicit base with -r,\n"
2476
"and (if you want) report this to the bzr developers\n")
2479
# TODO: move up to common parent; this isn't merge-specific anymore.
2480
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2481
"""Use tree.branch's parent if none was supplied.
2483
Report if the remembered location was used.
2485
if supplied_location is not None:
2486
return supplied_location
2487
stored_location = tree.branch.get_parent()
2488
mutter("%s", stored_location)
2489
if stored_location is None:
2490
raise errors.BzrCommandError("No location specified or remembered")
2491
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2492
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2493
return stored_location
2496
class cmd_remerge(Command):
2499
Use this if you want to try a different merge technique while resolving
2500
conflicts. Some merge techniques are better than others, and remerge
2501
lets you try different ones on different files.
2503
The options for remerge have the same meaning and defaults as the ones for
2504
merge. The difference is that remerge can (only) be run when there is a
2505
pending merge, and it lets you specify particular files.
2508
$ bzr remerge --show-base
2509
Re-do the merge of all conflicted files, and show the base text in
2510
conflict regions, in addition to the usual THIS and OTHER texts.
2512
$ bzr remerge --merge-type weave --reprocess foobar
2513
Re-do the merge of "foobar", using the weave merge algorithm, with
2514
additional processing to reduce the size of conflict regions.
2516
The following merge types are available:"""
2517
takes_args = ['file*']
2518
takes_options = ['merge-type', 'reprocess',
2519
Option('show-base', help="Show base revision text in "
2522
def run(self, file_list=None, merge_type=None, show_base=False,
2524
if merge_type is None:
2525
merge_type = _mod_merge.Merge3Merger
2526
tree, file_list = tree_files(file_list)
2529
parents = tree.get_parent_ids()
2530
if len(parents) != 2:
2531
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2532
" merges. Not cherrypicking or"
2534
repository = tree.branch.repository
2535
base_revision = common_ancestor(parents[0],
2536
parents[1], repository)
2537
base_tree = repository.revision_tree(base_revision)
2538
other_tree = repository.revision_tree(parents[1])
2539
interesting_ids = None
2541
conflicts = tree.conflicts()
2542
if file_list is not None:
2543
interesting_ids = set()
2544
for filename in file_list:
2545
file_id = tree.path2id(filename)
2547
raise errors.NotVersionedError(filename)
2548
interesting_ids.add(file_id)
2549
if tree.kind(file_id) != "directory":
2552
for name, ie in tree.inventory.iter_entries(file_id):
2553
interesting_ids.add(ie.file_id)
2554
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2556
# Remerge only supports resolving contents conflicts
2557
allowed_conflicts = ('text conflict', 'contents conflict')
2558
restore_files = [c.path for c in conflicts
2559
if c.typestring in allowed_conflicts]
2560
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2561
tree.set_conflicts(ConflictList(new_conflicts))
2562
if file_list is not None:
2563
restore_files = file_list
2564
for filename in restore_files:
2566
restore(tree.abspath(filename))
2567
except errors.NotConflicted:
2569
conflicts = _mod_merge.merge_inner(
2570
tree.branch, other_tree, base_tree,
2572
interesting_ids=interesting_ids,
2573
other_rev_id=parents[1],
2574
merge_type=merge_type,
2575
show_base=show_base,
2576
reprocess=reprocess)
2585
class cmd_revert(Command):
2586
"""Revert files to a previous revision.
2588
Giving a list of files will revert only those files. Otherwise, all files
2589
will be reverted. If the revision is not specified with '--revision', the
2590
last committed revision is used.
2592
To remove only some changes, without reverting to a prior version, use
2593
merge instead. For example, "merge . --r-2..-3" will remove the changes
2594
introduced by -2, without affecting the changes introduced by -1. Or
2595
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2597
By default, any files that have been manually changed will be backed up
2598
first. (Files changed only by merge are not backed up.) Backup files have
2599
'.~#~' appended to their name, where # is a number.
2601
When you provide files, you can use their current pathname or the pathname
2602
from the target revision. So you can use revert to "undelete" a file by
2603
name. If you name a directory, all the contents of that directory will be
2606
takes_options = ['revision', 'no-backup']
2607
takes_args = ['file*']
2608
aliases = ['merge-revert']
2610
def run(self, revision=None, no_backup=False, file_list=None):
2611
if file_list is not None:
2612
if len(file_list) == 0:
2613
raise errors.BzrCommandError("No files specified")
2617
tree, file_list = tree_files(file_list)
2618
if revision is None:
2619
# FIXME should be tree.last_revision
2620
rev_id = tree.last_revision()
2621
elif len(revision) != 1:
2622
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2624
rev_id = revision[0].in_history(tree.branch).rev_id
2625
pb = ui.ui_factory.nested_progress_bar()
2627
tree.revert(file_list,
2628
tree.branch.repository.revision_tree(rev_id),
2629
not no_backup, pb, report_changes=True)
2634
class cmd_assert_fail(Command):
2635
"""Test reporting of assertion failures"""
2636
# intended just for use in testing
2641
raise AssertionError("always fails")
2644
class cmd_help(Command):
2645
"""Show help on a command or other topic.
2647
For a list of all available commands, say 'bzr help commands'.
2649
takes_options = [Option('long', 'show help on all commands')]
2650
takes_args = ['topic?']
2651
aliases = ['?', '--help', '-?', '-h']
2654
def run(self, topic=None, long=False):
2656
if topic is None and long:
2658
bzrlib.help.help(topic)
2661
class cmd_shell_complete(Command):
2662
"""Show appropriate completions for context.
2664
For a list of all available commands, say 'bzr shell-complete'.
2666
takes_args = ['context?']
2671
def run(self, context=None):
2672
import shellcomplete
2673
shellcomplete.shellcomplete(context)
2676
class cmd_fetch(Command):
2677
"""Copy in history from another branch but don't merge it.
2679
This is an internal method used for pull and merge.
2682
takes_args = ['from_branch', 'to_branch']
2683
def run(self, from_branch, to_branch):
2684
from bzrlib.fetch import Fetcher
2685
from_b = Branch.open(from_branch)
2686
to_b = Branch.open(to_branch)
2687
Fetcher(to_b, from_b)
2690
class cmd_missing(Command):
2691
"""Show unmerged/unpulled revisions between two branches.
2693
OTHER_BRANCH may be local or remote.
2695
takes_args = ['other_branch?']
2696
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2698
'Display changes in the local branch only'),
2699
Option('theirs-only',
2700
'Display changes in the remote branch only'),
2705
encoding_type = 'replace'
2708
def run(self, other_branch=None, reverse=False, mine_only=False,
2709
theirs_only=False, log_format=None, long=False, short=False, line=False,
2710
show_ids=False, verbose=False):
2711
from bzrlib.missing import find_unmerged, iter_log_data
2712
from bzrlib.log import log_formatter
2713
local_branch = Branch.open_containing(u".")[0]
2714
parent = local_branch.get_parent()
2715
if other_branch is None:
2716
other_branch = parent
2717
if other_branch is None:
2718
raise errors.BzrCommandError("No peer location known or specified.")
2719
display_url = urlutils.unescape_for_display(parent,
2721
print "Using last location: " + display_url
2723
remote_branch = Branch.open(other_branch)
2724
if remote_branch.base == local_branch.base:
2725
remote_branch = local_branch
2726
local_branch.lock_read()
2728
remote_branch.lock_read()
2730
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2731
if (log_format is None):
2732
log_format = log.log_formatter_registry.get_default(
2734
lf = log_format(to_file=self.outf,
2736
show_timezone='original')
2737
if reverse is False:
2738
local_extra.reverse()
2739
remote_extra.reverse()
2740
if local_extra and not theirs_only:
2741
print "You have %d extra revision(s):" % len(local_extra)
2742
for data in iter_log_data(local_extra, local_branch.repository,
2745
printed_local = True
2747
printed_local = False
2748
if remote_extra and not mine_only:
2749
if printed_local is True:
2751
print "You are missing %d revision(s):" % len(remote_extra)
2752
for data in iter_log_data(remote_extra, remote_branch.repository,
2755
if not remote_extra and not local_extra:
2757
print "Branches are up to date."
2761
remote_branch.unlock()
2763
local_branch.unlock()
2764
if not status_code and parent is None and other_branch is not None:
2765
local_branch.lock_write()
2767
# handle race conditions - a parent might be set while we run.
2768
if local_branch.get_parent() is None:
2769
local_branch.set_parent(remote_branch.base)
2771
local_branch.unlock()
2775
class cmd_plugins(Command):
2780
import bzrlib.plugin
2781
from inspect import getdoc
2782
for name, plugin in bzrlib.plugin.all_plugins().items():
2783
if getattr(plugin, '__path__', None) is not None:
2784
print plugin.__path__[0]
2785
elif getattr(plugin, '__file__', None) is not None:
2786
print plugin.__file__
2792
print '\t', d.split('\n')[0]
2795
class cmd_testament(Command):
2796
"""Show testament (signing-form) of a revision."""
2797
takes_options = ['revision',
2798
Option('long', help='Produce long-format testament'),
2799
Option('strict', help='Produce a strict-format'
2801
takes_args = ['branch?']
2803
def run(self, branch=u'.', revision=None, long=False, strict=False):
2804
from bzrlib.testament import Testament, StrictTestament
2806
testament_class = StrictTestament
2808
testament_class = Testament
2809
b = WorkingTree.open_containing(branch)[0].branch
2812
if revision is None:
2813
rev_id = b.last_revision()
2815
rev_id = revision[0].in_history(b).rev_id
2816
t = testament_class.from_revision(b.repository, rev_id)
2818
sys.stdout.writelines(t.as_text_lines())
2820
sys.stdout.write(t.as_short_text())
2825
class cmd_annotate(Command):
2826
"""Show the origin of each line in a file.
2828
This prints out the given file with an annotation on the left side
2829
indicating which revision, author and date introduced the change.
2831
If the origin is the same for a run of consecutive lines, it is
2832
shown only at the top, unless the --all option is given.
2834
# TODO: annotate directories; showing when each file was last changed
2835
# TODO: if the working copy is modified, show annotations on that
2836
# with new uncommitted lines marked
2837
aliases = ['ann', 'blame', 'praise']
2838
takes_args = ['filename']
2839
takes_options = [Option('all', help='show annotations on all lines'),
2840
Option('long', help='show date in annotations'),
2846
def run(self, filename, all=False, long=False, revision=None,
2848
from bzrlib.annotate import annotate_file
2849
tree, relpath = WorkingTree.open_containing(filename)
2850
branch = tree.branch
2853
if revision is None:
2854
revision_id = branch.last_revision()
2855
elif len(revision) != 1:
2856
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2858
revision_id = revision[0].in_history(branch).rev_id
2859
file_id = tree.inventory.path2id(relpath)
2860
tree = branch.repository.revision_tree(revision_id)
2861
file_version = tree.inventory[file_id].revision
2862
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2868
class cmd_re_sign(Command):
2869
"""Create a digital signature for an existing revision."""
2870
# TODO be able to replace existing ones.
2872
hidden = True # is this right ?
2873
takes_args = ['revision_id*']
2874
takes_options = ['revision']
2876
def run(self, revision_id_list=None, revision=None):
2877
import bzrlib.gpg as gpg
2878
if revision_id_list is not None and revision is not None:
2879
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2880
if revision_id_list is None and revision is None:
2881
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2882
b = WorkingTree.open_containing(u'.')[0].branch
2883
gpg_strategy = gpg.GPGStrategy(b.get_config())
2884
if revision_id_list is not None:
2885
for revision_id in revision_id_list:
2886
b.repository.sign_revision(revision_id, gpg_strategy)
2887
elif revision is not None:
2888
if len(revision) == 1:
2889
revno, rev_id = revision[0].in_history(b)
2890
b.repository.sign_revision(rev_id, gpg_strategy)
2891
elif len(revision) == 2:
2892
# are they both on rh- if so we can walk between them
2893
# might be nice to have a range helper for arbitrary
2894
# revision paths. hmm.
2895
from_revno, from_revid = revision[0].in_history(b)
2896
to_revno, to_revid = revision[1].in_history(b)
2897
if to_revid is None:
2898
to_revno = b.revno()
2899
if from_revno is None or to_revno is None:
2900
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2901
for revno in range(from_revno, to_revno + 1):
2902
b.repository.sign_revision(b.get_rev_id(revno),
2905
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2908
class cmd_bind(Command):
2909
"""Convert the current branch into a checkout of the supplied branch.
2911
Once converted into a checkout, commits must succeed on the master branch
2912
before they will be applied to the local branch.
2914
See "help checkouts" for more information on checkouts.
2917
takes_args = ['location']
2920
def run(self, location=None):
2921
b, relpath = Branch.open_containing(u'.')
2922
b_other = Branch.open(location)
2925
except errors.DivergedBranches:
2926
raise errors.BzrCommandError('These branches have diverged.'
2927
' Try merging, and then bind again.')
2930
class cmd_unbind(Command):
2931
"""Convert the current checkout into a regular branch.
2933
After unbinding, the local branch is considered independent and subsequent
2934
commits will be local only.
2936
See "help checkouts" for more information on checkouts.
2943
b, relpath = Branch.open_containing(u'.')
2945
raise errors.BzrCommandError('Local branch is not bound')
2948
class cmd_uncommit(Command):
2949
"""Remove the last committed revision.
2951
--verbose will print out what is being removed.
2952
--dry-run will go through all the motions, but not actually
2955
In the future, uncommit will create a revision bundle, which can then
2959
# TODO: jam 20060108 Add an option to allow uncommit to remove
2960
# unreferenced information in 'branch-as-repository' branches.
2961
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2962
# information in shared branches as well.
2963
takes_options = ['verbose', 'revision',
2964
Option('dry-run', help='Don\'t actually make changes'),
2965
Option('force', help='Say yes to all questions.')]
2966
takes_args = ['location?']
2969
def run(self, location=None,
2970
dry_run=False, verbose=False,
2971
revision=None, force=False):
2972
from bzrlib.log import log_formatter, show_log
2974
from bzrlib.uncommit import uncommit
2976
if location is None:
2978
control, relpath = bzrdir.BzrDir.open_containing(location)
2980
tree = control.open_workingtree()
2982
except (errors.NoWorkingTree, errors.NotLocalUrl):
2984
b = control.open_branch()
2987
if revision is None:
2990
# 'bzr uncommit -r 10' actually means uncommit
2991
# so that the final tree is at revno 10.
2992
# but bzrlib.uncommit.uncommit() actually uncommits
2993
# the revisions that are supplied.
2994
# So we need to offset it by one
2995
revno = revision[0].in_history(b).revno+1
2997
if revno <= b.revno():
2998
rev_id = b.get_rev_id(revno)
3000
self.outf.write('No revisions to uncommit.\n')
3003
lf = log_formatter('short',
3005
show_timezone='original')
3010
direction='forward',
3011
start_revision=revno,
3012
end_revision=b.revno())
3015
print 'Dry-run, pretending to remove the above revisions.'
3017
val = raw_input('Press <enter> to continue')
3019
print 'The above revision(s) will be removed.'
3021
val = raw_input('Are you sure [y/N]? ')
3022
if val.lower() not in ('y', 'yes'):
3026
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3030
class cmd_break_lock(Command):
3031
"""Break a dead lock on a repository, branch or working directory.
3033
CAUTION: Locks should only be broken when you are sure that the process
3034
holding the lock has been stopped.
3036
You can get information on what locks are open via the 'bzr info' command.
3041
takes_args = ['location?']
3043
def run(self, location=None, show=False):
3044
if location is None:
3046
control, relpath = bzrdir.BzrDir.open_containing(location)
3048
control.break_lock()
3049
except NotImplementedError:
3053
class cmd_wait_until_signalled(Command):
3054
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3056
This just prints a line to signal when it is ready, then blocks on stdin.
3062
sys.stdout.write("running\n")
3064
sys.stdin.readline()
3067
class cmd_serve(Command):
3068
"""Run the bzr server."""
3070
aliases = ['server']
3074
help='serve on stdin/out for use from inetd or sshd'),
3076
help='listen for connections on nominated port of the form '
3077
'[hostname:]portnumber. Passing 0 as the port number will '
3078
'result in a dynamically allocated port.',
3081
help='serve contents of directory',
3083
Option('allow-writes',
3084
help='By default the server is a readonly server. Supplying '
3085
'--allow-writes enables write access to the contents of '
3086
'the served directory and below. '
3090
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3091
from bzrlib.transport import smart
3092
from bzrlib.transport import get_transport
3093
if directory is None:
3094
directory = os.getcwd()
3095
url = urlutils.local_path_to_url(directory)
3096
if not allow_writes:
3097
url = 'readonly+' + url
3098
t = get_transport(url)
3100
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3101
elif port is not None:
3103
host, port = port.split(':')
3106
server = smart.SmartTCPServer(t, host=host, port=int(port))
3107
print 'listening on port: ', server.port
3110
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3114
# command-line interpretation helper for merge-related commands
3115
def _merge_helper(other_revision, base_revision,
3116
check_clean=True, ignore_zero=False,
3117
this_dir=None, backup_files=False,
3119
file_list=None, show_base=False, reprocess=False,
3121
pb=DummyProgress()):
3122
"""Merge changes into a tree.
3125
list(path, revno) Base for three-way merge.
3126
If [None, None] then a base will be automatically determined.
3128
list(path, revno) Other revision for three-way merge.
3130
Directory to merge changes into; '.' by default.
3132
If true, this_dir must have no uncommitted changes before the
3134
ignore_zero - If true, suppress the "zero conflicts" message when
3135
there are no conflicts; should be set when doing something we expect
3136
to complete perfectly.
3137
file_list - If supplied, merge only changes to selected files.
3139
All available ancestors of other_revision and base_revision are
3140
automatically pulled into the branch.
3142
The revno may be -1 to indicate the last revision on the branch, which is
3145
This function is intended for use from the command line; programmatic
3146
clients might prefer to call merge.merge_inner(), which has less magic
3149
# Loading it late, so that we don't always have to import bzrlib.merge
3150
if merge_type is None:
3151
merge_type = _mod_merge.Merge3Merger
3152
if this_dir is None:
3154
this_tree = WorkingTree.open_containing(this_dir)[0]
3155
if show_base and not merge_type is _mod_merge.Merge3Merger:
3156
raise errors.BzrCommandError("Show-base is not supported for this merge"
3157
" type. %s" % merge_type)
3158
if reprocess and not merge_type.supports_reprocess:
3159
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3160
" type %s." % merge_type)
3161
if reprocess and show_base:
3162
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3164
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3166
merger.pp = ProgressPhase("Merge phase", 5, pb)
3167
merger.pp.next_phase()
3168
merger.check_basis(check_clean)
3169
merger.set_other(other_revision)
3170
merger.pp.next_phase()
3171
merger.set_base(base_revision)
3172
if merger.base_rev_id == merger.other_rev_id:
3173
note('Nothing to do.')
3175
if file_list is None:
3176
if pull and merger.base_rev_id == merger.this_rev_id:
3177
count = merger.this_tree.pull(merger.this_branch,
3178
False, merger.other_rev_id)
3179
note('%d revision(s) pulled.' % (count,))
3181
merger.backup_files = backup_files
3182
merger.merge_type = merge_type
3183
merger.set_interesting_files(file_list)
3184
merger.show_base = show_base
3185
merger.reprocess = reprocess
3186
conflicts = merger.do_merge()
3187
if file_list is None:
3188
merger.set_pending()
3195
merge = _merge_helper
3198
# these get imported and then picked up by the scan for cmd_*
3199
# TODO: Some more consistent way to split command definitions across files;
3200
# we do need to load at least some information about them to know of
3201
# aliases. ideally we would avoid loading the implementation until the
3202
# details were needed.
3203
from bzrlib.cmd_version_info import cmd_version_info
3204
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3205
from bzrlib.bundle.commands import cmd_bundle_revisions
3206
from bzrlib.sign_my_commits import cmd_sign_my_commits
3207
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3208
cmd_weave_plan_merge, cmd_weave_merge_text