1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
45
from bzrlib.branch import Branch
46
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
47
from bzrlib.conflicts import ConflictList
48
from bzrlib.revision import common_ancestor
49
from bzrlib.revisionspec import RevisionSpec
50
from bzrlib.workingtree import WorkingTree
53
from bzrlib.commands import Command, display_command
54
from bzrlib.option import Option
55
from bzrlib.progress import DummyProgress, ProgressPhase
56
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
59
def tree_files(file_list, default_branch=u'.'):
61
return internal_tree_files(file_list, default_branch)
62
except errors.FileInWrongBranch, e:
63
raise errors.BzrCommandError("%s is not in the same branch as %s" %
64
(e.path, file_list[0]))
67
# XXX: Bad function name; should possibly also be a class method of
68
# WorkingTree rather than a function.
69
def internal_tree_files(file_list, default_branch=u'.'):
70
"""Convert command-line paths to a WorkingTree and relative paths.
72
This is typically used for command-line processors that take one or
73
more filenames, and infer the workingtree that contains them.
75
The filenames given are not required to exist.
77
:param file_list: Filenames to convert.
79
:param default_branch: Fallback tree path to use if file_list is empty or
82
:return: workingtree, [relative_paths]
84
if file_list is None or len(file_list) == 0:
85
return WorkingTree.open_containing(default_branch)[0], file_list
86
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
88
for filename in file_list:
90
new_list.append(tree.relpath(osutils.dereference_path(filename)))
91
except errors.PathNotChild:
92
raise errors.FileInWrongBranch(tree.branch, filename)
96
def get_format_type(typestring):
97
"""Parse and return a format specifier."""
98
# Have to use BzrDirMetaFormat1 directly, so that
99
# RepositoryFormat.set_default_format works
100
if typestring == "default":
101
return bzrdir.BzrDirMetaFormat1()
103
return bzrdir.format_registry.make_bzrdir(typestring)
105
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
106
raise errors.BzrCommandError(msg)
109
# TODO: Make sure no commands unconditionally use the working directory as a
110
# branch. If a filename argument is used, the first of them should be used to
111
# specify the branch. (Perhaps this can be factored out into some kind of
112
# Argument class, representing a file in a branch, where the first occurrence
115
class cmd_status(Command):
116
"""Display status summary.
118
This reports on versioned and unknown files, reporting them
119
grouped by state. Possible states are:
122
Versioned in the working copy but not in the previous revision.
125
Versioned in the previous revision but removed or deleted
129
Path of this file changed from the previous revision;
130
the text may also have changed. This includes files whose
131
parent directory was renamed.
134
Text has changed since the previous revision.
137
Not versioned and not matching an ignore pattern.
139
To see ignored files use 'bzr ignored'. For details in the
140
changes to file texts, use 'bzr diff'.
142
--short gives a one character status flag for each item, similar
143
to the SVN's status command.
145
If no arguments are specified, the status of the entire working
146
directory is shown. Otherwise, only the status of the specified
147
files or directories is reported. If a directory is given, status
148
is reported for everything inside that directory.
150
If a revision argument is given, the status is calculated against
151
that revision, or between two revisions if two are provided.
154
# TODO: --no-recurse, --recurse options
156
takes_args = ['file*']
157
takes_options = ['show-ids', 'revision', 'short']
158
aliases = ['st', 'stat']
160
encoding_type = 'replace'
163
def run(self, show_ids=False, file_list=None, revision=None, short=False):
164
from bzrlib.status import show_tree_status
166
tree, file_list = tree_files(file_list)
168
show_tree_status(tree, show_ids=show_ids,
169
specific_files=file_list, revision=revision,
174
class cmd_cat_revision(Command):
175
"""Write out metadata for a revision.
177
The revision to print can either be specified by a specific
178
revision identifier, or you can use --revision.
182
takes_args = ['revision_id?']
183
takes_options = ['revision']
184
# cat-revision is more for frontends so should be exact
188
def run(self, revision_id=None, revision=None):
190
if revision_id is not None and revision is not None:
191
raise errors.BzrCommandError('You can only supply one of'
192
' revision_id or --revision')
193
if revision_id is None and revision is None:
194
raise errors.BzrCommandError('You must supply either'
195
' --revision or a revision_id')
196
b = WorkingTree.open_containing(u'.')[0].branch
198
# TODO: jam 20060112 should cat-revision always output utf-8?
199
if revision_id is not None:
200
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
201
elif revision is not None:
204
raise errors.BzrCommandError('You cannot specify a NULL'
206
revno, rev_id = rev.in_history(b)
207
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
210
class cmd_remove_tree(Command):
211
"""Remove the working tree from a given branch/checkout.
213
Since a lightweight checkout is little more than a working tree
214
this will refuse to run against one.
219
takes_args = ['location?']
221
def run(self, location='.'):
222
d = bzrdir.BzrDir.open(location)
225
working = d.open_workingtree()
226
except errors.NoWorkingTree:
227
raise errors.BzrCommandError("No working tree to remove")
228
except errors.NotLocalUrl:
229
raise errors.BzrCommandError("You cannot remove the working tree of a "
232
working_path = working.bzrdir.root_transport.base
233
branch_path = working.branch.bzrdir.root_transport.base
234
if working_path != branch_path:
235
raise errors.BzrCommandError("You cannot remove the working tree from "
236
"a lightweight checkout")
238
d.destroy_workingtree()
241
class cmd_revno(Command):
242
"""Show current revision number.
244
This is equal to the number of revisions on this branch.
247
takes_args = ['location?']
250
def run(self, location=u'.'):
251
self.outf.write(str(Branch.open_containing(location)[0].revno()))
252
self.outf.write('\n')
255
class cmd_revision_info(Command):
256
"""Show revision number and revision id for a given revision identifier.
259
takes_args = ['revision_info*']
260
takes_options = ['revision']
263
def run(self, revision=None, revision_info_list=[]):
266
if revision is not None:
267
revs.extend(revision)
268
if revision_info_list is not None:
269
for rev in revision_info_list:
270
revs.append(RevisionSpec.from_string(rev))
272
raise errors.BzrCommandError('You must supply a revision identifier')
274
b = WorkingTree.open_containing(u'.')[0].branch
277
revinfo = rev.in_history(b)
278
if revinfo.revno is None:
279
print ' %s' % revinfo.rev_id
281
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
284
class cmd_add(Command):
285
"""Add specified files or directories.
287
In non-recursive mode, all the named items are added, regardless
288
of whether they were previously ignored. A warning is given if
289
any of the named files are already versioned.
291
In recursive mode (the default), files are treated the same way
292
but the behaviour for directories is different. Directories that
293
are already versioned do not give a warning. All directories,
294
whether already versioned or not, are searched for files or
295
subdirectories that are neither versioned or ignored, and these
296
are added. This search proceeds recursively into versioned
297
directories. If no names are given '.' is assumed.
299
Therefore simply saying 'bzr add' will version all files that
300
are currently unknown.
302
Adding a file whose parent directory is not versioned will
303
implicitly add the parent, and so on up to the root. This means
304
you should never need to explicitly add a directory, they'll just
305
get added when you add a file in the directory.
307
--dry-run will show which files would be added, but not actually
310
--file-ids-from will try to use the file ids from the supplied path.
311
It looks up ids trying to find a matching parent directory with the
312
same filename, and then by pure path.
314
takes_args = ['file*']
315
takes_options = ['no-recurse', 'dry-run', 'verbose',
316
Option('file-ids-from', type=unicode,
317
help='Lookup file ids from here')]
318
encoding_type = 'replace'
320
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
324
if file_ids_from is not None:
326
base_tree, base_path = WorkingTree.open_containing(
328
except errors.NoWorkingTree:
329
base_branch, base_path = Branch.open_containing(
331
base_tree = base_branch.basis_tree()
333
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
334
to_file=self.outf, should_print=(not is_quiet()))
336
action = bzrlib.add.AddAction(to_file=self.outf,
337
should_print=(not is_quiet()))
339
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
340
action=action, save=not dry_run)
343
for glob in sorted(ignored.keys()):
344
for path in ignored[glob]:
345
self.outf.write("ignored %s matching \"%s\"\n"
349
for glob, paths in ignored.items():
350
match_len += len(paths)
351
self.outf.write("ignored %d file(s).\n" % match_len)
352
self.outf.write("If you wish to add some of these files,"
353
" please add them by name.\n")
356
class cmd_mkdir(Command):
357
"""Create a new versioned directory.
359
This is equivalent to creating the directory and then adding it.
362
takes_args = ['dir+']
363
encoding_type = 'replace'
365
def run(self, dir_list):
368
wt, dd = WorkingTree.open_containing(d)
370
self.outf.write('added %s\n' % d)
373
class cmd_relpath(Command):
374
"""Show path of a file relative to root"""
376
takes_args = ['filename']
380
def run(self, filename):
381
# TODO: jam 20050106 Can relpath return a munged path if
382
# sys.stdout encoding cannot represent it?
383
tree, relpath = WorkingTree.open_containing(filename)
384
self.outf.write(relpath)
385
self.outf.write('\n')
388
class cmd_inventory(Command):
389
"""Show inventory of the current working copy or a revision.
391
It is possible to limit the output to a particular entry
392
type using the --kind option. For example: --kind file.
394
It is also possible to restrict the list of files to a specific
395
set. For example: bzr inventory --show-ids this/file
398
takes_options = ['revision', 'show-ids', 'kind']
399
takes_args = ['file*']
402
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
403
if kind and kind not in ['file', 'directory', 'symlink']:
404
raise errors.BzrCommandError('invalid kind specified')
406
work_tree, file_list = tree_files(file_list)
408
if revision is not None:
409
if len(revision) > 1:
410
raise errors.BzrCommandError('bzr inventory --revision takes'
411
' exactly one revision identifier')
412
revision_id = revision[0].in_history(work_tree.branch).rev_id
413
tree = work_tree.branch.repository.revision_tree(revision_id)
415
# We include work_tree as well as 'tree' here
416
# So that doing '-r 10 path/foo' will lookup whatever file
417
# exists now at 'path/foo' even if it has been renamed, as
418
# well as whatever files existed in revision 10 at path/foo
419
trees = [tree, work_tree]
424
if file_list is not None:
425
file_ids = _mod_tree.find_ids_across_trees(file_list, trees,
426
require_versioned=True)
427
# find_ids_across_trees may include some paths that don't
429
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
430
for file_id in file_ids if file_id in tree)
432
entries = tree.inventory.entries()
434
for path, entry in entries:
435
if kind and kind != entry.kind:
438
self.outf.write('%-50s %s\n' % (path, entry.file_id))
440
self.outf.write(path)
441
self.outf.write('\n')
444
class cmd_mv(Command):
445
"""Move or rename a file.
448
bzr mv OLDNAME NEWNAME
449
bzr mv SOURCE... DESTINATION
451
If the last argument is a versioned directory, all the other names
452
are moved into it. Otherwise, there must be exactly two arguments
453
and the file is changed to a new name, which must not already exist.
455
Files cannot be moved between branches.
458
takes_args = ['names*']
459
aliases = ['move', 'rename']
460
encoding_type = 'replace'
462
def run(self, names_list):
463
if names_list is None:
466
if len(names_list) < 2:
467
raise errors.BzrCommandError("missing file argument")
468
tree, rel_names = tree_files(names_list)
470
if os.path.isdir(names_list[-1]):
471
# move into existing directory
472
for pair in tree.move(rel_names[:-1], rel_names[-1]):
473
self.outf.write("%s => %s\n" % pair)
475
if len(names_list) != 2:
476
raise errors.BzrCommandError('to mv multiple files the destination '
477
'must be a versioned directory')
478
tree.rename_one(rel_names[0], rel_names[1])
479
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
482
class cmd_pull(Command):
483
"""Turn this branch into a mirror of another branch.
485
This command only works on branches that have not diverged. Branches are
486
considered diverged if the destination branch's most recent commit is one
487
that has not been merged (directly or indirectly) into the parent.
489
If branches have diverged, you can use 'bzr merge' to integrate the changes
490
from one into the other. Once one branch has merged, the other should
491
be able to pull it again.
493
If you want to forget your local changes and just update your branch to
494
match the remote one, use pull --overwrite.
496
If there is no default location set, the first pull will set it. After
497
that, you can omit the location to use the default. To change the
498
default, use --remember. The value will only be saved if the remote
499
location can be accessed.
502
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
503
takes_args = ['location?']
504
encoding_type = 'replace'
506
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
507
# FIXME: too much stuff is in the command class
509
tree_to = WorkingTree.open_containing(u'.')[0]
510
branch_to = tree_to.branch
511
except errors.NoWorkingTree:
513
branch_to = Branch.open_containing(u'.')[0]
516
if location is not None:
518
reader = bundle.read_bundle_from_url(location)
519
except errors.NotABundle:
520
pass # Continue on considering this url a Branch
522
stored_loc = branch_to.get_parent()
524
if stored_loc is None:
525
raise errors.BzrCommandError("No pull location known or"
528
display_url = urlutils.unescape_for_display(stored_loc,
530
self.outf.write("Using saved location: %s\n" % display_url)
531
location = stored_loc
534
if reader is not None:
535
install_bundle(branch_to.repository, reader)
536
branch_from = branch_to
538
branch_from = Branch.open(location)
540
if branch_to.get_parent() is None or remember:
541
branch_to.set_parent(branch_from.base)
545
if reader is not None:
546
rev_id = reader.target
547
elif len(revision) == 1:
548
rev_id = revision[0].in_history(branch_from).rev_id
550
raise errors.BzrCommandError('bzr pull --revision takes one value.')
552
old_rh = branch_to.revision_history()
553
if tree_to is not None:
554
count = tree_to.pull(branch_from, overwrite, rev_id)
556
count = branch_to.pull(branch_from, overwrite, rev_id)
557
note('%d revision(s) pulled.' % (count,))
560
new_rh = branch_to.revision_history()
563
from bzrlib.log import show_changed_revisions
564
show_changed_revisions(branch_to, old_rh, new_rh,
568
class cmd_push(Command):
569
"""Update a mirror of this branch.
571
The target branch will not have its working tree populated because this
572
is both expensive, and is not supported on remote file systems.
574
Some smart servers or protocols *may* put the working tree in place in
577
This command only works on branches that have not diverged. Branches are
578
considered diverged if the destination branch's most recent commit is one
579
that has not been merged (directly or indirectly) by the source branch.
581
If branches have diverged, you can use 'bzr push --overwrite' to replace
582
the other branch completely, discarding its unmerged changes.
584
If you want to ensure you have the different changes in the other branch,
585
do a merge (see bzr help merge) from the other branch, and commit that.
586
After that you will be able to do a push without '--overwrite'.
588
If there is no default push location set, the first push will set it.
589
After that, you can omit the location to use the default. To change the
590
default, use --remember. The value will only be saved if the remote
591
location can be accessed.
594
takes_options = ['remember', 'overwrite', 'verbose',
595
Option('create-prefix',
596
help='Create the path leading up to the branch '
597
'if it does not already exist'),
598
Option('use-existing',
599
help='By default push will fail if the target'
600
' directory exists, but does not already'
601
' have a control directory. This flag will'
602
' allow push to proceed.'),
604
takes_args = ['location?']
605
encoding_type = 'replace'
607
def run(self, location=None, remember=False, overwrite=False,
608
create_prefix=False, verbose=False, use_existing=False):
609
# FIXME: Way too big! Put this into a function called from the
612
br_from = Branch.open_containing('.')[0]
613
stored_loc = br_from.get_push_location()
615
if stored_loc is None:
616
raise errors.BzrCommandError("No push location known or specified.")
618
display_url = urlutils.unescape_for_display(stored_loc,
620
self.outf.write("Using saved location: %s\n" % display_url)
621
location = stored_loc
623
to_transport = transport.get_transport(location)
624
location_url = to_transport.base
629
br_to = repository_to = dir_to = None
631
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
632
except errors.NotBranchError:
633
pass # Didn't find anything
635
# If we can open a branch, use its direct repository, otherwise see
636
# if there is a repository without a branch.
638
br_to = dir_to.open_branch()
639
except errors.NotBranchError:
640
# Didn't find a branch, can we find a repository?
642
repository_to = dir_to.find_repository()
643
except errors.NoRepositoryPresent:
646
# Found a branch, so we must have found a repository
647
repository_to = br_to.repository
651
# XXX: Refactor the create_prefix/no_create_prefix code into a
652
# common helper function
654
to_transport.mkdir('.')
655
except errors.FileExists:
657
raise errors.BzrCommandError("Target directory %s"
658
" already exists, but does not"
659
" have a valid .bzr directory."
660
" Supply --use-existing to"
661
" push there anyway."
663
except errors.NoSuchFile:
664
if not create_prefix:
665
raise errors.BzrCommandError("Parent directory of %s"
667
"\nYou may supply --create-prefix to create all"
668
" leading parent directories."
671
cur_transport = to_transport
672
needed = [cur_transport]
673
# Recurse upwards until we can create a directory successfully
675
new_transport = cur_transport.clone('..')
676
if new_transport.base == cur_transport.base:
677
raise errors.BzrCommandError("Failed to create path"
681
new_transport.mkdir('.')
682
except errors.NoSuchFile:
683
needed.append(new_transport)
684
cur_transport = new_transport
688
# Now we only need to create child directories
690
cur_transport = needed.pop()
691
cur_transport.mkdir('.')
693
# Now the target directory exists, but doesn't have a .bzr
694
# directory. So we need to create it, along with any work to create
695
# all of the dependent branches, etc.
696
dir_to = br_from.bzrdir.clone(location_url,
697
revision_id=br_from.last_revision())
698
br_to = dir_to.open_branch()
699
count = len(br_to.revision_history())
700
# We successfully created the target, remember it
701
if br_from.get_push_location() is None or remember:
702
br_from.set_push_location(br_to.base)
703
elif repository_to is None:
704
# we have a bzrdir but no branch or repository
705
# XXX: Figure out what to do other than complain.
706
raise errors.BzrCommandError("At %s you have a valid .bzr control"
707
" directory. But we could not find a valid repository or"
708
" branch associated with it. This is an unsupported"
709
" configuration. Please move the target directory out of the"
710
" way and try again."
713
# We have a repository but no branch, copy the revisions, and then
715
last_revision_id = br_from.last_revision()
716
repository_to.fetch(br_from.repository,
717
revision_id=last_revision_id)
718
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
719
count = len(br_to.revision_history())
720
if br_from.get_push_location() is None or remember:
721
br_from.set_push_location(br_to.base)
722
else: # We have a valid to branch
723
# We were able to connect to the remote location, so remember it
724
# we don't need to successfully push because of possible divergence.
725
if br_from.get_push_location() is None or remember:
726
br_from.set_push_location(br_to.base)
727
old_rh = br_to.revision_history()
730
tree_to = dir_to.open_workingtree()
731
except errors.NotLocalUrl:
732
warning('This transport does not update the working '
733
'tree of: %s' % (br_to.base,))
734
count = br_to.pull(br_from, overwrite)
735
except errors.NoWorkingTree:
736
count = br_to.pull(br_from, overwrite)
738
count = tree_to.pull(br_from, overwrite)
739
except errors.DivergedBranches:
740
raise errors.BzrCommandError('These branches have diverged.'
741
' Try using "merge" and then "push".')
742
note('%d revision(s) pushed.' % (count,))
745
new_rh = br_to.revision_history()
748
from bzrlib.log import show_changed_revisions
749
show_changed_revisions(br_to, old_rh, new_rh,
753
class cmd_branch(Command):
754
"""Create a new copy of a branch.
756
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
757
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
759
To retrieve the branch as of a particular revision, supply the --revision
760
parameter, as in "branch foo/bar -r 5".
762
--basis is to speed up branching from remote branches. When specified, it
763
copies all the file-contents, inventory and revision data from the basis
764
branch before copying anything from the remote branch.
766
takes_args = ['from_location', 'to_location?']
767
takes_options = ['revision', 'basis']
768
aliases = ['get', 'clone']
770
def run(self, from_location, to_location=None, revision=None, basis=None):
773
elif len(revision) > 1:
774
raise errors.BzrCommandError(
775
'bzr branch --revision takes exactly 1 revision value')
777
br_from = Branch.open(from_location)
779
if e.errno == errno.ENOENT:
780
raise errors.BzrCommandError('Source location "%s" does not'
781
' exist.' % to_location)
786
if basis is not None:
787
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
790
if len(revision) == 1 and revision[0] is not None:
791
revision_id = revision[0].in_history(br_from)[1]
793
# FIXME - wt.last_revision, fallback to branch, fall back to
794
# None or perhaps NULL_REVISION to mean copy nothing
796
revision_id = br_from.last_revision()
797
if to_location is None:
798
to_location = os.path.basename(from_location.rstrip("/\\"))
801
name = os.path.basename(to_location) + '\n'
803
to_transport = transport.get_transport(to_location)
805
to_transport.mkdir('.')
806
except errors.FileExists:
807
raise errors.BzrCommandError('Target directory "%s" already'
808
' exists.' % to_location)
809
except errors.NoSuchFile:
810
raise errors.BzrCommandError('Parent of "%s" does not exist.'
813
# preserve whatever source format we have.
814
dir = br_from.bzrdir.sprout(to_transport.base,
815
revision_id, basis_dir)
816
branch = dir.open_branch()
817
except errors.NoSuchRevision:
818
to_transport.delete_tree('.')
819
msg = "The branch %s has no revision %s." % (from_location, revision[0])
820
raise errors.BzrCommandError(msg)
821
except errors.UnlistableBranch:
822
osutils.rmtree(to_location)
823
msg = "The branch %s cannot be used as a --basis" % (basis,)
824
raise errors.BzrCommandError(msg)
826
branch.control_files.put_utf8('branch-name', name)
827
note('Branched %d revision(s).' % branch.revno())
832
class cmd_checkout(Command):
833
"""Create a new checkout of an existing branch.
835
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
836
the branch found in '.'. This is useful if you have removed the working tree
837
or if it was never created - i.e. if you pushed the branch to its current
840
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
841
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
843
To retrieve the branch as of a particular revision, supply the --revision
844
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
845
out of date [so you cannot commit] but it may be useful (i.e. to examine old
848
--basis is to speed up checking out from remote branches. When specified, it
849
uses the inventory and file contents from the basis branch in preference to the
850
branch being checked out.
852
takes_args = ['branch_location?', 'to_location?']
853
takes_options = ['revision', # , 'basis']
854
Option('lightweight',
855
help="perform a lightweight checkout. Lightweight "
856
"checkouts depend on access to the branch for "
857
"every operation. Normal checkouts can perform "
858
"common operations like diff and status without "
859
"such access, and also support local commits."
864
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
868
elif len(revision) > 1:
869
raise errors.BzrCommandError(
870
'bzr checkout --revision takes exactly 1 revision value')
871
if branch_location is None:
872
branch_location = osutils.getcwd()
873
to_location = branch_location
874
source = Branch.open(branch_location)
875
if len(revision) == 1 and revision[0] is not None:
876
revision_id = revision[0].in_history(source)[1]
879
if to_location is None:
880
to_location = os.path.basename(branch_location.rstrip("/\\"))
881
# if the source and to_location are the same,
882
# and there is no working tree,
883
# then reconstitute a branch
884
if (osutils.abspath(to_location) ==
885
osutils.abspath(branch_location)):
887
source.bzrdir.open_workingtree()
888
except errors.NoWorkingTree:
889
source.bzrdir.create_workingtree()
892
os.mkdir(to_location)
894
if e.errno == errno.EEXIST:
895
raise errors.BzrCommandError('Target directory "%s" already'
896
' exists.' % to_location)
897
if e.errno == errno.ENOENT:
898
raise errors.BzrCommandError('Parent of "%s" does not exist.'
902
source.create_checkout(to_location, revision_id, lightweight)
905
class cmd_renames(Command):
906
"""Show list of renamed files.
908
# TODO: Option to show renames between two historical versions.
910
# TODO: Only show renames under dir, rather than in the whole branch.
911
takes_args = ['dir?']
914
def run(self, dir=u'.'):
915
tree = WorkingTree.open_containing(dir)[0]
916
old_inv = tree.basis_tree().inventory
917
new_inv = tree.read_working_inventory()
918
renames = list(_mod_tree.find_renames(old_inv, new_inv))
920
for old_name, new_name in renames:
921
self.outf.write("%s => %s\n" % (old_name, new_name))
924
class cmd_update(Command):
925
"""Update a tree to have the latest code committed to its branch.
927
This will perform a merge into the working tree, and may generate
928
conflicts. If you have any local changes, you will still
929
need to commit them after the update for the update to be complete.
931
If you want to discard your local changes, you can just do a
932
'bzr revert' instead of 'bzr commit' after the update.
934
takes_args = ['dir?']
937
def run(self, dir='.'):
938
tree = WorkingTree.open_containing(dir)[0]
939
master = tree.branch.get_master_branch()
940
if master is not None:
943
tree.lock_tree_write()
945
existing_pending_merges = tree.get_parent_ids()[1:]
946
last_rev = tree.last_revision()
947
if last_rev == tree.branch.last_revision():
948
# may be up to date, check master too.
949
master = tree.branch.get_master_branch()
950
if master is None or last_rev == master.last_revision():
951
revno = tree.branch.revision_id_to_revno(last_rev)
952
note("Tree is up to date at revision %d." % (revno,))
954
conflicts = tree.update()
955
revno = tree.branch.revision_id_to_revno(tree.last_revision())
956
note('Updated to revision %d.' % (revno,))
957
if tree.get_parent_ids()[1:] != existing_pending_merges:
958
note('Your local commits will now show as pending merges with '
959
"'bzr status', and can be committed with 'bzr commit'.")
968
class cmd_info(Command):
969
"""Show information about a working tree, branch or repository.
971
This command will show all known locations and formats associated to the
972
tree, branch or repository. Statistical information is included with
975
Branches and working trees will also report any missing revisions.
977
takes_args = ['location?']
978
takes_options = ['verbose']
981
def run(self, location=None, verbose=False):
982
from bzrlib.info import show_bzrdir_info
983
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
987
class cmd_remove(Command):
988
"""Make a file unversioned.
990
This makes bzr stop tracking changes to a versioned file. It does
991
not delete the working copy.
993
You can specify one or more files, and/or --new. If you specify --new,
994
only 'added' files will be removed. If you specify both, then new files
995
in the specified directories will be removed. If the directories are
996
also new, they will also be removed.
998
takes_args = ['file*']
999
takes_options = ['verbose', Option('new', help='remove newly-added files')]
1001
encoding_type = 'replace'
1003
def run(self, file_list, verbose=False, new=False):
1004
tree, file_list = tree_files(file_list)
1006
if file_list is None:
1007
raise errors.BzrCommandError('Specify one or more files to'
1008
' remove, or use --new.')
1010
added = tree.changes_from(tree.basis_tree(),
1011
specific_files=file_list).added
1012
file_list = sorted([f[0] for f in added], reverse=True)
1013
if len(file_list) == 0:
1014
raise errors.BzrCommandError('No matching files.')
1015
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1018
class cmd_file_id(Command):
1019
"""Print file_id of a particular file or directory.
1021
The file_id is assigned when the file is first added and remains the
1022
same through all revisions where the file exists, even when it is
1027
takes_args = ['filename']
1030
def run(self, filename):
1031
tree, relpath = WorkingTree.open_containing(filename)
1032
i = tree.inventory.path2id(relpath)
1034
raise errors.NotVersionedError(filename)
1036
self.outf.write(i + '\n')
1039
class cmd_file_path(Command):
1040
"""Print path of file_ids to a file or directory.
1042
This prints one line for each directory down to the target,
1043
starting at the branch root.
1047
takes_args = ['filename']
1050
def run(self, filename):
1051
tree, relpath = WorkingTree.open_containing(filename)
1052
inv = tree.inventory
1053
fid = inv.path2id(relpath)
1055
raise errors.NotVersionedError(filename)
1056
for fip in inv.get_idpath(fid):
1057
self.outf.write(fip + '\n')
1060
class cmd_reconcile(Command):
1061
"""Reconcile bzr metadata in a branch.
1063
This can correct data mismatches that may have been caused by
1064
previous ghost operations or bzr upgrades. You should only
1065
need to run this command if 'bzr check' or a bzr developer
1066
advises you to run it.
1068
If a second branch is provided, cross-branch reconciliation is
1069
also attempted, which will check that data like the tree root
1070
id which was not present in very early bzr versions is represented
1071
correctly in both branches.
1073
At the same time it is run it may recompress data resulting in
1074
a potential saving in disk space or performance gain.
1076
The branch *MUST* be on a listable system such as local disk or sftp.
1078
takes_args = ['branch?']
1080
def run(self, branch="."):
1081
from bzrlib.reconcile import reconcile
1082
dir = bzrdir.BzrDir.open(branch)
1086
class cmd_revision_history(Command):
1087
"""Display the list of revision ids on a branch."""
1088
takes_args = ['location?']
1093
def run(self, location="."):
1094
branch = Branch.open_containing(location)[0]
1095
for revid in branch.revision_history():
1096
self.outf.write(revid)
1097
self.outf.write('\n')
1100
class cmd_ancestry(Command):
1101
"""List all revisions merged into this branch."""
1102
takes_args = ['location?']
1107
def run(self, location="."):
1109
wt = WorkingTree.open_containing(location)[0]
1110
except errors.NoWorkingTree:
1111
b = Branch.open(location)
1112
last_revision = b.last_revision()
1115
last_revision = wt.last_revision()
1117
revision_ids = b.repository.get_ancestry(last_revision)
1118
assert revision_ids[0] is None
1120
for revision_id in revision_ids:
1121
self.outf.write(revision_id + '\n')
1124
class cmd_init(Command):
1125
"""Make a directory into a versioned branch.
1127
Use this to create an empty branch, or before importing an
1130
If there is a repository in a parent directory of the location, then
1131
the history of the branch will be stored in the repository. Otherwise
1132
init creates a standalone branch which carries its own history in
1135
If there is already a branch at the location but it has no working tree,
1136
the tree can be populated with 'bzr checkout'.
1138
Recipe for importing a tree of files:
1143
bzr commit -m 'imported project'
1145
takes_args = ['location?']
1148
help='Specify a format for this branch. Current'
1149
' formats are: default, knit, metaweave and'
1150
' weave. Default is knit; metaweave and'
1151
' weave are deprecated',
1152
type=get_format_type),
1154
def run(self, location=None, format=None):
1156
format = get_format_type('default')
1157
if location is None:
1160
to_transport = transport.get_transport(location)
1162
# The path has to exist to initialize a
1163
# branch inside of it.
1164
# Just using os.mkdir, since I don't
1165
# believe that we want to create a bunch of
1166
# locations if the user supplies an extended path
1167
# TODO: create-prefix
1169
to_transport.mkdir('.')
1170
except errors.FileExists:
1174
existing_bzrdir = bzrdir.BzrDir.open(location)
1175
except errors.NotBranchError:
1176
# really a NotBzrDir error...
1177
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1179
from bzrlib.transport.local import LocalTransport
1180
if existing_bzrdir.has_branch():
1181
if (isinstance(to_transport, LocalTransport)
1182
and not existing_bzrdir.has_workingtree()):
1183
raise errors.BranchExistsWithoutWorkingTree(location)
1184
raise errors.AlreadyBranchError(location)
1186
existing_bzrdir.create_branch()
1187
existing_bzrdir.create_workingtree()
1190
class cmd_init_repository(Command):
1191
"""Create a shared repository to hold branches.
1193
New branches created under the repository directory will store their revisions
1194
in the repository, not in the branch directory, if the branch format supports
1200
bzr checkout --lightweight repo/trunk trunk-checkout
1204
takes_args = ["location"]
1205
takes_options = [Option('format',
1206
help='Specify a format for this repository.'
1207
' Current formats are: default, knit,'
1208
' metaweave and weave. Default is knit;'
1209
' metaweave and weave are deprecated',
1210
type=get_format_type),
1212
help='Allows branches in repository to have'
1214
aliases = ["init-repo"]
1215
def run(self, location, format=None, trees=False):
1217
format = get_format_type('default')
1219
if location is None:
1222
to_transport = transport.get_transport(location)
1224
to_transport.mkdir('.')
1225
except errors.FileExists:
1228
newdir = format.initialize_on_transport(to_transport)
1229
repo = newdir.create_repository(shared=True)
1230
repo.set_make_working_trees(trees)
1233
class cmd_diff(Command):
1234
"""Show differences in the working tree or between revisions.
1236
If files are listed, only the changes in those files are listed.
1237
Otherwise, all changes for the tree are listed.
1239
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1240
produces patches suitable for "patch -p1".
1244
Shows the difference in the working tree versus the last commit
1246
Difference between the working tree and revision 1
1248
Difference between revision 2 and revision 1
1249
bzr diff --diff-prefix old/:new/
1250
Same as 'bzr diff' but prefix paths with old/ and new/
1251
bzr diff bzr.mine bzr.dev
1252
Show the differences between the two working trees
1254
Show just the differences for 'foo.c'
1256
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1257
# or a graphical diff.
1259
# TODO: Python difflib is not exactly the same as unidiff; should
1260
# either fix it up or prefer to use an external diff.
1262
# TODO: Selected-file diff is inefficient and doesn't show you
1265
# TODO: This probably handles non-Unix newlines poorly.
1267
takes_args = ['file*']
1268
takes_options = ['revision', 'diff-options',
1269
Option('prefix', type=str,
1271
help='Set prefixes to added to old and new filenames, as '
1272
'two values separated by a colon.'),
1274
aliases = ['di', 'dif']
1275
encoding_type = 'exact'
1278
def run(self, revision=None, file_list=None, diff_options=None,
1280
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1282
if (prefix is None) or (prefix == '0'):
1290
old_label, new_label = prefix.split(":")
1292
raise BzrCommandError(
1293
"--prefix expects two values separated by a colon")
1295
if revision and len(revision) > 2:
1296
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1297
' one or two revision specifiers')
1300
tree1, file_list = internal_tree_files(file_list)
1304
except errors.FileInWrongBranch:
1305
if len(file_list) != 2:
1306
raise errors.BzrCommandError("Files are in different branches")
1308
tree1, file1 = WorkingTree.open_containing(file_list[0])
1309
tree2, file2 = WorkingTree.open_containing(file_list[1])
1310
if file1 != "" or file2 != "":
1311
# FIXME diff those two files. rbc 20051123
1312
raise errors.BzrCommandError("Files are in different branches")
1314
except errors.NotBranchError:
1315
if (revision is not None and len(revision) == 2
1316
and not revision[0].needs_branch()
1317
and not revision[1].needs_branch()):
1318
# If both revision specs include a branch, we can
1319
# diff them without needing a local working tree
1320
tree1, tree2 = None, None
1324
if tree2 is not None:
1325
if revision is not None:
1326
# FIXME: but there should be a clean way to diff between
1327
# non-default versions of two trees, it's not hard to do
1329
raise errors.BzrCommandError(
1330
"Sorry, diffing arbitrary revisions across branches "
1331
"is not implemented yet")
1332
return show_diff_trees(tree1, tree2, sys.stdout,
1333
specific_files=file_list,
1334
external_diff_options=diff_options,
1335
old_label=old_label, new_label=new_label)
1337
return diff_cmd_helper(tree1, file_list, diff_options,
1338
revision_specs=revision,
1339
old_label=old_label, new_label=new_label)
1342
class cmd_deleted(Command):
1343
"""List files deleted in the working tree.
1345
# TODO: Show files deleted since a previous revision, or
1346
# between two revisions.
1347
# TODO: Much more efficient way to do this: read in new
1348
# directories with readdir, rather than stating each one. Same
1349
# level of effort but possibly much less IO. (Or possibly not,
1350
# if the directories are very large...)
1351
takes_options = ['show-ids']
1354
def run(self, show_ids=False):
1355
tree = WorkingTree.open_containing(u'.')[0]
1356
old = tree.basis_tree()
1357
for path, ie in old.inventory.iter_entries():
1358
if not tree.has_id(ie.file_id):
1359
self.outf.write(path)
1361
self.outf.write(' ')
1362
self.outf.write(ie.file_id)
1363
self.outf.write('\n')
1366
class cmd_modified(Command):
1367
"""List files modified in working tree."""
1371
tree = WorkingTree.open_containing(u'.')[0]
1372
td = tree.changes_from(tree.basis_tree())
1373
for path, id, kind, text_modified, meta_modified in td.modified:
1374
self.outf.write(path + '\n')
1377
class cmd_added(Command):
1378
"""List files added in working tree."""
1382
wt = WorkingTree.open_containing(u'.')[0]
1383
basis_inv = wt.basis_tree().inventory
1386
if file_id in basis_inv:
1388
if inv.is_root(file_id) and len(basis_inv) == 0:
1390
path = inv.id2path(file_id)
1391
if not os.access(osutils.abspath(path), os.F_OK):
1393
self.outf.write(path + '\n')
1396
class cmd_root(Command):
1397
"""Show the tree root directory.
1399
The root is the nearest enclosing directory with a .bzr control
1401
takes_args = ['filename?']
1403
def run(self, filename=None):
1404
"""Print the branch root."""
1405
tree = WorkingTree.open_containing(filename)[0]
1406
self.outf.write(tree.basedir + '\n')
1409
class cmd_log(Command):
1410
"""Show log of a branch, file, or directory.
1412
By default show the log of the branch containing the working directory.
1414
To request a range of logs, you can use the command -r begin..end
1415
-r revision requests a specific revision, -r ..end or -r begin.. are
1421
bzr log -r -10.. http://server/branch
1424
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1426
takes_args = ['location?']
1427
takes_options = [Option('forward',
1428
help='show from oldest to newest'),
1432
help='show files changed in each revision'),
1433
'show-ids', 'revision',
1438
help='show revisions whose message matches this regexp',
1442
encoding_type = 'replace'
1445
def run(self, location=None, timezone='original',
1455
from bzrlib.log import log_formatter, show_log
1456
assert message is None or isinstance(message, basestring), \
1457
"invalid message argument %r" % message
1458
direction = (forward and 'forward') or 'reverse'
1463
# find the file id to log:
1465
dir, fp = bzrdir.BzrDir.open_containing(location)
1466
b = dir.open_branch()
1470
inv = dir.open_workingtree().inventory
1471
except (errors.NotBranchError, errors.NotLocalUrl):
1472
# either no tree, or is remote.
1473
inv = b.basis_tree().inventory
1474
file_id = inv.path2id(fp)
1476
raise errors.BzrCommandError(
1477
"Path does not have any revision history: %s" %
1481
# FIXME ? log the current subdir only RBC 20060203
1482
if revision is not None \
1483
and len(revision) > 0 and revision[0].get_branch():
1484
location = revision[0].get_branch()
1487
dir, relpath = bzrdir.BzrDir.open_containing(location)
1488
b = dir.open_branch()
1490
if revision is None:
1493
elif len(revision) == 1:
1494
rev1 = rev2 = revision[0].in_history(b).revno
1495
elif len(revision) == 2:
1496
if revision[1].get_branch() != revision[0].get_branch():
1497
# b is taken from revision[0].get_branch(), and
1498
# show_log will use its revision_history. Having
1499
# different branches will lead to weird behaviors.
1500
raise errors.BzrCommandError(
1501
"Log doesn't accept two revisions in different branches.")
1502
if revision[0].spec is None:
1503
# missing begin-range means first revision
1506
rev1 = revision[0].in_history(b).revno
1508
if revision[1].spec is None:
1509
# missing end-range means last known revision
1512
rev2 = revision[1].in_history(b).revno
1514
raise errors.BzrCommandError('bzr log --revision takes one or two values.')
1516
# By this point, the revision numbers are converted to the +ve
1517
# form if they were supplied in the -ve form, so we can do
1518
# this comparison in relative safety
1520
(rev2, rev1) = (rev1, rev2)
1522
if (log_format is None):
1523
default = b.get_config().log_format()
1524
log_format = get_log_format(long=long, short=short, line=line,
1526
lf = log_formatter(log_format,
1529
show_timezone=timezone)
1535
direction=direction,
1536
start_revision=rev1,
1541
def get_log_format(long=False, short=False, line=False, default='long'):
1542
log_format = default
1546
log_format = 'short'
1552
class cmd_touching_revisions(Command):
1553
"""Return revision-ids which affected a particular file.
1555
A more user-friendly interface is "bzr log FILE".
1559
takes_args = ["filename"]
1562
def run(self, filename):
1563
tree, relpath = WorkingTree.open_containing(filename)
1565
inv = tree.read_working_inventory()
1566
file_id = inv.path2id(relpath)
1567
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1568
self.outf.write("%6d %s\n" % (revno, what))
1571
class cmd_ls(Command):
1572
"""List files in a tree.
1575
takes_args = ['path?']
1576
# TODO: Take a revision or remote path and list that tree instead.
1577
takes_options = ['verbose', 'revision',
1578
Option('non-recursive',
1579
help='don\'t recurse into sub-directories'),
1581
help='Print all paths from the root of the branch.'),
1582
Option('unknown', help='Print unknown files'),
1583
Option('versioned', help='Print versioned files'),
1584
Option('ignored', help='Print ignored files'),
1586
Option('null', help='Null separate the files'),
1590
def run(self, revision=None, verbose=False,
1591
non_recursive=False, from_root=False,
1592
unknown=False, versioned=False, ignored=False,
1593
null=False, kind=None, show_ids=False, path=None):
1595
if kind and kind not in ('file', 'directory', 'symlink'):
1596
raise errors.BzrCommandError('invalid kind specified')
1598
if verbose and null:
1599
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1600
all = not (unknown or versioned or ignored)
1602
selection = {'I':ignored, '?':unknown, 'V':versioned}
1609
raise errors.BzrCommandError('cannot specify both --from-root'
1613
tree, relpath = WorkingTree.open_containing(fs_path)
1618
if revision is not None:
1619
tree = tree.branch.repository.revision_tree(
1620
revision[0].in_history(tree.branch).rev_id)
1622
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1623
if fp.startswith(relpath):
1624
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1625
if non_recursive and '/' in fp:
1627
if not all and not selection[fc]:
1629
if kind is not None and fkind != kind:
1632
kindch = entry.kind_character()
1633
outstring = '%-8s %s%s' % (fc, fp, kindch)
1634
if show_ids and fid is not None:
1635
outstring = "%-50s %s" % (outstring, fid)
1636
self.outf.write(outstring + '\n')
1638
self.outf.write(fp + '\0')
1641
self.outf.write(fid)
1642
self.outf.write('\0')
1650
self.outf.write('%-50s %s\n' % (fp, my_id))
1652
self.outf.write(fp + '\n')
1655
class cmd_unknowns(Command):
1656
"""List unknown files."""
1659
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1660
self.outf.write(osutils.quotefn(f) + '\n')
1663
class cmd_ignore(Command):
1664
"""Ignore specified files or patterns.
1666
To remove patterns from the ignore list, edit the .bzrignore file.
1668
Trailing slashes on patterns are ignored.
1669
If the pattern contains a slash or is a regular expression, it is compared
1670
to the whole path from the branch root. Otherwise, it is compared to only
1671
the last component of the path. To match a file only in the root
1672
directory, prepend './'.
1674
Ignore patterns specifying absolute paths are not allowed.
1676
Ignore patterns may include globbing wildcards such as:
1677
? - Matches any single character except '/'
1678
* - Matches 0 or more characters except '/'
1679
/**/ - Matches 0 or more directories in a path
1680
[a-z] - Matches a single character from within a group of characters
1682
Ignore patterns may also be Python regular expressions.
1683
Regular expression ignore patterns are identified by a 'RE:' prefix
1684
followed by the regular expression. Regular expression ignore patterns
1685
may not include named or numbered groups.
1687
Note: ignore patterns containing shell wildcards must be quoted from
1691
bzr ignore ./Makefile
1692
bzr ignore '*.class'
1693
bzr ignore 'lib/**/*.o'
1694
bzr ignore 'RE:lib/.*\.o'
1696
takes_args = ['name_pattern*']
1698
Option('old-default-rules',
1699
help='Out the ignore rules bzr < 0.9 always used.')
1702
def run(self, name_pattern_list=None, old_default_rules=None):
1703
from bzrlib.atomicfile import AtomicFile
1704
if old_default_rules is not None:
1705
# dump the rules and exit
1706
for pattern in ignores.OLD_DEFAULTS:
1709
if not name_pattern_list:
1710
raise errors.BzrCommandError("ignore requires at least one "
1711
"NAME_PATTERN or --old-default-rules")
1712
for name_pattern in name_pattern_list:
1713
if name_pattern[0] == '/':
1714
raise errors.BzrCommandError(
1715
"NAME_PATTERN should not be an absolute path")
1716
tree, relpath = WorkingTree.open_containing(u'.')
1717
ifn = tree.abspath('.bzrignore')
1718
if os.path.exists(ifn):
1721
igns = f.read().decode('utf-8')
1727
# TODO: If the file already uses crlf-style termination, maybe
1728
# we should use that for the newly added lines?
1730
if igns and igns[-1] != '\n':
1732
for name_pattern in name_pattern_list:
1733
igns += name_pattern.rstrip('/') + '\n'
1735
f = AtomicFile(ifn, 'wb')
1737
f.write(igns.encode('utf-8'))
1742
inv = tree.inventory
1743
if inv.path2id('.bzrignore'):
1744
mutter('.bzrignore is already versioned')
1746
mutter('need to make new .bzrignore file versioned')
1747
tree.add(['.bzrignore'])
1750
class cmd_ignored(Command):
1751
"""List ignored files and the patterns that matched them.
1753
See also: bzr ignore"""
1756
tree = WorkingTree.open_containing(u'.')[0]
1757
for path, file_class, kind, file_id, entry in tree.list_files():
1758
if file_class != 'I':
1760
## XXX: Slightly inefficient since this was already calculated
1761
pat = tree.is_ignored(path)
1762
print '%-50s %s' % (path, pat)
1765
class cmd_lookup_revision(Command):
1766
"""Lookup the revision-id from a revision-number
1769
bzr lookup-revision 33
1772
takes_args = ['revno']
1775
def run(self, revno):
1779
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1781
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1784
class cmd_export(Command):
1785
"""Export past revision to destination directory.
1787
If no revision is specified this exports the last committed revision.
1789
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1790
given, try to find the format with the extension. If no extension
1791
is found exports to a directory (equivalent to --format=dir).
1793
Root may be the top directory for tar, tgz and tbz2 formats. If none
1794
is given, the top directory will be the root name of the file.
1796
If branch is omitted then the branch containing the CWD will be used.
1798
Note: export of tree with non-ascii filenames to zip is not supported.
1800
Supported formats Autodetected by extension
1801
----------------- -------------------------
1804
tbz2 .tar.bz2, .tbz2
1808
takes_args = ['dest', 'branch?']
1809
takes_options = ['revision', 'format', 'root']
1810
def run(self, dest, branch=None, revision=None, format=None, root=None):
1811
from bzrlib.export import export
1814
tree = WorkingTree.open_containing(u'.')[0]
1817
b = Branch.open(branch)
1819
if revision is None:
1820
# should be tree.last_revision FIXME
1821
rev_id = b.last_revision()
1823
if len(revision) != 1:
1824
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1825
rev_id = revision[0].in_history(b).rev_id
1826
t = b.repository.revision_tree(rev_id)
1828
export(t, dest, format, root)
1829
except errors.NoSuchExportFormat, e:
1830
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1833
class cmd_cat(Command):
1834
"""Write a file's text from a previous revision."""
1836
takes_options = ['revision', 'name-from-revision']
1837
takes_args = ['filename']
1838
encoding_type = 'exact'
1841
def run(self, filename, revision=None, name_from_revision=False):
1842
if revision is not None and len(revision) != 1:
1843
raise errors.BzrCommandError("bzr cat --revision takes exactly"
1848
tree, relpath = WorkingTree.open_containing(filename)
1850
except (errors.NotBranchError, errors.NotLocalUrl):
1853
if revision is not None and revision[0].get_branch() is not None:
1854
b = Branch.open(revision[0].get_branch())
1856
b, relpath = Branch.open_containing(filename)
1857
tree = b.basis_tree()
1858
if revision is None:
1859
revision_id = b.last_revision()
1861
revision_id = revision[0].in_history(b).rev_id
1863
cur_file_id = tree.path2id(relpath)
1864
rev_tree = b.repository.revision_tree(revision_id)
1865
old_file_id = rev_tree.path2id(relpath)
1867
if name_from_revision:
1868
if old_file_id is None:
1869
raise errors.BzrCommandError("%r is not present in revision %s"
1870
% (filename, revision_id))
1872
rev_tree.print_file(old_file_id)
1873
elif cur_file_id is not None:
1874
rev_tree.print_file(cur_file_id)
1875
elif old_file_id is not None:
1876
rev_tree.print_file(old_file_id)
1878
raise errors.BzrCommandError("%r is not present in revision %s" %
1879
(filename, revision_id))
1882
class cmd_local_time_offset(Command):
1883
"""Show the offset in seconds from GMT to local time."""
1887
print osutils.local_time_offset()
1891
class cmd_commit(Command):
1892
"""Commit changes into a new revision.
1894
If no arguments are given, the entire tree is committed.
1896
If selected files are specified, only changes to those files are
1897
committed. If a directory is specified then the directory and everything
1898
within it is committed.
1900
A selected-file commit may fail in some cases where the committed
1901
tree would be invalid, such as trying to commit a file in a
1902
newly-added directory that is not itself committed.
1904
# TODO: Run hooks on tree to-be-committed, and after commit.
1906
# TODO: Strict commit that fails if there are deleted files.
1907
# (what does "deleted files" mean ??)
1909
# TODO: Give better message for -s, --summary, used by tla people
1911
# XXX: verbose currently does nothing
1913
takes_args = ['selected*']
1914
takes_options = ['message', 'verbose',
1916
help='commit even if nothing has changed'),
1917
Option('file', type=str,
1920
help='file containing commit message'),
1922
help="refuse to commit if there are unknown "
1923
"files in the working tree."),
1925
help="perform a local only commit in a bound "
1926
"branch. Such commits are not pushed to "
1927
"the master branch until a normal commit "
1931
aliases = ['ci', 'checkin']
1933
def run(self, message=None, file=None, verbose=True, selected_list=None,
1934
unchanged=False, strict=False, local=False):
1935
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1936
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1938
from bzrlib.msgeditor import edit_commit_message, \
1939
make_commit_message_template
1941
# TODO: Need a blackbox test for invoking the external editor; may be
1942
# slightly problematic to run this cross-platform.
1944
# TODO: do more checks that the commit will succeed before
1945
# spending the user's valuable time typing a commit message.
1946
tree, selected_list = tree_files(selected_list)
1947
if selected_list == ['']:
1948
# workaround - commit of root of tree should be exactly the same
1949
# as just default commit in that tree, and succeed even though
1950
# selected-file merge commit is not done yet
1953
if local and not tree.branch.get_bound_location():
1954
raise errors.LocalRequiresBoundBranch()
1956
def get_message(commit_obj):
1957
"""Callback to get commit message"""
1958
my_message = message
1959
if my_message is None and not file:
1960
template = make_commit_message_template(tree, selected_list)
1961
my_message = edit_commit_message(template)
1962
if my_message is None:
1963
raise errors.BzrCommandError("please specify a commit"
1964
" message with either --message or --file")
1965
elif my_message and file:
1966
raise errors.BzrCommandError(
1967
"please specify either --message or --file")
1969
my_message = codecs.open(file, 'rt',
1970
bzrlib.user_encoding).read()
1971
if my_message == "":
1972
raise errors.BzrCommandError("empty commit message specified")
1976
reporter = ReportCommitToLog()
1978
reporter = NullCommitReporter()
1981
tree.commit(message_callback=get_message,
1982
specific_files=selected_list,
1983
allow_pointless=unchanged, strict=strict, local=local,
1985
except PointlessCommit:
1986
# FIXME: This should really happen before the file is read in;
1987
# perhaps prepare the commit; get the message; then actually commit
1988
raise errors.BzrCommandError("no changes to commit."
1989
" use --unchanged to commit anyhow")
1990
except ConflictsInTree:
1991
raise errors.BzrCommandError('Conflicts detected in working '
1992
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
1994
except StrictCommitFailed:
1995
raise errors.BzrCommandError("Commit refused because there are"
1996
" unknown files in the working tree.")
1997
except errors.BoundBranchOutOfDate, e:
1998
raise errors.BzrCommandError(str(e) + "\n"
1999
'To commit to master branch, run update and then commit.\n'
2000
'You can also pass --local to commit to continue working '
2004
class cmd_check(Command):
2005
"""Validate consistency of branch history.
2007
This command checks various invariants about the branch storage to
2008
detect data corruption or bzr bugs.
2010
takes_args = ['branch?']
2011
takes_options = ['verbose']
2013
def run(self, branch=None, verbose=False):
2014
from bzrlib.check import check
2016
tree = WorkingTree.open_containing()[0]
2017
branch = tree.branch
2019
branch = Branch.open(branch)
2020
check(branch, verbose)
2023
class cmd_upgrade(Command):
2024
"""Upgrade branch storage to current format.
2026
The check command or bzr developers may sometimes advise you to run
2027
this command. When the default format has changed you may also be warned
2028
during other operations to upgrade.
2030
takes_args = ['url?']
2033
help='Upgrade to a specific format. Current formats'
2034
' are: default, knit, metaweave and weave.'
2035
' Default is knit; metaweave and weave are'
2037
type=get_format_type),
2041
def run(self, url='.', format=None):
2042
from bzrlib.upgrade import upgrade
2044
format = get_format_type('default')
2045
upgrade(url, format)
2048
class cmd_whoami(Command):
2049
"""Show or set bzr user id.
2053
bzr whoami 'Frank Chu <fchu@example.com>'
2055
takes_options = [ Option('email',
2056
help='display email address only'),
2058
help='set identity for the current branch instead of '
2061
takes_args = ['name?']
2062
encoding_type = 'replace'
2065
def run(self, email=False, branch=False, name=None):
2067
# use branch if we're inside one; otherwise global config
2069
c = Branch.open_containing('.')[0].get_config()
2070
except errors.NotBranchError:
2071
c = config.GlobalConfig()
2073
self.outf.write(c.user_email() + '\n')
2075
self.outf.write(c.username() + '\n')
2078
# display a warning if an email address isn't included in the given name.
2080
config.extract_email_address(name)
2081
except errors.NoEmailInUsername, e:
2082
warning('"%s" does not seem to contain an email address. '
2083
'This is allowed, but not recommended.', name)
2085
# use global config unless --branch given
2087
c = Branch.open_containing('.')[0].get_config()
2089
c = config.GlobalConfig()
2090
c.set_user_option('email', name)
2093
class cmd_nick(Command):
2094
"""Print or set the branch nickname.
2096
If unset, the tree root directory name is used as the nickname
2097
To print the current nickname, execute with no argument.
2099
takes_args = ['nickname?']
2100
def run(self, nickname=None):
2101
branch = Branch.open_containing(u'.')[0]
2102
if nickname is None:
2103
self.printme(branch)
2105
branch.nick = nickname
2108
def printme(self, branch):
2112
class cmd_selftest(Command):
2113
"""Run internal test suite.
2115
This creates temporary test directories in the working directory,
2116
but not existing data is affected. These directories are deleted
2117
if the tests pass, or left behind to help in debugging if they
2118
fail and --keep-output is specified.
2120
If arguments are given, they are regular expressions that say
2121
which tests should run.
2123
If the global option '--no-plugins' is given, plugins are not loaded
2124
before running the selftests. This has two effects: features provided or
2125
modified by plugins will not be tested, and tests provided by plugins will
2130
bzr --no-plugins selftest -v
2132
# TODO: --list should give a list of all available tests
2134
# NB: this is used from the class without creating an instance, which is
2135
# why it does not have a self parameter.
2136
def get_transport_type(typestring):
2137
"""Parse and return a transport specifier."""
2138
if typestring == "sftp":
2139
from bzrlib.transport.sftp import SFTPAbsoluteServer
2140
return SFTPAbsoluteServer
2141
if typestring == "memory":
2142
from bzrlib.transport.memory import MemoryServer
2144
if typestring == "fakenfs":
2145
from bzrlib.transport.fakenfs import FakeNFSServer
2146
return FakeNFSServer
2147
msg = "No known transport type %s. Supported types are: sftp\n" %\
2149
raise errors.BzrCommandError(msg)
2152
takes_args = ['testspecs*']
2153
takes_options = ['verbose',
2154
Option('one', help='stop when one test fails'),
2155
Option('keep-output',
2156
help='keep output directories when tests fail'),
2158
help='Use a different transport by default '
2159
'throughout the test suite.',
2160
type=get_transport_type),
2161
Option('benchmark', help='run the bzr bencharks.'),
2162
Option('lsprof-timed',
2163
help='generate lsprof output for benchmarked'
2164
' sections of code.'),
2165
Option('cache-dir', type=str,
2166
help='a directory to cache intermediate'
2167
' benchmark steps'),
2168
Option('clean-output',
2169
help='clean temporary tests directories'
2170
' without running tests'),
2172
encoding_type = 'replace'
2174
def run(self, testspecs_list=None, verbose=None, one=False,
2175
keep_output=False, transport=None, benchmark=None,
2176
lsprof_timed=None, cache_dir=None, clean_output=False):
2178
from bzrlib.tests import selftest
2179
import bzrlib.benchmarks as benchmarks
2180
from bzrlib.benchmarks import tree_creator
2183
from bzrlib.tests import clean_selftest_output
2184
clean_selftest_output()
2187
if cache_dir is not None:
2188
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2189
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2190
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2192
if testspecs_list is not None:
2193
pattern = '|'.join(testspecs_list)
2197
test_suite_factory = benchmarks.test_suite
2200
# TODO: should possibly lock the history file...
2201
benchfile = open(".perf_history", "at", buffering=1)
2203
test_suite_factory = None
2208
result = selftest(verbose=verbose,
2210
stop_on_failure=one,
2211
keep_output=keep_output,
2212
transport=transport,
2213
test_suite_factory=test_suite_factory,
2214
lsprof_timed=lsprof_timed,
2215
bench_history=benchfile)
2217
if benchfile is not None:
2220
info('tests passed')
2222
info('tests failed')
2223
return int(not result)
2226
class cmd_version(Command):
2227
"""Show version of bzr."""
2231
from bzrlib.version import show_version
2235
class cmd_rocks(Command):
2236
"""Statement of optimism."""
2242
print "it sure does!"
2245
class cmd_find_merge_base(Command):
2246
"""Find and print a base revision for merging two branches."""
2247
# TODO: Options to specify revisions on either side, as if
2248
# merging only part of the history.
2249
takes_args = ['branch', 'other']
2253
def run(self, branch, other):
2254
from bzrlib.revision import MultipleRevisionSources
2256
branch1 = Branch.open_containing(branch)[0]
2257
branch2 = Branch.open_containing(other)[0]
2259
history_1 = branch1.revision_history()
2260
history_2 = branch2.revision_history()
2262
last1 = branch1.last_revision()
2263
last2 = branch2.last_revision()
2265
source = MultipleRevisionSources(branch1.repository,
2268
base_rev_id = common_ancestor(last1, last2, source)
2270
print 'merge base is revision %s' % base_rev_id
2273
class cmd_merge(Command):
2274
"""Perform a three-way merge.
2276
The branch is the branch you will merge from. By default, it will merge
2277
the latest revision. If you specify a revision, that revision will be
2278
merged. If you specify two revisions, the first will be used as a BASE,
2279
and the second one as OTHER. Revision numbers are always relative to the
2282
By default, bzr will try to merge in all new work from the other
2283
branch, automatically determining an appropriate base. If this
2284
fails, you may need to give an explicit base.
2286
Merge will do its best to combine the changes in two branches, but there
2287
are some kinds of problems only a human can fix. When it encounters those,
2288
it will mark a conflict. A conflict means that you need to fix something,
2289
before you should commit.
2291
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2293
If there is no default branch set, the first merge will set it. After
2294
that, you can omit the branch to use the default. To change the
2295
default, use --remember. The value will only be saved if the remote
2296
location can be accessed.
2300
To merge the latest revision from bzr.dev
2301
bzr merge ../bzr.dev
2303
To merge changes up to and including revision 82 from bzr.dev
2304
bzr merge -r 82 ../bzr.dev
2306
To merge the changes introduced by 82, without previous changes:
2307
bzr merge -r 81..82 ../bzr.dev
2309
merge refuses to run if there are any uncommitted changes, unless
2312
The following merge types are available:
2314
takes_args = ['branch?']
2315
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2316
Option('show-base', help="Show base revision text in "
2318
Option('uncommitted', help='Apply uncommitted changes'
2319
' from a working copy, instead of branch changes'),
2320
Option('pull', help='If the destination is already'
2321
' completely merged into the source, pull from the'
2322
' source rather than merging. When this happens,'
2323
' you do not need to commit the result.'),
2327
from inspect import getdoc
2328
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2330
def run(self, branch=None, revision=None, force=False, merge_type=None,
2331
show_base=False, reprocess=False, remember=False,
2332
uncommitted=False, pull=False):
2333
if merge_type is None:
2334
merge_type = _mod_merge.Merge3Merger
2336
tree = WorkingTree.open_containing(u'.')[0]
2338
if branch is not None:
2340
reader = bundle.read_bundle_from_url(branch)
2341
except errors.NotABundle:
2342
pass # Continue on considering this url a Branch
2344
conflicts = merge_bundle(reader, tree, not force, merge_type,
2345
reprocess, show_base)
2351
if revision is None \
2352
or len(revision) < 1 or revision[0].needs_branch():
2353
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2355
if revision is None or len(revision) < 1:
2358
other = [branch, None]
2361
other = [branch, -1]
2362
other_branch, path = Branch.open_containing(branch)
2365
raise errors.BzrCommandError('Cannot use --uncommitted and'
2366
' --revision at the same time.')
2367
branch = revision[0].get_branch() or branch
2368
if len(revision) == 1:
2370
other_branch, path = Branch.open_containing(branch)
2371
revno = revision[0].in_history(other_branch).revno
2372
other = [branch, revno]
2374
assert len(revision) == 2
2375
if None in revision:
2376
raise errors.BzrCommandError(
2377
"Merge doesn't permit empty revision specifier.")
2378
base_branch, path = Branch.open_containing(branch)
2379
branch1 = revision[1].get_branch() or branch
2380
other_branch, path1 = Branch.open_containing(branch1)
2381
if revision[0].get_branch() is not None:
2382
# then path was obtained from it, and is None.
2385
base = [branch, revision[0].in_history(base_branch).revno]
2386
other = [branch1, revision[1].in_history(other_branch).revno]
2388
if tree.branch.get_parent() is None or remember:
2389
tree.branch.set_parent(other_branch.base)
2392
interesting_files = [path]
2394
interesting_files = None
2395
pb = ui.ui_factory.nested_progress_bar()
2398
conflict_count = _merge_helper(
2399
other, base, check_clean=(not force),
2400
merge_type=merge_type,
2401
reprocess=reprocess,
2402
show_base=show_base,
2404
pb=pb, file_list=interesting_files)
2407
if conflict_count != 0:
2411
except errors.AmbiguousBase, e:
2412
m = ("sorry, bzr can't determine the right merge base yet\n"
2413
"candidates are:\n "
2414
+ "\n ".join(e.bases)
2416
"please specify an explicit base with -r,\n"
2417
"and (if you want) report this to the bzr developers\n")
2420
# TODO: move up to common parent; this isn't merge-specific anymore.
2421
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2422
"""Use tree.branch's parent if none was supplied.
2424
Report if the remembered location was used.
2426
if supplied_location is not None:
2427
return supplied_location
2428
stored_location = tree.branch.get_parent()
2429
mutter("%s", stored_location)
2430
if stored_location is None:
2431
raise errors.BzrCommandError("No location specified or remembered")
2432
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2433
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2434
return stored_location
2437
class cmd_remerge(Command):
2440
Use this if you want to try a different merge technique while resolving
2441
conflicts. Some merge techniques are better than others, and remerge
2442
lets you try different ones on different files.
2444
The options for remerge have the same meaning and defaults as the ones for
2445
merge. The difference is that remerge can (only) be run when there is a
2446
pending merge, and it lets you specify particular files.
2449
$ bzr remerge --show-base
2450
Re-do the merge of all conflicted files, and show the base text in
2451
conflict regions, in addition to the usual THIS and OTHER texts.
2453
$ bzr remerge --merge-type weave --reprocess foobar
2454
Re-do the merge of "foobar", using the weave merge algorithm, with
2455
additional processing to reduce the size of conflict regions.
2457
The following merge types are available:"""
2458
takes_args = ['file*']
2459
takes_options = ['merge-type', 'reprocess',
2460
Option('show-base', help="Show base revision text in "
2464
from inspect import getdoc
2465
return getdoc(self) + '\n' + _mod_merge.merge_type_help()
2467
def run(self, file_list=None, merge_type=None, show_base=False,
2469
if merge_type is None:
2470
merge_type = _mod_merge.Merge3Merger
2471
tree, file_list = tree_files(file_list)
2474
parents = tree.get_parent_ids()
2475
if len(parents) != 2:
2476
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2477
" merges. Not cherrypicking or"
2479
repository = tree.branch.repository
2480
base_revision = common_ancestor(parents[0],
2481
parents[1], repository)
2482
base_tree = repository.revision_tree(base_revision)
2483
other_tree = repository.revision_tree(parents[1])
2484
interesting_ids = None
2486
conflicts = tree.conflicts()
2487
if file_list is not None:
2488
interesting_ids = set()
2489
for filename in file_list:
2490
file_id = tree.path2id(filename)
2492
raise errors.NotVersionedError(filename)
2493
interesting_ids.add(file_id)
2494
if tree.kind(file_id) != "directory":
2497
for name, ie in tree.inventory.iter_entries(file_id):
2498
interesting_ids.add(ie.file_id)
2499
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2501
# Remerge only supports resolving contents conflicts
2502
allowed_conflicts = ('text conflict', 'contents conflict')
2503
restore_files = [c.path for c in conflicts
2504
if c.typestring in allowed_conflicts]
2505
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2506
tree.set_conflicts(ConflictList(new_conflicts))
2507
if file_list is not None:
2508
restore_files = file_list
2509
for filename in restore_files:
2511
restore(tree.abspath(filename))
2512
except errors.NotConflicted:
2514
conflicts = _mod_merge.merge_inner(
2515
tree.branch, other_tree, base_tree,
2517
interesting_ids=interesting_ids,
2518
other_rev_id=parents[1],
2519
merge_type=merge_type,
2520
show_base=show_base,
2521
reprocess=reprocess)
2530
class cmd_revert(Command):
2531
"""Revert files to a previous revision.
2533
Giving a list of files will revert only those files. Otherwise, all files
2534
will be reverted. If the revision is not specified with '--revision', the
2535
last committed revision is used.
2537
To remove only some changes, without reverting to a prior version, use
2538
merge instead. For example, "merge . --r-2..-3" will remove the changes
2539
introduced by -2, without affecting the changes introduced by -1. Or
2540
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2542
By default, any files that have been manually changed will be backed up
2543
first. (Files changed only by merge are not backed up.) Backup files have
2544
'.~#~' appended to their name, where # is a number.
2546
When you provide files, you can use their current pathname or the pathname
2547
from the target revision. So you can use revert to "undelete" a file by
2548
name. If you name a directory, all the contents of that directory will be
2551
takes_options = ['revision', 'no-backup']
2552
takes_args = ['file*']
2553
aliases = ['merge-revert']
2555
def run(self, revision=None, no_backup=False, file_list=None):
2556
if file_list is not None:
2557
if len(file_list) == 0:
2558
raise errors.BzrCommandError("No files specified")
2562
tree, file_list = tree_files(file_list)
2563
if revision is None:
2564
# FIXME should be tree.last_revision
2565
rev_id = tree.last_revision()
2566
elif len(revision) != 1:
2567
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2569
rev_id = revision[0].in_history(tree.branch).rev_id
2570
pb = ui.ui_factory.nested_progress_bar()
2572
tree.revert(file_list,
2573
tree.branch.repository.revision_tree(rev_id),
2579
class cmd_assert_fail(Command):
2580
"""Test reporting of assertion failures"""
2581
# intended just for use in testing
2586
raise AssertionError("always fails")
2589
class cmd_help(Command):
2590
"""Show help on a command or other topic.
2592
For a list of all available commands, say 'bzr help commands'.
2594
takes_options = [Option('long', 'show help on all commands')]
2595
takes_args = ['topic?']
2596
aliases = ['?', '--help', '-?', '-h']
2599
def run(self, topic=None, long=False):
2601
if topic is None and long:
2603
bzrlib.help.help(topic)
2606
class cmd_shell_complete(Command):
2607
"""Show appropriate completions for context.
2609
For a list of all available commands, say 'bzr shell-complete'.
2611
takes_args = ['context?']
2616
def run(self, context=None):
2617
import shellcomplete
2618
shellcomplete.shellcomplete(context)
2621
class cmd_fetch(Command):
2622
"""Copy in history from another branch but don't merge it.
2624
This is an internal method used for pull and merge.
2627
takes_args = ['from_branch', 'to_branch']
2628
def run(self, from_branch, to_branch):
2629
from bzrlib.fetch import Fetcher
2630
from_b = Branch.open(from_branch)
2631
to_b = Branch.open(to_branch)
2632
Fetcher(to_b, from_b)
2635
class cmd_missing(Command):
2636
"""Show unmerged/unpulled revisions between two branches.
2638
OTHER_BRANCH may be local or remote.
2640
takes_args = ['other_branch?']
2641
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2643
'Display changes in the local branch only'),
2644
Option('theirs-only',
2645
'Display changes in the remote branch only'),
2653
encoding_type = 'replace'
2656
def run(self, other_branch=None, reverse=False, mine_only=False,
2657
theirs_only=False, log_format=None, long=False, short=False, line=False,
2658
show_ids=False, verbose=False):
2659
from bzrlib.missing import find_unmerged, iter_log_data
2660
from bzrlib.log import log_formatter
2661
local_branch = Branch.open_containing(u".")[0]
2662
parent = local_branch.get_parent()
2663
if other_branch is None:
2664
other_branch = parent
2665
if other_branch is None:
2666
raise errors.BzrCommandError("No peer location known or specified.")
2667
print "Using last location: " + local_branch.get_parent()
2668
remote_branch = Branch.open(other_branch)
2669
if remote_branch.base == local_branch.base:
2670
remote_branch = local_branch
2671
local_branch.lock_read()
2673
remote_branch.lock_read()
2675
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2676
if (log_format is None):
2677
default = local_branch.get_config().log_format()
2678
log_format = get_log_format(long=long, short=short,
2679
line=line, default=default)
2680
lf = log_formatter(log_format,
2683
show_timezone='original')
2684
if reverse is False:
2685
local_extra.reverse()
2686
remote_extra.reverse()
2687
if local_extra and not theirs_only:
2688
print "You have %d extra revision(s):" % len(local_extra)
2689
for data in iter_log_data(local_extra, local_branch.repository,
2692
printed_local = True
2694
printed_local = False
2695
if remote_extra and not mine_only:
2696
if printed_local is True:
2698
print "You are missing %d revision(s):" % len(remote_extra)
2699
for data in iter_log_data(remote_extra, remote_branch.repository,
2702
if not remote_extra and not local_extra:
2704
print "Branches are up to date."
2708
remote_branch.unlock()
2710
local_branch.unlock()
2711
if not status_code and parent is None and other_branch is not None:
2712
local_branch.lock_write()
2714
# handle race conditions - a parent might be set while we run.
2715
if local_branch.get_parent() is None:
2716
local_branch.set_parent(remote_branch.base)
2718
local_branch.unlock()
2722
class cmd_plugins(Command):
2727
import bzrlib.plugin
2728
from inspect import getdoc
2729
for name, plugin in bzrlib.plugin.all_plugins().items():
2730
if getattr(plugin, '__path__', None) is not None:
2731
print plugin.__path__[0]
2732
elif getattr(plugin, '__file__', None) is not None:
2733
print plugin.__file__
2739
print '\t', d.split('\n')[0]
2742
class cmd_testament(Command):
2743
"""Show testament (signing-form) of a revision."""
2744
takes_options = ['revision',
2745
Option('long', help='Produce long-format testament'),
2746
Option('strict', help='Produce a strict-format'
2748
takes_args = ['branch?']
2750
def run(self, branch=u'.', revision=None, long=False, strict=False):
2751
from bzrlib.testament import Testament, StrictTestament
2753
testament_class = StrictTestament
2755
testament_class = Testament
2756
b = WorkingTree.open_containing(branch)[0].branch
2759
if revision is None:
2760
rev_id = b.last_revision()
2762
rev_id = revision[0].in_history(b).rev_id
2763
t = testament_class.from_revision(b.repository, rev_id)
2765
sys.stdout.writelines(t.as_text_lines())
2767
sys.stdout.write(t.as_short_text())
2772
class cmd_annotate(Command):
2773
"""Show the origin of each line in a file.
2775
This prints out the given file with an annotation on the left side
2776
indicating which revision, author and date introduced the change.
2778
If the origin is the same for a run of consecutive lines, it is
2779
shown only at the top, unless the --all option is given.
2781
# TODO: annotate directories; showing when each file was last changed
2782
# TODO: if the working copy is modified, show annotations on that
2783
# with new uncommitted lines marked
2784
aliases = ['ann', 'blame', 'praise']
2785
takes_args = ['filename']
2786
takes_options = [Option('all', help='show annotations on all lines'),
2787
Option('long', help='show date in annotations'),
2793
def run(self, filename, all=False, long=False, revision=None,
2795
from bzrlib.annotate import annotate_file
2796
tree, relpath = WorkingTree.open_containing(filename)
2797
branch = tree.branch
2800
if revision is None:
2801
revision_id = branch.last_revision()
2802
elif len(revision) != 1:
2803
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2805
revision_id = revision[0].in_history(branch).rev_id
2806
file_id = tree.inventory.path2id(relpath)
2807
tree = branch.repository.revision_tree(revision_id)
2808
file_version = tree.inventory[file_id].revision
2809
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
2815
class cmd_re_sign(Command):
2816
"""Create a digital signature for an existing revision."""
2817
# TODO be able to replace existing ones.
2819
hidden = True # is this right ?
2820
takes_args = ['revision_id*']
2821
takes_options = ['revision']
2823
def run(self, revision_id_list=None, revision=None):
2824
import bzrlib.gpg as gpg
2825
if revision_id_list is not None and revision is not None:
2826
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2827
if revision_id_list is None and revision is None:
2828
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2829
b = WorkingTree.open_containing(u'.')[0].branch
2830
gpg_strategy = gpg.GPGStrategy(b.get_config())
2831
if revision_id_list is not None:
2832
for revision_id in revision_id_list:
2833
b.repository.sign_revision(revision_id, gpg_strategy)
2834
elif revision is not None:
2835
if len(revision) == 1:
2836
revno, rev_id = revision[0].in_history(b)
2837
b.repository.sign_revision(rev_id, gpg_strategy)
2838
elif len(revision) == 2:
2839
# are they both on rh- if so we can walk between them
2840
# might be nice to have a range helper for arbitrary
2841
# revision paths. hmm.
2842
from_revno, from_revid = revision[0].in_history(b)
2843
to_revno, to_revid = revision[1].in_history(b)
2844
if to_revid is None:
2845
to_revno = b.revno()
2846
if from_revno is None or to_revno is None:
2847
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
2848
for revno in range(from_revno, to_revno + 1):
2849
b.repository.sign_revision(b.get_rev_id(revno),
2852
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2855
class cmd_bind(Command):
2856
"""Bind the current branch to a master branch.
2858
After binding, commits must succeed on the master branch
2859
before they are executed on the local one.
2862
takes_args = ['location']
2865
def run(self, location=None):
2866
b, relpath = Branch.open_containing(u'.')
2867
b_other = Branch.open(location)
2870
except errors.DivergedBranches:
2871
raise errors.BzrCommandError('These branches have diverged.'
2872
' Try merging, and then bind again.')
2875
class cmd_unbind(Command):
2876
"""Unbind the current branch from its master branch.
2878
After unbinding, the local branch is considered independent.
2879
All subsequent commits will be local.
2886
b, relpath = Branch.open_containing(u'.')
2888
raise errors.BzrCommandError('Local branch is not bound')
2891
class cmd_uncommit(Command):
2892
"""Remove the last committed revision.
2894
--verbose will print out what is being removed.
2895
--dry-run will go through all the motions, but not actually
2898
In the future, uncommit will create a revision bundle, which can then
2902
# TODO: jam 20060108 Add an option to allow uncommit to remove
2903
# unreferenced information in 'branch-as-repository' branches.
2904
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2905
# information in shared branches as well.
2906
takes_options = ['verbose', 'revision',
2907
Option('dry-run', help='Don\'t actually make changes'),
2908
Option('force', help='Say yes to all questions.')]
2909
takes_args = ['location?']
2912
def run(self, location=None,
2913
dry_run=False, verbose=False,
2914
revision=None, force=False):
2915
from bzrlib.log import log_formatter, show_log
2917
from bzrlib.uncommit import uncommit
2919
if location is None:
2921
control, relpath = bzrdir.BzrDir.open_containing(location)
2923
tree = control.open_workingtree()
2925
except (errors.NoWorkingTree, errors.NotLocalUrl):
2927
b = control.open_branch()
2930
if revision is None:
2933
# 'bzr uncommit -r 10' actually means uncommit
2934
# so that the final tree is at revno 10.
2935
# but bzrlib.uncommit.uncommit() actually uncommits
2936
# the revisions that are supplied.
2937
# So we need to offset it by one
2938
revno = revision[0].in_history(b).revno+1
2940
if revno <= b.revno():
2941
rev_id = b.get_rev_id(revno)
2943
self.outf.write('No revisions to uncommit.\n')
2946
lf = log_formatter('short',
2948
show_timezone='original')
2953
direction='forward',
2954
start_revision=revno,
2955
end_revision=b.revno())
2958
print 'Dry-run, pretending to remove the above revisions.'
2960
val = raw_input('Press <enter> to continue')
2962
print 'The above revision(s) will be removed.'
2964
val = raw_input('Are you sure [y/N]? ')
2965
if val.lower() not in ('y', 'yes'):
2969
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2973
class cmd_break_lock(Command):
2974
"""Break a dead lock on a repository, branch or working directory.
2976
CAUTION: Locks should only be broken when you are sure that the process
2977
holding the lock has been stopped.
2979
You can get information on what locks are open via the 'bzr info' command.
2984
takes_args = ['location?']
2986
def run(self, location=None, show=False):
2987
if location is None:
2989
control, relpath = bzrdir.BzrDir.open_containing(location)
2991
control.break_lock()
2992
except NotImplementedError:
2996
class cmd_wait_until_signalled(Command):
2997
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
2999
This just prints a line to signal when it is ready, then blocks on stdin.
3005
sys.stdout.write("running\n")
3007
sys.stdin.readline()
3010
class cmd_serve(Command):
3011
"""Run the bzr server."""
3013
aliases = ['server']
3017
help='serve on stdin/out for use from inetd or sshd'),
3019
help='listen for connections on nominated port of the form '
3020
'[hostname:]portnumber. Passing 0 as the port number will '
3021
'result in a dynamically allocated port.',
3024
help='serve contents of directory',
3026
Option('allow-writes',
3027
help='By default the server is a readonly server. Supplying '
3028
'--allow-writes enables write access to the contents of '
3029
'the served directory and below. '
3033
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3034
from bzrlib.transport import smart
3035
from bzrlib.transport import get_transport
3036
if directory is None:
3037
directory = os.getcwd()
3038
url = urlutils.local_path_to_url(directory)
3039
if not allow_writes:
3040
url = 'readonly+' + url
3041
t = get_transport(url)
3043
server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
3044
elif port is not None:
3046
host, port = port.split(':')
3049
server = smart.SmartTCPServer(t, host=host, port=int(port))
3050
print 'listening on port: ', server.port
3053
raise errors.BzrCommandError("bzr serve requires one of --inet or --port")
3057
# command-line interpretation helper for merge-related commands
3058
def _merge_helper(other_revision, base_revision,
3059
check_clean=True, ignore_zero=False,
3060
this_dir=None, backup_files=False,
3062
file_list=None, show_base=False, reprocess=False,
3064
pb=DummyProgress()):
3065
"""Merge changes into a tree.
3068
list(path, revno) Base for three-way merge.
3069
If [None, None] then a base will be automatically determined.
3071
list(path, revno) Other revision for three-way merge.
3073
Directory to merge changes into; '.' by default.
3075
If true, this_dir must have no uncommitted changes before the
3077
ignore_zero - If true, suppress the "zero conflicts" message when
3078
there are no conflicts; should be set when doing something we expect
3079
to complete perfectly.
3080
file_list - If supplied, merge only changes to selected files.
3082
All available ancestors of other_revision and base_revision are
3083
automatically pulled into the branch.
3085
The revno may be -1 to indicate the last revision on the branch, which is
3088
This function is intended for use from the command line; programmatic
3089
clients might prefer to call merge.merge_inner(), which has less magic
3092
# Loading it late, so that we don't always have to import bzrlib.merge
3093
if merge_type is None:
3094
merge_type = _mod_merge.Merge3Merger
3095
if this_dir is None:
3097
this_tree = WorkingTree.open_containing(this_dir)[0]
3098
if show_base and not merge_type is _mod_merge.Merge3Merger:
3099
raise errors.BzrCommandError("Show-base is not supported for this merge"
3100
" type. %s" % merge_type)
3101
if reprocess and not merge_type.supports_reprocess:
3102
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3103
" type %s." % merge_type)
3104
if reprocess and show_base:
3105
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3107
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3109
merger.pp = ProgressPhase("Merge phase", 5, pb)
3110
merger.pp.next_phase()
3111
merger.check_basis(check_clean)
3112
merger.set_other(other_revision)
3113
merger.pp.next_phase()
3114
merger.set_base(base_revision)
3115
if merger.base_rev_id == merger.other_rev_id:
3116
note('Nothing to do.')
3118
if file_list is None:
3119
if pull and merger.base_rev_id == merger.this_rev_id:
3120
count = merger.this_tree.pull(merger.this_branch,
3121
False, merger.other_rev_id)
3122
note('%d revision(s) pulled.' % (count,))
3124
merger.backup_files = backup_files
3125
merger.merge_type = merge_type
3126
merger.set_interesting_files(file_list)
3127
merger.show_base = show_base
3128
merger.reprocess = reprocess
3129
conflicts = merger.do_merge()
3130
if file_list is None:
3131
merger.set_pending()
3138
merge = _merge_helper
3141
# these get imported and then picked up by the scan for cmd_*
3142
# TODO: Some more consistent way to split command definitions across files;
3143
# we do need to load at least some information about them to know of
3144
# aliases. ideally we would avoid loading the implementation until the
3145
# details were needed.
3146
from bzrlib.cmd_version_info import cmd_version_info
3147
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3148
from bzrlib.bundle.commands import cmd_bundle_revisions
3149
from bzrlib.sign_my_commits import cmd_sign_my_commits
3150
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3151
cmd_weave_plan_merge, cmd_weave_merge_text