1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
47
from bzrlib.branch import Branch
48
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
49
from bzrlib.conflicts import ConflictList
50
from bzrlib.revision import common_ancestor
51
from bzrlib.revisionspec import RevisionSpec
52
from bzrlib.workingtree import WorkingTree
55
from bzrlib.commands import Command, display_command
56
from bzrlib.option import Option, RegistryOption
57
from bzrlib.progress import DummyProgress, ProgressPhase
58
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
61
def tree_files(file_list, default_branch=u'.'):
63
return internal_tree_files(file_list, default_branch)
64
except errors.FileInWrongBranch, e:
65
raise errors.BzrCommandError("%s is not in the same branch as %s" %
66
(e.path, file_list[0]))
69
# XXX: Bad function name; should possibly also be a class method of
70
# WorkingTree rather than a function.
71
def internal_tree_files(file_list, default_branch=u'.'):
72
"""Convert command-line paths to a WorkingTree and relative paths.
74
This is typically used for command-line processors that take one or
75
more filenames, and infer the workingtree that contains them.
77
The filenames given are not required to exist.
79
:param file_list: Filenames to convert.
81
:param default_branch: Fallback tree path to use if file_list is empty or
84
:return: workingtree, [relative_paths]
86
if file_list is None or len(file_list) == 0:
87
return WorkingTree.open_containing(default_branch)[0], file_list
88
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
90
for filename in file_list:
92
new_list.append(tree.relpath(osutils.dereference_path(filename)))
93
except errors.PathNotChild:
94
raise errors.FileInWrongBranch(tree.branch, filename)
98
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
99
def get_format_type(typestring):
100
"""Parse and return a format specifier."""
101
# Have to use BzrDirMetaFormat1 directly, so that
102
# RepositoryFormat.set_default_format works
103
if typestring == "default":
104
return bzrdir.BzrDirMetaFormat1()
106
return bzrdir.format_registry.make_bzrdir(typestring)
108
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
109
raise errors.BzrCommandError(msg)
112
# TODO: Make sure no commands unconditionally use the working directory as a
113
# branch. If a filename argument is used, the first of them should be used to
114
# specify the branch. (Perhaps this can be factored out into some kind of
115
# Argument class, representing a file in a branch, where the first occurrence
118
class cmd_status(Command):
119
"""Display status summary.
121
This reports on versioned and unknown files, reporting them
122
grouped by state. Possible states are:
125
Versioned in the working copy but not in the previous revision.
128
Versioned in the previous revision but removed or deleted
132
Path of this file changed from the previous revision;
133
the text may also have changed. This includes files whose
134
parent directory was renamed.
137
Text has changed since the previous revision.
140
File kind has been changed (e.g. from file to directory).
143
Not versioned and not matching an ignore pattern.
145
To see ignored files use 'bzr ignored'. For details in the
146
changes to file texts, use 'bzr diff'.
148
--short gives a status flags for each item, similar to the SVN's status
151
Column 1: versioning / renames
157
P Entry for a pending merge (not a file)
166
* The execute bit was changed
168
If no arguments are specified, the status of the entire working
169
directory is shown. Otherwise, only the status of the specified
170
files or directories is reported. If a directory is given, status
171
is reported for everything inside that directory.
173
If a revision argument is given, the status is calculated against
174
that revision, or between two revisions if two are provided.
177
# TODO: --no-recurse, --recurse options
179
takes_args = ['file*']
180
takes_options = ['show-ids', 'revision', 'short']
181
aliases = ['st', 'stat']
183
encoding_type = 'replace'
186
def run(self, show_ids=False, file_list=None, revision=None, short=False):
187
from bzrlib.status import show_tree_status
189
tree, file_list = tree_files(file_list)
191
show_tree_status(tree, show_ids=show_ids,
192
specific_files=file_list, revision=revision,
197
class cmd_cat_revision(Command):
198
"""Write out metadata for a revision.
200
The revision to print can either be specified by a specific
201
revision identifier, or you can use --revision.
205
takes_args = ['revision_id?']
206
takes_options = ['revision']
207
# cat-revision is more for frontends so should be exact
211
def run(self, revision_id=None, revision=None):
213
if revision_id is not None and revision is not None:
214
raise errors.BzrCommandError('You can only supply one of'
215
' revision_id or --revision')
216
if revision_id is None and revision is None:
217
raise errors.BzrCommandError('You must supply either'
218
' --revision or a revision_id')
219
b = WorkingTree.open_containing(u'.')[0].branch
221
# TODO: jam 20060112 should cat-revision always output utf-8?
222
if revision_id is not None:
223
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
224
elif revision is not None:
227
raise errors.BzrCommandError('You cannot specify a NULL'
229
revno, rev_id = rev.in_history(b)
230
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
233
class cmd_remove_tree(Command):
234
"""Remove the working tree from a given branch/checkout.
236
Since a lightweight checkout is little more than a working tree
237
this will refuse to run against one.
242
takes_args = ['location?']
244
def run(self, location='.'):
245
d = bzrdir.BzrDir.open(location)
248
working = d.open_workingtree()
249
except errors.NoWorkingTree:
250
raise errors.BzrCommandError("No working tree to remove")
251
except errors.NotLocalUrl:
252
raise errors.BzrCommandError("You cannot remove the working tree of a "
255
working_path = working.bzrdir.root_transport.base
256
branch_path = working.branch.bzrdir.root_transport.base
257
if working_path != branch_path:
258
raise errors.BzrCommandError("You cannot remove the working tree from "
259
"a lightweight checkout")
261
d.destroy_workingtree()
264
class cmd_revno(Command):
265
"""Show current revision number.
267
This is equal to the number of revisions on this branch.
270
takes_args = ['location?']
273
def run(self, location=u'.'):
274
self.outf.write(str(Branch.open_containing(location)[0].revno()))
275
self.outf.write('\n')
278
class cmd_revision_info(Command):
279
"""Show revision number and revision id for a given revision identifier.
282
takes_args = ['revision_info*']
283
takes_options = ['revision']
286
def run(self, revision=None, revision_info_list=[]):
289
if revision is not None:
290
revs.extend(revision)
291
if revision_info_list is not None:
292
for rev in revision_info_list:
293
revs.append(RevisionSpec.from_string(rev))
295
raise errors.BzrCommandError('You must supply a revision identifier')
297
b = WorkingTree.open_containing(u'.')[0].branch
300
revinfo = rev.in_history(b)
301
if revinfo.revno is None:
302
print ' %s' % revinfo.rev_id
304
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
307
class cmd_add(Command):
308
"""Add specified files or directories.
310
In non-recursive mode, all the named items are added, regardless
311
of whether they were previously ignored. A warning is given if
312
any of the named files are already versioned.
314
In recursive mode (the default), files are treated the same way
315
but the behaviour for directories is different. Directories that
316
are already versioned do not give a warning. All directories,
317
whether already versioned or not, are searched for files or
318
subdirectories that are neither versioned or ignored, and these
319
are added. This search proceeds recursively into versioned
320
directories. If no names are given '.' is assumed.
322
Therefore simply saying 'bzr add' will version all files that
323
are currently unknown.
325
Adding a file whose parent directory is not versioned will
326
implicitly add the parent, and so on up to the root. This means
327
you should never need to explicitly add a directory, they'll just
328
get added when you add a file in the directory.
330
--dry-run will show which files would be added, but not actually
333
--file-ids-from will try to use the file ids from the supplied path.
334
It looks up ids trying to find a matching parent directory with the
335
same filename, and then by pure path.
337
takes_args = ['file*']
338
takes_options = ['no-recurse', 'dry-run', 'verbose',
339
Option('file-ids-from', type=unicode,
340
help='Lookup file ids from here')]
341
encoding_type = 'replace'
343
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
347
if file_ids_from is not None:
349
base_tree, base_path = WorkingTree.open_containing(
351
except errors.NoWorkingTree:
352
base_branch, base_path = Branch.open_containing(
354
base_tree = base_branch.basis_tree()
356
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
357
to_file=self.outf, should_print=(not is_quiet()))
359
action = bzrlib.add.AddAction(to_file=self.outf,
360
should_print=(not is_quiet()))
362
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
363
action=action, save=not dry_run)
366
for glob in sorted(ignored.keys()):
367
for path in ignored[glob]:
368
self.outf.write("ignored %s matching \"%s\"\n"
372
for glob, paths in ignored.items():
373
match_len += len(paths)
374
self.outf.write("ignored %d file(s).\n" % match_len)
375
self.outf.write("If you wish to add some of these files,"
376
" please add them by name.\n")
379
class cmd_mkdir(Command):
380
"""Create a new versioned directory.
382
This is equivalent to creating the directory and then adding it.
385
takes_args = ['dir+']
386
encoding_type = 'replace'
388
def run(self, dir_list):
391
wt, dd = WorkingTree.open_containing(d)
393
self.outf.write('added %s\n' % d)
396
class cmd_relpath(Command):
397
"""Show path of a file relative to root"""
399
takes_args = ['filename']
403
def run(self, filename):
404
# TODO: jam 20050106 Can relpath return a munged path if
405
# sys.stdout encoding cannot represent it?
406
tree, relpath = WorkingTree.open_containing(filename)
407
self.outf.write(relpath)
408
self.outf.write('\n')
411
class cmd_inventory(Command):
412
"""Show inventory of the current working copy or a revision.
414
It is possible to limit the output to a particular entry
415
type using the --kind option. For example: --kind file.
417
It is also possible to restrict the list of files to a specific
418
set. For example: bzr inventory --show-ids this/file
425
takes_options = ['revision', 'show-ids', 'kind']
427
takes_args = ['file*']
430
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
431
if kind and kind not in ['file', 'directory', 'symlink']:
432
raise errors.BzrCommandError('invalid kind specified')
434
work_tree, file_list = tree_files(file_list)
436
if revision is not None:
437
if len(revision) > 1:
438
raise errors.BzrCommandError('bzr inventory --revision takes'
439
' exactly one revision identifier')
440
revision_id = revision[0].in_history(work_tree.branch).rev_id
441
tree = work_tree.branch.repository.revision_tree(revision_id)
443
# We include work_tree as well as 'tree' here
444
# So that doing '-r 10 path/foo' will lookup whatever file
445
# exists now at 'path/foo' even if it has been renamed, as
446
# well as whatever files existed in revision 10 at path/foo
447
trees = [tree, work_tree]
452
if file_list is not None:
453
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
454
require_versioned=True)
455
# find_ids_across_trees may include some paths that don't
457
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
458
for file_id in file_ids if file_id in tree)
460
entries = tree.inventory.entries()
462
for path, entry in entries:
463
if kind and kind != entry.kind:
466
self.outf.write('%-50s %s\n' % (path, entry.file_id))
468
self.outf.write(path)
469
self.outf.write('\n')
472
class cmd_mv(Command):
473
"""Move or rename a file.
476
bzr mv OLDNAME NEWNAME
477
bzr mv SOURCE... DESTINATION
479
If the last argument is a versioned directory, all the other names
480
are moved into it. Otherwise, there must be exactly two arguments
481
and the file is changed to a new name.
483
If OLDNAME does not exist on the filesystem but is versioned and
484
NEWNAME does exist on the filesystem but is not versioned, mv
485
assumes that the file has been manually moved and only updates
486
its internal inventory to reflect that change.
487
The same is valid when moving many SOURCE files to a DESTINATION.
489
Files cannot be moved between branches.
492
takes_args = ['names*']
493
takes_options = [Option("after", help="move only the bzr identifier"
494
" of the file (file has already been moved). Use this flag if"
495
" bzr is not able to detect this itself.")]
496
aliases = ['move', 'rename']
497
encoding_type = 'replace'
499
def run(self, names_list, after=False):
500
if names_list is None:
503
if len(names_list) < 2:
504
raise errors.BzrCommandError("missing file argument")
505
tree, rel_names = tree_files(names_list)
507
if os.path.isdir(names_list[-1]):
508
# move into existing directory
509
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
510
self.outf.write("%s => %s\n" % pair)
512
if len(names_list) != 2:
513
raise errors.BzrCommandError('to mv multiple files the'
514
' destination must be a versioned'
516
tree.rename_one(rel_names[0], rel_names[1], after=after)
517
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
520
class cmd_pull(Command):
521
"""Turn this branch into a mirror of another branch.
523
This command only works on branches that have not diverged. Branches are
524
considered diverged if the destination branch's most recent commit is one
525
that has not been merged (directly or indirectly) into the parent.
527
If branches have diverged, you can use 'bzr merge' to integrate the changes
528
from one into the other. Once one branch has merged, the other should
529
be able to pull it again.
531
If you want to forget your local changes and just update your branch to
532
match the remote one, use pull --overwrite.
534
If there is no default location set, the first pull will set it. After
535
that, you can omit the location to use the default. To change the
536
default, use --remember. The value will only be saved if the remote
537
location can be accessed.
540
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
542
help='branch to pull into, '
543
'rather than the one containing the working directory',
548
takes_args = ['location?']
549
encoding_type = 'replace'
551
def run(self, location=None, remember=False, overwrite=False,
552
revision=None, verbose=False,
554
# FIXME: too much stuff is in the command class
555
if directory is None:
558
tree_to = WorkingTree.open_containing(directory)[0]
559
branch_to = tree_to.branch
560
except errors.NoWorkingTree:
562
branch_to = Branch.open_containing(directory)[0]
565
if location is not None:
567
reader = bundle.read_bundle_from_url(location)
568
except errors.NotABundle:
569
pass # Continue on considering this url a Branch
571
stored_loc = branch_to.get_parent()
573
if stored_loc is None:
574
raise errors.BzrCommandError("No pull location known or"
577
display_url = urlutils.unescape_for_display(stored_loc,
579
self.outf.write("Using saved location: %s\n" % display_url)
580
location = stored_loc
582
if reader is not None:
583
install_bundle(branch_to.repository, reader)
584
branch_from = branch_to
586
branch_from = Branch.open(location)
588
if branch_to.get_parent() is None or remember:
589
branch_to.set_parent(branch_from.base)
593
if reader is not None:
594
rev_id = reader.target
595
elif len(revision) == 1:
596
rev_id = revision[0].in_history(branch_from).rev_id
598
raise errors.BzrCommandError('bzr pull --revision takes one value.')
600
old_rh = branch_to.revision_history()
601
if tree_to is not None:
602
count = tree_to.pull(branch_from, overwrite, rev_id,
603
delta.ChangeReporter(tree_to.inventory))
605
count = branch_to.pull(branch_from, overwrite, rev_id)
606
note('%d revision(s) pulled.' % (count,))
609
new_rh = branch_to.revision_history()
612
from bzrlib.log import show_changed_revisions
613
show_changed_revisions(branch_to, old_rh, new_rh,
617
class cmd_push(Command):
618
"""Update a mirror of this branch.
620
The target branch will not have its working tree populated because this
621
is both expensive, and is not supported on remote file systems.
623
Some smart servers or protocols *may* put the working tree in place in
626
This command only works on branches that have not diverged. Branches are
627
considered diverged if the destination branch's most recent commit is one
628
that has not been merged (directly or indirectly) by the source branch.
630
If branches have diverged, you can use 'bzr push --overwrite' to replace
631
the other branch completely, discarding its unmerged changes.
633
If you want to ensure you have the different changes in the other branch,
634
do a merge (see bzr help merge) from the other branch, and commit that.
635
After that you will be able to do a push without '--overwrite'.
637
If there is no default push location set, the first push will set it.
638
After that, you can omit the location to use the default. To change the
639
default, use --remember. The value will only be saved if the remote
640
location can be accessed.
643
takes_options = ['remember', 'overwrite', 'verbose',
644
Option('create-prefix',
645
help='Create the path leading up to the branch '
646
'if it does not already exist'),
648
help='branch to push from, '
649
'rather than the one containing the working directory',
653
Option('use-existing-dir',
654
help='By default push will fail if the target'
655
' directory exists, but does not already'
656
' have a control directory. This flag will'
657
' allow push to proceed.'),
659
takes_args = ['location?']
660
encoding_type = 'replace'
662
def run(self, location=None, remember=False, overwrite=False,
663
create_prefix=False, verbose=False,
664
use_existing_dir=False,
666
# FIXME: Way too big! Put this into a function called from the
668
if directory is None:
670
br_from = Branch.open_containing(directory)[0]
671
stored_loc = br_from.get_push_location()
673
if stored_loc is None:
674
raise errors.BzrCommandError("No push location known or specified.")
676
display_url = urlutils.unescape_for_display(stored_loc,
678
self.outf.write("Using saved location: %s\n" % display_url)
679
location = stored_loc
681
to_transport = transport.get_transport(location)
682
location_url = to_transport.base
687
br_to = repository_to = dir_to = None
689
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
690
except errors.NotBranchError:
691
pass # Didn't find anything
693
# If we can open a branch, use its direct repository, otherwise see
694
# if there is a repository without a branch.
696
br_to = dir_to.open_branch()
697
except errors.NotBranchError:
698
# Didn't find a branch, can we find a repository?
700
repository_to = dir_to.find_repository()
701
except errors.NoRepositoryPresent:
704
# Found a branch, so we must have found a repository
705
repository_to = br_to.repository
709
# XXX: Refactor the create_prefix/no_create_prefix code into a
710
# common helper function
712
to_transport.mkdir('.')
713
except errors.FileExists:
714
if not use_existing_dir:
715
raise errors.BzrCommandError("Target directory %s"
716
" already exists, but does not have a valid .bzr"
717
" directory. Supply --use-existing-dir to push"
718
" there anyway." % location)
719
except errors.NoSuchFile:
720
if not create_prefix:
721
raise errors.BzrCommandError("Parent directory of %s"
723
"\nYou may supply --create-prefix to create all"
724
" leading parent directories."
727
cur_transport = to_transport
728
needed = [cur_transport]
729
# Recurse upwards until we can create a directory successfully
731
new_transport = cur_transport.clone('..')
732
if new_transport.base == cur_transport.base:
733
raise errors.BzrCommandError("Failed to create path"
737
new_transport.mkdir('.')
738
except errors.NoSuchFile:
739
needed.append(new_transport)
740
cur_transport = new_transport
744
# Now we only need to create child directories
746
cur_transport = needed.pop()
747
cur_transport.mkdir('.')
749
# Now the target directory exists, but doesn't have a .bzr
750
# directory. So we need to create it, along with any work to create
751
# all of the dependent branches, etc.
752
dir_to = br_from.bzrdir.clone(location_url,
753
revision_id=br_from.last_revision())
754
br_to = dir_to.open_branch()
755
count = br_to.last_revision_info()[0]
756
# We successfully created the target, remember it
757
if br_from.get_push_location() is None or remember:
758
br_from.set_push_location(br_to.base)
759
elif repository_to is None:
760
# we have a bzrdir but no branch or repository
761
# XXX: Figure out what to do other than complain.
762
raise errors.BzrCommandError("At %s you have a valid .bzr control"
763
" directory, but not a branch or repository. This is an"
764
" unsupported configuration. Please move the target directory"
765
" out of the way and try again."
768
# We have a repository but no branch, copy the revisions, and then
770
last_revision_id = br_from.last_revision()
771
repository_to.fetch(br_from.repository,
772
revision_id=last_revision_id)
773
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
774
count = len(br_to.revision_history())
775
if br_from.get_push_location() is None or remember:
776
br_from.set_push_location(br_to.base)
777
else: # We have a valid to branch
778
# We were able to connect to the remote location, so remember it
779
# we don't need to successfully push because of possible divergence.
780
if br_from.get_push_location() is None or remember:
781
br_from.set_push_location(br_to.base)
782
old_rh = br_to.revision_history()
785
tree_to = dir_to.open_workingtree()
786
except errors.NotLocalUrl:
787
warning('This transport does not update the working '
788
'tree of: %s' % (br_to.base,))
789
count = br_from.push(br_to, overwrite)
790
except errors.NoWorkingTree:
791
count = br_from.push(br_to, overwrite)
795
count = br_from.push(tree_to.branch, overwrite)
799
except errors.DivergedBranches:
800
raise errors.BzrCommandError('These branches have diverged.'
801
' Try using "merge" and then "push".')
802
note('%d revision(s) pushed.' % (count,))
805
new_rh = br_to.revision_history()
808
from bzrlib.log import show_changed_revisions
809
show_changed_revisions(br_to, old_rh, new_rh,
813
class cmd_branch(Command):
814
"""Create a new copy of a branch.
816
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
817
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
819
To retrieve the branch as of a particular revision, supply the --revision
820
parameter, as in "branch foo/bar -r 5".
822
--basis is to speed up branching from remote branches. When specified, it
823
copies all the file-contents, inventory and revision data from the basis
824
branch before copying anything from the remote branch.
826
takes_args = ['from_location', 'to_location?']
827
takes_options = ['revision', 'basis']
828
aliases = ['get', 'clone']
830
def run(self, from_location, to_location=None, revision=None, basis=None):
833
elif len(revision) > 1:
834
raise errors.BzrCommandError(
835
'bzr branch --revision takes exactly 1 revision value')
837
br_from = Branch.open(from_location)
840
if basis is not None:
841
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
844
if len(revision) == 1 and revision[0] is not None:
845
revision_id = revision[0].in_history(br_from)[1]
847
# FIXME - wt.last_revision, fallback to branch, fall back to
848
# None or perhaps NULL_REVISION to mean copy nothing
850
revision_id = br_from.last_revision()
851
if to_location is None:
852
to_location = os.path.basename(from_location.rstrip("/\\"))
855
name = os.path.basename(to_location) + '\n'
857
to_transport = transport.get_transport(to_location)
859
to_transport.mkdir('.')
860
except errors.FileExists:
861
raise errors.BzrCommandError('Target directory "%s" already'
862
' exists.' % to_location)
863
except errors.NoSuchFile:
864
raise errors.BzrCommandError('Parent of "%s" does not exist.'
867
# preserve whatever source format we have.
868
dir = br_from.bzrdir.sprout(to_transport.base,
869
revision_id, basis_dir)
870
branch = dir.open_branch()
871
except errors.NoSuchRevision:
872
to_transport.delete_tree('.')
873
msg = "The branch %s has no revision %s." % (from_location, revision[0])
874
raise errors.BzrCommandError(msg)
875
except errors.UnlistableBranch:
876
osutils.rmtree(to_location)
877
msg = "The branch %s cannot be used as a --basis" % (basis,)
878
raise errors.BzrCommandError(msg)
880
branch.control_files.put_utf8('branch-name', name)
881
note('Branched %d revision(s).' % branch.revno())
886
class cmd_checkout(Command):
887
"""Create a new checkout of an existing branch.
889
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
890
the branch found in '.'. This is useful if you have removed the working tree
891
or if it was never created - i.e. if you pushed the branch to its current
894
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
895
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
897
To retrieve the branch as of a particular revision, supply the --revision
898
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
899
out of date [so you cannot commit] but it may be useful (i.e. to examine old
902
--basis is to speed up checking out from remote branches. When specified, it
903
uses the inventory and file contents from the basis branch in preference to the
904
branch being checked out.
906
See "help checkouts" for more information on checkouts.
908
takes_args = ['branch_location?', 'to_location?']
909
takes_options = ['revision', # , 'basis']
910
Option('lightweight',
911
help="perform a lightweight checkout. Lightweight "
912
"checkouts depend on access to the branch for "
913
"every operation. Normal checkouts can perform "
914
"common operations like diff and status without "
915
"such access, and also support local commits."
920
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
924
elif len(revision) > 1:
925
raise errors.BzrCommandError(
926
'bzr checkout --revision takes exactly 1 revision value')
927
if branch_location is None:
928
branch_location = osutils.getcwd()
929
to_location = branch_location
930
source = Branch.open(branch_location)
931
if len(revision) == 1 and revision[0] is not None:
932
revision_id = revision[0].in_history(source)[1]
935
if to_location is None:
936
to_location = os.path.basename(branch_location.rstrip("/\\"))
937
# if the source and to_location are the same,
938
# and there is no working tree,
939
# then reconstitute a branch
940
if (osutils.abspath(to_location) ==
941
osutils.abspath(branch_location)):
943
source.bzrdir.open_workingtree()
944
except errors.NoWorkingTree:
945
source.bzrdir.create_workingtree()
948
os.mkdir(to_location)
950
if e.errno == errno.EEXIST:
951
raise errors.BzrCommandError('Target directory "%s" already'
952
' exists.' % to_location)
953
if e.errno == errno.ENOENT:
954
raise errors.BzrCommandError('Parent of "%s" does not exist.'
958
source.create_checkout(to_location, revision_id, lightweight)
961
class cmd_renames(Command):
962
"""Show list of renamed files.
964
# TODO: Option to show renames between two historical versions.
966
# TODO: Only show renames under dir, rather than in the whole branch.
967
takes_args = ['dir?']
970
def run(self, dir=u'.'):
971
tree = WorkingTree.open_containing(dir)[0]
972
old_inv = tree.basis_tree().inventory
973
new_inv = tree.read_working_inventory()
974
renames = list(_mod_tree.find_renames(old_inv, new_inv))
976
for old_name, new_name in renames:
977
self.outf.write("%s => %s\n" % (old_name, new_name))
980
class cmd_update(Command):
981
"""Update a tree to have the latest code committed to its branch.
983
This will perform a merge into the working tree, and may generate
984
conflicts. If you have any local changes, you will still
985
need to commit them after the update for the update to be complete.
987
If you want to discard your local changes, you can just do a
988
'bzr revert' instead of 'bzr commit' after the update.
990
takes_args = ['dir?']
993
def run(self, dir='.'):
994
tree = WorkingTree.open_containing(dir)[0]
995
master = tree.branch.get_master_branch()
996
if master is not None:
999
tree.lock_tree_write()
1001
existing_pending_merges = tree.get_parent_ids()[1:]
1002
last_rev = tree.last_revision()
1003
if last_rev == tree.branch.last_revision():
1004
# may be up to date, check master too.
1005
master = tree.branch.get_master_branch()
1006
if master is None or last_rev == master.last_revision():
1007
revno = tree.branch.revision_id_to_revno(last_rev)
1008
note("Tree is up to date at revision %d." % (revno,))
1010
conflicts = tree.update()
1011
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1012
note('Updated to revision %d.' % (revno,))
1013
if tree.get_parent_ids()[1:] != existing_pending_merges:
1014
note('Your local commits will now show as pending merges with '
1015
"'bzr status', and can be committed with 'bzr commit'.")
1024
class cmd_info(Command):
1025
"""Show information about a working tree, branch or repository.
1027
This command will show all known locations and formats associated to the
1028
tree, branch or repository. Statistical information is included with
1031
Branches and working trees will also report any missing revisions.
1033
takes_args = ['location?']
1034
takes_options = ['verbose']
1037
def run(self, location=None, verbose=False):
1038
from bzrlib.info import show_bzrdir_info
1039
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1043
class cmd_remove(Command):
1044
"""Make a file unversioned.
1046
This makes bzr stop tracking changes to a versioned file. It does
1047
not delete the working copy.
1049
You can specify one or more files, and/or --new. If you specify --new,
1050
only 'added' files will be removed. If you specify both, then new files
1051
in the specified directories will be removed. If the directories are
1052
also new, they will also be removed.
1054
takes_args = ['file*']
1055
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1057
encoding_type = 'replace'
1059
def run(self, file_list, verbose=False, new=False):
1060
tree, file_list = tree_files(file_list)
1062
if file_list is None:
1063
raise errors.BzrCommandError('Specify one or more files to'
1064
' remove, or use --new.')
1066
added = tree.changes_from(tree.basis_tree(),
1067
specific_files=file_list).added
1068
file_list = sorted([f[0] for f in added], reverse=True)
1069
if len(file_list) == 0:
1070
raise errors.BzrCommandError('No matching files.')
1071
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1074
class cmd_file_id(Command):
1075
"""Print file_id of a particular file or directory.
1077
The file_id is assigned when the file is first added and remains the
1078
same through all revisions where the file exists, even when it is
1083
takes_args = ['filename']
1086
def run(self, filename):
1087
tree, relpath = WorkingTree.open_containing(filename)
1088
i = tree.inventory.path2id(relpath)
1090
raise errors.NotVersionedError(filename)
1092
self.outf.write(i + '\n')
1095
class cmd_file_path(Command):
1096
"""Print path of file_ids to a file or directory.
1098
This prints one line for each directory down to the target,
1099
starting at the branch root.
1103
takes_args = ['filename']
1106
def run(self, filename):
1107
tree, relpath = WorkingTree.open_containing(filename)
1108
inv = tree.inventory
1109
fid = inv.path2id(relpath)
1111
raise errors.NotVersionedError(filename)
1112
for fip in inv.get_idpath(fid):
1113
self.outf.write(fip + '\n')
1116
class cmd_reconcile(Command):
1117
"""Reconcile bzr metadata in a branch.
1119
This can correct data mismatches that may have been caused by
1120
previous ghost operations or bzr upgrades. You should only
1121
need to run this command if 'bzr check' or a bzr developer
1122
advises you to run it.
1124
If a second branch is provided, cross-branch reconciliation is
1125
also attempted, which will check that data like the tree root
1126
id which was not present in very early bzr versions is represented
1127
correctly in both branches.
1129
At the same time it is run it may recompress data resulting in
1130
a potential saving in disk space or performance gain.
1132
The branch *MUST* be on a listable system such as local disk or sftp.
1134
takes_args = ['branch?']
1136
def run(self, branch="."):
1137
from bzrlib.reconcile import reconcile
1138
dir = bzrdir.BzrDir.open(branch)
1142
class cmd_revision_history(Command):
1143
"""Display the list of revision ids on a branch."""
1144
takes_args = ['location?']
1149
def run(self, location="."):
1150
branch = Branch.open_containing(location)[0]
1151
for revid in branch.revision_history():
1152
self.outf.write(revid)
1153
self.outf.write('\n')
1156
class cmd_ancestry(Command):
1157
"""List all revisions merged into this branch."""
1158
takes_args = ['location?']
1163
def run(self, location="."):
1165
wt = WorkingTree.open_containing(location)[0]
1166
except errors.NoWorkingTree:
1167
b = Branch.open(location)
1168
last_revision = b.last_revision()
1171
last_revision = wt.last_revision()
1173
revision_ids = b.repository.get_ancestry(last_revision)
1174
assert revision_ids[0] is None
1176
for revision_id in revision_ids:
1177
self.outf.write(revision_id + '\n')
1180
class cmd_init(Command):
1181
"""Make a directory into a versioned branch.
1183
Use this to create an empty branch, or before importing an
1186
If there is a repository in a parent directory of the location, then
1187
the history of the branch will be stored in the repository. Otherwise
1188
init creates a standalone branch which carries its own history in
1191
If there is already a branch at the location but it has no working tree,
1192
the tree can be populated with 'bzr checkout'.
1194
Recipe for importing a tree of files:
1199
bzr commit -m 'imported project'
1201
takes_args = ['location?']
1203
RegistryOption('format',
1204
help='Specify a format for this branch. '
1205
'See "help formats".',
1206
registry=bzrdir.format_registry,
1207
converter=bzrdir.format_registry.make_bzrdir,
1208
value_switches=True,
1209
title="Branch Format",
1211
Option('append-revisions-only',
1212
help='Never change revnos or the existing log.'
1213
' Append revisions to it only.')
1215
def run(self, location=None, format=None, append_revisions_only=False):
1217
format = bzrdir.format_registry.make_bzrdir('default')
1218
if location is None:
1221
to_transport = transport.get_transport(location)
1223
# The path has to exist to initialize a
1224
# branch inside of it.
1225
# Just using os.mkdir, since I don't
1226
# believe that we want to create a bunch of
1227
# locations if the user supplies an extended path
1228
# TODO: create-prefix
1230
to_transport.mkdir('.')
1231
except errors.FileExists:
1235
existing_bzrdir = bzrdir.BzrDir.open(location)
1236
except errors.NotBranchError:
1237
# really a NotBzrDir error...
1238
branch = bzrdir.BzrDir.create_branch_convenience(location,
1241
from bzrlib.transport.local import LocalTransport
1242
if existing_bzrdir.has_branch():
1243
if (isinstance(to_transport, LocalTransport)
1244
and not existing_bzrdir.has_workingtree()):
1245
raise errors.BranchExistsWithoutWorkingTree(location)
1246
raise errors.AlreadyBranchError(location)
1248
branch = existing_bzrdir.create_branch()
1249
existing_bzrdir.create_workingtree()
1250
if append_revisions_only:
1252
branch.set_append_revisions_only(True)
1253
except errors.UpgradeRequired:
1254
raise errors.BzrCommandError('This branch format cannot be set'
1255
' to append-revisions-only. Try --experimental-branch6')
1258
class cmd_init_repository(Command):
1259
"""Create a shared repository to hold branches.
1261
New branches created under the repository directory will store their revisions
1262
in the repository, not in the branch directory, if the branch format supports
1268
bzr checkout --lightweight repo/trunk trunk-checkout
1272
takes_args = ["location"]
1273
takes_options = [RegistryOption('format',
1274
help='Specify a format for this repository. See'
1275
' "bzr help formats" for details',
1276
registry=bzrdir.format_registry,
1277
converter=bzrdir.format_registry.make_bzrdir,
1278
value_switches=True, title='Repository format'),
1280
help='Allows branches in repository to have'
1282
aliases = ["init-repo"]
1283
def run(self, location, format=None, trees=False):
1285
format = bzrdir.format_registry.make_bzrdir('default')
1287
if location is None:
1290
to_transport = transport.get_transport(location)
1292
to_transport.mkdir('.')
1293
except errors.FileExists:
1296
newdir = format.initialize_on_transport(to_transport)
1297
repo = newdir.create_repository(shared=True)
1298
repo.set_make_working_trees(trees)
1301
class cmd_diff(Command):
1302
"""Show differences in the working tree or between revisions.
1304
If files are listed, only the changes in those files are listed.
1305
Otherwise, all changes for the tree are listed.
1307
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1308
produces patches suitable for "patch -p1".
1312
Shows the difference in the working tree versus the last commit
1314
Difference between the working tree and revision 1
1316
Difference between revision 2 and revision 1
1317
bzr diff --diff-prefix old/:new/
1318
Same as 'bzr diff' but prefix paths with old/ and new/
1319
bzr diff bzr.mine bzr.dev
1320
Show the differences between the two working trees
1322
Show just the differences for 'foo.c'
1324
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1325
# or a graphical diff.
1327
# TODO: Python difflib is not exactly the same as unidiff; should
1328
# either fix it up or prefer to use an external diff.
1330
# TODO: Selected-file diff is inefficient and doesn't show you
1333
# TODO: This probably handles non-Unix newlines poorly.
1335
takes_args = ['file*']
1336
takes_options = ['revision', 'diff-options',
1337
Option('prefix', type=str,
1339
help='Set prefixes to added to old and new filenames, as '
1340
'two values separated by a colon.'),
1342
aliases = ['di', 'dif']
1343
encoding_type = 'exact'
1346
def run(self, revision=None, file_list=None, diff_options=None,
1348
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1350
if (prefix is None) or (prefix == '0'):
1358
old_label, new_label = prefix.split(":")
1360
raise BzrCommandError(
1361
"--prefix expects two values separated by a colon")
1363
if revision and len(revision) > 2:
1364
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1365
' one or two revision specifiers')
1368
tree1, file_list = internal_tree_files(file_list)
1372
except errors.FileInWrongBranch:
1373
if len(file_list) != 2:
1374
raise errors.BzrCommandError("Files are in different branches")
1376
tree1, file1 = WorkingTree.open_containing(file_list[0])
1377
tree2, file2 = WorkingTree.open_containing(file_list[1])
1378
if file1 != "" or file2 != "":
1379
# FIXME diff those two files. rbc 20051123
1380
raise errors.BzrCommandError("Files are in different branches")
1382
except errors.NotBranchError:
1383
if (revision is not None and len(revision) == 2
1384
and not revision[0].needs_branch()
1385
and not revision[1].needs_branch()):
1386
# If both revision specs include a branch, we can
1387
# diff them without needing a local working tree
1388
tree1, tree2 = None, None
1392
if tree2 is not None:
1393
if revision is not None:
1394
# FIXME: but there should be a clean way to diff between
1395
# non-default versions of two trees, it's not hard to do
1397
raise errors.BzrCommandError(
1398
"Sorry, diffing arbitrary revisions across branches "
1399
"is not implemented yet")
1400
return show_diff_trees(tree1, tree2, sys.stdout,
1401
specific_files=file_list,
1402
external_diff_options=diff_options,
1403
old_label=old_label, new_label=new_label)
1405
return diff_cmd_helper(tree1, file_list, diff_options,
1406
revision_specs=revision,
1407
old_label=old_label, new_label=new_label)
1410
class cmd_deleted(Command):
1411
"""List files deleted in the working tree.
1413
# TODO: Show files deleted since a previous revision, or
1414
# between two revisions.
1415
# TODO: Much more efficient way to do this: read in new
1416
# directories with readdir, rather than stating each one. Same
1417
# level of effort but possibly much less IO. (Or possibly not,
1418
# if the directories are very large...)
1419
takes_options = ['show-ids']
1422
def run(self, show_ids=False):
1423
tree = WorkingTree.open_containing(u'.')[0]
1424
old = tree.basis_tree()
1425
for path, ie in old.inventory.iter_entries():
1426
if not tree.has_id(ie.file_id):
1427
self.outf.write(path)
1429
self.outf.write(' ')
1430
self.outf.write(ie.file_id)
1431
self.outf.write('\n')
1434
class cmd_modified(Command):
1435
"""List files modified in working tree.
1437
See also: "bzr status".
1444
tree = WorkingTree.open_containing(u'.')[0]
1445
td = tree.changes_from(tree.basis_tree())
1446
for path, id, kind, text_modified, meta_modified in td.modified:
1447
self.outf.write(path + '\n')
1450
class cmd_added(Command):
1451
"""List files added in working tree.
1453
See also: "bzr status".
1460
wt = WorkingTree.open_containing(u'.')[0]
1461
basis_inv = wt.basis_tree().inventory
1464
if file_id in basis_inv:
1466
if inv.is_root(file_id) and len(basis_inv) == 0:
1468
path = inv.id2path(file_id)
1469
if not os.access(osutils.abspath(path), os.F_OK):
1471
self.outf.write(path + '\n')
1474
class cmd_root(Command):
1475
"""Show the tree root directory.
1477
The root is the nearest enclosing directory with a .bzr control
1479
takes_args = ['filename?']
1481
def run(self, filename=None):
1482
"""Print the branch root."""
1483
tree = WorkingTree.open_containing(filename)[0]
1484
self.outf.write(tree.basedir + '\n')
1487
class cmd_log(Command):
1488
"""Show log of a branch, file, or directory.
1490
By default show the log of the branch containing the working directory.
1492
To request a range of logs, you can use the command -r begin..end
1493
-r revision requests a specific revision, -r ..end or -r begin.. are
1499
bzr log -r -10.. http://server/branch
1502
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1504
takes_args = ['location?']
1505
takes_options = [Option('forward',
1506
help='show from oldest to newest'),
1510
help='show files changed in each revision'),
1511
'show-ids', 'revision',
1515
help='show revisions whose message matches this regexp',
1518
encoding_type = 'replace'
1521
def run(self, location=None, timezone='original',
1528
from bzrlib.log import show_log
1529
assert message is None or isinstance(message, basestring), \
1530
"invalid message argument %r" % message
1531
direction = (forward and 'forward') or 'reverse'
1536
# find the file id to log:
1538
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1542
tree = b.basis_tree()
1543
inv = tree.inventory
1544
file_id = inv.path2id(fp)
1546
raise errors.BzrCommandError(
1547
"Path does not have any revision history: %s" %
1551
# FIXME ? log the current subdir only RBC 20060203
1552
if revision is not None \
1553
and len(revision) > 0 and revision[0].get_branch():
1554
location = revision[0].get_branch()
1557
dir, relpath = bzrdir.BzrDir.open_containing(location)
1558
b = dir.open_branch()
1562
if revision is None:
1565
elif len(revision) == 1:
1566
rev1 = rev2 = revision[0].in_history(b).revno
1567
elif len(revision) == 2:
1568
if revision[1].get_branch() != revision[0].get_branch():
1569
# b is taken from revision[0].get_branch(), and
1570
# show_log will use its revision_history. Having
1571
# different branches will lead to weird behaviors.
1572
raise errors.BzrCommandError(
1573
"Log doesn't accept two revisions in different"
1575
if revision[0].spec is None:
1576
# missing begin-range means first revision
1579
rev1 = revision[0].in_history(b).revno
1581
if revision[1].spec is None:
1582
# missing end-range means last known revision
1585
rev2 = revision[1].in_history(b).revno
1587
raise errors.BzrCommandError(
1588
'bzr log --revision takes one or two values.')
1590
# By this point, the revision numbers are converted to the +ve
1591
# form if they were supplied in the -ve form, so we can do
1592
# this comparison in relative safety
1594
(rev2, rev1) = (rev1, rev2)
1596
if log_format is None:
1597
log_format = log.log_formatter_registry.get_default(b)
1599
lf = log_format(show_ids=show_ids, to_file=self.outf,
1600
show_timezone=timezone)
1606
direction=direction,
1607
start_revision=rev1,
1614
def get_log_format(long=False, short=False, line=False, default='long'):
1615
log_format = default
1619
log_format = 'short'
1625
class cmd_touching_revisions(Command):
1626
"""Return revision-ids which affected a particular file.
1628
A more user-friendly interface is "bzr log FILE".
1632
takes_args = ["filename"]
1635
def run(self, filename):
1636
tree, relpath = WorkingTree.open_containing(filename)
1638
inv = tree.read_working_inventory()
1639
file_id = inv.path2id(relpath)
1640
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1641
self.outf.write("%6d %s\n" % (revno, what))
1644
class cmd_ls(Command):
1645
"""List files in a tree.
1648
takes_args = ['path?']
1649
# TODO: Take a revision or remote path and list that tree instead.
1650
takes_options = ['verbose', 'revision',
1651
Option('non-recursive',
1652
help='don\'t recurse into sub-directories'),
1654
help='Print all paths from the root of the branch.'),
1655
Option('unknown', help='Print unknown files'),
1656
Option('versioned', help='Print versioned files'),
1657
Option('ignored', help='Print ignored files'),
1659
Option('null', help='Null separate the files'),
1663
def run(self, revision=None, verbose=False,
1664
non_recursive=False, from_root=False,
1665
unknown=False, versioned=False, ignored=False,
1666
null=False, kind=None, show_ids=False, path=None):
1668
if kind and kind not in ('file', 'directory', 'symlink'):
1669
raise errors.BzrCommandError('invalid kind specified')
1671
if verbose and null:
1672
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1673
all = not (unknown or versioned or ignored)
1675
selection = {'I':ignored, '?':unknown, 'V':versioned}
1682
raise errors.BzrCommandError('cannot specify both --from-root'
1686
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1692
if revision is not None:
1693
tree = branch.repository.revision_tree(
1694
revision[0].in_history(branch).rev_id)
1696
tree = branch.basis_tree()
1698
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1699
if fp.startswith(relpath):
1700
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1701
if non_recursive and '/' in fp:
1703
if not all and not selection[fc]:
1705
if kind is not None and fkind != kind:
1708
kindch = entry.kind_character()
1709
outstring = '%-8s %s%s' % (fc, fp, kindch)
1710
if show_ids and fid is not None:
1711
outstring = "%-50s %s" % (outstring, fid)
1712
self.outf.write(outstring + '\n')
1714
self.outf.write(fp + '\0')
1717
self.outf.write(fid)
1718
self.outf.write('\0')
1726
self.outf.write('%-50s %s\n' % (fp, my_id))
1728
self.outf.write(fp + '\n')
1731
class cmd_unknowns(Command):
1732
"""List unknown files.
1734
See also: "bzr ls --unknown".
1741
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1742
self.outf.write(osutils.quotefn(f) + '\n')
1745
class cmd_ignore(Command):
1746
"""Ignore specified files or patterns.
1748
To remove patterns from the ignore list, edit the .bzrignore file.
1750
Trailing slashes on patterns are ignored.
1751
If the pattern contains a slash or is a regular expression, it is compared
1752
to the whole path from the branch root. Otherwise, it is compared to only
1753
the last component of the path. To match a file only in the root
1754
directory, prepend './'.
1756
Ignore patterns specifying absolute paths are not allowed.
1758
Ignore patterns may include globbing wildcards such as:
1759
? - Matches any single character except '/'
1760
* - Matches 0 or more characters except '/'
1761
/**/ - Matches 0 or more directories in a path
1762
[a-z] - Matches a single character from within a group of characters
1764
Ignore patterns may also be Python regular expressions.
1765
Regular expression ignore patterns are identified by a 'RE:' prefix
1766
followed by the regular expression. Regular expression ignore patterns
1767
may not include named or numbered groups.
1769
Note: ignore patterns containing shell wildcards must be quoted from
1773
bzr ignore ./Makefile
1774
bzr ignore '*.class'
1775
bzr ignore 'lib/**/*.o'
1776
bzr ignore 'RE:lib/.*\.o'
1778
takes_args = ['name_pattern*']
1780
Option('old-default-rules',
1781
help='Out the ignore rules bzr < 0.9 always used.')
1784
def run(self, name_pattern_list=None, old_default_rules=None):
1785
from bzrlib.atomicfile import AtomicFile
1786
if old_default_rules is not None:
1787
# dump the rules and exit
1788
for pattern in ignores.OLD_DEFAULTS:
1791
if not name_pattern_list:
1792
raise errors.BzrCommandError("ignore requires at least one "
1793
"NAME_PATTERN or --old-default-rules")
1794
for name_pattern in name_pattern_list:
1795
if name_pattern[0] == '/':
1796
raise errors.BzrCommandError(
1797
"NAME_PATTERN should not be an absolute path")
1798
tree, relpath = WorkingTree.open_containing(u'.')
1799
ifn = tree.abspath('.bzrignore')
1800
if os.path.exists(ifn):
1803
igns = f.read().decode('utf-8')
1809
# TODO: If the file already uses crlf-style termination, maybe
1810
# we should use that for the newly added lines?
1812
if igns and igns[-1] != '\n':
1814
for name_pattern in name_pattern_list:
1815
igns += name_pattern.rstrip('/') + '\n'
1817
f = AtomicFile(ifn, 'wb')
1819
f.write(igns.encode('utf-8'))
1824
inv = tree.inventory
1825
if inv.path2id('.bzrignore'):
1826
mutter('.bzrignore is already versioned')
1828
mutter('need to make new .bzrignore file versioned')
1829
tree.add(['.bzrignore'])
1832
class cmd_ignored(Command):
1833
"""List ignored files and the patterns that matched them.
1835
See also: bzr ignore"""
1838
tree = WorkingTree.open_containing(u'.')[0]
1839
for path, file_class, kind, file_id, entry in tree.list_files():
1840
if file_class != 'I':
1842
## XXX: Slightly inefficient since this was already calculated
1843
pat = tree.is_ignored(path)
1844
print '%-50s %s' % (path, pat)
1847
class cmd_lookup_revision(Command):
1848
"""Lookup the revision-id from a revision-number
1851
bzr lookup-revision 33
1854
takes_args = ['revno']
1857
def run(self, revno):
1861
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1863
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1866
class cmd_export(Command):
1867
"""Export past revision to destination directory.
1869
If no revision is specified this exports the last committed revision.
1871
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1872
given, try to find the format with the extension. If no extension
1873
is found exports to a directory (equivalent to --format=dir).
1875
Root may be the top directory for tar, tgz and tbz2 formats. If none
1876
is given, the top directory will be the root name of the file.
1878
If branch is omitted then the branch containing the CWD will be used.
1880
Note: export of tree with non-ascii filenames to zip is not supported.
1882
Supported formats Autodetected by extension
1883
----------------- -------------------------
1886
tbz2 .tar.bz2, .tbz2
1890
takes_args = ['dest', 'branch?']
1891
takes_options = ['revision', 'format', 'root']
1892
def run(self, dest, branch=None, revision=None, format=None, root=None):
1893
from bzrlib.export import export
1896
tree = WorkingTree.open_containing(u'.')[0]
1899
b = Branch.open(branch)
1901
if revision is None:
1902
# should be tree.last_revision FIXME
1903
rev_id = b.last_revision()
1905
if len(revision) != 1:
1906
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1907
rev_id = revision[0].in_history(b).rev_id
1908
t = b.repository.revision_tree(rev_id)
1910
export(t, dest, format, root)
1911
except errors.NoSuchExportFormat, e:
1912
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1915
class cmd_cat(Command):
1916
"""Write a file's text from a previous revision."""
1918
takes_options = ['revision', 'name-from-revision']
1919
takes_args = ['filename']
1920
encoding_type = 'exact'
1923
def run(self, filename, revision=None, name_from_revision=False):
1924
if revision is not None and len(revision) != 1:
1925
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1930
tree, relpath = WorkingTree.open_containing(filename)
1932
except (errors.NotBranchError, errors.NotLocalUrl):
1935
if revision is not None and revision[0].get_branch() is not None:
1936
b = Branch.open(revision[0].get_branch())
1938
b, relpath = Branch.open_containing(filename)
1939
tree = b.basis_tree()
1940
if revision is None:
1941
revision_id = b.last_revision()
1943
revision_id = revision[0].in_history(b).rev_id
1945
cur_file_id = tree.path2id(relpath)
1946
rev_tree = b.repository.revision_tree(revision_id)
1947
old_file_id = rev_tree.path2id(relpath)
1949
if name_from_revision:
1950
if old_file_id is None:
1951
raise errors.BzrCommandError("%r is not present in revision %s"
1952
% (filename, revision_id))
1954
rev_tree.print_file(old_file_id)
1955
elif cur_file_id is not None:
1956
rev_tree.print_file(cur_file_id)
1957
elif old_file_id is not None:
1958
rev_tree.print_file(old_file_id)
1960
raise errors.BzrCommandError("%r is not present in revision %s" %
1961
(filename, revision_id))
1964
class cmd_local_time_offset(Command):
1965
"""Show the offset in seconds from GMT to local time."""
1969
print osutils.local_time_offset()
1973
class cmd_commit(Command):
1974
"""Commit changes into a new revision.
1976
If no arguments are given, the entire tree is committed.
1978
If selected files are specified, only changes to those files are
1979
committed. If a directory is specified then the directory and everything
1980
within it is committed.
1982
A selected-file commit may fail in some cases where the committed
1983
tree would be invalid, such as trying to commit a file in a
1984
newly-added directory that is not itself committed.
1986
# TODO: Run hooks on tree to-be-committed, and after commit.
1988
# TODO: Strict commit that fails if there are deleted files.
1989
# (what does "deleted files" mean ??)
1991
# TODO: Give better message for -s, --summary, used by tla people
1993
# XXX: verbose currently does nothing
1995
takes_args = ['selected*']
1996
takes_options = ['message', 'verbose',
1998
help='commit even if nothing has changed'),
1999
Option('file', type=str,
2002
help='file containing commit message'),
2004
help="refuse to commit if there are unknown "
2005
"files in the working tree."),
2007
help="perform a local only commit in a bound "
2008
"branch. Such commits are not pushed to "
2009
"the master branch until a normal commit "
2013
aliases = ['ci', 'checkin']
2015
def run(self, message=None, file=None, verbose=True, selected_list=None,
2016
unchanged=False, strict=False, local=False):
2017
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2018
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2020
from bzrlib.msgeditor import edit_commit_message, \
2021
make_commit_message_template
2023
# TODO: Need a blackbox test for invoking the external editor; may be
2024
# slightly problematic to run this cross-platform.
2026
# TODO: do more checks that the commit will succeed before
2027
# spending the user's valuable time typing a commit message.
2028
tree, selected_list = tree_files(selected_list)
2029
if selected_list == ['']:
2030
# workaround - commit of root of tree should be exactly the same
2031
# as just default commit in that tree, and succeed even though
2032
# selected-file merge commit is not done yet
2035
if local and not tree.branch.get_bound_location():
2036
raise errors.LocalRequiresBoundBranch()
2038
def get_message(commit_obj):
2039
"""Callback to get commit message"""
2040
my_message = message
2041
if my_message is None and not file:
2042
template = make_commit_message_template(tree, selected_list)
2043
my_message = edit_commit_message(template)
2044
if my_message is None:
2045
raise errors.BzrCommandError("please specify a commit"
2046
" message with either --message or --file")
2047
elif my_message and file:
2048
raise errors.BzrCommandError(
2049
"please specify either --message or --file")
2051
my_message = codecs.open(file, 'rt',
2052
bzrlib.user_encoding).read()
2053
if my_message == "":
2054
raise errors.BzrCommandError("empty commit message specified")
2058
reporter = ReportCommitToLog()
2060
reporter = NullCommitReporter()
2063
tree.commit(message_callback=get_message,
2064
specific_files=selected_list,
2065
allow_pointless=unchanged, strict=strict, local=local,
2067
except PointlessCommit:
2068
# FIXME: This should really happen before the file is read in;
2069
# perhaps prepare the commit; get the message; then actually commit
2070
raise errors.BzrCommandError("no changes to commit."
2071
" use --unchanged to commit anyhow")
2072
except ConflictsInTree:
2073
raise errors.BzrCommandError('Conflicts detected in working '
2074
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2076
except StrictCommitFailed:
2077
raise errors.BzrCommandError("Commit refused because there are"
2078
" unknown files in the working tree.")
2079
except errors.BoundBranchOutOfDate, e:
2080
raise errors.BzrCommandError(str(e) + "\n"
2081
'To commit to master branch, run update and then commit.\n'
2082
'You can also pass --local to commit to continue working '
2086
class cmd_check(Command):
2087
"""Validate consistency of branch history.
2089
This command checks various invariants about the branch storage to
2090
detect data corruption or bzr bugs.
2092
takes_args = ['branch?']
2093
takes_options = ['verbose']
2095
def run(self, branch=None, verbose=False):
2096
from bzrlib.check import check
2098
tree = WorkingTree.open_containing()[0]
2099
branch = tree.branch
2101
branch = Branch.open(branch)
2102
check(branch, verbose)
2105
class cmd_upgrade(Command):
2106
"""Upgrade branch storage to current format.
2108
The check command or bzr developers may sometimes advise you to run
2109
this command. When the default format has changed you may also be warned
2110
during other operations to upgrade.
2112
takes_args = ['url?']
2114
RegistryOption('format',
2115
help='Upgrade to a specific format. See "bzr help'
2116
' formats" for details',
2117
registry=bzrdir.format_registry,
2118
converter=bzrdir.format_registry.make_bzrdir,
2119
value_switches=True, title='Branch format'),
2123
def run(self, url='.', format=None):
2124
from bzrlib.upgrade import upgrade
2126
format = bzrdir.format_registry.make_bzrdir('default')
2127
upgrade(url, format)
2130
class cmd_whoami(Command):
2131
"""Show or set bzr user id.
2135
bzr whoami 'Frank Chu <fchu@example.com>'
2137
takes_options = [ Option('email',
2138
help='display email address only'),
2140
help='set identity for the current branch instead of '
2143
takes_args = ['name?']
2144
encoding_type = 'replace'
2147
def run(self, email=False, branch=False, name=None):
2149
# use branch if we're inside one; otherwise global config
2151
c = Branch.open_containing('.')[0].get_config()
2152
except errors.NotBranchError:
2153
c = config.GlobalConfig()
2155
self.outf.write(c.user_email() + '\n')
2157
self.outf.write(c.username() + '\n')
2160
# display a warning if an email address isn't included in the given name.
2162
config.extract_email_address(name)
2163
except errors.NoEmailInUsername, e:
2164
warning('"%s" does not seem to contain an email address. '
2165
'This is allowed, but not recommended.', name)
2167
# use global config unless --branch given
2169
c = Branch.open_containing('.')[0].get_config()
2171
c = config.GlobalConfig()
2172
c.set_user_option('email', name)
2175
class cmd_nick(Command):
2176
"""Print or set the branch nickname.
2178
If unset, the tree root directory name is used as the nickname
2179
To print the current nickname, execute with no argument.
2181
takes_args = ['nickname?']
2182
def run(self, nickname=None):
2183
branch = Branch.open_containing(u'.')[0]
2184
if nickname is None:
2185
self.printme(branch)
2187
branch.nick = nickname
2190
def printme(self, branch):
2194
class cmd_selftest(Command):
2195
"""Run internal test suite.
2197
This creates temporary test directories in the working directory, but not
2198
existing data is affected. These directories are deleted if the tests
2199
pass, or left behind to help in debugging if they fail and --keep-output
2202
If arguments are given, they are regular expressions that say which tests
2203
should run. Tests matching any expression are run, and other tests are
2206
Alternatively if --first is given, matching tests are run first and then
2207
all other tests are run. This is useful if you have been working in a
2208
particular area, but want to make sure nothing else was broken.
2210
If the global option '--no-plugins' is given, plugins are not loaded
2211
before running the selftests. This has two effects: features provided or
2212
modified by plugins will not be tested, and tests provided by plugins will
2217
run only tests relating to 'ignore'
2218
bzr --no-plugins selftest -v
2219
disable plugins and list tests as they're run
2221
# TODO: --list should give a list of all available tests
2223
# NB: this is used from the class without creating an instance, which is
2224
# why it does not have a self parameter.
2225
def get_transport_type(typestring):
2226
"""Parse and return a transport specifier."""
2227
if typestring == "sftp":
2228
from bzrlib.transport.sftp import SFTPAbsoluteServer
2229
return SFTPAbsoluteServer
2230
if typestring == "memory":
2231
from bzrlib.transport.memory import MemoryServer
2233
if typestring == "fakenfs":
2234
from bzrlib.transport.fakenfs import FakeNFSServer
2235
return FakeNFSServer
2236
msg = "No known transport type %s. Supported types are: sftp\n" %\
2238
raise errors.BzrCommandError(msg)
2241
takes_args = ['testspecs*']
2242
takes_options = ['verbose',
2243
Option('one', help='stop when one test fails'),
2244
Option('keep-output',
2245
help='keep output directories when tests fail'),
2247
help='Use a different transport by default '
2248
'throughout the test suite.',
2249
type=get_transport_type),
2250
Option('benchmark', help='run the bzr bencharks.'),
2251
Option('lsprof-timed',
2252
help='generate lsprof output for benchmarked'
2253
' sections of code.'),
2254
Option('cache-dir', type=str,
2255
help='a directory to cache intermediate'
2256
' benchmark steps'),
2257
Option('clean-output',
2258
help='clean temporary tests directories'
2259
' without running tests'),
2261
help='run all tests, but run specified tests first',
2264
encoding_type = 'replace'
2266
def run(self, testspecs_list=None, verbose=None, one=False,
2267
keep_output=False, transport=None, benchmark=None,
2268
lsprof_timed=None, cache_dir=None, clean_output=False,
2271
from bzrlib.tests import selftest
2272
import bzrlib.benchmarks as benchmarks
2273
from bzrlib.benchmarks import tree_creator
2276
from bzrlib.tests import clean_selftest_output
2277
clean_selftest_output()
2280
if cache_dir is not None:
2281
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2282
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2283
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2285
if testspecs_list is not None:
2286
pattern = '|'.join(testspecs_list)
2290
test_suite_factory = benchmarks.test_suite
2293
# TODO: should possibly lock the history file...
2294
benchfile = open(".perf_history", "at", buffering=1)
2296
test_suite_factory = None
2301
result = selftest(verbose=verbose,
2303
stop_on_failure=one,
2304
keep_output=keep_output,
2305
transport=transport,
2306
test_suite_factory=test_suite_factory,
2307
lsprof_timed=lsprof_timed,
2308
bench_history=benchfile,
2309
matching_tests_first=first,
2312
if benchfile is not None:
2315
info('tests passed')
2317
info('tests failed')
2318
return int(not result)
2321
class cmd_version(Command):
2322
"""Show version of bzr."""
2326
from bzrlib.version import show_version
2330
class cmd_rocks(Command):
2331
"""Statement of optimism."""
2337
print "it sure does!"
2340
class cmd_find_merge_base(Command):
2341
"""Find and print a base revision for merging two branches."""
2342
# TODO: Options to specify revisions on either side, as if
2343
# merging only part of the history.
2344
takes_args = ['branch', 'other']
2348
def run(self, branch, other):
2349
from bzrlib.revision import MultipleRevisionSources
2351
branch1 = Branch.open_containing(branch)[0]
2352
branch2 = Branch.open_containing(other)[0]
2354
last1 = branch1.last_revision()
2355
last2 = branch2.last_revision()
2357
source = MultipleRevisionSources(branch1.repository,
2360
base_rev_id = common_ancestor(last1, last2, source)
2362
print 'merge base is revision %s' % base_rev_id
2365
class cmd_merge(Command):
2366
"""Perform a three-way merge.
2368
The branch is the branch you will merge from. By default, it will merge
2369
the latest revision. If you specify a revision, that revision will be
2370
merged. If you specify two revisions, the first will be used as a BASE,
2371
and the second one as OTHER. Revision numbers are always relative to the
2374
By default, bzr will try to merge in all new work from the other
2375
branch, automatically determining an appropriate base. If this
2376
fails, you may need to give an explicit base.
2378
Merge will do its best to combine the changes in two branches, but there
2379
are some kinds of problems only a human can fix. When it encounters those,
2380
it will mark a conflict. A conflict means that you need to fix something,
2381
before you should commit.
2383
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2385
If there is no default branch set, the first merge will set it. After
2386
that, you can omit the branch to use the default. To change the
2387
default, use --remember. The value will only be saved if the remote
2388
location can be accessed.
2390
The results of the merge are placed into the destination working
2391
directory, where they can be reviewed (with bzr diff), tested, and then
2392
committed to record the result of the merge.
2396
To merge the latest revision from bzr.dev
2397
bzr merge ../bzr.dev
2399
To merge changes up to and including revision 82 from bzr.dev
2400
bzr merge -r 82 ../bzr.dev
2402
To merge the changes introduced by 82, without previous changes:
2403
bzr merge -r 81..82 ../bzr.dev
2405
merge refuses to run if there are any uncommitted changes, unless
2408
The following merge types are available:
2410
takes_args = ['branch?']
2411
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2412
Option('show-base', help="Show base revision text in "
2414
Option('uncommitted', help='Apply uncommitted changes'
2415
' from a working copy, instead of branch changes'),
2416
Option('pull', help='If the destination is already'
2417
' completely merged into the source, pull from the'
2418
' source rather than merging. When this happens,'
2419
' you do not need to commit the result.'),
2421
help='branch to merge into, '
2422
'rather than the one containing the working directory',
2428
def run(self, branch=None, revision=None, force=False, merge_type=None,
2429
show_base=False, reprocess=False, remember=False,
2430
uncommitted=False, pull=False,
2433
if merge_type is None:
2434
merge_type = _mod_merge.Merge3Merger
2436
if directory is None: directory = u'.'
2437
tree = WorkingTree.open_containing(directory)[0]
2438
change_reporter = delta.ChangeReporter(tree.inventory)
2440
if branch is not None:
2442
reader = bundle.read_bundle_from_url(branch)
2443
except errors.NotABundle:
2444
pass # Continue on considering this url a Branch
2446
conflicts = merge_bundle(reader, tree, not force, merge_type,
2447
reprocess, show_base, change_reporter)
2453
if revision is None \
2454
or len(revision) < 1 or revision[0].needs_branch():
2455
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2457
if revision is None or len(revision) < 1:
2460
other = [branch, None]
2463
other = [branch, -1]
2464
other_branch, path = Branch.open_containing(branch)
2467
raise errors.BzrCommandError('Cannot use --uncommitted and'
2468
' --revision at the same time.')
2469
branch = revision[0].get_branch() or branch
2470
if len(revision) == 1:
2472
other_branch, path = Branch.open_containing(branch)
2473
revno = revision[0].in_history(other_branch).revno
2474
other = [branch, revno]
2476
assert len(revision) == 2
2477
if None in revision:
2478
raise errors.BzrCommandError(
2479
"Merge doesn't permit empty revision specifier.")
2480
base_branch, path = Branch.open_containing(branch)
2481
branch1 = revision[1].get_branch() or branch
2482
other_branch, path1 = Branch.open_containing(branch1)
2483
if revision[0].get_branch() is not None:
2484
# then path was obtained from it, and is None.
2487
base = [branch, revision[0].in_history(base_branch).revno]
2488
other = [branch1, revision[1].in_history(other_branch).revno]
2490
if tree.branch.get_parent() is None or remember:
2491
tree.branch.set_parent(other_branch.base)
2494
interesting_files = [path]
2496
interesting_files = None
2497
pb = ui.ui_factory.nested_progress_bar()
2500
conflict_count = _merge_helper(
2501
other, base, check_clean=(not force),
2502
merge_type=merge_type,
2503
reprocess=reprocess,
2504
show_base=show_base,
2507
pb=pb, file_list=interesting_files,
2508
change_reporter=change_reporter)
2511
if conflict_count != 0:
2515
except errors.AmbiguousBase, e:
2516
m = ("sorry, bzr can't determine the right merge base yet\n"
2517
"candidates are:\n "
2518
+ "\n ".join(e.bases)
2520
"please specify an explicit base with -r,\n"
2521
"and (if you want) report this to the bzr developers\n")
2524
# TODO: move up to common parent; this isn't merge-specific anymore.
2525
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2526
"""Use tree.branch's parent if none was supplied.
2528
Report if the remembered location was used.
2530
if supplied_location is not None:
2531
return supplied_location
2532
stored_location = tree.branch.get_parent()
2533
mutter("%s", stored_location)
2534
if stored_location is None:
2535
raise errors.BzrCommandError("No location specified or remembered")
2536
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2537
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2538
return stored_location
2541
class cmd_remerge(Command):
2544
Use this if you want to try a different merge technique while resolving
2545
conflicts. Some merge techniques are better than others, and remerge
2546
lets you try different ones on different files.
2548
The options for remerge have the same meaning and defaults as the ones for
2549
merge. The difference is that remerge can (only) be run when there is a
2550
pending merge, and it lets you specify particular files.
2553
$ bzr remerge --show-base
2554
Re-do the merge of all conflicted files, and show the base text in
2555
conflict regions, in addition to the usual THIS and OTHER texts.
2557
$ bzr remerge --merge-type weave --reprocess foobar
2558
Re-do the merge of "foobar", using the weave merge algorithm, with
2559
additional processing to reduce the size of conflict regions.
2561
The following merge types are available:"""
2562
takes_args = ['file*']
2563
takes_options = ['merge-type', 'reprocess',
2564
Option('show-base', help="Show base revision text in "
2567
def run(self, file_list=None, merge_type=None, show_base=False,
2569
if merge_type is None:
2570
merge_type = _mod_merge.Merge3Merger
2571
tree, file_list = tree_files(file_list)
2574
parents = tree.get_parent_ids()
2575
if len(parents) != 2:
2576
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2577
" merges. Not cherrypicking or"
2579
repository = tree.branch.repository
2580
base_revision = common_ancestor(parents[0],
2581
parents[1], repository)
2582
base_tree = repository.revision_tree(base_revision)
2583
other_tree = repository.revision_tree(parents[1])
2584
interesting_ids = None
2586
conflicts = tree.conflicts()
2587
if file_list is not None:
2588
interesting_ids = set()
2589
for filename in file_list:
2590
file_id = tree.path2id(filename)
2592
raise errors.NotVersionedError(filename)
2593
interesting_ids.add(file_id)
2594
if tree.kind(file_id) != "directory":
2597
for name, ie in tree.inventory.iter_entries(file_id):
2598
interesting_ids.add(ie.file_id)
2599
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2601
# Remerge only supports resolving contents conflicts
2602
allowed_conflicts = ('text conflict', 'contents conflict')
2603
restore_files = [c.path for c in conflicts
2604
if c.typestring in allowed_conflicts]
2605
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2606
tree.set_conflicts(ConflictList(new_conflicts))
2607
if file_list is not None:
2608
restore_files = file_list
2609
for filename in restore_files:
2611
restore(tree.abspath(filename))
2612
except errors.NotConflicted:
2614
conflicts = _mod_merge.merge_inner(
2615
tree.branch, other_tree, base_tree,
2617
interesting_ids=interesting_ids,
2618
other_rev_id=parents[1],
2619
merge_type=merge_type,
2620
show_base=show_base,
2621
reprocess=reprocess)
2630
class cmd_revert(Command):
2631
"""Revert files to a previous revision.
2633
Giving a list of files will revert only those files. Otherwise, all files
2634
will be reverted. If the revision is not specified with '--revision', the
2635
last committed revision is used.
2637
To remove only some changes, without reverting to a prior version, use
2638
merge instead. For example, "merge . --r-2..-3" will remove the changes
2639
introduced by -2, without affecting the changes introduced by -1. Or
2640
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2642
By default, any files that have been manually changed will be backed up
2643
first. (Files changed only by merge are not backed up.) Backup files have
2644
'.~#~' appended to their name, where # is a number.
2646
When you provide files, you can use their current pathname or the pathname
2647
from the target revision. So you can use revert to "undelete" a file by
2648
name. If you name a directory, all the contents of that directory will be
2651
takes_options = ['revision', 'no-backup']
2652
takes_args = ['file*']
2653
aliases = ['merge-revert']
2655
def run(self, revision=None, no_backup=False, file_list=None):
2656
if file_list is not None:
2657
if len(file_list) == 0:
2658
raise errors.BzrCommandError("No files specified")
2662
tree, file_list = tree_files(file_list)
2663
if revision is None:
2664
# FIXME should be tree.last_revision
2665
rev_id = tree.last_revision()
2666
elif len(revision) != 1:
2667
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2669
rev_id = revision[0].in_history(tree.branch).rev_id
2670
pb = ui.ui_factory.nested_progress_bar()
2672
tree.revert(file_list,
2673
tree.branch.repository.revision_tree(rev_id),
2674
not no_backup, pb, report_changes=True)
2679
class cmd_assert_fail(Command):
2680
"""Test reporting of assertion failures"""
2681
# intended just for use in testing
2686
raise AssertionError("always fails")
2689
class cmd_help(Command):
2690
"""Show help on a command or other topic.
2692
For a list of all available commands, say 'bzr help commands'.
2694
takes_options = [Option('long', 'show help on all commands')]
2695
takes_args = ['topic?']
2696
aliases = ['?', '--help', '-?', '-h']
2699
def run(self, topic=None, long=False):
2701
if topic is None and long:
2703
bzrlib.help.help(topic)
2706
class cmd_shell_complete(Command):
2707
"""Show appropriate completions for context.
2709
For a list of all available commands, say 'bzr shell-complete'.
2711
takes_args = ['context?']
2716
def run(self, context=None):
2717
import shellcomplete
2718
shellcomplete.shellcomplete(context)
2721
class cmd_fetch(Command):
2722
"""Copy in history from another branch but don't merge it.
2724
This is an internal method used for pull and merge.
2727
takes_args = ['from_branch', 'to_branch']
2728
def run(self, from_branch, to_branch):
2729
from bzrlib.fetch import Fetcher
2730
from_b = Branch.open(from_branch)
2731
to_b = Branch.open(to_branch)
2732
Fetcher(to_b, from_b)
2735
class cmd_missing(Command):
2736
"""Show unmerged/unpulled revisions between two branches.
2738
OTHER_BRANCH may be local or remote.
2740
takes_args = ['other_branch?']
2741
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2743
'Display changes in the local branch only'),
2744
Option('theirs-only',
2745
'Display changes in the remote branch only'),
2750
encoding_type = 'replace'
2753
def run(self, other_branch=None, reverse=False, mine_only=False,
2754
theirs_only=False, log_format=None, long=False, short=False, line=False,
2755
show_ids=False, verbose=False):
2756
from bzrlib.missing import find_unmerged, iter_log_data
2757
from bzrlib.log import log_formatter
2758
local_branch = Branch.open_containing(u".")[0]
2759
parent = local_branch.get_parent()
2760
if other_branch is None:
2761
other_branch = parent
2762
if other_branch is None:
2763
raise errors.BzrCommandError("No peer location known or specified.")
2764
display_url = urlutils.unescape_for_display(parent,
2766
print "Using last location: " + display_url
2768
remote_branch = Branch.open(other_branch)
2769
if remote_branch.base == local_branch.base:
2770
remote_branch = local_branch
2771
local_branch.lock_read()
2773
remote_branch.lock_read()
2775
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2776
if (log_format is None):
2777
log_format = log.log_formatter_registry.get_default(
2779
lf = log_format(to_file=self.outf,
2781
show_timezone='original')
2782
if reverse is False:
2783
local_extra.reverse()
2784
remote_extra.reverse()
2785
if local_extra and not theirs_only:
2786
print "You have %d extra revision(s):" % len(local_extra)
2787
for data in iter_log_data(local_extra, local_branch.repository,
2790
printed_local = True
2792
printed_local = False
2793
if remote_extra and not mine_only:
2794
if printed_local is True:
2796
print "You are missing %d revision(s):" % len(remote_extra)
2797
for data in iter_log_data(remote_extra, remote_branch.repository,
2800
if not remote_extra and not local_extra:
2802
print "Branches are up to date."
2806
remote_branch.unlock()
2808
local_branch.unlock()
2809
if not status_code and parent is None and other_branch is not None:
2810
local_branch.lock_write()
2812
# handle race conditions - a parent might be set while we run.
2813
if local_branch.get_parent() is None:
2814
local_branch.set_parent(remote_branch.base)
2816
local_branch.unlock()
2820
class cmd_plugins(Command):
2825
import bzrlib.plugin
2826
from inspect import getdoc
2827
for name, plugin in bzrlib.plugin.all_plugins().items():
2828
if getattr(plugin, '__path__', None) is not None:
2829
print plugin.__path__[0]
2830
elif getattr(plugin, '__file__', None) is not None:
2831
print plugin.__file__
2837
print '\t', d.split('\n')[0]
2840
class cmd_testament(Command):
2841
"""Show testament (signing-form) of a revision."""
2842
takes_options = ['revision',
2843
Option('long', help='Produce long-format testament'),
2844
Option('strict', help='Produce a strict-format'
2846
takes_args = ['branch?']
2848
def run(self, branch=u'.', revision=None, long=False, strict=False):
2849
from bzrlib.testament import Testament, StrictTestament
2851
testament_class = StrictTestament
2853
testament_class = Testament
2854
b = WorkingTree.open_containing(branch)[0].branch
2857
if revision is None:
2858
rev_id = b.last_revision()
2860
rev_id = revision[0].in_history(b).rev_id
2861
t = testament_class.from_revision(b.repository, rev_id)
2863
sys.stdout.writelines(t.as_text_lines())
2865
sys.stdout.write(t.as_short_text())
2870
class cmd_annotate(Command):
2871
"""Show the origin of each line in a file.
2873
This prints out the given file with an annotation on the left side
2874
indicating which revision, author and date introduced the change.
2876
If the origin is the same for a run of consecutive lines, it is
2877
shown only at the top, unless the --all option is given.
2879
# TODO: annotate directories; showing when each file was last changed
2880
# TODO: if the working copy is modified, show annotations on that
2881
# with new uncommitted lines marked
2882
aliases = ['ann', 'blame', 'praise']
2883
takes_args = ['filename']
2884
takes_options = [Option('all', help='show annotations on all lines'),
2885
Option('long', help='show date in annotations'),
2891
def run(self, filename, all=False, long=False, revision=None,
2893
from bzrlib.annotate import annotate_file
2894
tree, relpath = WorkingTree.open_containing(filename)
2895
branch = tree.branch
2898
if revision is None:
2899
revision_id = branch.last_revision()
2900
elif len(revision) != 1:
2901
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2903
revision_id = revision[0].in_history(branch).rev_id
2904
file_id = tree.inventory.path2id(relpath)
2905
tree = branch.repository.revision_tree(revision_id)
2906
file_version = tree.inventory[file_id].revision
2907
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2913
class cmd_re_sign(Command):
2914
"""Create a digital signature for an existing revision."""
2915
# TODO be able to replace existing ones.
2917
hidden = True # is this right ?
2918
takes_args = ['revision_id*']
2919
takes_options = ['revision']
2921
def run(self, revision_id_list=None, revision=None):
2922
import bzrlib.gpg as gpg
2923
if revision_id_list is not None and revision is not None:
2924
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2925
if revision_id_list is None and revision is None:
2926
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2927
b = WorkingTree.open_containing(u'.')[0].branch
2928
gpg_strategy = gpg.GPGStrategy(b.get_config())
2929
if revision_id_list is not None:
2930
for revision_id in revision_id_list:
2931
b.repository.sign_revision(revision_id, gpg_strategy)
2932
elif revision is not None:
2933
if len(revision) == 1:
2934
revno, rev_id = revision[0].in_history(b)
2935
b.repository.sign_revision(rev_id, gpg_strategy)
2936
elif len(revision) == 2:
2937
# are they both on rh- if so we can walk between them
2938
# might be nice to have a range helper for arbitrary
2939
# revision paths. hmm.
2940
from_revno, from_revid = revision[0].in_history(b)
2941
to_revno, to_revid = revision[1].in_history(b)
2942
if to_revid is None:
2943
to_revno = b.revno()
2944
if from_revno is None or to_revno is None:
2945
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2946
for revno in range(from_revno, to_revno + 1):
2947
b.repository.sign_revision(b.get_rev_id(revno),
2950
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2953
class cmd_bind(Command):
2954
"""Convert the current branch into a checkout of the supplied branch.
2956
Once converted into a checkout, commits must succeed on the master branch
2957
before they will be applied to the local branch.
2959
See "help checkouts" for more information on checkouts.
2962
takes_args = ['location?']
2965
def run(self, location=None):
2966
b, relpath = Branch.open_containing(u'.')
2967
if location is None:
2969
location = b.get_old_bound_location()
2970
except errors.UpgradeRequired:
2971
raise errors.BzrCommandError('No location supplied. '
2972
'This format does not remember old locations.')
2974
if location is None:
2975
raise errors.BzrCommandError('No location supplied and no '
2976
'previous location known')
2977
b_other = Branch.open(location)
2980
except errors.DivergedBranches:
2981
raise errors.BzrCommandError('These branches have diverged.'
2982
' Try merging, and then bind again.')
2985
class cmd_unbind(Command):
2986
"""Convert the current checkout into a regular branch.
2988
After unbinding, the local branch is considered independent and subsequent
2989
commits will be local only.
2991
See "help checkouts" for more information on checkouts.
2998
b, relpath = Branch.open_containing(u'.')
3000
raise errors.BzrCommandError('Local branch is not bound')
3003
class cmd_uncommit(Command):
3004
"""Remove the last committed revision.
3006
--verbose will print out what is being removed.
3007
--dry-run will go through all the motions, but not actually
3010
In the future, uncommit will create a revision bundle, which can then
3014
# TODO: jam 20060108 Add an option to allow uncommit to remove
3015
# unreferenced information in 'branch-as-repository' branches.
3016
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3017
# information in shared branches as well.
3018
takes_options = ['verbose', 'revision',
3019
Option('dry-run', help='Don\'t actually make changes'),
3020
Option('force', help='Say yes to all questions.')]
3021
takes_args = ['location?']
3024
def run(self, location=None,
3025
dry_run=False, verbose=False,
3026
revision=None, force=False):
3027
from bzrlib.log import log_formatter, show_log
3029
from bzrlib.uncommit import uncommit
3031
if location is None:
3033
control, relpath = bzrdir.BzrDir.open_containing(location)
3035
tree = control.open_workingtree()
3037
except (errors.NoWorkingTree, errors.NotLocalUrl):
3039
b = control.open_branch()
3042
if revision is None:
3045
# 'bzr uncommit -r 10' actually means uncommit
3046
# so that the final tree is at revno 10.
3047
# but bzrlib.uncommit.uncommit() actually uncommits
3048
# the revisions that are supplied.
3049
# So we need to offset it by one
3050
revno = revision[0].in_history(b).revno+1
3052
if revno <= b.revno():
3053
rev_id = b.get_rev_id(revno)
3055
self.outf.write('No revisions to uncommit.\n')
3058
lf = log_formatter('short',
3060
show_timezone='original')
3065
direction='forward',
3066
start_revision=revno,
3067
end_revision=b.revno())
3070
print 'Dry-run, pretending to remove the above revisions.'
3072
val = raw_input('Press <enter> to continue')
3074
print 'The above revision(s) will be removed.'
3076
val = raw_input('Are you sure [y/N]? ')
3077
if val.lower() not in ('y', 'yes'):
3081
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3085
class cmd_break_lock(Command):
3086
"""Break a dead lock on a repository, branch or working directory.
3088
CAUTION: Locks should only be broken when you are sure that the process
3089
holding the lock has been stopped.
3091
You can get information on what locks are open via the 'bzr info' command.
3096
takes_args = ['location?']
3098
def run(self, location=None, show=False):
3099
if location is None:
3101
control, relpath = bzrdir.BzrDir.open_containing(location)
3103
control.break_lock()
3104
except NotImplementedError:
3108
class cmd_wait_until_signalled(Command):
3109
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3111
This just prints a line to signal when it is ready, then blocks on stdin.
3117
sys.stdout.write("running\n")
3119
sys.stdin.readline()
3122
class cmd_serve(Command):
3123
"""Run the bzr server."""
3125
aliases = ['server']
3129
help='serve on stdin/out for use from inetd or sshd'),
3131
help='listen for connections on nominated port of the form '
3132
'[hostname:]portnumber. Passing 0 as the port number will '
3133
'result in a dynamically allocated port.',
3136
help='serve contents of directory',
3138
Option('allow-writes',
3139
help='By default the server is a readonly server. Supplying '
3140
'--allow-writes enables write access to the contents of '
3141
'the served directory and below. '
3145
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3146
from bzrlib.transport import smart
3147
from bzrlib.transport import get_transport
3148
if directory is None:
3149
directory = os.getcwd()
3150
url = urlutils.local_path_to_url(directory)
3151
if not allow_writes:
3152
url = 'readonly+' + url
3153
t = get_transport(url)
3155
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3156
elif port is not None:
3158
host, port = port.split(':')
3161
server = smart.SmartTCPServer(t, host=host, port=int(port))
3162
print 'listening on port: ', server.port
3165
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3169
# command-line interpretation helper for merge-related commands
3170
def _merge_helper(other_revision, base_revision,
3171
check_clean=True, ignore_zero=False,
3172
this_dir=None, backup_files=False,
3174
file_list=None, show_base=False, reprocess=False,
3177
change_reporter=None):
3178
"""Merge changes into a tree.
3181
list(path, revno) Base for three-way merge.
3182
If [None, None] then a base will be automatically determined.
3184
list(path, revno) Other revision for three-way merge.
3186
Directory to merge changes into; '.' by default.
3188
If true, this_dir must have no uncommitted changes before the
3190
ignore_zero - If true, suppress the "zero conflicts" message when
3191
there are no conflicts; should be set when doing something we expect
3192
to complete perfectly.
3193
file_list - If supplied, merge only changes to selected files.
3195
All available ancestors of other_revision and base_revision are
3196
automatically pulled into the branch.
3198
The revno may be -1 to indicate the last revision on the branch, which is
3201
This function is intended for use from the command line; programmatic
3202
clients might prefer to call merge.merge_inner(), which has less magic
3205
# Loading it late, so that we don't always have to import bzrlib.merge
3206
if merge_type is None:
3207
merge_type = _mod_merge.Merge3Merger
3208
if this_dir is None:
3210
this_tree = WorkingTree.open_containing(this_dir)[0]
3211
if show_base and not merge_type is _mod_merge.Merge3Merger:
3212
raise errors.BzrCommandError("Show-base is not supported for this merge"
3213
" type. %s" % merge_type)
3214
if reprocess and not merge_type.supports_reprocess:
3215
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3216
" type %s." % merge_type)
3217
if reprocess and show_base:
3218
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3220
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3221
pb=pb, change_reporter=change_reporter)
3222
merger.pp = ProgressPhase("Merge phase", 5, pb)
3223
merger.pp.next_phase()
3224
merger.check_basis(check_clean)
3225
merger.set_other(other_revision)
3226
merger.pp.next_phase()
3227
merger.set_base(base_revision)
3228
if merger.base_rev_id == merger.other_rev_id:
3229
note('Nothing to do.')
3231
if file_list is None:
3232
if pull and merger.base_rev_id == merger.this_rev_id:
3233
count = merger.this_tree.pull(merger.this_branch,
3234
False, merger.other_rev_id)
3235
note('%d revision(s) pulled.' % (count,))
3237
merger.backup_files = backup_files
3238
merger.merge_type = merge_type
3239
merger.set_interesting_files(file_list)
3240
merger.show_base = show_base
3241
merger.reprocess = reprocess
3242
conflicts = merger.do_merge()
3243
if file_list is None:
3244
merger.set_pending()
3251
merge = _merge_helper
3254
# these get imported and then picked up by the scan for cmd_*
3255
# TODO: Some more consistent way to split command definitions across files;
3256
# we do need to load at least some information about them to know of
3257
# aliases. ideally we would avoid loading the implementation until the
3258
# details were needed.
3259
from bzrlib.cmd_version_info import cmd_version_info
3260
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3261
from bzrlib.bundle.commands import cmd_bundle_revisions
3262
from bzrlib.sign_my_commits import cmd_sign_my_commits
3263
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3264
cmd_weave_plan_merge, cmd_weave_merge_text