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)
604
count = branch_to.pull(branch_from, overwrite, rev_id)
605
note('%d revision(s) pulled.' % (count,))
608
new_rh = branch_to.revision_history()
611
from bzrlib.log import show_changed_revisions
612
show_changed_revisions(branch_to, old_rh, new_rh,
616
class cmd_push(Command):
617
"""Update a mirror of this branch.
619
The target branch will not have its working tree populated because this
620
is both expensive, and is not supported on remote file systems.
622
Some smart servers or protocols *may* put the working tree in place in
625
This command only works on branches that have not diverged. Branches are
626
considered diverged if the destination branch's most recent commit is one
627
that has not been merged (directly or indirectly) by the source branch.
629
If branches have diverged, you can use 'bzr push --overwrite' to replace
630
the other branch completely, discarding its unmerged changes.
632
If you want to ensure you have the different changes in the other branch,
633
do a merge (see bzr help merge) from the other branch, and commit that.
634
After that you will be able to do a push without '--overwrite'.
636
If there is no default push location set, the first push will set it.
637
After that, you can omit the location to use the default. To change the
638
default, use --remember. The value will only be saved if the remote
639
location can be accessed.
642
takes_options = ['remember', 'overwrite', 'verbose',
643
Option('create-prefix',
644
help='Create the path leading up to the branch '
645
'if it does not already exist'),
647
help='branch to push from, '
648
'rather than the one containing the working directory',
652
Option('use-existing-dir',
653
help='By default push will fail if the target'
654
' directory exists, but does not already'
655
' have a control directory. This flag will'
656
' allow push to proceed.'),
658
takes_args = ['location?']
659
encoding_type = 'replace'
661
def run(self, location=None, remember=False, overwrite=False,
662
create_prefix=False, verbose=False,
663
use_existing_dir=False,
665
# FIXME: Way too big! Put this into a function called from the
667
if directory is None:
669
br_from = Branch.open_containing(directory)[0]
670
stored_loc = br_from.get_push_location()
672
if stored_loc is None:
673
raise errors.BzrCommandError("No push location known or specified.")
675
display_url = urlutils.unescape_for_display(stored_loc,
677
self.outf.write("Using saved location: %s\n" % display_url)
678
location = stored_loc
680
to_transport = transport.get_transport(location)
681
location_url = to_transport.base
686
br_to = repository_to = dir_to = None
688
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
689
except errors.NotBranchError:
690
pass # Didn't find anything
692
# If we can open a branch, use its direct repository, otherwise see
693
# if there is a repository without a branch.
695
br_to = dir_to.open_branch()
696
except errors.NotBranchError:
697
# Didn't find a branch, can we find a repository?
699
repository_to = dir_to.find_repository()
700
except errors.NoRepositoryPresent:
703
# Found a branch, so we must have found a repository
704
repository_to = br_to.repository
708
# XXX: Refactor the create_prefix/no_create_prefix code into a
709
# common helper function
711
to_transport.mkdir('.')
712
except errors.FileExists:
713
if not use_existing_dir:
714
raise errors.BzrCommandError("Target directory %s"
715
" already exists, but does not have a valid .bzr"
716
" directory. Supply --use-existing-dir to push"
717
" there anyway." % location)
718
except errors.NoSuchFile:
719
if not create_prefix:
720
raise errors.BzrCommandError("Parent directory of %s"
722
"\nYou may supply --create-prefix to create all"
723
" leading parent directories."
726
cur_transport = to_transport
727
needed = [cur_transport]
728
# Recurse upwards until we can create a directory successfully
730
new_transport = cur_transport.clone('..')
731
if new_transport.base == cur_transport.base:
732
raise errors.BzrCommandError("Failed to create path"
736
new_transport.mkdir('.')
737
except errors.NoSuchFile:
738
needed.append(new_transport)
739
cur_transport = new_transport
743
# Now we only need to create child directories
745
cur_transport = needed.pop()
746
cur_transport.mkdir('.')
748
# Now the target directory exists, but doesn't have a .bzr
749
# directory. So we need to create it, along with any work to create
750
# all of the dependent branches, etc.
751
dir_to = br_from.bzrdir.clone(location_url,
752
revision_id=br_from.last_revision())
753
br_to = dir_to.open_branch()
754
count = br_to.last_revision_info()[0]
755
# We successfully created the target, remember it
756
if br_from.get_push_location() is None or remember:
757
br_from.set_push_location(br_to.base)
758
elif repository_to is None:
759
# we have a bzrdir but no branch or repository
760
# XXX: Figure out what to do other than complain.
761
raise errors.BzrCommandError("At %s you have a valid .bzr control"
762
" directory, but not a branch or repository. This is an"
763
" unsupported configuration. Please move the target directory"
764
" out of the way and try again."
767
# We have a repository but no branch, copy the revisions, and then
769
last_revision_id = br_from.last_revision()
770
repository_to.fetch(br_from.repository,
771
revision_id=last_revision_id)
772
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
773
count = len(br_to.revision_history())
774
if br_from.get_push_location() is None or remember:
775
br_from.set_push_location(br_to.base)
776
else: # We have a valid to branch
777
# We were able to connect to the remote location, so remember it
778
# we don't need to successfully push because of possible divergence.
779
if br_from.get_push_location() is None or remember:
780
br_from.set_push_location(br_to.base)
781
old_rh = br_to.revision_history()
784
tree_to = dir_to.open_workingtree()
785
except errors.NotLocalUrl:
786
warning('This transport does not update the working '
787
'tree of: %s' % (br_to.base,))
788
count = br_from.push(br_to, overwrite)
789
except errors.NoWorkingTree:
790
count = br_from.push(br_to, overwrite)
794
count = br_from.push(tree_to.branch, overwrite)
798
except errors.DivergedBranches:
799
raise errors.BzrCommandError('These branches have diverged.'
800
' Try using "merge" and then "push".')
801
note('%d revision(s) pushed.' % (count,))
804
new_rh = br_to.revision_history()
807
from bzrlib.log import show_changed_revisions
808
show_changed_revisions(br_to, old_rh, new_rh,
812
class cmd_branch(Command):
813
"""Create a new copy of a branch.
815
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
816
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
818
To retrieve the branch as of a particular revision, supply the --revision
819
parameter, as in "branch foo/bar -r 5".
821
--basis is to speed up branching from remote branches. When specified, it
822
copies all the file-contents, inventory and revision data from the basis
823
branch before copying anything from the remote branch.
825
takes_args = ['from_location', 'to_location?']
826
takes_options = ['revision', 'basis']
827
aliases = ['get', 'clone']
829
def run(self, from_location, to_location=None, revision=None, basis=None):
832
elif len(revision) > 1:
833
raise errors.BzrCommandError(
834
'bzr branch --revision takes exactly 1 revision value')
836
br_from = Branch.open(from_location)
839
if basis is not None:
840
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
843
if len(revision) == 1 and revision[0] is not None:
844
revision_id = revision[0].in_history(br_from)[1]
846
# FIXME - wt.last_revision, fallback to branch, fall back to
847
# None or perhaps NULL_REVISION to mean copy nothing
849
revision_id = br_from.last_revision()
850
if to_location is None:
851
to_location = os.path.basename(from_location.rstrip("/\\"))
854
name = os.path.basename(to_location) + '\n'
856
to_transport = transport.get_transport(to_location)
858
to_transport.mkdir('.')
859
except errors.FileExists:
860
raise errors.BzrCommandError('Target directory "%s" already'
861
' exists.' % to_location)
862
except errors.NoSuchFile:
863
raise errors.BzrCommandError('Parent of "%s" does not exist.'
866
# preserve whatever source format we have.
867
dir = br_from.bzrdir.sprout(to_transport.base,
868
revision_id, basis_dir)
869
branch = dir.open_branch()
870
except errors.NoSuchRevision:
871
to_transport.delete_tree('.')
872
msg = "The branch %s has no revision %s." % (from_location, revision[0])
873
raise errors.BzrCommandError(msg)
874
except errors.UnlistableBranch:
875
osutils.rmtree(to_location)
876
msg = "The branch %s cannot be used as a --basis" % (basis,)
877
raise errors.BzrCommandError(msg)
879
branch.control_files.put_utf8('branch-name', name)
880
note('Branched %d revision(s).' % branch.revno())
885
class cmd_checkout(Command):
886
"""Create a new checkout of an existing branch.
888
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
889
the branch found in '.'. This is useful if you have removed the working tree
890
or if it was never created - i.e. if you pushed the branch to its current
893
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
894
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
896
To retrieve the branch as of a particular revision, supply the --revision
897
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
898
out of date [so you cannot commit] but it may be useful (i.e. to examine old
901
--basis is to speed up checking out from remote branches. When specified, it
902
uses the inventory and file contents from the basis branch in preference to the
903
branch being checked out.
905
See "help checkouts" for more information on checkouts.
907
takes_args = ['branch_location?', 'to_location?']
908
takes_options = ['revision', # , 'basis']
909
Option('lightweight',
910
help="perform a lightweight checkout. Lightweight "
911
"checkouts depend on access to the branch for "
912
"every operation. Normal checkouts can perform "
913
"common operations like diff and status without "
914
"such access, and also support local commits."
919
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
923
elif len(revision) > 1:
924
raise errors.BzrCommandError(
925
'bzr checkout --revision takes exactly 1 revision value')
926
if branch_location is None:
927
branch_location = osutils.getcwd()
928
to_location = branch_location
929
source = Branch.open(branch_location)
930
if len(revision) == 1 and revision[0] is not None:
931
revision_id = revision[0].in_history(source)[1]
934
if to_location is None:
935
to_location = os.path.basename(branch_location.rstrip("/\\"))
936
# if the source and to_location are the same,
937
# and there is no working tree,
938
# then reconstitute a branch
939
if (osutils.abspath(to_location) ==
940
osutils.abspath(branch_location)):
942
source.bzrdir.open_workingtree()
943
except errors.NoWorkingTree:
944
source.bzrdir.create_workingtree()
947
os.mkdir(to_location)
949
if e.errno == errno.EEXIST:
950
raise errors.BzrCommandError('Target directory "%s" already'
951
' exists.' % to_location)
952
if e.errno == errno.ENOENT:
953
raise errors.BzrCommandError('Parent of "%s" does not exist.'
957
source.create_checkout(to_location, revision_id, lightweight)
960
class cmd_renames(Command):
961
"""Show list of renamed files.
963
# TODO: Option to show renames between two historical versions.
965
# TODO: Only show renames under dir, rather than in the whole branch.
966
takes_args = ['dir?']
969
def run(self, dir=u'.'):
970
tree = WorkingTree.open_containing(dir)[0]
971
old_inv = tree.basis_tree().inventory
972
new_inv = tree.read_working_inventory()
973
renames = list(_mod_tree.find_renames(old_inv, new_inv))
975
for old_name, new_name in renames:
976
self.outf.write("%s => %s\n" % (old_name, new_name))
979
class cmd_update(Command):
980
"""Update a tree to have the latest code committed to its branch.
982
This will perform a merge into the working tree, and may generate
983
conflicts. If you have any local changes, you will still
984
need to commit them after the update for the update to be complete.
986
If you want to discard your local changes, you can just do a
987
'bzr revert' instead of 'bzr commit' after the update.
989
takes_args = ['dir?']
992
def run(self, dir='.'):
993
tree = WorkingTree.open_containing(dir)[0]
994
master = tree.branch.get_master_branch()
995
if master is not None:
998
tree.lock_tree_write()
1000
existing_pending_merges = tree.get_parent_ids()[1:]
1001
last_rev = tree.last_revision()
1002
if last_rev == tree.branch.last_revision():
1003
# may be up to date, check master too.
1004
master = tree.branch.get_master_branch()
1005
if master is None or last_rev == master.last_revision():
1006
revno = tree.branch.revision_id_to_revno(last_rev)
1007
note("Tree is up to date at revision %d." % (revno,))
1009
conflicts = tree.update()
1010
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1011
note('Updated to revision %d.' % (revno,))
1012
if tree.get_parent_ids()[1:] != existing_pending_merges:
1013
note('Your local commits will now show as pending merges with '
1014
"'bzr status', and can be committed with 'bzr commit'.")
1023
class cmd_info(Command):
1024
"""Show information about a working tree, branch or repository.
1026
This command will show all known locations and formats associated to the
1027
tree, branch or repository. Statistical information is included with
1030
Branches and working trees will also report any missing revisions.
1032
takes_args = ['location?']
1033
takes_options = ['verbose']
1036
def run(self, location=None, verbose=False):
1037
from bzrlib.info import show_bzrdir_info
1038
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1042
class cmd_remove(Command):
1043
"""Make a file unversioned.
1045
This makes bzr stop tracking changes to a versioned file. It does
1046
not delete the working copy.
1048
You can specify one or more files, and/or --new. If you specify --new,
1049
only 'added' files will be removed. If you specify both, then new files
1050
in the specified directories will be removed. If the directories are
1051
also new, they will also be removed.
1053
takes_args = ['file*']
1054
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1056
encoding_type = 'replace'
1058
def run(self, file_list, verbose=False, new=False):
1059
tree, file_list = tree_files(file_list)
1061
if file_list is None:
1062
raise errors.BzrCommandError('Specify one or more files to'
1063
' remove, or use --new.')
1065
added = tree.changes_from(tree.basis_tree(),
1066
specific_files=file_list).added
1067
file_list = sorted([f[0] for f in added], reverse=True)
1068
if len(file_list) == 0:
1069
raise errors.BzrCommandError('No matching files.')
1070
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1073
class cmd_file_id(Command):
1074
"""Print file_id of a particular file or directory.
1076
The file_id is assigned when the file is first added and remains the
1077
same through all revisions where the file exists, even when it is
1082
takes_args = ['filename']
1085
def run(self, filename):
1086
tree, relpath = WorkingTree.open_containing(filename)
1087
i = tree.inventory.path2id(relpath)
1089
raise errors.NotVersionedError(filename)
1091
self.outf.write(i + '\n')
1094
class cmd_file_path(Command):
1095
"""Print path of file_ids to a file or directory.
1097
This prints one line for each directory down to the target,
1098
starting at the branch root.
1102
takes_args = ['filename']
1105
def run(self, filename):
1106
tree, relpath = WorkingTree.open_containing(filename)
1107
inv = tree.inventory
1108
fid = inv.path2id(relpath)
1110
raise errors.NotVersionedError(filename)
1111
for fip in inv.get_idpath(fid):
1112
self.outf.write(fip + '\n')
1115
class cmd_reconcile(Command):
1116
"""Reconcile bzr metadata in a branch.
1118
This can correct data mismatches that may have been caused by
1119
previous ghost operations or bzr upgrades. You should only
1120
need to run this command if 'bzr check' or a bzr developer
1121
advises you to run it.
1123
If a second branch is provided, cross-branch reconciliation is
1124
also attempted, which will check that data like the tree root
1125
id which was not present in very early bzr versions is represented
1126
correctly in both branches.
1128
At the same time it is run it may recompress data resulting in
1129
a potential saving in disk space or performance gain.
1131
The branch *MUST* be on a listable system such as local disk or sftp.
1133
takes_args = ['branch?']
1135
def run(self, branch="."):
1136
from bzrlib.reconcile import reconcile
1137
dir = bzrdir.BzrDir.open(branch)
1141
class cmd_revision_history(Command):
1142
"""Display the list of revision ids on a branch."""
1143
takes_args = ['location?']
1148
def run(self, location="."):
1149
branch = Branch.open_containing(location)[0]
1150
for revid in branch.revision_history():
1151
self.outf.write(revid)
1152
self.outf.write('\n')
1155
class cmd_ancestry(Command):
1156
"""List all revisions merged into this branch."""
1157
takes_args = ['location?']
1162
def run(self, location="."):
1164
wt = WorkingTree.open_containing(location)[0]
1165
except errors.NoWorkingTree:
1166
b = Branch.open(location)
1167
last_revision = b.last_revision()
1170
last_revision = wt.last_revision()
1172
revision_ids = b.repository.get_ancestry(last_revision)
1173
assert revision_ids[0] is None
1175
for revision_id in revision_ids:
1176
self.outf.write(revision_id + '\n')
1179
class cmd_init(Command):
1180
"""Make a directory into a versioned branch.
1182
Use this to create an empty branch, or before importing an
1185
If there is a repository in a parent directory of the location, then
1186
the history of the branch will be stored in the repository. Otherwise
1187
init creates a standalone branch which carries its own history in
1190
If there is already a branch at the location but it has no working tree,
1191
the tree can be populated with 'bzr checkout'.
1193
Recipe for importing a tree of files:
1198
bzr commit -m 'imported project'
1200
takes_args = ['location?']
1202
RegistryOption('format',
1203
help='Specify a format for this branch. '
1204
'See "help formats".',
1205
registry=bzrdir.format_registry,
1206
converter=bzrdir.format_registry.make_bzrdir,
1207
value_switches=True,
1208
title="Branch Format",
1210
Option('append-revisions-only',
1211
help='Never change revnos or the existing log.'
1212
' Append revisions to it only.')
1214
def run(self, location=None, format=None, append_revisions_only=False):
1216
format = bzrdir.format_registry.make_bzrdir('default')
1217
if location is None:
1220
to_transport = transport.get_transport(location)
1222
# The path has to exist to initialize a
1223
# branch inside of it.
1224
# Just using os.mkdir, since I don't
1225
# believe that we want to create a bunch of
1226
# locations if the user supplies an extended path
1227
# TODO: create-prefix
1229
to_transport.mkdir('.')
1230
except errors.FileExists:
1234
existing_bzrdir = bzrdir.BzrDir.open(location)
1235
except errors.NotBranchError:
1236
# really a NotBzrDir error...
1237
branch = bzrdir.BzrDir.create_branch_convenience(location,
1240
from bzrlib.transport.local import LocalTransport
1241
if existing_bzrdir.has_branch():
1242
if (isinstance(to_transport, LocalTransport)
1243
and not existing_bzrdir.has_workingtree()):
1244
raise errors.BranchExistsWithoutWorkingTree(location)
1245
raise errors.AlreadyBranchError(location)
1247
branch = existing_bzrdir.create_branch()
1248
existing_bzrdir.create_workingtree()
1249
if append_revisions_only:
1251
branch.set_append_revisions_only(True)
1252
except errors.UpgradeRequired:
1253
raise errors.BzrCommandError('This branch format cannot be set'
1254
' to append-revisions-only. Try --experimental-branch6')
1257
class cmd_init_repository(Command):
1258
"""Create a shared repository to hold branches.
1260
New branches created under the repository directory will store their revisions
1261
in the repository, not in the branch directory, if the branch format supports
1267
bzr checkout --lightweight repo/trunk trunk-checkout
1271
takes_args = ["location"]
1272
takes_options = [RegistryOption('format',
1273
help='Specify a format for this repository. See'
1274
' "bzr help formats" for details',
1275
registry=bzrdir.format_registry,
1276
converter=bzrdir.format_registry.make_bzrdir,
1277
value_switches=True, title='Repository format'),
1279
help='Allows branches in repository to have'
1281
aliases = ["init-repo"]
1282
def run(self, location, format=None, trees=False):
1284
format = bzrdir.format_registry.make_bzrdir('default')
1286
if location is None:
1289
to_transport = transport.get_transport(location)
1291
to_transport.mkdir('.')
1292
except errors.FileExists:
1295
newdir = format.initialize_on_transport(to_transport)
1296
repo = newdir.create_repository(shared=True)
1297
repo.set_make_working_trees(trees)
1300
class cmd_diff(Command):
1301
"""Show differences in the working tree or between revisions.
1303
If files are listed, only the changes in those files are listed.
1304
Otherwise, all changes for the tree are listed.
1306
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1307
produces patches suitable for "patch -p1".
1311
Shows the difference in the working tree versus the last commit
1313
Difference between the working tree and revision 1
1315
Difference between revision 2 and revision 1
1316
bzr diff --diff-prefix old/:new/
1317
Same as 'bzr diff' but prefix paths with old/ and new/
1318
bzr diff bzr.mine bzr.dev
1319
Show the differences between the two working trees
1321
Show just the differences for 'foo.c'
1323
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1324
# or a graphical diff.
1326
# TODO: Python difflib is not exactly the same as unidiff; should
1327
# either fix it up or prefer to use an external diff.
1329
# TODO: Selected-file diff is inefficient and doesn't show you
1332
# TODO: This probably handles non-Unix newlines poorly.
1334
takes_args = ['file*']
1335
takes_options = ['revision', 'diff-options',
1336
Option('prefix', type=str,
1338
help='Set prefixes to added to old and new filenames, as '
1339
'two values separated by a colon.'),
1341
aliases = ['di', 'dif']
1342
encoding_type = 'exact'
1345
def run(self, revision=None, file_list=None, diff_options=None,
1347
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1349
if (prefix is None) or (prefix == '0'):
1357
old_label, new_label = prefix.split(":")
1359
raise BzrCommandError(
1360
"--prefix expects two values separated by a colon")
1362
if revision and len(revision) > 2:
1363
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1364
' one or two revision specifiers')
1367
tree1, file_list = internal_tree_files(file_list)
1371
except errors.FileInWrongBranch:
1372
if len(file_list) != 2:
1373
raise errors.BzrCommandError("Files are in different branches")
1375
tree1, file1 = WorkingTree.open_containing(file_list[0])
1376
tree2, file2 = WorkingTree.open_containing(file_list[1])
1377
if file1 != "" or file2 != "":
1378
# FIXME diff those two files. rbc 20051123
1379
raise errors.BzrCommandError("Files are in different branches")
1381
except errors.NotBranchError:
1382
if (revision is not None and len(revision) == 2
1383
and not revision[0].needs_branch()
1384
and not revision[1].needs_branch()):
1385
# If both revision specs include a branch, we can
1386
# diff them without needing a local working tree
1387
tree1, tree2 = None, None
1391
if tree2 is not None:
1392
if revision is not None:
1393
# FIXME: but there should be a clean way to diff between
1394
# non-default versions of two trees, it's not hard to do
1396
raise errors.BzrCommandError(
1397
"Sorry, diffing arbitrary revisions across branches "
1398
"is not implemented yet")
1399
return show_diff_trees(tree1, tree2, sys.stdout,
1400
specific_files=file_list,
1401
external_diff_options=diff_options,
1402
old_label=old_label, new_label=new_label)
1404
return diff_cmd_helper(tree1, file_list, diff_options,
1405
revision_specs=revision,
1406
old_label=old_label, new_label=new_label)
1409
class cmd_deleted(Command):
1410
"""List files deleted in the working tree.
1412
# TODO: Show files deleted since a previous revision, or
1413
# between two revisions.
1414
# TODO: Much more efficient way to do this: read in new
1415
# directories with readdir, rather than stating each one. Same
1416
# level of effort but possibly much less IO. (Or possibly not,
1417
# if the directories are very large...)
1418
takes_options = ['show-ids']
1421
def run(self, show_ids=False):
1422
tree = WorkingTree.open_containing(u'.')[0]
1423
old = tree.basis_tree()
1424
for path, ie in old.inventory.iter_entries():
1425
if not tree.has_id(ie.file_id):
1426
self.outf.write(path)
1428
self.outf.write(' ')
1429
self.outf.write(ie.file_id)
1430
self.outf.write('\n')
1433
class cmd_modified(Command):
1434
"""List files modified in working tree.
1436
See also: "bzr status".
1443
tree = WorkingTree.open_containing(u'.')[0]
1444
td = tree.changes_from(tree.basis_tree())
1445
for path, id, kind, text_modified, meta_modified in td.modified:
1446
self.outf.write(path + '\n')
1449
class cmd_added(Command):
1450
"""List files added in working tree.
1452
See also: "bzr status".
1459
wt = WorkingTree.open_containing(u'.')[0]
1460
basis_inv = wt.basis_tree().inventory
1463
if file_id in basis_inv:
1465
if inv.is_root(file_id) and len(basis_inv) == 0:
1467
path = inv.id2path(file_id)
1468
if not os.access(osutils.abspath(path), os.F_OK):
1470
self.outf.write(path + '\n')
1473
class cmd_root(Command):
1474
"""Show the tree root directory.
1476
The root is the nearest enclosing directory with a .bzr control
1478
takes_args = ['filename?']
1480
def run(self, filename=None):
1481
"""Print the branch root."""
1482
tree = WorkingTree.open_containing(filename)[0]
1483
self.outf.write(tree.basedir + '\n')
1486
class cmd_log(Command):
1487
"""Show log of a branch, file, or directory.
1489
By default show the log of the branch containing the working directory.
1491
To request a range of logs, you can use the command -r begin..end
1492
-r revision requests a specific revision, -r ..end or -r begin.. are
1498
bzr log -r -10.. http://server/branch
1501
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1503
takes_args = ['location?']
1504
takes_options = [Option('forward',
1505
help='show from oldest to newest'),
1509
help='show files changed in each revision'),
1510
'show-ids', 'revision',
1514
help='show revisions whose message matches this regexp',
1517
encoding_type = 'replace'
1520
def run(self, location=None, timezone='original',
1527
from bzrlib.log import show_log
1528
assert message is None or isinstance(message, basestring), \
1529
"invalid message argument %r" % message
1530
direction = (forward and 'forward') or 'reverse'
1535
# find the file id to log:
1537
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1541
tree = b.basis_tree()
1542
inv = tree.inventory
1543
file_id = inv.path2id(fp)
1545
raise errors.BzrCommandError(
1546
"Path does not have any revision history: %s" %
1550
# FIXME ? log the current subdir only RBC 20060203
1551
if revision is not None \
1552
and len(revision) > 0 and revision[0].get_branch():
1553
location = revision[0].get_branch()
1556
dir, relpath = bzrdir.BzrDir.open_containing(location)
1557
b = dir.open_branch()
1561
if revision is None:
1564
elif len(revision) == 1:
1565
rev1 = rev2 = revision[0].in_history(b).revno
1566
elif len(revision) == 2:
1567
if revision[1].get_branch() != revision[0].get_branch():
1568
# b is taken from revision[0].get_branch(), and
1569
# show_log will use its revision_history. Having
1570
# different branches will lead to weird behaviors.
1571
raise errors.BzrCommandError(
1572
"Log doesn't accept two revisions in different"
1574
if revision[0].spec is None:
1575
# missing begin-range means first revision
1578
rev1 = revision[0].in_history(b).revno
1580
if revision[1].spec is None:
1581
# missing end-range means last known revision
1584
rev2 = revision[1].in_history(b).revno
1586
raise errors.BzrCommandError(
1587
'bzr log --revision takes one or two values.')
1589
# By this point, the revision numbers are converted to the +ve
1590
# form if they were supplied in the -ve form, so we can do
1591
# this comparison in relative safety
1593
(rev2, rev1) = (rev1, rev2)
1595
if log_format is None:
1596
log_format = log.log_formatter_registry.get_default(b)
1598
lf = log_format(show_ids=show_ids, to_file=self.outf,
1599
show_timezone=timezone)
1605
direction=direction,
1606
start_revision=rev1,
1613
def get_log_format(long=False, short=False, line=False, default='long'):
1614
log_format = default
1618
log_format = 'short'
1624
class cmd_touching_revisions(Command):
1625
"""Return revision-ids which affected a particular file.
1627
A more user-friendly interface is "bzr log FILE".
1631
takes_args = ["filename"]
1634
def run(self, filename):
1635
tree, relpath = WorkingTree.open_containing(filename)
1637
inv = tree.read_working_inventory()
1638
file_id = inv.path2id(relpath)
1639
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1640
self.outf.write("%6d %s\n" % (revno, what))
1643
class cmd_ls(Command):
1644
"""List files in a tree.
1647
takes_args = ['path?']
1648
# TODO: Take a revision or remote path and list that tree instead.
1649
takes_options = ['verbose', 'revision',
1650
Option('non-recursive',
1651
help='don\'t recurse into sub-directories'),
1653
help='Print all paths from the root of the branch.'),
1654
Option('unknown', help='Print unknown files'),
1655
Option('versioned', help='Print versioned files'),
1656
Option('ignored', help='Print ignored files'),
1658
Option('null', help='Null separate the files'),
1662
def run(self, revision=None, verbose=False,
1663
non_recursive=False, from_root=False,
1664
unknown=False, versioned=False, ignored=False,
1665
null=False, kind=None, show_ids=False, path=None):
1667
if kind and kind not in ('file', 'directory', 'symlink'):
1668
raise errors.BzrCommandError('invalid kind specified')
1670
if verbose and null:
1671
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1672
all = not (unknown or versioned or ignored)
1674
selection = {'I':ignored, '?':unknown, 'V':versioned}
1681
raise errors.BzrCommandError('cannot specify both --from-root'
1685
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1691
if revision is not None:
1692
tree = branch.repository.revision_tree(
1693
revision[0].in_history(branch).rev_id)
1695
tree = branch.basis_tree()
1697
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1698
if fp.startswith(relpath):
1699
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1700
if non_recursive and '/' in fp:
1702
if not all and not selection[fc]:
1704
if kind is not None and fkind != kind:
1707
kindch = entry.kind_character()
1708
outstring = '%-8s %s%s' % (fc, fp, kindch)
1709
if show_ids and fid is not None:
1710
outstring = "%-50s %s" % (outstring, fid)
1711
self.outf.write(outstring + '\n')
1713
self.outf.write(fp + '\0')
1716
self.outf.write(fid)
1717
self.outf.write('\0')
1725
self.outf.write('%-50s %s\n' % (fp, my_id))
1727
self.outf.write(fp + '\n')
1730
class cmd_unknowns(Command):
1731
"""List unknown files.
1733
See also: "bzr ls --unknown".
1740
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1741
self.outf.write(osutils.quotefn(f) + '\n')
1744
class cmd_ignore(Command):
1745
"""Ignore specified files or patterns.
1747
To remove patterns from the ignore list, edit the .bzrignore file.
1749
Trailing slashes on patterns are ignored.
1750
If the pattern contains a slash or is a regular expression, it is compared
1751
to the whole path from the branch root. Otherwise, it is compared to only
1752
the last component of the path. To match a file only in the root
1753
directory, prepend './'.
1755
Ignore patterns specifying absolute paths are not allowed.
1757
Ignore patterns may include globbing wildcards such as:
1758
? - Matches any single character except '/'
1759
* - Matches 0 or more characters except '/'
1760
/**/ - Matches 0 or more directories in a path
1761
[a-z] - Matches a single character from within a group of characters
1763
Ignore patterns may also be Python regular expressions.
1764
Regular expression ignore patterns are identified by a 'RE:' prefix
1765
followed by the regular expression. Regular expression ignore patterns
1766
may not include named or numbered groups.
1768
Note: ignore patterns containing shell wildcards must be quoted from
1772
bzr ignore ./Makefile
1773
bzr ignore '*.class'
1774
bzr ignore 'lib/**/*.o'
1775
bzr ignore 'RE:lib/.*\.o'
1777
takes_args = ['name_pattern*']
1779
Option('old-default-rules',
1780
help='Out the ignore rules bzr < 0.9 always used.')
1783
def run(self, name_pattern_list=None, old_default_rules=None):
1784
from bzrlib.atomicfile import AtomicFile
1785
if old_default_rules is not None:
1786
# dump the rules and exit
1787
for pattern in ignores.OLD_DEFAULTS:
1790
if not name_pattern_list:
1791
raise errors.BzrCommandError("ignore requires at least one "
1792
"NAME_PATTERN or --old-default-rules")
1793
for name_pattern in name_pattern_list:
1794
if name_pattern[0] == '/':
1795
raise errors.BzrCommandError(
1796
"NAME_PATTERN should not be an absolute path")
1797
tree, relpath = WorkingTree.open_containing(u'.')
1798
ifn = tree.abspath('.bzrignore')
1799
if os.path.exists(ifn):
1802
igns = f.read().decode('utf-8')
1808
# TODO: If the file already uses crlf-style termination, maybe
1809
# we should use that for the newly added lines?
1811
if igns and igns[-1] != '\n':
1813
for name_pattern in name_pattern_list:
1814
igns += name_pattern.rstrip('/') + '\n'
1816
f = AtomicFile(ifn, 'wb')
1818
f.write(igns.encode('utf-8'))
1823
inv = tree.inventory
1824
if inv.path2id('.bzrignore'):
1825
mutter('.bzrignore is already versioned')
1827
mutter('need to make new .bzrignore file versioned')
1828
tree.add(['.bzrignore'])
1831
class cmd_ignored(Command):
1832
"""List ignored files and the patterns that matched them.
1834
See also: bzr ignore"""
1837
tree = WorkingTree.open_containing(u'.')[0]
1838
for path, file_class, kind, file_id, entry in tree.list_files():
1839
if file_class != 'I':
1841
## XXX: Slightly inefficient since this was already calculated
1842
pat = tree.is_ignored(path)
1843
print '%-50s %s' % (path, pat)
1846
class cmd_lookup_revision(Command):
1847
"""Lookup the revision-id from a revision-number
1850
bzr lookup-revision 33
1853
takes_args = ['revno']
1856
def run(self, revno):
1860
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1862
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1865
class cmd_export(Command):
1866
"""Export past revision to destination directory.
1868
If no revision is specified this exports the last committed revision.
1870
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1871
given, try to find the format with the extension. If no extension
1872
is found exports to a directory (equivalent to --format=dir).
1874
Root may be the top directory for tar, tgz and tbz2 formats. If none
1875
is given, the top directory will be the root name of the file.
1877
If branch is omitted then the branch containing the CWD will be used.
1879
Note: export of tree with non-ascii filenames to zip is not supported.
1881
Supported formats Autodetected by extension
1882
----------------- -------------------------
1885
tbz2 .tar.bz2, .tbz2
1889
takes_args = ['dest', 'branch?']
1890
takes_options = ['revision', 'format', 'root']
1891
def run(self, dest, branch=None, revision=None, format=None, root=None):
1892
from bzrlib.export import export
1895
tree = WorkingTree.open_containing(u'.')[0]
1898
b = Branch.open(branch)
1900
if revision is None:
1901
# should be tree.last_revision FIXME
1902
rev_id = b.last_revision()
1904
if len(revision) != 1:
1905
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1906
rev_id = revision[0].in_history(b).rev_id
1907
t = b.repository.revision_tree(rev_id)
1909
export(t, dest, format, root)
1910
except errors.NoSuchExportFormat, e:
1911
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1914
class cmd_cat(Command):
1915
"""Write a file's text from a previous revision."""
1917
takes_options = ['revision', 'name-from-revision']
1918
takes_args = ['filename']
1919
encoding_type = 'exact'
1922
def run(self, filename, revision=None, name_from_revision=False):
1923
if revision is not None and len(revision) != 1:
1924
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1929
tree, relpath = WorkingTree.open_containing(filename)
1931
except (errors.NotBranchError, errors.NotLocalUrl):
1934
if revision is not None and revision[0].get_branch() is not None:
1935
b = Branch.open(revision[0].get_branch())
1937
b, relpath = Branch.open_containing(filename)
1938
tree = b.basis_tree()
1939
if revision is None:
1940
revision_id = b.last_revision()
1942
revision_id = revision[0].in_history(b).rev_id
1944
cur_file_id = tree.path2id(relpath)
1945
rev_tree = b.repository.revision_tree(revision_id)
1946
old_file_id = rev_tree.path2id(relpath)
1948
if name_from_revision:
1949
if old_file_id is None:
1950
raise errors.BzrCommandError("%r is not present in revision %s"
1951
% (filename, revision_id))
1953
rev_tree.print_file(old_file_id)
1954
elif cur_file_id is not None:
1955
rev_tree.print_file(cur_file_id)
1956
elif old_file_id is not None:
1957
rev_tree.print_file(old_file_id)
1959
raise errors.BzrCommandError("%r is not present in revision %s" %
1960
(filename, revision_id))
1963
class cmd_local_time_offset(Command):
1964
"""Show the offset in seconds from GMT to local time."""
1968
print osutils.local_time_offset()
1972
class cmd_commit(Command):
1973
"""Commit changes into a new revision.
1975
If no arguments are given, the entire tree is committed.
1977
If selected files are specified, only changes to those files are
1978
committed. If a directory is specified then the directory and everything
1979
within it is committed.
1981
A selected-file commit may fail in some cases where the committed
1982
tree would be invalid, such as trying to commit a file in a
1983
newly-added directory that is not itself committed.
1985
# TODO: Run hooks on tree to-be-committed, and after commit.
1987
# TODO: Strict commit that fails if there are deleted files.
1988
# (what does "deleted files" mean ??)
1990
# TODO: Give better message for -s, --summary, used by tla people
1992
# XXX: verbose currently does nothing
1994
takes_args = ['selected*']
1995
takes_options = ['message', 'verbose',
1997
help='commit even if nothing has changed'),
1998
Option('file', type=str,
2001
help='file containing commit message'),
2003
help="refuse to commit if there are unknown "
2004
"files in the working tree."),
2006
help="perform a local only commit in a bound "
2007
"branch. Such commits are not pushed to "
2008
"the master branch until a normal commit "
2012
aliases = ['ci', 'checkin']
2014
def run(self, message=None, file=None, verbose=True, selected_list=None,
2015
unchanged=False, strict=False, local=False):
2016
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2017
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2019
from bzrlib.msgeditor import edit_commit_message, \
2020
make_commit_message_template
2022
# TODO: Need a blackbox test for invoking the external editor; may be
2023
# slightly problematic to run this cross-platform.
2025
# TODO: do more checks that the commit will succeed before
2026
# spending the user's valuable time typing a commit message.
2027
tree, selected_list = tree_files(selected_list)
2028
if selected_list == ['']:
2029
# workaround - commit of root of tree should be exactly the same
2030
# as just default commit in that tree, and succeed even though
2031
# selected-file merge commit is not done yet
2034
if local and not tree.branch.get_bound_location():
2035
raise errors.LocalRequiresBoundBranch()
2037
def get_message(commit_obj):
2038
"""Callback to get commit message"""
2039
my_message = message
2040
if my_message is None and not file:
2041
template = make_commit_message_template(tree, selected_list)
2042
my_message = edit_commit_message(template)
2043
if my_message is None:
2044
raise errors.BzrCommandError("please specify a commit"
2045
" message with either --message or --file")
2046
elif my_message and file:
2047
raise errors.BzrCommandError(
2048
"please specify either --message or --file")
2050
my_message = codecs.open(file, 'rt',
2051
bzrlib.user_encoding).read()
2052
if my_message == "":
2053
raise errors.BzrCommandError("empty commit message specified")
2057
reporter = ReportCommitToLog()
2059
reporter = NullCommitReporter()
2062
tree.commit(message_callback=get_message,
2063
specific_files=selected_list,
2064
allow_pointless=unchanged, strict=strict, local=local,
2066
except PointlessCommit:
2067
# FIXME: This should really happen before the file is read in;
2068
# perhaps prepare the commit; get the message; then actually commit
2069
raise errors.BzrCommandError("no changes to commit."
2070
" use --unchanged to commit anyhow")
2071
except ConflictsInTree:
2072
raise errors.BzrCommandError('Conflicts detected in working '
2073
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2075
except StrictCommitFailed:
2076
raise errors.BzrCommandError("Commit refused because there are"
2077
" unknown files in the working tree.")
2078
except errors.BoundBranchOutOfDate, e:
2079
raise errors.BzrCommandError(str(e) + "\n"
2080
'To commit to master branch, run update and then commit.\n'
2081
'You can also pass --local to commit to continue working '
2085
class cmd_check(Command):
2086
"""Validate consistency of branch history.
2088
This command checks various invariants about the branch storage to
2089
detect data corruption or bzr bugs.
2091
takes_args = ['branch?']
2092
takes_options = ['verbose']
2094
def run(self, branch=None, verbose=False):
2095
from bzrlib.check import check
2097
tree = WorkingTree.open_containing()[0]
2098
branch = tree.branch
2100
branch = Branch.open(branch)
2101
check(branch, verbose)
2104
class cmd_upgrade(Command):
2105
"""Upgrade branch storage to current format.
2107
The check command or bzr developers may sometimes advise you to run
2108
this command. When the default format has changed you may also be warned
2109
during other operations to upgrade.
2111
takes_args = ['url?']
2113
RegistryOption('format',
2114
help='Upgrade to a specific format. See "bzr help'
2115
' formats" for details',
2116
registry=bzrdir.format_registry,
2117
converter=bzrdir.format_registry.make_bzrdir,
2118
value_switches=True, title='Branch format'),
2122
def run(self, url='.', format=None):
2123
from bzrlib.upgrade import upgrade
2125
format = bzrdir.format_registry.make_bzrdir('default')
2126
upgrade(url, format)
2129
class cmd_whoami(Command):
2130
"""Show or set bzr user id.
2134
bzr whoami 'Frank Chu <fchu@example.com>'
2136
takes_options = [ Option('email',
2137
help='display email address only'),
2139
help='set identity for the current branch instead of '
2142
takes_args = ['name?']
2143
encoding_type = 'replace'
2146
def run(self, email=False, branch=False, name=None):
2148
# use branch if we're inside one; otherwise global config
2150
c = Branch.open_containing('.')[0].get_config()
2151
except errors.NotBranchError:
2152
c = config.GlobalConfig()
2154
self.outf.write(c.user_email() + '\n')
2156
self.outf.write(c.username() + '\n')
2159
# display a warning if an email address isn't included in the given name.
2161
config.extract_email_address(name)
2162
except errors.NoEmailInUsername, e:
2163
warning('"%s" does not seem to contain an email address. '
2164
'This is allowed, but not recommended.', name)
2166
# use global config unless --branch given
2168
c = Branch.open_containing('.')[0].get_config()
2170
c = config.GlobalConfig()
2171
c.set_user_option('email', name)
2174
class cmd_nick(Command):
2175
"""Print or set the branch nickname.
2177
If unset, the tree root directory name is used as the nickname
2178
To print the current nickname, execute with no argument.
2180
takes_args = ['nickname?']
2181
def run(self, nickname=None):
2182
branch = Branch.open_containing(u'.')[0]
2183
if nickname is None:
2184
self.printme(branch)
2186
branch.nick = nickname
2189
def printme(self, branch):
2193
class cmd_selftest(Command):
2194
"""Run internal test suite.
2196
This creates temporary test directories in the working directory, but not
2197
existing data is affected. These directories are deleted if the tests
2198
pass, or left behind to help in debugging if they fail and --keep-output
2201
If arguments are given, they are regular expressions that say which tests
2202
should run. Tests matching any expression are run, and other tests are
2205
Alternatively if --first is given, matching tests are run first and then
2206
all other tests are run. This is useful if you have been working in a
2207
particular area, but want to make sure nothing else was broken.
2209
If the global option '--no-plugins' is given, plugins are not loaded
2210
before running the selftests. This has two effects: features provided or
2211
modified by plugins will not be tested, and tests provided by plugins will
2216
run only tests relating to 'ignore'
2217
bzr --no-plugins selftest -v
2218
disable plugins and list tests as they're run
2220
# TODO: --list should give a list of all available tests
2222
# NB: this is used from the class without creating an instance, which is
2223
# why it does not have a self parameter.
2224
def get_transport_type(typestring):
2225
"""Parse and return a transport specifier."""
2226
if typestring == "sftp":
2227
from bzrlib.transport.sftp import SFTPAbsoluteServer
2228
return SFTPAbsoluteServer
2229
if typestring == "memory":
2230
from bzrlib.transport.memory import MemoryServer
2232
if typestring == "fakenfs":
2233
from bzrlib.transport.fakenfs import FakeNFSServer
2234
return FakeNFSServer
2235
msg = "No known transport type %s. Supported types are: sftp\n" %\
2237
raise errors.BzrCommandError(msg)
2240
takes_args = ['testspecs*']
2241
takes_options = ['verbose',
2242
Option('one', help='stop when one test fails'),
2243
Option('keep-output',
2244
help='keep output directories when tests fail'),
2246
help='Use a different transport by default '
2247
'throughout the test suite.',
2248
type=get_transport_type),
2249
Option('benchmark', help='run the bzr bencharks.'),
2250
Option('lsprof-timed',
2251
help='generate lsprof output for benchmarked'
2252
' sections of code.'),
2253
Option('cache-dir', type=str,
2254
help='a directory to cache intermediate'
2255
' benchmark steps'),
2256
Option('clean-output',
2257
help='clean temporary tests directories'
2258
' without running tests'),
2260
help='run all tests, but run specified tests first',
2263
encoding_type = 'replace'
2265
def run(self, testspecs_list=None, verbose=None, one=False,
2266
keep_output=False, transport=None, benchmark=None,
2267
lsprof_timed=None, cache_dir=None, clean_output=False,
2270
from bzrlib.tests import selftest
2271
import bzrlib.benchmarks as benchmarks
2272
from bzrlib.benchmarks import tree_creator
2275
from bzrlib.tests import clean_selftest_output
2276
clean_selftest_output()
2279
if cache_dir is not None:
2280
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2281
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2282
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2284
if testspecs_list is not None:
2285
pattern = '|'.join(testspecs_list)
2289
test_suite_factory = benchmarks.test_suite
2292
# TODO: should possibly lock the history file...
2293
benchfile = open(".perf_history", "at", buffering=1)
2295
test_suite_factory = None
2300
result = selftest(verbose=verbose,
2302
stop_on_failure=one,
2303
keep_output=keep_output,
2304
transport=transport,
2305
test_suite_factory=test_suite_factory,
2306
lsprof_timed=lsprof_timed,
2307
bench_history=benchfile,
2308
matching_tests_first=first,
2311
if benchfile is not None:
2314
info('tests passed')
2316
info('tests failed')
2317
return int(not result)
2320
class cmd_version(Command):
2321
"""Show version of bzr."""
2325
from bzrlib.version import show_version
2329
class cmd_rocks(Command):
2330
"""Statement of optimism."""
2336
print "it sure does!"
2339
class cmd_find_merge_base(Command):
2340
"""Find and print a base revision for merging two branches."""
2341
# TODO: Options to specify revisions on either side, as if
2342
# merging only part of the history.
2343
takes_args = ['branch', 'other']
2347
def run(self, branch, other):
2348
from bzrlib.revision import MultipleRevisionSources
2350
branch1 = Branch.open_containing(branch)[0]
2351
branch2 = Branch.open_containing(other)[0]
2353
last1 = branch1.last_revision()
2354
last2 = branch2.last_revision()
2356
source = MultipleRevisionSources(branch1.repository,
2359
base_rev_id = common_ancestor(last1, last2, source)
2361
print 'merge base is revision %s' % base_rev_id
2364
class cmd_merge(Command):
2365
"""Perform a three-way merge.
2367
The branch is the branch you will merge from. By default, it will merge
2368
the latest revision. If you specify a revision, that revision will be
2369
merged. If you specify two revisions, the first will be used as a BASE,
2370
and the second one as OTHER. Revision numbers are always relative to the
2373
By default, bzr will try to merge in all new work from the other
2374
branch, automatically determining an appropriate base. If this
2375
fails, you may need to give an explicit base.
2377
Merge will do its best to combine the changes in two branches, but there
2378
are some kinds of problems only a human can fix. When it encounters those,
2379
it will mark a conflict. A conflict means that you need to fix something,
2380
before you should commit.
2382
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2384
If there is no default branch set, the first merge will set it. After
2385
that, you can omit the branch to use the default. To change the
2386
default, use --remember. The value will only be saved if the remote
2387
location can be accessed.
2389
The results of the merge are placed into the destination working
2390
directory, where they can be reviewed (with bzr diff), tested, and then
2391
committed to record the result of the merge.
2395
To merge the latest revision from bzr.dev
2396
bzr merge ../bzr.dev
2398
To merge changes up to and including revision 82 from bzr.dev
2399
bzr merge -r 82 ../bzr.dev
2401
To merge the changes introduced by 82, without previous changes:
2402
bzr merge -r 81..82 ../bzr.dev
2404
merge refuses to run if there are any uncommitted changes, unless
2407
The following merge types are available:
2409
takes_args = ['branch?']
2410
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2411
Option('show-base', help="Show base revision text in "
2413
Option('uncommitted', help='Apply uncommitted changes'
2414
' from a working copy, instead of branch changes'),
2415
Option('pull', help='If the destination is already'
2416
' completely merged into the source, pull from the'
2417
' source rather than merging. When this happens,'
2418
' you do not need to commit the result.'),
2420
help='branch to merge into, '
2421
'rather than the one containing the working directory',
2427
def run(self, branch=None, revision=None, force=False, merge_type=None,
2428
show_base=False, reprocess=False, remember=False,
2429
uncommitted=False, pull=False,
2432
if merge_type is None:
2433
merge_type = _mod_merge.Merge3Merger
2434
if directory is None: directory = u'.'
2435
tree = WorkingTree.open_containing(directory)[0]
2437
if branch is not None:
2439
reader = bundle.read_bundle_from_url(branch)
2440
except errors.NotABundle:
2441
pass # Continue on considering this url a Branch
2443
conflicts = merge_bundle(reader, tree, not force, merge_type,
2444
reprocess, show_base)
2450
if revision is None \
2451
or len(revision) < 1 or revision[0].needs_branch():
2452
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2454
if revision is None or len(revision) < 1:
2457
other = [branch, None]
2460
other = [branch, -1]
2461
other_branch, path = Branch.open_containing(branch)
2464
raise errors.BzrCommandError('Cannot use --uncommitted and'
2465
' --revision at the same time.')
2466
branch = revision[0].get_branch() or branch
2467
if len(revision) == 1:
2469
other_branch, path = Branch.open_containing(branch)
2470
revno = revision[0].in_history(other_branch).revno
2471
other = [branch, revno]
2473
assert len(revision) == 2
2474
if None in revision:
2475
raise errors.BzrCommandError(
2476
"Merge doesn't permit empty revision specifier.")
2477
base_branch, path = Branch.open_containing(branch)
2478
branch1 = revision[1].get_branch() or branch
2479
other_branch, path1 = Branch.open_containing(branch1)
2480
if revision[0].get_branch() is not None:
2481
# then path was obtained from it, and is None.
2484
base = [branch, revision[0].in_history(base_branch).revno]
2485
other = [branch1, revision[1].in_history(other_branch).revno]
2487
if tree.branch.get_parent() is None or remember:
2488
tree.branch.set_parent(other_branch.base)
2491
interesting_files = [path]
2493
interesting_files = None
2494
pb = ui.ui_factory.nested_progress_bar()
2497
conflict_count = _merge_helper(
2498
other, base, check_clean=(not force),
2499
merge_type=merge_type,
2500
reprocess=reprocess,
2501
show_base=show_base,
2504
pb=pb, file_list=interesting_files)
2507
if conflict_count != 0:
2511
except errors.AmbiguousBase, e:
2512
m = ("sorry, bzr can't determine the right merge base yet\n"
2513
"candidates are:\n "
2514
+ "\n ".join(e.bases)
2516
"please specify an explicit base with -r,\n"
2517
"and (if you want) report this to the bzr developers\n")
2520
# TODO: move up to common parent; this isn't merge-specific anymore.
2521
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2522
"""Use tree.branch's parent if none was supplied.
2524
Report if the remembered location was used.
2526
if supplied_location is not None:
2527
return supplied_location
2528
stored_location = tree.branch.get_parent()
2529
mutter("%s", stored_location)
2530
if stored_location is None:
2531
raise errors.BzrCommandError("No location specified or remembered")
2532
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2533
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2534
return stored_location
2537
class cmd_remerge(Command):
2540
Use this if you want to try a different merge technique while resolving
2541
conflicts. Some merge techniques are better than others, and remerge
2542
lets you try different ones on different files.
2544
The options for remerge have the same meaning and defaults as the ones for
2545
merge. The difference is that remerge can (only) be run when there is a
2546
pending merge, and it lets you specify particular files.
2549
$ bzr remerge --show-base
2550
Re-do the merge of all conflicted files, and show the base text in
2551
conflict regions, in addition to the usual THIS and OTHER texts.
2553
$ bzr remerge --merge-type weave --reprocess foobar
2554
Re-do the merge of "foobar", using the weave merge algorithm, with
2555
additional processing to reduce the size of conflict regions.
2557
The following merge types are available:"""
2558
takes_args = ['file*']
2559
takes_options = ['merge-type', 'reprocess',
2560
Option('show-base', help="Show base revision text in "
2563
def run(self, file_list=None, merge_type=None, show_base=False,
2565
if merge_type is None:
2566
merge_type = _mod_merge.Merge3Merger
2567
tree, file_list = tree_files(file_list)
2570
parents = tree.get_parent_ids()
2571
if len(parents) != 2:
2572
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2573
" merges. Not cherrypicking or"
2575
repository = tree.branch.repository
2576
base_revision = common_ancestor(parents[0],
2577
parents[1], repository)
2578
base_tree = repository.revision_tree(base_revision)
2579
other_tree = repository.revision_tree(parents[1])
2580
interesting_ids = None
2582
conflicts = tree.conflicts()
2583
if file_list is not None:
2584
interesting_ids = set()
2585
for filename in file_list:
2586
file_id = tree.path2id(filename)
2588
raise errors.NotVersionedError(filename)
2589
interesting_ids.add(file_id)
2590
if tree.kind(file_id) != "directory":
2593
for name, ie in tree.inventory.iter_entries(file_id):
2594
interesting_ids.add(ie.file_id)
2595
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2597
# Remerge only supports resolving contents conflicts
2598
allowed_conflicts = ('text conflict', 'contents conflict')
2599
restore_files = [c.path for c in conflicts
2600
if c.typestring in allowed_conflicts]
2601
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2602
tree.set_conflicts(ConflictList(new_conflicts))
2603
if file_list is not None:
2604
restore_files = file_list
2605
for filename in restore_files:
2607
restore(tree.abspath(filename))
2608
except errors.NotConflicted:
2610
conflicts = _mod_merge.merge_inner(
2611
tree.branch, other_tree, base_tree,
2613
interesting_ids=interesting_ids,
2614
other_rev_id=parents[1],
2615
merge_type=merge_type,
2616
show_base=show_base,
2617
reprocess=reprocess)
2626
class cmd_revert(Command):
2627
"""Revert files to a previous revision.
2629
Giving a list of files will revert only those files. Otherwise, all files
2630
will be reverted. If the revision is not specified with '--revision', the
2631
last committed revision is used.
2633
To remove only some changes, without reverting to a prior version, use
2634
merge instead. For example, "merge . --r-2..-3" will remove the changes
2635
introduced by -2, without affecting the changes introduced by -1. Or
2636
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2638
By default, any files that have been manually changed will be backed up
2639
first. (Files changed only by merge are not backed up.) Backup files have
2640
'.~#~' appended to their name, where # is a number.
2642
When you provide files, you can use their current pathname or the pathname
2643
from the target revision. So you can use revert to "undelete" a file by
2644
name. If you name a directory, all the contents of that directory will be
2647
takes_options = ['revision', 'no-backup']
2648
takes_args = ['file*']
2649
aliases = ['merge-revert']
2651
def run(self, revision=None, no_backup=False, file_list=None):
2652
if file_list is not None:
2653
if len(file_list) == 0:
2654
raise errors.BzrCommandError("No files specified")
2658
tree, file_list = tree_files(file_list)
2659
if revision is None:
2660
# FIXME should be tree.last_revision
2661
rev_id = tree.last_revision()
2662
elif len(revision) != 1:
2663
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2665
rev_id = revision[0].in_history(tree.branch).rev_id
2666
pb = ui.ui_factory.nested_progress_bar()
2668
tree.revert(file_list,
2669
tree.branch.repository.revision_tree(rev_id),
2670
not no_backup, pb, report_changes=True)
2675
class cmd_assert_fail(Command):
2676
"""Test reporting of assertion failures"""
2677
# intended just for use in testing
2682
raise AssertionError("always fails")
2685
class cmd_help(Command):
2686
"""Show help on a command or other topic.
2688
For a list of all available commands, say 'bzr help commands'.
2690
takes_options = [Option('long', 'show help on all commands')]
2691
takes_args = ['topic?']
2692
aliases = ['?', '--help', '-?', '-h']
2695
def run(self, topic=None, long=False):
2697
if topic is None and long:
2699
bzrlib.help.help(topic)
2702
class cmd_shell_complete(Command):
2703
"""Show appropriate completions for context.
2705
For a list of all available commands, say 'bzr shell-complete'.
2707
takes_args = ['context?']
2712
def run(self, context=None):
2713
import shellcomplete
2714
shellcomplete.shellcomplete(context)
2717
class cmd_fetch(Command):
2718
"""Copy in history from another branch but don't merge it.
2720
This is an internal method used for pull and merge.
2723
takes_args = ['from_branch', 'to_branch']
2724
def run(self, from_branch, to_branch):
2725
from bzrlib.fetch import Fetcher
2726
from_b = Branch.open(from_branch)
2727
to_b = Branch.open(to_branch)
2728
Fetcher(to_b, from_b)
2731
class cmd_missing(Command):
2732
"""Show unmerged/unpulled revisions between two branches.
2734
OTHER_BRANCH may be local or remote.
2736
takes_args = ['other_branch?']
2737
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2739
'Display changes in the local branch only'),
2740
Option('theirs-only',
2741
'Display changes in the remote branch only'),
2746
encoding_type = 'replace'
2749
def run(self, other_branch=None, reverse=False, mine_only=False,
2750
theirs_only=False, log_format=None, long=False, short=False, line=False,
2751
show_ids=False, verbose=False):
2752
from bzrlib.missing import find_unmerged, iter_log_data
2753
from bzrlib.log import log_formatter
2754
local_branch = Branch.open_containing(u".")[0]
2755
parent = local_branch.get_parent()
2756
if other_branch is None:
2757
other_branch = parent
2758
if other_branch is None:
2759
raise errors.BzrCommandError("No peer location known or specified.")
2760
display_url = urlutils.unescape_for_display(parent,
2762
print "Using last location: " + display_url
2764
remote_branch = Branch.open(other_branch)
2765
if remote_branch.base == local_branch.base:
2766
remote_branch = local_branch
2767
local_branch.lock_read()
2769
remote_branch.lock_read()
2771
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2772
if (log_format is None):
2773
log_format = log.log_formatter_registry.get_default(
2775
lf = log_format(to_file=self.outf,
2777
show_timezone='original')
2778
if reverse is False:
2779
local_extra.reverse()
2780
remote_extra.reverse()
2781
if local_extra and not theirs_only:
2782
print "You have %d extra revision(s):" % len(local_extra)
2783
for data in iter_log_data(local_extra, local_branch.repository,
2786
printed_local = True
2788
printed_local = False
2789
if remote_extra and not mine_only:
2790
if printed_local is True:
2792
print "You are missing %d revision(s):" % len(remote_extra)
2793
for data in iter_log_data(remote_extra, remote_branch.repository,
2796
if not remote_extra and not local_extra:
2798
print "Branches are up to date."
2802
remote_branch.unlock()
2804
local_branch.unlock()
2805
if not status_code and parent is None and other_branch is not None:
2806
local_branch.lock_write()
2808
# handle race conditions - a parent might be set while we run.
2809
if local_branch.get_parent() is None:
2810
local_branch.set_parent(remote_branch.base)
2812
local_branch.unlock()
2816
class cmd_plugins(Command):
2821
import bzrlib.plugin
2822
from inspect import getdoc
2823
for name, plugin in bzrlib.plugin.all_plugins().items():
2824
if getattr(plugin, '__path__', None) is not None:
2825
print plugin.__path__[0]
2826
elif getattr(plugin, '__file__', None) is not None:
2827
print plugin.__file__
2833
print '\t', d.split('\n')[0]
2836
class cmd_testament(Command):
2837
"""Show testament (signing-form) of a revision."""
2838
takes_options = ['revision',
2839
Option('long', help='Produce long-format testament'),
2840
Option('strict', help='Produce a strict-format'
2842
takes_args = ['branch?']
2844
def run(self, branch=u'.', revision=None, long=False, strict=False):
2845
from bzrlib.testament import Testament, StrictTestament
2847
testament_class = StrictTestament
2849
testament_class = Testament
2850
b = WorkingTree.open_containing(branch)[0].branch
2853
if revision is None:
2854
rev_id = b.last_revision()
2856
rev_id = revision[0].in_history(b).rev_id
2857
t = testament_class.from_revision(b.repository, rev_id)
2859
sys.stdout.writelines(t.as_text_lines())
2861
sys.stdout.write(t.as_short_text())
2866
class cmd_annotate(Command):
2867
"""Show the origin of each line in a file.
2869
This prints out the given file with an annotation on the left side
2870
indicating which revision, author and date introduced the change.
2872
If the origin is the same for a run of consecutive lines, it is
2873
shown only at the top, unless the --all option is given.
2875
# TODO: annotate directories; showing when each file was last changed
2876
# TODO: if the working copy is modified, show annotations on that
2877
# with new uncommitted lines marked
2878
aliases = ['ann', 'blame', 'praise']
2879
takes_args = ['filename']
2880
takes_options = [Option('all', help='show annotations on all lines'),
2881
Option('long', help='show date in annotations'),
2887
def run(self, filename, all=False, long=False, revision=None,
2889
from bzrlib.annotate import annotate_file
2890
tree, relpath = WorkingTree.open_containing(filename)
2891
branch = tree.branch
2894
if revision is None:
2895
revision_id = branch.last_revision()
2896
elif len(revision) != 1:
2897
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2899
revision_id = revision[0].in_history(branch).rev_id
2900
file_id = tree.inventory.path2id(relpath)
2901
tree = branch.repository.revision_tree(revision_id)
2902
file_version = tree.inventory[file_id].revision
2903
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2909
class cmd_re_sign(Command):
2910
"""Create a digital signature for an existing revision."""
2911
# TODO be able to replace existing ones.
2913
hidden = True # is this right ?
2914
takes_args = ['revision_id*']
2915
takes_options = ['revision']
2917
def run(self, revision_id_list=None, revision=None):
2918
import bzrlib.gpg as gpg
2919
if revision_id_list is not None and revision is not None:
2920
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2921
if revision_id_list is None and revision is None:
2922
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2923
b = WorkingTree.open_containing(u'.')[0].branch
2924
gpg_strategy = gpg.GPGStrategy(b.get_config())
2925
if revision_id_list is not None:
2926
for revision_id in revision_id_list:
2927
b.repository.sign_revision(revision_id, gpg_strategy)
2928
elif revision is not None:
2929
if len(revision) == 1:
2930
revno, rev_id = revision[0].in_history(b)
2931
b.repository.sign_revision(rev_id, gpg_strategy)
2932
elif len(revision) == 2:
2933
# are they both on rh- if so we can walk between them
2934
# might be nice to have a range helper for arbitrary
2935
# revision paths. hmm.
2936
from_revno, from_revid = revision[0].in_history(b)
2937
to_revno, to_revid = revision[1].in_history(b)
2938
if to_revid is None:
2939
to_revno = b.revno()
2940
if from_revno is None or to_revno is None:
2941
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2942
for revno in range(from_revno, to_revno + 1):
2943
b.repository.sign_revision(b.get_rev_id(revno),
2946
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2949
class cmd_bind(Command):
2950
"""Convert the current branch into a checkout of the supplied branch.
2952
Once converted into a checkout, commits must succeed on the master branch
2953
before they will be applied to the local branch.
2955
See "help checkouts" for more information on checkouts.
2958
takes_args = ['location?']
2961
def run(self, location=None):
2962
b, relpath = Branch.open_containing(u'.')
2963
if location is None:
2965
location = b.get_old_bound_location()
2966
except errors.UpgradeRequired:
2967
raise errors.BzrCommandError('No location supplied. '
2968
'This format does not remember old locations.')
2970
if location is None:
2971
raise errors.BzrCommandError('No location supplied and no '
2972
'previous location known')
2973
b_other = Branch.open(location)
2976
except errors.DivergedBranches:
2977
raise errors.BzrCommandError('These branches have diverged.'
2978
' Try merging, and then bind again.')
2981
class cmd_unbind(Command):
2982
"""Convert the current checkout into a regular branch.
2984
After unbinding, the local branch is considered independent and subsequent
2985
commits will be local only.
2987
See "help checkouts" for more information on checkouts.
2994
b, relpath = Branch.open_containing(u'.')
2996
raise errors.BzrCommandError('Local branch is not bound')
2999
class cmd_uncommit(Command):
3000
"""Remove the last committed revision.
3002
--verbose will print out what is being removed.
3003
--dry-run will go through all the motions, but not actually
3006
In the future, uncommit will create a revision bundle, which can then
3010
# TODO: jam 20060108 Add an option to allow uncommit to remove
3011
# unreferenced information in 'branch-as-repository' branches.
3012
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3013
# information in shared branches as well.
3014
takes_options = ['verbose', 'revision',
3015
Option('dry-run', help='Don\'t actually make changes'),
3016
Option('force', help='Say yes to all questions.')]
3017
takes_args = ['location?']
3020
def run(self, location=None,
3021
dry_run=False, verbose=False,
3022
revision=None, force=False):
3023
from bzrlib.log import log_formatter, show_log
3025
from bzrlib.uncommit import uncommit
3027
if location is None:
3029
control, relpath = bzrdir.BzrDir.open_containing(location)
3031
tree = control.open_workingtree()
3033
except (errors.NoWorkingTree, errors.NotLocalUrl):
3035
b = control.open_branch()
3038
if revision is None:
3041
# 'bzr uncommit -r 10' actually means uncommit
3042
# so that the final tree is at revno 10.
3043
# but bzrlib.uncommit.uncommit() actually uncommits
3044
# the revisions that are supplied.
3045
# So we need to offset it by one
3046
revno = revision[0].in_history(b).revno+1
3048
if revno <= b.revno():
3049
rev_id = b.get_rev_id(revno)
3051
self.outf.write('No revisions to uncommit.\n')
3054
lf = log_formatter('short',
3056
show_timezone='original')
3061
direction='forward',
3062
start_revision=revno,
3063
end_revision=b.revno())
3066
print 'Dry-run, pretending to remove the above revisions.'
3068
val = raw_input('Press <enter> to continue')
3070
print 'The above revision(s) will be removed.'
3072
val = raw_input('Are you sure [y/N]? ')
3073
if val.lower() not in ('y', 'yes'):
3077
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3081
class cmd_break_lock(Command):
3082
"""Break a dead lock on a repository, branch or working directory.
3084
CAUTION: Locks should only be broken when you are sure that the process
3085
holding the lock has been stopped.
3087
You can get information on what locks are open via the 'bzr info' command.
3092
takes_args = ['location?']
3094
def run(self, location=None, show=False):
3095
if location is None:
3097
control, relpath = bzrdir.BzrDir.open_containing(location)
3099
control.break_lock()
3100
except NotImplementedError:
3104
class cmd_wait_until_signalled(Command):
3105
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3107
This just prints a line to signal when it is ready, then blocks on stdin.
3113
sys.stdout.write("running\n")
3115
sys.stdin.readline()
3118
class cmd_serve(Command):
3119
"""Run the bzr server."""
3121
aliases = ['server']
3125
help='serve on stdin/out for use from inetd or sshd'),
3127
help='listen for connections on nominated port of the form '
3128
'[hostname:]portnumber. Passing 0 as the port number will '
3129
'result in a dynamically allocated port.',
3132
help='serve contents of directory',
3134
Option('allow-writes',
3135
help='By default the server is a readonly server. Supplying '
3136
'--allow-writes enables write access to the contents of '
3137
'the served directory and below. '
3141
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3142
from bzrlib.transport import smart
3143
from bzrlib.transport import get_transport
3144
if directory is None:
3145
directory = os.getcwd()
3146
url = urlutils.local_path_to_url(directory)
3147
if not allow_writes:
3148
url = 'readonly+' + url
3149
t = get_transport(url)
3151
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3152
elif port is not None:
3154
host, port = port.split(':')
3157
server = smart.SmartTCPServer(t, host=host, port=int(port))
3158
print 'listening on port: ', server.port
3161
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3165
# command-line interpretation helper for merge-related commands
3166
def _merge_helper(other_revision, base_revision,
3167
check_clean=True, ignore_zero=False,
3168
this_dir=None, backup_files=False,
3170
file_list=None, show_base=False, reprocess=False,
3172
pb=DummyProgress()):
3173
"""Merge changes into a tree.
3176
list(path, revno) Base for three-way merge.
3177
If [None, None] then a base will be automatically determined.
3179
list(path, revno) Other revision for three-way merge.
3181
Directory to merge changes into; '.' by default.
3183
If true, this_dir must have no uncommitted changes before the
3185
ignore_zero - If true, suppress the "zero conflicts" message when
3186
there are no conflicts; should be set when doing something we expect
3187
to complete perfectly.
3188
file_list - If supplied, merge only changes to selected files.
3190
All available ancestors of other_revision and base_revision are
3191
automatically pulled into the branch.
3193
The revno may be -1 to indicate the last revision on the branch, which is
3196
This function is intended for use from the command line; programmatic
3197
clients might prefer to call merge.merge_inner(), which has less magic
3200
# Loading it late, so that we don't always have to import bzrlib.merge
3201
if merge_type is None:
3202
merge_type = _mod_merge.Merge3Merger
3203
if this_dir is None:
3205
this_tree = WorkingTree.open_containing(this_dir)[0]
3206
if show_base and not merge_type is _mod_merge.Merge3Merger:
3207
raise errors.BzrCommandError("Show-base is not supported for this merge"
3208
" type. %s" % merge_type)
3209
if reprocess and not merge_type.supports_reprocess:
3210
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3211
" type %s." % merge_type)
3212
if reprocess and show_base:
3213
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3215
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3217
merger.pp = ProgressPhase("Merge phase", 5, pb)
3218
merger.pp.next_phase()
3219
merger.check_basis(check_clean)
3220
merger.set_other(other_revision)
3221
merger.pp.next_phase()
3222
merger.set_base(base_revision)
3223
if merger.base_rev_id == merger.other_rev_id:
3224
note('Nothing to do.')
3226
if file_list is None:
3227
if pull and merger.base_rev_id == merger.this_rev_id:
3228
count = merger.this_tree.pull(merger.this_branch,
3229
False, merger.other_rev_id)
3230
note('%d revision(s) pulled.' % (count,))
3232
merger.backup_files = backup_files
3233
merger.merge_type = merge_type
3234
merger.set_interesting_files(file_list)
3235
merger.show_base = show_base
3236
merger.reprocess = reprocess
3237
conflicts = merger.do_merge()
3238
if file_list is None:
3239
merger.set_pending()
3246
merge = _merge_helper
3249
# these get imported and then picked up by the scan for cmd_*
3250
# TODO: Some more consistent way to split command definitions across files;
3251
# we do need to load at least some information about them to know of
3252
# aliases. ideally we would avoid loading the implementation until the
3253
# details were needed.
3254
from bzrlib.cmd_version_info import cmd_version_info
3255
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3256
from bzrlib.bundle.commands import cmd_bundle_revisions
3257
from bzrlib.sign_my_commits import cmd_sign_my_commits
3258
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3259
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
