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"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
43
revision as _mod_revision,
50
from bzrlib.branch import Branch
51
from bzrlib.conflicts import ConflictList
52
from bzrlib.revisionspec import RevisionSpec
53
from bzrlib.smtp_connection import SMTPConnection
54
from bzrlib.workingtree import WorkingTree
57
from bzrlib.commands import Command, display_command
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
59
from bzrlib.trace import mutter, note, warning, is_quiet, info
62
def tree_files(file_list, default_branch=u'.'):
64
return internal_tree_files(file_list, default_branch)
65
except errors.FileInWrongBranch, e:
66
raise errors.BzrCommandError("%s is not in the same branch as %s" %
67
(e.path, file_list[0]))
70
# XXX: Bad function name; should possibly also be a class method of
71
# WorkingTree rather than a function.
72
def internal_tree_files(file_list, default_branch=u'.'):
73
"""Convert command-line paths to a WorkingTree and relative paths.
75
This is typically used for command-line processors that take one or
76
more filenames, and infer the workingtree that contains them.
78
The filenames given are not required to exist.
80
:param file_list: Filenames to convert.
82
:param default_branch: Fallback tree path to use if file_list is empty or
85
:return: workingtree, [relative_paths]
87
if file_list is None or len(file_list) == 0:
88
return WorkingTree.open_containing(default_branch)[0], file_list
89
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
91
for filename in file_list:
93
new_list.append(tree.relpath(osutils.dereference_path(filename)))
94
except errors.PathNotChild:
95
raise errors.FileInWrongBranch(tree.branch, filename)
99
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
100
def get_format_type(typestring):
101
"""Parse and return a format specifier."""
102
# Have to use BzrDirMetaFormat1 directly, so that
103
# RepositoryFormat.set_default_format works
104
if typestring == "default":
105
return bzrdir.BzrDirMetaFormat1()
107
return bzrdir.format_registry.make_bzrdir(typestring)
109
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
110
raise errors.BzrCommandError(msg)
113
# TODO: Make sure no commands unconditionally use the working directory as a
114
# branch. If a filename argument is used, the first of them should be used to
115
# specify the branch. (Perhaps this can be factored out into some kind of
116
# Argument class, representing a file in a branch, where the first occurrence
119
class cmd_status(Command):
120
"""Display status summary.
122
This reports on versioned and unknown files, reporting them
123
grouped by state. Possible states are:
126
Versioned in the working copy but not in the previous revision.
129
Versioned in the previous revision but removed or deleted
133
Path of this file changed from the previous revision;
134
the text may also have changed. This includes files whose
135
parent directory was renamed.
138
Text has changed since the previous revision.
141
File kind has been changed (e.g. from file to directory).
144
Not versioned and not matching an ignore pattern.
146
To see ignored files use 'bzr ignored'. For details on the
147
changes to file texts, use 'bzr diff'.
149
Note that --short or -S gives status flags for each item, similar
150
to Subversion's status command. To get output similar to svn -q,
153
If no arguments are specified, the status of the entire working
154
directory is shown. Otherwise, only the status of the specified
155
files or directories is reported. If a directory is given, status
156
is reported for everything inside that directory.
158
If a revision argument is given, the status is calculated against
159
that revision, or between two revisions if two are provided.
162
# TODO: --no-recurse, --recurse options
164
takes_args = ['file*']
165
takes_options = ['show-ids', 'revision', 'change',
166
Option('short', help='Use short status indicators.',
168
Option('versioned', help='Only show versioned files.',
171
aliases = ['st', 'stat']
173
encoding_type = 'replace'
174
_see_also = ['diff', 'revert', 'status-flags']
177
def run(self, show_ids=False, file_list=None, revision=None, short=False,
179
from bzrlib.status import show_tree_status
181
if revision and len(revision) > 2:
182
raise errors.BzrCommandError('bzr status --revision takes exactly'
183
' one or two revision specifiers')
185
tree, file_list = tree_files(file_list)
187
show_tree_status(tree, show_ids=show_ids,
188
specific_files=file_list, revision=revision,
189
to_file=self.outf, short=short, versioned=versioned)
192
class cmd_cat_revision(Command):
193
"""Write out metadata for a revision.
195
The revision to print can either be specified by a specific
196
revision identifier, or you can use --revision.
200
takes_args = ['revision_id?']
201
takes_options = ['revision']
202
# cat-revision is more for frontends so should be exact
206
def run(self, revision_id=None, revision=None):
207
if revision_id is not None and revision is not None:
208
raise errors.BzrCommandError('You can only supply one of'
209
' revision_id or --revision')
210
if revision_id is None and revision is None:
211
raise errors.BzrCommandError('You must supply either'
212
' --revision or a revision_id')
213
b = WorkingTree.open_containing(u'.')[0].branch
215
# TODO: jam 20060112 should cat-revision always output utf-8?
216
if revision_id is not None:
217
revision_id = osutils.safe_revision_id(revision_id, warn=False)
218
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
219
elif revision is not None:
222
raise errors.BzrCommandError('You cannot specify a NULL'
224
revno, rev_id = rev.in_history(b)
225
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
228
class cmd_remove_tree(Command):
229
"""Remove the working tree from a given branch/checkout.
231
Since a lightweight checkout is little more than a working tree
232
this will refuse to run against one.
234
To re-create the working tree, use "bzr checkout".
236
_see_also = ['checkout', 'working-trees']
238
takes_args = ['location?']
240
def run(self, location='.'):
241
d = bzrdir.BzrDir.open(location)
244
working = d.open_workingtree()
245
except errors.NoWorkingTree:
246
raise errors.BzrCommandError("No working tree to remove")
247
except errors.NotLocalUrl:
248
raise errors.BzrCommandError("You cannot remove the working tree of a "
251
working_path = working.bzrdir.root_transport.base
252
branch_path = working.branch.bzrdir.root_transport.base
253
if working_path != branch_path:
254
raise errors.BzrCommandError("You cannot remove the working tree from "
255
"a lightweight checkout")
257
d.destroy_workingtree()
260
class cmd_revno(Command):
261
"""Show current revision number.
263
This is equal to the number of revisions on this branch.
267
takes_args = ['location?']
270
def run(self, location=u'.'):
271
self.outf.write(str(Branch.open_containing(location)[0].revno()))
272
self.outf.write('\n')
275
class cmd_revision_info(Command):
276
"""Show revision number and revision id for a given revision identifier.
279
takes_args = ['revision_info*']
280
takes_options = ['revision']
283
def run(self, revision=None, revision_info_list=[]):
286
if revision is not None:
287
revs.extend(revision)
288
if revision_info_list is not None:
289
for rev in revision_info_list:
290
revs.append(RevisionSpec.from_string(rev))
292
b = Branch.open_containing(u'.')[0]
295
revs.append(RevisionSpec.from_string('-1'))
298
revinfo = rev.in_history(b)
299
if revinfo.revno is None:
300
dotted_map = b.get_revision_id_to_revno_map()
301
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
302
print '%s %s' % (revno, 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. This option is rarely needed
336
but can be useful when adding the same logical file into two
337
branches that will be merged later (without showing the two different
338
adds as a conflict). It is also useful when merging another project
339
into a subdirectory of this one.
341
takes_args = ['file*']
344
help="Don't recursively add the contents of directories."),
346
help="Show what would be done, but don't actually do anything."),
348
Option('file-ids-from',
350
help='Lookup file ids from this tree.'),
352
encoding_type = 'replace'
353
_see_also = ['remove']
355
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
360
if file_ids_from is not None:
362
base_tree, base_path = WorkingTree.open_containing(
364
except errors.NoWorkingTree:
365
base_branch, base_path = Branch.open_containing(
367
base_tree = base_branch.basis_tree()
369
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
370
to_file=self.outf, should_print=(not is_quiet()))
372
action = bzrlib.add.AddAction(to_file=self.outf,
373
should_print=(not is_quiet()))
376
base_tree.lock_read()
378
file_list = self._maybe_expand_globs(file_list)
380
tree = WorkingTree.open_containing(file_list[0])[0]
382
tree = WorkingTree.open_containing(u'.')[0]
383
added, ignored = tree.smart_add(file_list, not
384
no_recurse, action=action, save=not dry_run)
386
if base_tree is not None:
390
for glob in sorted(ignored.keys()):
391
for path in ignored[glob]:
392
self.outf.write("ignored %s matching \"%s\"\n"
396
for glob, paths in ignored.items():
397
match_len += len(paths)
398
self.outf.write("ignored %d file(s).\n" % match_len)
399
self.outf.write("If you wish to add some of these files,"
400
" please add them by name.\n")
403
class cmd_mkdir(Command):
404
"""Create a new versioned directory.
406
This is equivalent to creating the directory and then adding it.
409
takes_args = ['dir+']
410
encoding_type = 'replace'
412
def run(self, dir_list):
415
wt, dd = WorkingTree.open_containing(d)
417
self.outf.write('added %s\n' % d)
420
class cmd_relpath(Command):
421
"""Show path of a file relative to root"""
423
takes_args = ['filename']
427
def run(self, filename):
428
# TODO: jam 20050106 Can relpath return a munged path if
429
# sys.stdout encoding cannot represent it?
430
tree, relpath = WorkingTree.open_containing(filename)
431
self.outf.write(relpath)
432
self.outf.write('\n')
435
class cmd_inventory(Command):
436
"""Show inventory of the current working copy or a revision.
438
It is possible to limit the output to a particular entry
439
type using the --kind option. For example: --kind file.
441
It is also possible to restrict the list of files to a specific
442
set. For example: bzr inventory --show-ids this/file
451
help='List entries of a particular kind: file, directory, symlink.',
454
takes_args = ['file*']
457
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
458
if kind and kind not in ['file', 'directory', 'symlink']:
459
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
461
work_tree, file_list = tree_files(file_list)
462
work_tree.lock_read()
464
if revision is not None:
465
if len(revision) > 1:
466
raise errors.BzrCommandError(
467
'bzr inventory --revision takes exactly one revision'
469
revision_id = revision[0].as_revision_id(work_tree.branch)
470
tree = work_tree.branch.repository.revision_tree(revision_id)
472
extra_trees = [work_tree]
478
if file_list is not None:
479
file_ids = tree.paths2ids(file_list, trees=extra_trees,
480
require_versioned=True)
481
# find_ids_across_trees may include some paths that don't
483
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
484
for file_id in file_ids if file_id in tree)
486
entries = tree.inventory.entries()
489
if tree is not work_tree:
492
for path, entry in entries:
493
if kind and kind != entry.kind:
496
self.outf.write('%-50s %s\n' % (path, entry.file_id))
498
self.outf.write(path)
499
self.outf.write('\n')
502
class cmd_mv(Command):
503
"""Move or rename a file.
506
bzr mv OLDNAME NEWNAME
508
bzr mv SOURCE... DESTINATION
510
If the last argument is a versioned directory, all the other names
511
are moved into it. Otherwise, there must be exactly two arguments
512
and the file is changed to a new name.
514
If OLDNAME does not exist on the filesystem but is versioned and
515
NEWNAME does exist on the filesystem but is not versioned, mv
516
assumes that the file has been manually moved and only updates
517
its internal inventory to reflect that change.
518
The same is valid when moving many SOURCE files to a DESTINATION.
520
Files cannot be moved between branches.
523
takes_args = ['names*']
524
takes_options = [Option("after", help="Move only the bzr identifier"
525
" of the file, because the file has already been moved."),
527
aliases = ['move', 'rename']
528
encoding_type = 'replace'
530
def run(self, names_list, after=False):
531
if names_list is None:
534
if len(names_list) < 2:
535
raise errors.BzrCommandError("missing file argument")
536
tree, rel_names = tree_files(names_list)
539
self._run(tree, names_list, rel_names, after)
543
def _run(self, tree, names_list, rel_names, after):
544
into_existing = osutils.isdir(names_list[-1])
545
if into_existing and len(names_list) == 2:
547
# a. case-insensitive filesystem and change case of dir
548
# b. move directory after the fact (if the source used to be
549
# a directory, but now doesn't exist in the working tree
550
# and the target is an existing directory, just rename it)
551
if (not tree.case_sensitive
552
and rel_names[0].lower() == rel_names[1].lower()):
553
into_existing = False
556
from_id = tree.path2id(rel_names[0])
557
if (not osutils.lexists(names_list[0]) and
558
from_id and inv.get_file_kind(from_id) == "directory"):
559
into_existing = False
562
# move into existing directory
563
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
564
self.outf.write("%s => %s\n" % pair)
566
if len(names_list) != 2:
567
raise errors.BzrCommandError('to mv multiple files the'
568
' destination must be a versioned'
570
tree.rename_one(rel_names[0], rel_names[1], after=after)
571
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
574
class cmd_pull(Command):
575
"""Turn this branch into a mirror of another branch.
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) into the parent.
581
If branches have diverged, you can use 'bzr merge' to integrate the changes
582
from one into the other. Once one branch has merged, the other should
583
be able to pull it again.
585
If you want to forget your local changes and just update your branch to
586
match the remote one, use pull --overwrite.
588
If there is no default location set, the first pull will set it. After
589
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
_see_also = ['push', 'update', 'status-flags']
595
takes_options = ['remember', 'overwrite', 'revision',
596
custom_help('verbose',
597
help='Show logs of pulled revisions.'),
599
help='Branch to pull into, '
600
'rather than the one containing the working directory.',
605
takes_args = ['location?']
606
encoding_type = 'replace'
608
def run(self, location=None, remember=False, overwrite=False,
609
revision=None, verbose=False,
611
# FIXME: too much stuff is in the command class
614
if directory is None:
617
tree_to = WorkingTree.open_containing(directory)[0]
618
branch_to = tree_to.branch
619
except errors.NoWorkingTree:
621
branch_to = Branch.open_containing(directory)[0]
623
possible_transports = []
624
if location is not None:
626
mergeable = bundle.read_mergeable_from_url(location,
627
possible_transports=possible_transports)
628
except errors.NotABundle:
631
stored_loc = branch_to.get_parent()
633
if stored_loc is None:
634
raise errors.BzrCommandError("No pull location known or"
637
display_url = urlutils.unescape_for_display(stored_loc,
640
self.outf.write("Using saved location: %s\n" % display_url)
641
location = stored_loc
643
if mergeable is not None:
644
if revision is not None:
645
raise errors.BzrCommandError(
646
'Cannot use -r with merge directives or bundles')
647
mergeable.install_revisions(branch_to.repository)
648
base_revision_id, revision_id, verified = \
649
mergeable.get_merge_request(branch_to.repository)
650
branch_from = branch_to
652
branch_from = Branch.open(location,
653
possible_transports=possible_transports)
655
if branch_to.get_parent() is None or remember:
656
branch_to.set_parent(branch_from.base)
658
if revision is not None:
659
if len(revision) == 1:
660
revision_id = revision[0].as_revision_id(branch_from)
662
raise errors.BzrCommandError(
663
'bzr pull --revision takes one value.')
666
old_rh = branch_to.revision_history()
667
if tree_to is not None:
668
change_reporter = delta._ChangeReporter(
669
unversioned_filter=tree_to.is_ignored)
670
result = tree_to.pull(branch_from, overwrite, revision_id,
672
possible_transports=possible_transports)
674
result = branch_to.pull(branch_from, overwrite, revision_id)
676
result.report(self.outf)
678
new_rh = branch_to.revision_history()
679
log.show_changed_revisions(branch_to, old_rh, new_rh,
683
class cmd_push(Command):
684
"""Update a mirror of this branch.
686
The target branch will not have its working tree populated because this
687
is both expensive, and is not supported on remote file systems.
689
Some smart servers or protocols *may* put the working tree in place in
692
This command only works on branches that have not diverged. Branches are
693
considered diverged if the destination branch's most recent commit is one
694
that has not been merged (directly or indirectly) by the source branch.
696
If branches have diverged, you can use 'bzr push --overwrite' to replace
697
the other branch completely, discarding its unmerged changes.
699
If you want to ensure you have the different changes in the other branch,
700
do a merge (see bzr help merge) from the other branch, and commit that.
701
After that you will be able to do a push without '--overwrite'.
703
If there is no default push location set, the first push will set it.
704
After that, you can omit the location to use the default. To change the
705
default, use --remember. The value will only be saved if the remote
706
location can be accessed.
709
_see_also = ['pull', 'update', 'working-trees']
710
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
711
Option('create-prefix',
712
help='Create the path leading up to the branch '
713
'if it does not already exist.'),
715
help='Branch to push from, '
716
'rather than the one containing the working directory.',
720
Option('use-existing-dir',
721
help='By default push will fail if the target'
722
' directory exists, but does not already'
723
' have a control directory. This flag will'
724
' allow push to proceed.'),
726
takes_args = ['location?']
727
encoding_type = 'replace'
729
def run(self, location=None, remember=False, overwrite=False,
730
create_prefix=False, verbose=False, revision=None,
731
use_existing_dir=False,
733
# FIXME: Way too big! Put this into a function called from the
735
if directory is None:
737
br_from = Branch.open_containing(directory)[0]
738
stored_loc = br_from.get_push_location()
740
if stored_loc is None:
741
raise errors.BzrCommandError("No push location known or specified.")
743
display_url = urlutils.unescape_for_display(stored_loc,
745
self.outf.write("Using saved location: %s\n" % display_url)
746
location = stored_loc
748
to_transport = transport.get_transport(location)
750
br_to = repository_to = dir_to = None
752
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
753
except errors.NotBranchError:
754
pass # Didn't find anything
756
# If we can open a branch, use its direct repository, otherwise see
757
# if there is a repository without a branch.
759
br_to = dir_to.open_branch()
760
except errors.NotBranchError:
761
# Didn't find a branch, can we find a repository?
763
repository_to = dir_to.find_repository()
764
except errors.NoRepositoryPresent:
767
# Found a branch, so we must have found a repository
768
repository_to = br_to.repository
770
if revision is not None:
771
if len(revision) == 1:
772
revision_id = revision[0].in_history(br_from).rev_id
774
raise errors.BzrCommandError(
775
'bzr push --revision takes one value.')
777
revision_id = br_from.last_revision()
783
# The destination doesn't exist; create it.
784
# XXX: Refactor the create_prefix/no_create_prefix code into a
785
# common helper function
787
def make_directory(transport):
791
def redirected(redirected_transport, e, redirection_notice):
792
return transport.get_transport(e.get_target_url())
795
to_transport = transport.do_catching_redirections(
796
make_directory, to_transport, redirected)
797
except errors.FileExists:
798
if not use_existing_dir:
799
raise errors.BzrCommandError("Target directory %s"
800
" already exists, but does not have a valid .bzr"
801
" directory. Supply --use-existing-dir to push"
802
" there anyway." % location)
803
except errors.NoSuchFile:
804
if not create_prefix:
805
raise errors.BzrCommandError("Parent directory of %s"
807
"\nYou may supply --create-prefix to create all"
808
" leading parent directories."
810
_create_prefix(to_transport)
811
except errors.TooManyRedirections:
812
raise errors.BzrCommandError("Too many redirections trying "
813
"to make %s." % location)
815
# Now the target directory exists, but doesn't have a .bzr
816
# directory. So we need to create it, along with any work to create
817
# all of the dependent branches, etc.
818
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
819
revision_id=revision_id)
820
br_to = dir_to.open_branch()
821
# TODO: Some more useful message about what was copied
822
note('Created new branch.')
823
# We successfully created the target, remember it
824
if br_from.get_push_location() is None or remember:
825
br_from.set_push_location(br_to.base)
826
elif repository_to is None:
827
# we have a bzrdir but no branch or repository
828
# XXX: Figure out what to do other than complain.
829
raise errors.BzrCommandError("At %s you have a valid .bzr control"
830
" directory, but not a branch or repository. This is an"
831
" unsupported configuration. Please move the target directory"
832
" out of the way and try again."
835
# We have a repository but no branch, copy the revisions, and then
837
repository_to.fetch(br_from.repository, revision_id=revision_id)
838
br_to = br_from.clone(dir_to, revision_id=revision_id)
839
note('Created new branch.')
840
if br_from.get_push_location() is None or remember:
841
br_from.set_push_location(br_to.base)
842
else: # We have a valid to branch
843
# We were able to connect to the remote location, so remember it
844
# we don't need to successfully push because of possible divergence.
845
if br_from.get_push_location() is None or remember:
846
br_from.set_push_location(br_to.base)
848
old_rh = br_to.revision_history()
851
tree_to = dir_to.open_workingtree()
852
except errors.NotLocalUrl:
853
warning("This transport does not update the working "
854
"tree of: %s. See 'bzr help working-trees' for "
855
"more information." % br_to.base)
856
push_result = br_from.push(br_to, overwrite,
857
stop_revision=revision_id)
858
except errors.NoWorkingTree:
859
push_result = br_from.push(br_to, overwrite,
860
stop_revision=revision_id)
864
push_result = br_from.push(tree_to.branch, overwrite,
865
stop_revision=revision_id)
869
except errors.DivergedBranches:
870
raise errors.BzrCommandError('These branches have diverged.'
871
' Try using "merge" and then "push".')
872
if push_result is not None:
873
push_result.report(self.outf)
875
new_rh = br_to.revision_history()
878
from bzrlib.log import show_changed_revisions
879
show_changed_revisions(br_to, old_rh, new_rh,
882
# we probably did a clone rather than a push, so a message was
887
class cmd_branch(Command):
888
"""Create a new copy of a branch.
890
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
891
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
892
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
893
is derived from the FROM_LOCATION by stripping a leading scheme or drive
894
identifier, if any. For example, "branch lp:foo-bar" will attempt to
897
To retrieve the branch as of a particular revision, supply the --revision
898
parameter, as in "branch foo/bar -r 5".
901
_see_also = ['checkout']
902
takes_args = ['from_location', 'to_location?']
903
takes_options = ['revision', Option('hardlink',
904
help='Hard-link working tree files where possible.')]
905
aliases = ['get', 'clone']
907
def run(self, from_location, to_location=None, revision=None,
909
from bzrlib.tag import _merge_tags_if_possible
912
elif len(revision) > 1:
913
raise errors.BzrCommandError(
914
'bzr branch --revision takes exactly 1 revision value')
916
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
920
if len(revision) == 1 and revision[0] is not None:
921
revision_id = revision[0].as_revision_id(br_from)
923
# FIXME - wt.last_revision, fallback to branch, fall back to
924
# None or perhaps NULL_REVISION to mean copy nothing
926
revision_id = br_from.last_revision()
927
if to_location is None:
928
to_location = urlutils.derive_to_location(from_location)
931
name = os.path.basename(to_location) + '\n'
933
to_transport = transport.get_transport(to_location)
935
to_transport.mkdir('.')
936
except errors.FileExists:
937
raise errors.BzrCommandError('Target directory "%s" already'
938
' exists.' % to_location)
939
except errors.NoSuchFile:
940
raise errors.BzrCommandError('Parent of "%s" does not exist.'
943
# preserve whatever source format we have.
944
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
945
possible_transports=[to_transport],
946
accelerator_tree=accelerator_tree,
948
branch = dir.open_branch()
949
except errors.NoSuchRevision:
950
to_transport.delete_tree('.')
951
msg = "The branch %s has no revision %s." % (from_location, revision[0])
952
raise errors.BzrCommandError(msg)
954
branch.control_files.put_utf8('branch-name', name)
955
_merge_tags_if_possible(br_from, branch)
956
note('Branched %d revision(s).' % branch.revno())
961
class cmd_checkout(Command):
962
"""Create a new checkout of an existing branch.
964
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
965
the branch found in '.'. This is useful if you have removed the working tree
966
or if it was never created - i.e. if you pushed the branch to its current
969
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
970
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
971
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
972
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
973
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
976
To retrieve the branch as of a particular revision, supply the --revision
977
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
978
out of date [so you cannot commit] but it may be useful (i.e. to examine old
982
_see_also = ['checkouts', 'branch']
983
takes_args = ['branch_location?', 'to_location?']
984
takes_options = ['revision',
985
Option('lightweight',
986
help="Perform a lightweight checkout. Lightweight "
987
"checkouts depend on access to the branch for "
988
"every operation. Normal checkouts can perform "
989
"common operations like diff and status without "
990
"such access, and also support local commits."
992
Option('files-from', type=str,
993
help="Get file contents from this tree."),
995
help='Hard-link working tree files where possible.'
1000
def run(self, branch_location=None, to_location=None, revision=None,
1001
lightweight=False, files_from=None, hardlink=False):
1002
if revision is None:
1004
elif len(revision) > 1:
1005
raise errors.BzrCommandError(
1006
'bzr checkout --revision takes exactly 1 revision value')
1007
if branch_location is None:
1008
branch_location = osutils.getcwd()
1009
to_location = branch_location
1010
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1012
if files_from is not None:
1013
accelerator_tree = WorkingTree.open(files_from)
1014
if len(revision) == 1 and revision[0] is not None:
1015
revision_id = revision[0].as_revision_id(source)
1018
if to_location is None:
1019
to_location = urlutils.derive_to_location(branch_location)
1020
# if the source and to_location are the same,
1021
# and there is no working tree,
1022
# then reconstitute a branch
1023
if (osutils.abspath(to_location) ==
1024
osutils.abspath(branch_location)):
1026
source.bzrdir.open_workingtree()
1027
except errors.NoWorkingTree:
1028
source.bzrdir.create_workingtree(revision_id)
1030
source.create_checkout(to_location, revision_id, lightweight,
1031
accelerator_tree, hardlink)
1034
class cmd_renames(Command):
1035
"""Show list of renamed files.
1037
# TODO: Option to show renames between two historical versions.
1039
# TODO: Only show renames under dir, rather than in the whole branch.
1040
_see_also = ['status']
1041
takes_args = ['dir?']
1044
def run(self, dir=u'.'):
1045
tree = WorkingTree.open_containing(dir)[0]
1048
new_inv = tree.inventory
1049
old_tree = tree.basis_tree()
1050
old_tree.lock_read()
1052
old_inv = old_tree.inventory
1053
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1055
for old_name, new_name in renames:
1056
self.outf.write("%s => %s\n" % (old_name, new_name))
1063
class cmd_update(Command):
1064
"""Update a tree to have the latest code committed to its branch.
1066
This will perform a merge into the working tree, and may generate
1067
conflicts. If you have any local changes, you will still
1068
need to commit them after the update for the update to be complete.
1070
If you want to discard your local changes, you can just do a
1071
'bzr revert' instead of 'bzr commit' after the update.
1074
_see_also = ['pull', 'working-trees', 'status-flags']
1075
takes_args = ['dir?']
1078
def run(self, dir='.'):
1079
tree = WorkingTree.open_containing(dir)[0]
1080
possible_transports = []
1081
master = tree.branch.get_master_branch(
1082
possible_transports=possible_transports)
1083
if master is not None:
1086
tree.lock_tree_write()
1088
existing_pending_merges = tree.get_parent_ids()[1:]
1089
last_rev = _mod_revision.ensure_null(tree.last_revision())
1090
if last_rev == _mod_revision.ensure_null(
1091
tree.branch.last_revision()):
1092
# may be up to date, check master too.
1093
if master is None or last_rev == _mod_revision.ensure_null(
1094
master.last_revision()):
1095
revno = tree.branch.revision_id_to_revno(last_rev)
1096
note("Tree is up to date at revision %d." % (revno,))
1098
conflicts = tree.update(
1099
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1100
possible_transports=possible_transports)
1101
revno = tree.branch.revision_id_to_revno(
1102
_mod_revision.ensure_null(tree.last_revision()))
1103
note('Updated to revision %d.' % (revno,))
1104
if tree.get_parent_ids()[1:] != existing_pending_merges:
1105
note('Your local commits will now show as pending merges with '
1106
"'bzr status', and can be committed with 'bzr commit'.")
1115
class cmd_info(Command):
1116
"""Show information about a working tree, branch or repository.
1118
This command will show all known locations and formats associated to the
1119
tree, branch or repository. Statistical information is included with
1122
Branches and working trees will also report any missing revisions.
1124
_see_also = ['revno', 'working-trees', 'repositories']
1125
takes_args = ['location?']
1126
takes_options = ['verbose']
1127
encoding_type = 'replace'
1130
def run(self, location=None, verbose=False):
1135
from bzrlib.info import show_bzrdir_info
1136
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1137
verbose=noise_level, outfile=self.outf)
1140
class cmd_remove(Command):
1141
"""Remove files or directories.
1143
This makes bzr stop tracking changes to the specified files and
1144
delete them if they can easily be recovered using revert.
1146
You can specify one or more files, and/or --new. If you specify --new,
1147
only 'added' files will be removed. If you specify both, then new files
1148
in the specified directories will be removed. If the directories are
1149
also new, they will also be removed.
1151
takes_args = ['file*']
1152
takes_options = ['verbose',
1153
Option('new', help='Remove newly-added files.'),
1154
RegistryOption.from_kwargs('file-deletion-strategy',
1155
'The file deletion mode to be used.',
1156
title='Deletion Strategy', value_switches=True, enum_switch=False,
1157
safe='Only delete files if they can be'
1158
' safely recovered (default).',
1159
keep="Don't delete any files.",
1160
force='Delete all the specified files, even if they can not be '
1161
'recovered and even if they are non-empty directories.')]
1163
encoding_type = 'replace'
1165
def run(self, file_list, verbose=False, new=False,
1166
file_deletion_strategy='safe'):
1167
tree, file_list = tree_files(file_list)
1169
if file_list is not None:
1170
file_list = [f for f in file_list]
1172
raise errors.BzrCommandError('Specify one or more files to'
1173
' remove, or use --new.')
1176
added = tree.changes_from(tree.basis_tree(),
1177
specific_files=file_list).added
1178
file_list = sorted([f[0] for f in added], reverse=True)
1179
if len(file_list) == 0:
1180
raise errors.BzrCommandError('No matching files.')
1181
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1182
keep_files=file_deletion_strategy=='keep',
1183
force=file_deletion_strategy=='force')
1186
class cmd_file_id(Command):
1187
"""Print file_id of a particular file or directory.
1189
The file_id is assigned when the file is first added and remains the
1190
same through all revisions where the file exists, even when it is
1195
_see_also = ['inventory', 'ls']
1196
takes_args = ['filename']
1199
def run(self, filename):
1200
tree, relpath = WorkingTree.open_containing(filename)
1201
i = tree.path2id(relpath)
1203
raise errors.NotVersionedError(filename)
1205
self.outf.write(i + '\n')
1208
class cmd_file_path(Command):
1209
"""Print path of file_ids to a file or directory.
1211
This prints one line for each directory down to the target,
1212
starting at the branch root.
1216
takes_args = ['filename']
1219
def run(self, filename):
1220
tree, relpath = WorkingTree.open_containing(filename)
1221
fid = tree.path2id(relpath)
1223
raise errors.NotVersionedError(filename)
1224
segments = osutils.splitpath(relpath)
1225
for pos in range(1, len(segments) + 1):
1226
path = osutils.joinpath(segments[:pos])
1227
self.outf.write("%s\n" % tree.path2id(path))
1230
class cmd_reconcile(Command):
1231
"""Reconcile bzr metadata in a branch.
1233
This can correct data mismatches that may have been caused by
1234
previous ghost operations or bzr upgrades. You should only
1235
need to run this command if 'bzr check' or a bzr developer
1236
advises you to run it.
1238
If a second branch is provided, cross-branch reconciliation is
1239
also attempted, which will check that data like the tree root
1240
id which was not present in very early bzr versions is represented
1241
correctly in both branches.
1243
At the same time it is run it may recompress data resulting in
1244
a potential saving in disk space or performance gain.
1246
The branch *MUST* be on a listable system such as local disk or sftp.
1249
_see_also = ['check']
1250
takes_args = ['branch?']
1252
def run(self, branch="."):
1253
from bzrlib.reconcile import reconcile
1254
dir = bzrdir.BzrDir.open(branch)
1258
class cmd_revision_history(Command):
1259
"""Display the list of revision ids on a branch."""
1262
takes_args = ['location?']
1267
def run(self, location="."):
1268
branch = Branch.open_containing(location)[0]
1269
for revid in branch.revision_history():
1270
self.outf.write(revid)
1271
self.outf.write('\n')
1274
class cmd_ancestry(Command):
1275
"""List all revisions merged into this branch."""
1277
_see_also = ['log', 'revision-history']
1278
takes_args = ['location?']
1283
def run(self, location="."):
1285
wt = WorkingTree.open_containing(location)[0]
1286
except errors.NoWorkingTree:
1287
b = Branch.open(location)
1288
last_revision = b.last_revision()
1291
last_revision = wt.last_revision()
1293
revision_ids = b.repository.get_ancestry(last_revision)
1294
assert revision_ids[0] is None
1296
for revision_id in revision_ids:
1297
self.outf.write(revision_id + '\n')
1300
class cmd_init(Command):
1301
"""Make a directory into a versioned branch.
1303
Use this to create an empty branch, or before importing an
1306
If there is a repository in a parent directory of the location, then
1307
the history of the branch will be stored in the repository. Otherwise
1308
init creates a standalone branch which carries its own history
1309
in the .bzr directory.
1311
If there is already a branch at the location but it has no working tree,
1312
the tree can be populated with 'bzr checkout'.
1314
Recipe for importing a tree of files::
1320
bzr commit -m "imported project"
1323
_see_also = ['init-repository', 'branch', 'checkout']
1324
takes_args = ['location?']
1326
Option('create-prefix',
1327
help='Create the path leading up to the branch '
1328
'if it does not already exist.'),
1329
RegistryOption('format',
1330
help='Specify a format for this branch. '
1331
'See "help formats".',
1332
registry=bzrdir.format_registry,
1333
converter=bzrdir.format_registry.make_bzrdir,
1334
value_switches=True,
1335
title="Branch Format",
1337
Option('append-revisions-only',
1338
help='Never change revnos or the existing log.'
1339
' Append revisions to it only.')
1341
def run(self, location=None, format=None, append_revisions_only=False,
1342
create_prefix=False):
1344
format = bzrdir.format_registry.make_bzrdir('default')
1345
if location is None:
1348
to_transport = transport.get_transport(location)
1350
# The path has to exist to initialize a
1351
# branch inside of it.
1352
# Just using os.mkdir, since I don't
1353
# believe that we want to create a bunch of
1354
# locations if the user supplies an extended path
1356
to_transport.ensure_base()
1357
except errors.NoSuchFile:
1358
if not create_prefix:
1359
raise errors.BzrCommandError("Parent directory of %s"
1361
"\nYou may supply --create-prefix to create all"
1362
" leading parent directories."
1364
_create_prefix(to_transport)
1367
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1368
except errors.NotBranchError:
1369
# really a NotBzrDir error...
1370
create_branch = bzrdir.BzrDir.create_branch_convenience
1371
branch = create_branch(to_transport.base, format=format,
1372
possible_transports=[to_transport])
1374
from bzrlib.transport.local import LocalTransport
1375
if existing_bzrdir.has_branch():
1376
if (isinstance(to_transport, LocalTransport)
1377
and not existing_bzrdir.has_workingtree()):
1378
raise errors.BranchExistsWithoutWorkingTree(location)
1379
raise errors.AlreadyBranchError(location)
1381
branch = existing_bzrdir.create_branch()
1382
existing_bzrdir.create_workingtree()
1383
if append_revisions_only:
1385
branch.set_append_revisions_only(True)
1386
except errors.UpgradeRequired:
1387
raise errors.BzrCommandError('This branch format cannot be set'
1388
' to append-revisions-only. Try --experimental-branch6')
1391
class cmd_init_repository(Command):
1392
"""Create a shared repository to hold branches.
1394
New branches created under the repository directory will store their
1395
revisions in the repository, not in the branch directory.
1397
If the --no-trees option is used then the branches in the repository
1398
will not have working trees by default.
1401
Create a shared repositories holding just branches::
1403
bzr init-repo --no-trees repo
1406
Make a lightweight checkout elsewhere::
1408
bzr checkout --lightweight repo/trunk trunk-checkout
1413
_see_also = ['init', 'branch', 'checkout', 'repositories']
1414
takes_args = ["location"]
1415
takes_options = [RegistryOption('format',
1416
help='Specify a format for this repository. See'
1417
' "bzr help formats" for details.',
1418
registry=bzrdir.format_registry,
1419
converter=bzrdir.format_registry.make_bzrdir,
1420
value_switches=True, title='Repository format'),
1422
help='Branches in the repository will default to'
1423
' not having a working tree.'),
1425
aliases = ["init-repo"]
1427
def run(self, location, format=None, no_trees=False):
1429
format = bzrdir.format_registry.make_bzrdir('default')
1431
if location is None:
1434
to_transport = transport.get_transport(location)
1435
to_transport.ensure_base()
1437
newdir = format.initialize_on_transport(to_transport)
1438
repo = newdir.create_repository(shared=True)
1439
repo.set_make_working_trees(not no_trees)
1442
class cmd_diff(Command):
1443
"""Show differences in the working tree, between revisions or branches.
1445
If no arguments are given, all changes for the current tree are listed.
1446
If files are given, only the changes in those files are listed.
1447
Remote and multiple branches can be compared by using the --old and
1448
--new options. If not provided, the default for both is derived from
1449
the first argument, if any, or the current tree if no arguments are
1452
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1453
produces patches suitable for "patch -p1".
1457
2 - unrepresentable changes
1462
Shows the difference in the working tree versus the last commit::
1466
Difference between the working tree and revision 1::
1470
Difference between revision 2 and revision 1::
1474
Difference between revision 2 and revision 1 for branch xxx::
1478
Show just the differences for file NEWS::
1482
Show the differences in working tree xxx for file NEWS::
1486
Show the differences from branch xxx to this working tree:
1490
Show the differences between two branches for file NEWS::
1492
bzr diff --old xxx --new yyy NEWS
1494
Same as 'bzr diff' but prefix paths with old/ and new/::
1496
bzr diff --prefix old/:new/
1498
_see_also = ['status']
1499
takes_args = ['file*']
1501
Option('diff-options', type=str,
1502
help='Pass these options to the external diff program.'),
1503
Option('prefix', type=str,
1505
help='Set prefixes added to old and new filenames, as '
1506
'two values separated by a colon. (eg "old/:new/").'),
1508
help='Branch/tree to compare from.',
1512
help='Branch/tree to compare to.',
1518
help='Use this command to compare files.',
1522
aliases = ['di', 'dif']
1523
encoding_type = 'exact'
1526
def run(self, revision=None, file_list=None, diff_options=None,
1527
prefix=None, old=None, new=None, using=None):
1528
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1530
if (prefix is None) or (prefix == '0'):
1538
old_label, new_label = prefix.split(":")
1540
raise errors.BzrCommandError(
1541
'--prefix expects two values separated by a colon'
1542
' (eg "old/:new/")')
1544
if revision and len(revision) > 2:
1545
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1546
' one or two revision specifiers')
1548
old_tree, new_tree, specific_files, extra_trees = \
1549
_get_trees_to_diff(file_list, revision, old, new)
1550
return show_diff_trees(old_tree, new_tree, sys.stdout,
1551
specific_files=specific_files,
1552
external_diff_options=diff_options,
1553
old_label=old_label, new_label=new_label,
1554
extra_trees=extra_trees, using=using)
1557
class cmd_deleted(Command):
1558
"""List files deleted in the working tree.
1560
# TODO: Show files deleted since a previous revision, or
1561
# between two revisions.
1562
# TODO: Much more efficient way to do this: read in new
1563
# directories with readdir, rather than stating each one. Same
1564
# level of effort but possibly much less IO. (Or possibly not,
1565
# if the directories are very large...)
1566
_see_also = ['status', 'ls']
1567
takes_options = ['show-ids']
1570
def run(self, show_ids=False):
1571
tree = WorkingTree.open_containing(u'.')[0]
1574
old = tree.basis_tree()
1577
for path, ie in old.inventory.iter_entries():
1578
if not tree.has_id(ie.file_id):
1579
self.outf.write(path)
1581
self.outf.write(' ')
1582
self.outf.write(ie.file_id)
1583
self.outf.write('\n')
1590
class cmd_modified(Command):
1591
"""List files modified in working tree.
1595
_see_also = ['status', 'ls']
1599
tree = WorkingTree.open_containing(u'.')[0]
1600
td = tree.changes_from(tree.basis_tree())
1601
for path, id, kind, text_modified, meta_modified in td.modified:
1602
self.outf.write(path + '\n')
1605
class cmd_added(Command):
1606
"""List files added in working tree.
1610
_see_also = ['status', 'ls']
1614
wt = WorkingTree.open_containing(u'.')[0]
1617
basis = wt.basis_tree()
1620
basis_inv = basis.inventory
1623
if file_id in basis_inv:
1625
if inv.is_root(file_id) and len(basis_inv) == 0:
1627
path = inv.id2path(file_id)
1628
if not os.access(osutils.abspath(path), os.F_OK):
1630
self.outf.write(path + '\n')
1637
class cmd_root(Command):
1638
"""Show the tree root directory.
1640
The root is the nearest enclosing directory with a .bzr control
1643
takes_args = ['filename?']
1645
def run(self, filename=None):
1646
"""Print the branch root."""
1647
tree = WorkingTree.open_containing(filename)[0]
1648
self.outf.write(tree.basedir + '\n')
1651
def _parse_limit(limitstring):
1653
return int(limitstring)
1655
msg = "The limit argument must be an integer."
1656
raise errors.BzrCommandError(msg)
1659
class cmd_log(Command):
1660
"""Show log of a branch, file, or directory.
1662
By default show the log of the branch containing the working directory.
1664
To request a range of logs, you can use the command -r begin..end
1665
-r revision requests a specific revision, -r ..end or -r begin.. are
1669
Log the current branch::
1677
Log the last 10 revisions of a branch::
1679
bzr log -r -10.. http://server/branch
1682
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1684
takes_args = ['location?']
1687
help='Show from oldest to newest.'),
1690
help='Display timezone as local, original, or utc.'),
1691
custom_help('verbose',
1692
help='Show files changed in each revision.'),
1698
help='Show revisions whose message matches this '
1699
'regular expression.',
1703
help='Limit the output to the first N revisions.',
1707
encoding_type = 'replace'
1710
def run(self, location=None, timezone='original',
1718
from bzrlib.log import show_log
1719
assert message is None or isinstance(message, basestring), \
1720
"invalid message argument %r" % message
1721
direction = (forward and 'forward') or 'reverse'
1726
# find the file id to log:
1728
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1732
tree = b.basis_tree()
1733
file_id = tree.path2id(fp)
1735
raise errors.BzrCommandError(
1736
"Path does not have any revision history: %s" %
1740
# FIXME ? log the current subdir only RBC 20060203
1741
if revision is not None \
1742
and len(revision) > 0 and revision[0].get_branch():
1743
location = revision[0].get_branch()
1746
dir, relpath = bzrdir.BzrDir.open_containing(location)
1747
b = dir.open_branch()
1751
if revision is None:
1754
elif len(revision) == 1:
1755
rev1 = rev2 = revision[0].in_history(b)
1756
elif len(revision) == 2:
1757
if revision[1].get_branch() != revision[0].get_branch():
1758
# b is taken from revision[0].get_branch(), and
1759
# show_log will use its revision_history. Having
1760
# different branches will lead to weird behaviors.
1761
raise errors.BzrCommandError(
1762
"Log doesn't accept two revisions in different"
1764
rev1 = revision[0].in_history(b)
1765
rev2 = revision[1].in_history(b)
1767
raise errors.BzrCommandError(
1768
'bzr log --revision takes one or two values.')
1770
if log_format is None:
1771
log_format = log.log_formatter_registry.get_default(b)
1773
lf = log_format(show_ids=show_ids, to_file=self.outf,
1774
show_timezone=timezone)
1780
direction=direction,
1781
start_revision=rev1,
1789
def get_log_format(long=False, short=False, line=False, default='long'):
1790
log_format = default
1794
log_format = 'short'
1800
class cmd_touching_revisions(Command):
1801
"""Return revision-ids which affected a particular file.
1803
A more user-friendly interface is "bzr log FILE".
1807
takes_args = ["filename"]
1810
def run(self, filename):
1811
tree, relpath = WorkingTree.open_containing(filename)
1813
file_id = tree.path2id(relpath)
1814
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1815
self.outf.write("%6d %s\n" % (revno, what))
1818
class cmd_ls(Command):
1819
"""List files in a tree.
1822
_see_also = ['status', 'cat']
1823
takes_args = ['path?']
1824
# TODO: Take a revision or remote path and list that tree instead.
1828
Option('non-recursive',
1829
help='Don\'t recurse into subdirectories.'),
1831
help='Print paths relative to the root of the branch.'),
1832
Option('unknown', help='Print unknown files.'),
1833
Option('versioned', help='Print versioned files.'),
1834
Option('ignored', help='Print ignored files.'),
1836
help='Write an ascii NUL (\\0) separator '
1837
'between files rather than a newline.'),
1839
help='List entries of a particular kind: file, directory, symlink.',
1844
def run(self, revision=None, verbose=False,
1845
non_recursive=False, from_root=False,
1846
unknown=False, versioned=False, ignored=False,
1847
null=False, kind=None, show_ids=False, path=None):
1849
if kind and kind not in ('file', 'directory', 'symlink'):
1850
raise errors.BzrCommandError('invalid kind specified')
1852
if verbose and null:
1853
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1854
all = not (unknown or versioned or ignored)
1856
selection = {'I':ignored, '?':unknown, 'V':versioned}
1863
raise errors.BzrCommandError('cannot specify both --from-root'
1867
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1873
if revision is not None:
1874
tree = branch.repository.revision_tree(
1875
revision[0].as_revision_id(branch))
1877
tree = branch.basis_tree()
1881
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1882
if fp.startswith(relpath):
1883
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1884
if non_recursive and '/' in fp:
1886
if not all and not selection[fc]:
1888
if kind is not None and fkind != kind:
1891
kindch = entry.kind_character()
1892
outstring = '%-8s %s%s' % (fc, fp, kindch)
1893
if show_ids and fid is not None:
1894
outstring = "%-50s %s" % (outstring, fid)
1895
self.outf.write(outstring + '\n')
1897
self.outf.write(fp + '\0')
1900
self.outf.write(fid)
1901
self.outf.write('\0')
1909
self.outf.write('%-50s %s\n' % (fp, my_id))
1911
self.outf.write(fp + '\n')
1916
class cmd_unknowns(Command):
1917
"""List unknown files.
1925
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1926
self.outf.write(osutils.quotefn(f) + '\n')
1929
class cmd_ignore(Command):
1930
"""Ignore specified files or patterns.
1932
To remove patterns from the ignore list, edit the .bzrignore file.
1934
Trailing slashes on patterns are ignored.
1935
If the pattern contains a slash or is a regular expression, it is compared
1936
to the whole path from the branch root. Otherwise, it is compared to only
1937
the last component of the path. To match a file only in the root
1938
directory, prepend './'.
1940
Ignore patterns specifying absolute paths are not allowed.
1942
Ignore patterns may include globbing wildcards such as::
1944
? - Matches any single character except '/'
1945
* - Matches 0 or more characters except '/'
1946
/**/ - Matches 0 or more directories in a path
1947
[a-z] - Matches a single character from within a group of characters
1949
Ignore patterns may also be Python regular expressions.
1950
Regular expression ignore patterns are identified by a 'RE:' prefix
1951
followed by the regular expression. Regular expression ignore patterns
1952
may not include named or numbered groups.
1954
Note: ignore patterns containing shell wildcards must be quoted from
1958
Ignore the top level Makefile::
1960
bzr ignore ./Makefile
1962
Ignore class files in all directories::
1964
bzr ignore "*.class"
1966
Ignore .o files under the lib directory::
1968
bzr ignore "lib/**/*.o"
1970
Ignore .o files under the lib directory::
1972
bzr ignore "RE:lib/.*\.o"
1974
Ignore everything but the "debian" toplevel directory::
1976
bzr ignore "RE:(?!debian/).*"
1979
_see_also = ['status', 'ignored']
1980
takes_args = ['name_pattern*']
1982
Option('old-default-rules',
1983
help='Write out the ignore rules bzr < 0.9 always used.')
1986
def run(self, name_pattern_list=None, old_default_rules=None):
1987
from bzrlib.atomicfile import AtomicFile
1988
if old_default_rules is not None:
1989
# dump the rules and exit
1990
for pattern in ignores.OLD_DEFAULTS:
1993
if not name_pattern_list:
1994
raise errors.BzrCommandError("ignore requires at least one "
1995
"NAME_PATTERN or --old-default-rules")
1996
name_pattern_list = [globbing.normalize_pattern(p)
1997
for p in name_pattern_list]
1998
for name_pattern in name_pattern_list:
1999
if (name_pattern[0] == '/' or
2000
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2001
raise errors.BzrCommandError(
2002
"NAME_PATTERN should not be an absolute path")
2003
tree, relpath = WorkingTree.open_containing(u'.')
2004
ifn = tree.abspath('.bzrignore')
2005
if os.path.exists(ifn):
2008
igns = f.read().decode('utf-8')
2014
# TODO: If the file already uses crlf-style termination, maybe
2015
# we should use that for the newly added lines?
2017
if igns and igns[-1] != '\n':
2019
for name_pattern in name_pattern_list:
2020
igns += name_pattern + '\n'
2022
f = AtomicFile(ifn, 'wb')
2024
f.write(igns.encode('utf-8'))
2029
if not tree.path2id('.bzrignore'):
2030
tree.add(['.bzrignore'])
2032
ignored = globbing.Globster(name_pattern_list)
2035
for entry in tree.list_files():
2039
if ignored.match(filename):
2040
matches.append(filename.encode('utf-8'))
2042
if len(matches) > 0:
2043
print "Warning: the following files are version controlled and" \
2044
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2046
class cmd_ignored(Command):
2047
"""List ignored files and the patterns that matched them.
2050
encoding_type = 'replace'
2051
_see_also = ['ignore']
2055
tree = WorkingTree.open_containing(u'.')[0]
2058
for path, file_class, kind, file_id, entry in tree.list_files():
2059
if file_class != 'I':
2061
## XXX: Slightly inefficient since this was already calculated
2062
pat = tree.is_ignored(path)
2063
self.outf.write('%-50s %s\n' % (path, pat))
2068
class cmd_lookup_revision(Command):
2069
"""Lookup the revision-id from a revision-number
2072
bzr lookup-revision 33
2075
takes_args = ['revno']
2078
def run(self, revno):
2082
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2084
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2087
class cmd_export(Command):
2088
"""Export current or past revision to a destination directory or archive.
2090
If no revision is specified this exports the last committed revision.
2092
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2093
given, try to find the format with the extension. If no extension
2094
is found exports to a directory (equivalent to --format=dir).
2096
If root is supplied, it will be used as the root directory inside
2097
container formats (tar, zip, etc). If it is not supplied it will default
2098
to the exported filename. The root option has no effect for 'dir' format.
2100
If branch is omitted then the branch containing the current working
2101
directory will be used.
2103
Note: Export of tree with non-ASCII filenames to zip is not supported.
2105
================= =========================
2106
Supported formats Autodetected by extension
2107
================= =========================
2110
tbz2 .tar.bz2, .tbz2
2113
================= =========================
2115
takes_args = ['dest', 'branch?']
2118
help="Type of file to export to.",
2123
help="Name of the root directory inside the exported file."),
2125
def run(self, dest, branch=None, revision=None, format=None, root=None):
2126
from bzrlib.export import export
2129
tree = WorkingTree.open_containing(u'.')[0]
2132
b = Branch.open(branch)
2134
if revision is None:
2135
# should be tree.last_revision FIXME
2136
rev_id = b.last_revision()
2138
if len(revision) != 1:
2139
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2140
rev_id = revision[0].as_revision_id(b)
2141
t = b.repository.revision_tree(rev_id)
2143
export(t, dest, format, root)
2144
except errors.NoSuchExportFormat, e:
2145
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2148
class cmd_cat(Command):
2149
"""Write the contents of a file as of a given revision to standard output.
2151
If no revision is nominated, the last revision is used.
2153
Note: Take care to redirect standard output when using this command on a
2159
Option('name-from-revision', help='The path name in the old tree.'),
2162
takes_args = ['filename']
2163
encoding_type = 'exact'
2166
def run(self, filename, revision=None, name_from_revision=False):
2167
if revision is not None and len(revision) != 1:
2168
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2169
" one revision specifier")
2170
tree, branch, relpath = \
2171
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2174
return self._run(tree, branch, relpath, filename, revision,
2179
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2181
tree = b.basis_tree()
2182
if revision is None:
2183
revision_id = b.last_revision()
2185
revision_id = revision[0].as_revision_id(b)
2187
cur_file_id = tree.path2id(relpath)
2188
rev_tree = b.repository.revision_tree(revision_id)
2189
old_file_id = rev_tree.path2id(relpath)
2191
if name_from_revision:
2192
if old_file_id is None:
2193
raise errors.BzrCommandError("%r is not present in revision %s"
2194
% (filename, revision_id))
2196
rev_tree.print_file(old_file_id)
2197
elif cur_file_id is not None:
2198
rev_tree.print_file(cur_file_id)
2199
elif old_file_id is not None:
2200
rev_tree.print_file(old_file_id)
2202
raise errors.BzrCommandError("%r is not present in revision %s" %
2203
(filename, revision_id))
2206
class cmd_local_time_offset(Command):
2207
"""Show the offset in seconds from GMT to local time."""
2211
print osutils.local_time_offset()
2215
class cmd_commit(Command):
2216
"""Commit changes into a new revision.
2218
If no arguments are given, the entire tree is committed.
2220
If selected files are specified, only changes to those files are
2221
committed. If a directory is specified then the directory and everything
2222
within it is committed.
2224
If author of the change is not the same person as the committer, you can
2225
specify the author's name using the --author option. The name should be
2226
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2228
A selected-file commit may fail in some cases where the committed
2229
tree would be invalid. Consider::
2234
bzr commit foo -m "committing foo"
2235
bzr mv foo/bar foo/baz
2238
bzr commit foo/bar -m "committing bar but not baz"
2240
In the example above, the last commit will fail by design. This gives
2241
the user the opportunity to decide whether they want to commit the
2242
rename at the same time, separately first, or not at all. (As a general
2243
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2245
Note: A selected-file commit after a merge is not yet supported.
2247
# TODO: Run hooks on tree to-be-committed, and after commit.
2249
# TODO: Strict commit that fails if there are deleted files.
2250
# (what does "deleted files" mean ??)
2252
# TODO: Give better message for -s, --summary, used by tla people
2254
# XXX: verbose currently does nothing
2256
_see_also = ['bugs', 'uncommit']
2257
takes_args = ['selected*']
2259
Option('message', type=unicode,
2261
help="Description of the new revision."),
2264
help='Commit even if nothing has changed.'),
2265
Option('file', type=str,
2268
help='Take commit message from this file.'),
2270
help="Refuse to commit if there are unknown "
2271
"files in the working tree."),
2272
ListOption('fixes', type=str,
2273
help="Mark a bug as being fixed by this revision."),
2274
Option('author', type=unicode,
2275
help="Set the author's name, if it's different "
2276
"from the committer."),
2278
help="Perform a local commit in a bound "
2279
"branch. Local commits are not pushed to "
2280
"the master branch until a normal commit "
2284
help='When no message is supplied, show the diff along'
2285
' with the status summary in the message editor.'),
2287
aliases = ['ci', 'checkin']
2289
def _get_bug_fix_properties(self, fixes, branch):
2291
# Configure the properties for bug fixing attributes.
2292
for fixed_bug in fixes:
2293
tokens = fixed_bug.split(':')
2294
if len(tokens) != 2:
2295
raise errors.BzrCommandError(
2296
"Invalid bug %s. Must be in the form of 'tag:id'. "
2297
"Commit refused." % fixed_bug)
2298
tag, bug_id = tokens
2300
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2301
except errors.UnknownBugTrackerAbbreviation:
2302
raise errors.BzrCommandError(
2303
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2304
except errors.MalformedBugIdentifier:
2305
raise errors.BzrCommandError(
2306
"Invalid bug identifier for %s. Commit refused."
2308
properties.append('%s fixed' % bug_url)
2309
return '\n'.join(properties)
2311
def run(self, message=None, file=None, verbose=False, selected_list=None,
2312
unchanged=False, strict=False, local=False, fixes=None,
2313
author=None, show_diff=False):
2314
from bzrlib.errors import (
2319
from bzrlib.msgeditor import (
2320
edit_commit_message_encoded,
2321
make_commit_message_template_encoded
2324
# TODO: Need a blackbox test for invoking the external editor; may be
2325
# slightly problematic to run this cross-platform.
2327
# TODO: do more checks that the commit will succeed before
2328
# spending the user's valuable time typing a commit message.
2332
tree, selected_list = tree_files(selected_list)
2333
if selected_list == ['']:
2334
# workaround - commit of root of tree should be exactly the same
2335
# as just default commit in that tree, and succeed even though
2336
# selected-file merge commit is not done yet
2341
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2343
properties['bugs'] = bug_property
2345
if local and not tree.branch.get_bound_location():
2346
raise errors.LocalRequiresBoundBranch()
2348
def get_message(commit_obj):
2349
"""Callback to get commit message"""
2350
my_message = message
2351
if my_message is None and not file:
2352
t = make_commit_message_template_encoded(tree,
2353
selected_list, diff=show_diff,
2354
output_encoding=bzrlib.user_encoding)
2355
my_message = edit_commit_message_encoded(t)
2356
if my_message is None:
2357
raise errors.BzrCommandError("please specify a commit"
2358
" message with either --message or --file")
2359
elif my_message and file:
2360
raise errors.BzrCommandError(
2361
"please specify either --message or --file")
2363
my_message = codecs.open(file, 'rt',
2364
bzrlib.user_encoding).read()
2365
if my_message == "":
2366
raise errors.BzrCommandError("empty commit message specified")
2370
tree.commit(message_callback=get_message,
2371
specific_files=selected_list,
2372
allow_pointless=unchanged, strict=strict, local=local,
2373
reporter=None, verbose=verbose, revprops=properties,
2375
except PointlessCommit:
2376
# FIXME: This should really happen before the file is read in;
2377
# perhaps prepare the commit; get the message; then actually commit
2378
raise errors.BzrCommandError("no changes to commit."
2379
" use --unchanged to commit anyhow")
2380
except ConflictsInTree:
2381
raise errors.BzrCommandError('Conflicts detected in working '
2382
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2384
except StrictCommitFailed:
2385
raise errors.BzrCommandError("Commit refused because there are"
2386
" unknown files in the working tree.")
2387
except errors.BoundBranchOutOfDate, e:
2388
raise errors.BzrCommandError(str(e) + "\n"
2389
'To commit to master branch, run update and then commit.\n'
2390
'You can also pass --local to commit to continue working '
2394
class cmd_check(Command):
2395
"""Validate consistency of branch history.
2397
This command checks various invariants about the branch storage to
2398
detect data corruption or bzr bugs.
2402
revisions: This is just the number of revisions checked. It doesn't
2404
versionedfiles: This is just the number of versionedfiles checked. It
2405
doesn't indicate a problem.
2406
unreferenced ancestors: Texts that are ancestors of other texts, but
2407
are not properly referenced by the revision ancestry. This is a
2408
subtle problem that Bazaar can work around.
2409
unique file texts: This is the total number of unique file contents
2410
seen in the checked revisions. It does not indicate a problem.
2411
repeated file texts: This is the total number of repeated texts seen
2412
in the checked revisions. Texts can be repeated when their file
2413
entries are modified, but the file contents are not. It does not
2417
_see_also = ['reconcile']
2418
takes_args = ['branch?']
2419
takes_options = ['verbose']
2421
def run(self, branch=None, verbose=False):
2422
from bzrlib.check import check
2424
branch_obj = Branch.open_containing('.')[0]
2426
branch_obj = Branch.open(branch)
2427
check(branch_obj, verbose)
2428
# bit hacky, check the tree parent is accurate
2431
tree = WorkingTree.open_containing('.')[0]
2433
tree = WorkingTree.open(branch)
2434
except (errors.NoWorkingTree, errors.NotLocalUrl):
2437
# This is a primitive 'check' for tree state. Currently this is not
2438
# integrated into the main check logic as yet.
2441
tree_basis = tree.basis_tree()
2442
tree_basis.lock_read()
2444
repo_basis = tree.branch.repository.revision_tree(
2445
tree.last_revision())
2446
if len(list(repo_basis.iter_changes(tree_basis))):
2447
raise errors.BzrCheckError(
2448
"Mismatched basis inventory content.")
2456
class cmd_upgrade(Command):
2457
"""Upgrade branch storage to current format.
2459
The check command or bzr developers may sometimes advise you to run
2460
this command. When the default format has changed you may also be warned
2461
during other operations to upgrade.
2464
_see_also = ['check']
2465
takes_args = ['url?']
2467
RegistryOption('format',
2468
help='Upgrade to a specific format. See "bzr help'
2469
' formats" for details.',
2470
registry=bzrdir.format_registry,
2471
converter=bzrdir.format_registry.make_bzrdir,
2472
value_switches=True, title='Branch format'),
2475
def run(self, url='.', format=None):
2476
from bzrlib.upgrade import upgrade
2478
format = bzrdir.format_registry.make_bzrdir('default')
2479
upgrade(url, format)
2482
class cmd_whoami(Command):
2483
"""Show or set bzr user id.
2486
Show the email of the current user::
2490
Set the current user::
2492
bzr whoami "Frank Chu <fchu@example.com>"
2494
takes_options = [ Option('email',
2495
help='Display email address only.'),
2497
help='Set identity for the current branch instead of '
2500
takes_args = ['name?']
2501
encoding_type = 'replace'
2504
def run(self, email=False, branch=False, name=None):
2506
# use branch if we're inside one; otherwise global config
2508
c = Branch.open_containing('.')[0].get_config()
2509
except errors.NotBranchError:
2510
c = config.GlobalConfig()
2512
self.outf.write(c.user_email() + '\n')
2514
self.outf.write(c.username() + '\n')
2517
# display a warning if an email address isn't included in the given name.
2519
config.extract_email_address(name)
2520
except errors.NoEmailInUsername, e:
2521
warning('"%s" does not seem to contain an email address. '
2522
'This is allowed, but not recommended.', name)
2524
# use global config unless --branch given
2526
c = Branch.open_containing('.')[0].get_config()
2528
c = config.GlobalConfig()
2529
c.set_user_option('email', name)
2532
class cmd_nick(Command):
2533
"""Print or set the branch nickname.
2535
If unset, the tree root directory name is used as the nickname
2536
To print the current nickname, execute with no argument.
2539
_see_also = ['info']
2540
takes_args = ['nickname?']
2541
def run(self, nickname=None):
2542
branch = Branch.open_containing(u'.')[0]
2543
if nickname is None:
2544
self.printme(branch)
2546
branch.nick = nickname
2549
def printme(self, branch):
2553
class cmd_selftest(Command):
2554
"""Run internal test suite.
2556
If arguments are given, they are regular expressions that say which tests
2557
should run. Tests matching any expression are run, and other tests are
2560
Alternatively if --first is given, matching tests are run first and then
2561
all other tests are run. This is useful if you have been working in a
2562
particular area, but want to make sure nothing else was broken.
2564
If --exclude is given, tests that match that regular expression are
2565
excluded, regardless of whether they match --first or not.
2567
To help catch accidential dependencies between tests, the --randomize
2568
option is useful. In most cases, the argument used is the word 'now'.
2569
Note that the seed used for the random number generator is displayed
2570
when this option is used. The seed can be explicitly passed as the
2571
argument to this option if required. This enables reproduction of the
2572
actual ordering used if and when an order sensitive problem is encountered.
2574
If --list-only is given, the tests that would be run are listed. This is
2575
useful when combined with --first, --exclude and/or --randomize to
2576
understand their impact. The test harness reports "Listed nn tests in ..."
2577
instead of "Ran nn tests in ..." when list mode is enabled.
2579
If the global option '--no-plugins' is given, plugins are not loaded
2580
before running the selftests. This has two effects: features provided or
2581
modified by plugins will not be tested, and tests provided by plugins will
2584
Tests that need working space on disk use a common temporary directory,
2585
typically inside $TMPDIR or /tmp.
2588
Run only tests relating to 'ignore'::
2592
Disable plugins and list tests as they're run::
2594
bzr --no-plugins selftest -v
2596
# NB: this is used from the class without creating an instance, which is
2597
# why it does not have a self parameter.
2598
def get_transport_type(typestring):
2599
"""Parse and return a transport specifier."""
2600
if typestring == "sftp":
2601
from bzrlib.transport.sftp import SFTPAbsoluteServer
2602
return SFTPAbsoluteServer
2603
if typestring == "memory":
2604
from bzrlib.transport.memory import MemoryServer
2606
if typestring == "fakenfs":
2607
from bzrlib.transport.fakenfs import FakeNFSServer
2608
return FakeNFSServer
2609
msg = "No known transport type %s. Supported types are: sftp\n" %\
2611
raise errors.BzrCommandError(msg)
2614
takes_args = ['testspecs*']
2615
takes_options = ['verbose',
2617
help='Stop when one test fails.',
2621
help='Use a different transport by default '
2622
'throughout the test suite.',
2623
type=get_transport_type),
2625
help='Run the benchmarks rather than selftests.'),
2626
Option('lsprof-timed',
2627
help='Generate lsprof output for benchmarked'
2628
' sections of code.'),
2629
Option('cache-dir', type=str,
2630
help='Cache intermediate benchmark output in this '
2633
help='Run all tests, but run specified tests first.',
2637
help='List the tests instead of running them.'),
2638
Option('randomize', type=str, argname="SEED",
2639
help='Randomize the order of tests using the given'
2640
' seed or "now" for the current time.'),
2641
Option('exclude', type=str, argname="PATTERN",
2643
help='Exclude tests that match this regular'
2645
Option('strict', help='Fail on missing dependencies or '
2647
Option('load-list', type=str, argname='TESTLISTFILE',
2648
help='Load a test id list from a text file.'),
2650
encoding_type = 'replace'
2652
def run(self, testspecs_list=None, verbose=False, one=False,
2653
transport=None, benchmark=None,
2654
lsprof_timed=None, cache_dir=None,
2655
first=False, list_only=False,
2656
randomize=None, exclude=None, strict=False,
2659
from bzrlib.tests import selftest
2660
import bzrlib.benchmarks as benchmarks
2661
from bzrlib.benchmarks import tree_creator
2663
if cache_dir is not None:
2664
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2666
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2667
print ' %s (%s python%s)' % (
2669
bzrlib.version_string,
2670
bzrlib._format_version_tuple(sys.version_info),
2673
if testspecs_list is not None:
2674
pattern = '|'.join(testspecs_list)
2678
test_suite_factory = benchmarks.test_suite
2679
# Unless user explicitly asks for quiet, be verbose in benchmarks
2680
verbose = not is_quiet()
2681
# TODO: should possibly lock the history file...
2682
benchfile = open(".perf_history", "at", buffering=1)
2684
test_suite_factory = None
2687
result = selftest(verbose=verbose,
2689
stop_on_failure=one,
2690
transport=transport,
2691
test_suite_factory=test_suite_factory,
2692
lsprof_timed=lsprof_timed,
2693
bench_history=benchfile,
2694
matching_tests_first=first,
2695
list_only=list_only,
2696
random_seed=randomize,
2697
exclude_pattern=exclude,
2699
load_list=load_list,
2702
if benchfile is not None:
2705
note('tests passed')
2707
note('tests failed')
2708
return int(not result)
2711
class cmd_version(Command):
2712
"""Show version of bzr."""
2714
encoding_type = 'replace'
2718
from bzrlib.version import show_version
2719
show_version(to_file=self.outf)
2722
class cmd_rocks(Command):
2723
"""Statement of optimism."""
2729
print "It sure does!"
2732
class cmd_find_merge_base(Command):
2733
"""Find and print a base revision for merging two branches."""
2734
# TODO: Options to specify revisions on either side, as if
2735
# merging only part of the history.
2736
takes_args = ['branch', 'other']
2740
def run(self, branch, other):
2741
from bzrlib.revision import ensure_null
2743
branch1 = Branch.open_containing(branch)[0]
2744
branch2 = Branch.open_containing(other)[0]
2749
last1 = ensure_null(branch1.last_revision())
2750
last2 = ensure_null(branch2.last_revision())
2752
graph = branch1.repository.get_graph(branch2.repository)
2753
base_rev_id = graph.find_unique_lca(last1, last2)
2755
print 'merge base is revision %s' % base_rev_id
2762
class cmd_merge(Command):
2763
"""Perform a three-way merge.
2765
The branch is the branch you will merge from. By default, it will merge
2766
the latest revision. If you specify a revision, that revision will be
2767
merged. If you specify two revisions, the first will be used as a BASE,
2768
and the second one as OTHER. Revision numbers are always relative to the
2771
By default, bzr will try to merge in all new work from the other
2772
branch, automatically determining an appropriate base. If this
2773
fails, you may need to give an explicit base.
2775
Merge will do its best to combine the changes in two branches, but there
2776
are some kinds of problems only a human can fix. When it encounters those,
2777
it will mark a conflict. A conflict means that you need to fix something,
2778
before you should commit.
2780
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2782
If there is no default branch set, the first merge will set it. After
2783
that, you can omit the branch to use the default. To change the
2784
default, use --remember. The value will only be saved if the remote
2785
location can be accessed.
2787
The results of the merge are placed into the destination working
2788
directory, where they can be reviewed (with bzr diff), tested, and then
2789
committed to record the result of the merge.
2791
merge refuses to run if there are any uncommitted changes, unless
2795
To merge the latest revision from bzr.dev::
2797
bzr merge ../bzr.dev
2799
To merge changes up to and including revision 82 from bzr.dev::
2801
bzr merge -r 82 ../bzr.dev
2803
To merge the changes introduced by 82, without previous changes::
2805
bzr merge -r 81..82 ../bzr.dev
2808
encoding_type = 'exact'
2809
_see_also = ['update', 'remerge', 'status-flags']
2810
takes_args = ['branch?']
2815
help='Merge even if the destination tree has uncommitted changes.'),
2819
Option('show-base', help="Show base revision text in "
2821
Option('uncommitted', help='Apply uncommitted changes'
2822
' from a working copy, instead of branch changes.'),
2823
Option('pull', help='If the destination is already'
2824
' completely merged into the source, pull from the'
2825
' source rather than merging. When this happens,'
2826
' you do not need to commit the result.'),
2828
help='Branch to merge into, '
2829
'rather than the one containing the working directory.',
2833
Option('preview', help='Instead of merging, show a diff of the merge.')
2836
def run(self, branch=None, revision=None, force=False, merge_type=None,
2837
show_base=False, reprocess=False, remember=False,
2838
uncommitted=False, pull=False,
2842
# This is actually a branch (or merge-directive) *location*.
2846
if merge_type is None:
2847
merge_type = _mod_merge.Merge3Merger
2849
if directory is None: directory = u'.'
2850
possible_transports = []
2852
allow_pending = True
2853
verified = 'inapplicable'
2854
tree = WorkingTree.open_containing(directory)[0]
2855
change_reporter = delta._ChangeReporter(
2856
unversioned_filter=tree.is_ignored)
2859
pb = ui.ui_factory.nested_progress_bar()
2860
cleanups.append(pb.finished)
2862
cleanups.append(tree.unlock)
2863
if location is not None:
2865
mergeable = bundle.read_mergeable_from_url(location,
2866
possible_transports=possible_transports)
2867
except errors.NotABundle:
2871
raise errors.BzrCommandError('Cannot use --uncommitted'
2872
' with bundles or merge directives.')
2874
if revision is not None:
2875
raise errors.BzrCommandError(
2876
'Cannot use -r with merge directives or bundles')
2877
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2880
if merger is None and uncommitted:
2881
if revision is not None and len(revision) > 0:
2882
raise errors.BzrCommandError('Cannot use --uncommitted and'
2883
' --revision at the same time.')
2884
location = self._select_branch_location(tree, location)[0]
2885
other_tree, other_path = WorkingTree.open_containing(location)
2886
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2888
allow_pending = False
2889
if other_path != '':
2890
merger.interesting_files = [other_path]
2893
merger, allow_pending = self._get_merger_from_branch(tree,
2894
location, revision, remember, possible_transports, pb)
2896
merger.merge_type = merge_type
2897
merger.reprocess = reprocess
2898
merger.show_base = show_base
2899
self.sanity_check_merger(merger)
2900
if (merger.base_rev_id == merger.other_rev_id and
2901
merger.other_rev_id != None):
2902
note('Nothing to do.')
2905
if merger.interesting_files is not None:
2906
raise errors.BzrCommandError('Cannot pull individual files')
2907
if (merger.base_rev_id == tree.last_revision()):
2908
result = tree.pull(merger.other_branch, False,
2909
merger.other_rev_id)
2910
result.report(self.outf)
2912
merger.check_basis(not force)
2914
return self._do_preview(merger)
2916
return self._do_merge(merger, change_reporter, allow_pending,
2919
for cleanup in reversed(cleanups):
2922
def _do_preview(self, merger):
2923
from bzrlib.diff import show_diff_trees
2924
tree_merger = merger.make_merger()
2925
tt = tree_merger.make_preview_transform()
2927
result_tree = tt.get_preview_tree()
2928
show_diff_trees(merger.this_tree, result_tree, self.outf,
2929
old_label='', new_label='')
2933
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2934
merger.change_reporter = change_reporter
2935
conflict_count = merger.do_merge()
2937
merger.set_pending()
2938
if verified == 'failed':
2939
warning('Preview patch does not match changes')
2940
if conflict_count != 0:
2945
def sanity_check_merger(self, merger):
2946
if (merger.show_base and
2947
not merger.merge_type is _mod_merge.Merge3Merger):
2948
raise errors.BzrCommandError("Show-base is not supported for this"
2949
" merge type. %s" % merger.merge_type)
2950
if merger.reprocess and not merger.merge_type.supports_reprocess:
2951
raise errors.BzrCommandError("Conflict reduction is not supported"
2952
" for merge type %s." %
2954
if merger.reprocess and merger.show_base:
2955
raise errors.BzrCommandError("Cannot do conflict reduction and"
2958
def _get_merger_from_branch(self, tree, location, revision, remember,
2959
possible_transports, pb):
2960
"""Produce a merger from a location, assuming it refers to a branch."""
2961
from bzrlib.tag import _merge_tags_if_possible
2962
assert revision is None or len(revision) < 3
2963
# find the branch locations
2964
other_loc, user_location = self._select_branch_location(tree, location,
2966
if revision is not None and len(revision) == 2:
2967
base_loc, _unused = self._select_branch_location(tree,
2968
location, revision, 0)
2970
base_loc = other_loc
2972
other_branch, other_path = Branch.open_containing(other_loc,
2973
possible_transports)
2974
if base_loc == other_loc:
2975
base_branch = other_branch
2977
base_branch, base_path = Branch.open_containing(base_loc,
2978
possible_transports)
2979
# Find the revision ids
2980
if revision is None or len(revision) < 1 or revision[-1] is None:
2981
other_revision_id = _mod_revision.ensure_null(
2982
other_branch.last_revision())
2984
other_revision_id = revision[-1].as_revision_id(other_branch)
2985
if (revision is not None and len(revision) == 2
2986
and revision[0] is not None):
2987
base_revision_id = revision[0].as_revision_id(base_branch)
2989
base_revision_id = None
2990
# Remember where we merge from
2991
if ((remember or tree.branch.get_submit_branch() is None) and
2992
user_location is not None):
2993
tree.branch.set_submit_branch(other_branch.base)
2994
_merge_tags_if_possible(other_branch, tree.branch)
2995
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2996
other_revision_id, base_revision_id, other_branch, base_branch)
2997
if other_path != '':
2998
allow_pending = False
2999
merger.interesting_files = [other_path]
3001
allow_pending = True
3002
return merger, allow_pending
3004
def _select_branch_location(self, tree, user_location, revision=None,
3006
"""Select a branch location, according to possible inputs.
3008
If provided, branches from ``revision`` are preferred. (Both
3009
``revision`` and ``index`` must be supplied.)
3011
Otherwise, the ``location`` parameter is used. If it is None, then the
3012
``submit`` or ``parent`` location is used, and a note is printed.
3014
:param tree: The working tree to select a branch for merging into
3015
:param location: The location entered by the user
3016
:param revision: The revision parameter to the command
3017
:param index: The index to use for the revision parameter. Negative
3018
indices are permitted.
3019
:return: (selected_location, user_location). The default location
3020
will be the user-entered location.
3022
if (revision is not None and index is not None
3023
and revision[index] is not None):
3024
branch = revision[index].get_branch()
3025
if branch is not None:
3026
return branch, branch
3027
if user_location is None:
3028
location = self._get_remembered(tree, 'Merging from')
3030
location = user_location
3031
return location, user_location
3033
def _get_remembered(self, tree, verb_string):
3034
"""Use tree.branch's parent if none was supplied.
3036
Report if the remembered location was used.
3038
stored_location = tree.branch.get_submit_branch()
3039
if stored_location is None:
3040
stored_location = tree.branch.get_parent()
3041
mutter("%s", stored_location)
3042
if stored_location is None:
3043
raise errors.BzrCommandError("No location specified or remembered")
3044
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3045
note(u"%s remembered location %s", verb_string, display_url)
3046
return stored_location
3049
class cmd_remerge(Command):
3052
Use this if you want to try a different merge technique while resolving
3053
conflicts. Some merge techniques are better than others, and remerge
3054
lets you try different ones on different files.
3056
The options for remerge have the same meaning and defaults as the ones for
3057
merge. The difference is that remerge can (only) be run when there is a
3058
pending merge, and it lets you specify particular files.
3061
Re-do the merge of all conflicted files, and show the base text in
3062
conflict regions, in addition to the usual THIS and OTHER texts::
3064
bzr remerge --show-base
3066
Re-do the merge of "foobar", using the weave merge algorithm, with
3067
additional processing to reduce the size of conflict regions::
3069
bzr remerge --merge-type weave --reprocess foobar
3071
takes_args = ['file*']
3076
help="Show base revision text in conflicts."),
3079
def run(self, file_list=None, merge_type=None, show_base=False,
3081
if merge_type is None:
3082
merge_type = _mod_merge.Merge3Merger
3083
tree, file_list = tree_files(file_list)
3086
parents = tree.get_parent_ids()
3087
if len(parents) != 2:
3088
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3089
" merges. Not cherrypicking or"
3091
repository = tree.branch.repository
3092
interesting_ids = None
3094
conflicts = tree.conflicts()
3095
if file_list is not None:
3096
interesting_ids = set()
3097
for filename in file_list:
3098
file_id = tree.path2id(filename)
3100
raise errors.NotVersionedError(filename)
3101
interesting_ids.add(file_id)
3102
if tree.kind(file_id) != "directory":
3105
for name, ie in tree.inventory.iter_entries(file_id):
3106
interesting_ids.add(ie.file_id)
3107
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3109
# Remerge only supports resolving contents conflicts
3110
allowed_conflicts = ('text conflict', 'contents conflict')
3111
restore_files = [c.path for c in conflicts
3112
if c.typestring in allowed_conflicts]
3113
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3114
tree.set_conflicts(ConflictList(new_conflicts))
3115
if file_list is not None:
3116
restore_files = file_list
3117
for filename in restore_files:
3119
restore(tree.abspath(filename))
3120
except errors.NotConflicted:
3122
# Disable pending merges, because the file texts we are remerging
3123
# have not had those merges performed. If we use the wrong parents
3124
# list, we imply that the working tree text has seen and rejected
3125
# all the changes from the other tree, when in fact those changes
3126
# have not yet been seen.
3127
pb = ui.ui_factory.nested_progress_bar()
3128
tree.set_parent_ids(parents[:1])
3130
merger = _mod_merge.Merger.from_revision_ids(pb,
3132
merger.interesting_ids = interesting_ids
3133
merger.merge_type = merge_type
3134
merger.show_base = show_base
3135
merger.reprocess = reprocess
3136
conflicts = merger.do_merge()
3138
tree.set_parent_ids(parents)
3148
class cmd_revert(Command):
3149
"""Revert files to a previous revision.
3151
Giving a list of files will revert only those files. Otherwise, all files
3152
will be reverted. If the revision is not specified with '--revision', the
3153
last committed revision is used.
3155
To remove only some changes, without reverting to a prior version, use
3156
merge instead. For example, "merge . --revision -2..-3" will remove the
3157
changes introduced by -2, without affecting the changes introduced by -1.
3158
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3160
By default, any files that have been manually changed will be backed up
3161
first. (Files changed only by merge are not backed up.) Backup files have
3162
'.~#~' appended to their name, where # is a number.
3164
When you provide files, you can use their current pathname or the pathname
3165
from the target revision. So you can use revert to "undelete" a file by
3166
name. If you name a directory, all the contents of that directory will be
3169
Any files that have been newly added since that revision will be deleted,
3170
with a backup kept if appropriate. Directories containing unknown files
3171
will not be deleted.
3173
The working tree contains a list of pending merged revisions, which will
3174
be included as parents in the next commit. Normally, revert clears that
3175
list as well as reverting the files. If any files are specified, revert
3176
leaves the pending merge list alone and reverts only the files. Use "bzr
3177
revert ." in the tree root to revert all files but keep the merge record,
3178
and "bzr revert --forget-merges" to clear the pending merge list without
3179
reverting any files.
3182
_see_also = ['cat', 'export']
3185
Option('no-backup', "Do not save backups of reverted files."),
3186
Option('forget-merges',
3187
'Remove pending merge marker, without changing any files.'),
3189
takes_args = ['file*']
3191
def run(self, revision=None, no_backup=False, file_list=None,
3192
forget_merges=None):
3193
tree, file_list = tree_files(file_list)
3195
tree.set_parent_ids(tree.get_parent_ids()[:1])
3197
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3200
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3201
if revision is None:
3202
rev_id = tree.last_revision()
3203
elif len(revision) != 1:
3204
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3206
rev_id = revision[0].as_revision_id(tree.branch)
3207
pb = ui.ui_factory.nested_progress_bar()
3209
tree.revert(file_list,
3210
tree.branch.repository.revision_tree(rev_id),
3211
not no_backup, pb, report_changes=True)
3216
class cmd_assert_fail(Command):
3217
"""Test reporting of assertion failures"""
3218
# intended just for use in testing
3223
raise AssertionError("always fails")
3226
class cmd_help(Command):
3227
"""Show help on a command or other topic.
3230
_see_also = ['topics']
3232
Option('long', 'Show help on all commands.'),
3234
takes_args = ['topic?']
3235
aliases = ['?', '--help', '-?', '-h']
3238
def run(self, topic=None, long=False):
3240
if topic is None and long:
3242
bzrlib.help.help(topic)
3245
class cmd_shell_complete(Command):
3246
"""Show appropriate completions for context.
3248
For a list of all available commands, say 'bzr shell-complete'.
3250
takes_args = ['context?']
3255
def run(self, context=None):
3256
import shellcomplete
3257
shellcomplete.shellcomplete(context)
3260
class cmd_fetch(Command):
3261
"""Copy in history from another branch but don't merge it.
3263
This is an internal method used for pull and merge.
3266
takes_args = ['from_branch', 'to_branch']
3267
def run(self, from_branch, to_branch):
3268
from bzrlib.fetch import Fetcher
3269
from_b = Branch.open(from_branch)
3270
to_b = Branch.open(to_branch)
3271
Fetcher(to_b, from_b)
3274
class cmd_missing(Command):
3275
"""Show unmerged/unpulled revisions between two branches.
3277
OTHER_BRANCH may be local or remote.
3280
_see_also = ['merge', 'pull']
3281
takes_args = ['other_branch?']
3283
Option('reverse', 'Reverse the order of revisions.'),
3285
'Display changes in the local branch only.'),
3286
Option('this' , 'Same as --mine-only.'),
3287
Option('theirs-only',
3288
'Display changes in the remote branch only.'),
3289
Option('other', 'Same as --theirs-only.'),
3294
encoding_type = 'replace'
3297
def run(self, other_branch=None, reverse=False, mine_only=False,
3298
theirs_only=False, log_format=None, long=False, short=False, line=False,
3299
show_ids=False, verbose=False, this=False, other=False):
3300
from bzrlib.missing import find_unmerged, iter_log_revisions
3307
local_branch = Branch.open_containing(u".")[0]
3308
parent = local_branch.get_parent()
3309
if other_branch is None:
3310
other_branch = parent
3311
if other_branch is None:
3312
raise errors.BzrCommandError("No peer location known"
3314
display_url = urlutils.unescape_for_display(parent,
3316
self.outf.write("Using last location: " + display_url + "\n")
3318
remote_branch = Branch.open(other_branch)
3319
if remote_branch.base == local_branch.base:
3320
remote_branch = local_branch
3321
local_branch.lock_read()
3323
remote_branch.lock_read()
3325
local_extra, remote_extra = find_unmerged(local_branch,
3327
if log_format is None:
3328
registry = log.log_formatter_registry
3329
log_format = registry.get_default(local_branch)
3330
lf = log_format(to_file=self.outf,
3332
show_timezone='original')
3333
if reverse is False:
3334
local_extra.reverse()
3335
remote_extra.reverse()
3336
if local_extra and not theirs_only:
3337
self.outf.write("You have %d extra revision(s):\n" %
3339
for revision in iter_log_revisions(local_extra,
3340
local_branch.repository,
3342
lf.log_revision(revision)
3343
printed_local = True
3345
printed_local = False
3346
if remote_extra and not mine_only:
3347
if printed_local is True:
3348
self.outf.write("\n\n\n")
3349
self.outf.write("You are missing %d revision(s):\n" %
3351
for revision in iter_log_revisions(remote_extra,
3352
remote_branch.repository,
3354
lf.log_revision(revision)
3355
if not remote_extra and not local_extra:
3357
self.outf.write("Branches are up to date.\n")
3361
remote_branch.unlock()
3363
local_branch.unlock()
3364
if not status_code and parent is None and other_branch is not None:
3365
local_branch.lock_write()
3367
# handle race conditions - a parent might be set while we run.
3368
if local_branch.get_parent() is None:
3369
local_branch.set_parent(remote_branch.base)
3371
local_branch.unlock()
3375
class cmd_pack(Command):
3376
"""Compress the data within a repository."""
3378
_see_also = ['repositories']
3379
takes_args = ['branch_or_repo?']
3381
def run(self, branch_or_repo='.'):
3382
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3384
branch = dir.open_branch()
3385
repository = branch.repository
3386
except errors.NotBranchError:
3387
repository = dir.open_repository()
3391
class cmd_plugins(Command):
3392
"""List the installed plugins.
3394
This command displays the list of installed plugins including
3395
version of plugin and a short description of each.
3397
--verbose shows the path where each plugin is located.
3399
A plugin is an external component for Bazaar that extends the
3400
revision control system, by adding or replacing code in Bazaar.
3401
Plugins can do a variety of things, including overriding commands,
3402
adding new commands, providing additional network transports and
3403
customizing log output.
3405
See the Bazaar web site, http://bazaar-vcs.org, for further
3406
information on plugins including where to find them and how to
3407
install them. Instructions are also provided there on how to
3408
write new plugins using the Python programming language.
3410
takes_options = ['verbose']
3413
def run(self, verbose=False):
3414
import bzrlib.plugin
3415
from inspect import getdoc
3417
for name, plugin in bzrlib.plugin.plugins().items():
3418
version = plugin.__version__
3419
if version == 'unknown':
3421
name_ver = '%s %s' % (name, version)
3422
d = getdoc(plugin.module)
3424
doc = d.split('\n')[0]
3426
doc = '(no description)'
3427
result.append((name_ver, doc, plugin.path()))
3428
for name_ver, doc, path in sorted(result):
3436
class cmd_testament(Command):
3437
"""Show testament (signing-form) of a revision."""
3440
Option('long', help='Produce long-format testament.'),
3442
help='Produce a strict-format testament.')]
3443
takes_args = ['branch?']
3445
def run(self, branch=u'.', revision=None, long=False, strict=False):
3446
from bzrlib.testament import Testament, StrictTestament
3448
testament_class = StrictTestament
3450
testament_class = Testament
3451
b = WorkingTree.open_containing(branch)[0].branch
3454
if revision is None:
3455
rev_id = b.last_revision()
3457
rev_id = revision[0].as_revision_id(b)
3458
t = testament_class.from_revision(b.repository, rev_id)
3460
sys.stdout.writelines(t.as_text_lines())
3462
sys.stdout.write(t.as_short_text())
3467
class cmd_annotate(Command):
3468
"""Show the origin of each line in a file.
3470
This prints out the given file with an annotation on the left side
3471
indicating which revision, author and date introduced the change.
3473
If the origin is the same for a run of consecutive lines, it is
3474
shown only at the top, unless the --all option is given.
3476
# TODO: annotate directories; showing when each file was last changed
3477
# TODO: if the working copy is modified, show annotations on that
3478
# with new uncommitted lines marked
3479
aliases = ['ann', 'blame', 'praise']
3480
takes_args = ['filename']
3481
takes_options = [Option('all', help='Show annotations on all lines.'),
3482
Option('long', help='Show commit date in annotations.'),
3486
encoding_type = 'exact'
3489
def run(self, filename, all=False, long=False, revision=None,
3491
from bzrlib.annotate import annotate_file
3492
wt, branch, relpath = \
3493
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3499
if revision is None:
3500
revision_id = branch.last_revision()
3501
elif len(revision) != 1:
3502
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3504
revision_id = revision[0].as_revision_id(branch)
3505
tree = branch.repository.revision_tree(revision_id)
3507
file_id = wt.path2id(relpath)
3509
file_id = tree.path2id(relpath)
3511
raise errors.NotVersionedError(filename)
3512
file_version = tree.inventory[file_id].revision
3513
annotate_file(branch, file_version, file_id, long, all, self.outf,
3522
class cmd_re_sign(Command):
3523
"""Create a digital signature for an existing revision."""
3524
# TODO be able to replace existing ones.
3526
hidden = True # is this right ?
3527
takes_args = ['revision_id*']
3528
takes_options = ['revision']
3530
def run(self, revision_id_list=None, revision=None):
3531
if revision_id_list is not None and revision is not None:
3532
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3533
if revision_id_list is None and revision is None:
3534
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3535
b = WorkingTree.open_containing(u'.')[0].branch
3538
return self._run(b, revision_id_list, revision)
3542
def _run(self, b, revision_id_list, revision):
3543
import bzrlib.gpg as gpg
3544
gpg_strategy = gpg.GPGStrategy(b.get_config())
3545
if revision_id_list is not None:
3546
b.repository.start_write_group()
3548
for revision_id in revision_id_list:
3549
b.repository.sign_revision(revision_id, gpg_strategy)
3551
b.repository.abort_write_group()
3554
b.repository.commit_write_group()
3555
elif revision is not None:
3556
if len(revision) == 1:
3557
revno, rev_id = revision[0].in_history(b)
3558
b.repository.start_write_group()
3560
b.repository.sign_revision(rev_id, gpg_strategy)
3562
b.repository.abort_write_group()
3565
b.repository.commit_write_group()
3566
elif len(revision) == 2:
3567
# are they both on rh- if so we can walk between them
3568
# might be nice to have a range helper for arbitrary
3569
# revision paths. hmm.
3570
from_revno, from_revid = revision[0].in_history(b)
3571
to_revno, to_revid = revision[1].in_history(b)
3572
if to_revid is None:
3573
to_revno = b.revno()
3574
if from_revno is None or to_revno is None:
3575
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3576
b.repository.start_write_group()
3578
for revno in range(from_revno, to_revno + 1):
3579
b.repository.sign_revision(b.get_rev_id(revno),
3582
b.repository.abort_write_group()
3585
b.repository.commit_write_group()
3587
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3590
class cmd_bind(Command):
3591
"""Convert the current branch into a checkout of the supplied branch.
3593
Once converted into a checkout, commits must succeed on the master branch
3594
before they will be applied to the local branch.
3597
_see_also = ['checkouts', 'unbind']
3598
takes_args = ['location?']
3601
def run(self, location=None):
3602
b, relpath = Branch.open_containing(u'.')
3603
if location is None:
3605
location = b.get_old_bound_location()
3606
except errors.UpgradeRequired:
3607
raise errors.BzrCommandError('No location supplied. '
3608
'This format does not remember old locations.')
3610
if location is None:
3611
raise errors.BzrCommandError('No location supplied and no '
3612
'previous location known')
3613
b_other = Branch.open(location)
3616
except errors.DivergedBranches:
3617
raise errors.BzrCommandError('These branches have diverged.'
3618
' Try merging, and then bind again.')
3621
class cmd_unbind(Command):
3622
"""Convert the current checkout into a regular branch.
3624
After unbinding, the local branch is considered independent and subsequent
3625
commits will be local only.
3628
_see_also = ['checkouts', 'bind']
3633
b, relpath = Branch.open_containing(u'.')
3635
raise errors.BzrCommandError('Local branch is not bound')
3638
class cmd_uncommit(Command):
3639
"""Remove the last committed revision.
3641
--verbose will print out what is being removed.
3642
--dry-run will go through all the motions, but not actually
3645
If --revision is specified, uncommit revisions to leave the branch at the
3646
specified revision. For example, "bzr uncommit -r 15" will leave the
3647
branch at revision 15.
3649
In the future, uncommit will create a revision bundle, which can then
3653
# TODO: jam 20060108 Add an option to allow uncommit to remove
3654
# unreferenced information in 'branch-as-repository' branches.
3655
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3656
# information in shared branches as well.
3657
_see_also = ['commit']
3658
takes_options = ['verbose', 'revision',
3659
Option('dry-run', help='Don\'t actually make changes.'),
3660
Option('force', help='Say yes to all questions.'),
3662
help="Only remove the commits from the local branch"
3663
" when in a checkout."
3666
takes_args = ['location?']
3668
encoding_type = 'replace'
3670
def run(self, location=None,
3671
dry_run=False, verbose=False,
3672
revision=None, force=False, local=False):
3673
if location is None:
3675
control, relpath = bzrdir.BzrDir.open_containing(location)
3677
tree = control.open_workingtree()
3679
except (errors.NoWorkingTree, errors.NotLocalUrl):
3681
b = control.open_branch()
3683
if tree is not None:
3688
return self._run(b, tree, dry_run, verbose, revision, force,
3691
if tree is not None:
3696
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3697
from bzrlib.log import log_formatter, show_log
3698
from bzrlib.uncommit import uncommit
3700
last_revno, last_rev_id = b.last_revision_info()
3703
if revision is None:
3705
rev_id = last_rev_id
3707
# 'bzr uncommit -r 10' actually means uncommit
3708
# so that the final tree is at revno 10.
3709
# but bzrlib.uncommit.uncommit() actually uncommits
3710
# the revisions that are supplied.
3711
# So we need to offset it by one
3712
revno = revision[0].in_history(b).revno + 1
3713
if revno <= last_revno:
3714
rev_id = b.get_rev_id(revno)
3716
if rev_id is None or _mod_revision.is_null(rev_id):
3717
self.outf.write('No revisions to uncommit.\n')
3720
lf = log_formatter('short',
3722
show_timezone='original')
3727
direction='forward',
3728
start_revision=revno,
3729
end_revision=last_revno)
3732
print 'Dry-run, pretending to remove the above revisions.'
3734
val = raw_input('Press <enter> to continue')
3736
print 'The above revision(s) will be removed.'
3738
val = raw_input('Are you sure [y/N]? ')
3739
if val.lower() not in ('y', 'yes'):
3743
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3744
revno=revno, local=local)
3747
class cmd_break_lock(Command):
3748
"""Break a dead lock on a repository, branch or working directory.
3750
CAUTION: Locks should only be broken when you are sure that the process
3751
holding the lock has been stopped.
3753
You can get information on what locks are open via the 'bzr info' command.
3758
takes_args = ['location?']
3760
def run(self, location=None, show=False):
3761
if location is None:
3763
control, relpath = bzrdir.BzrDir.open_containing(location)
3765
control.break_lock()
3766
except NotImplementedError:
3770
class cmd_wait_until_signalled(Command):
3771
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3773
This just prints a line to signal when it is ready, then blocks on stdin.
3779
sys.stdout.write("running\n")
3781
sys.stdin.readline()
3784
class cmd_serve(Command):
3785
"""Run the bzr server."""
3787
aliases = ['server']
3791
help='Serve on stdin/out for use from inetd or sshd.'),
3793
help='Listen for connections on nominated port of the form '
3794
'[hostname:]portnumber. Passing 0 as the port number will '
3795
'result in a dynamically allocated port. The default port is '
3799
help='Serve contents of this directory.',
3801
Option('allow-writes',
3802
help='By default the server is a readonly server. Supplying '
3803
'--allow-writes enables write access to the contents of '
3804
'the served directory and below.'
3808
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3809
from bzrlib import lockdir
3810
from bzrlib.smart import medium, server
3811
from bzrlib.transport import get_transport
3812
from bzrlib.transport.chroot import ChrootServer
3813
if directory is None:
3814
directory = os.getcwd()
3815
url = urlutils.local_path_to_url(directory)
3816
if not allow_writes:
3817
url = 'readonly+' + url
3818
chroot_server = ChrootServer(get_transport(url))
3819
chroot_server.setUp()
3820
t = get_transport(chroot_server.get_url())
3822
smart_server = medium.SmartServerPipeStreamMedium(
3823
sys.stdin, sys.stdout, t)
3825
host = medium.BZR_DEFAULT_INTERFACE
3827
port = medium.BZR_DEFAULT_PORT
3830
host, port = port.split(':')
3832
smart_server = server.SmartTCPServer(t, host=host, port=port)
3833
print 'listening on port: ', smart_server.port
3835
# for the duration of this server, no UI output is permitted.
3836
# note that this may cause problems with blackbox tests. This should
3837
# be changed with care though, as we dont want to use bandwidth sending
3838
# progress over stderr to smart server clients!
3839
old_factory = ui.ui_factory
3840
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3842
ui.ui_factory = ui.SilentUIFactory()
3843
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3844
smart_server.serve()
3846
ui.ui_factory = old_factory
3847
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3850
class cmd_join(Command):
3851
"""Combine a subtree into its containing tree.
3853
This command is for experimental use only. It requires the target tree
3854
to be in dirstate-with-subtree format, which cannot be converted into
3857
The TREE argument should be an independent tree, inside another tree, but
3858
not part of it. (Such trees can be produced by "bzr split", but also by
3859
running "bzr branch" with the target inside a tree.)
3861
The result is a combined tree, with the subtree no longer an independant
3862
part. This is marked as a merge of the subtree into the containing tree,
3863
and all history is preserved.
3865
If --reference is specified, the subtree retains its independence. It can
3866
be branched by itself, and can be part of multiple projects at the same
3867
time. But operations performed in the containing tree, such as commit
3868
and merge, will recurse into the subtree.
3871
_see_also = ['split']
3872
takes_args = ['tree']
3874
Option('reference', help='Join by reference.'),
3878
def run(self, tree, reference=False):
3879
sub_tree = WorkingTree.open(tree)
3880
parent_dir = osutils.dirname(sub_tree.basedir)
3881
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3882
repo = containing_tree.branch.repository
3883
if not repo.supports_rich_root():
3884
raise errors.BzrCommandError(
3885
"Can't join trees because %s doesn't support rich root data.\n"
3886
"You can use bzr upgrade on the repository."
3890
containing_tree.add_reference(sub_tree)
3891
except errors.BadReferenceTarget, e:
3892
# XXX: Would be better to just raise a nicely printable
3893
# exception from the real origin. Also below. mbp 20070306
3894
raise errors.BzrCommandError("Cannot join %s. %s" %
3898
containing_tree.subsume(sub_tree)
3899
except errors.BadSubsumeSource, e:
3900
raise errors.BzrCommandError("Cannot join %s. %s" %
3904
class cmd_split(Command):
3905
"""Split a subdirectory of a tree into a separate tree.
3907
This command will produce a target tree in a format that supports
3908
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3909
converted into earlier formats like 'dirstate-tags'.
3911
The TREE argument should be a subdirectory of a working tree. That
3912
subdirectory will be converted into an independent tree, with its own
3913
branch. Commits in the top-level tree will not apply to the new subtree.
3916
# join is not un-hidden yet
3917
#_see_also = ['join']
3918
takes_args = ['tree']
3920
def run(self, tree):
3921
containing_tree, subdir = WorkingTree.open_containing(tree)
3922
sub_id = containing_tree.path2id(subdir)
3924
raise errors.NotVersionedError(subdir)
3926
containing_tree.extract(sub_id)
3927
except errors.RootNotRich:
3928
raise errors.UpgradeRequired(containing_tree.branch.base)
3931
class cmd_merge_directive(Command):
3932
"""Generate a merge directive for auto-merge tools.
3934
A directive requests a merge to be performed, and also provides all the
3935
information necessary to do so. This means it must either include a
3936
revision bundle, or the location of a branch containing the desired
3939
A submit branch (the location to merge into) must be supplied the first
3940
time the command is issued. After it has been supplied once, it will
3941
be remembered as the default.
3943
A public branch is optional if a revision bundle is supplied, but required
3944
if --diff or --plain is specified. It will be remembered as the default
3945
after the first use.
3948
takes_args = ['submit_branch?', 'public_branch?']
3952
_see_also = ['send']
3955
RegistryOption.from_kwargs('patch-type',
3956
'The type of patch to include in the directive.',
3958
value_switches=True,
3960
bundle='Bazaar revision bundle (default).',
3961
diff='Normal unified diff.',
3962
plain='No patch, just directive.'),
3963
Option('sign', help='GPG-sign the directive.'), 'revision',
3964
Option('mail-to', type=str,
3965
help='Instead of printing the directive, email to this address.'),
3966
Option('message', type=str, short_name='m',
3967
help='Message to use when committing this merge.')
3970
encoding_type = 'exact'
3972
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3973
sign=False, revision=None, mail_to=None, message=None):
3974
from bzrlib.revision import ensure_null, NULL_REVISION
3975
include_patch, include_bundle = {
3976
'plain': (False, False),
3977
'diff': (True, False),
3978
'bundle': (True, True),
3980
branch = Branch.open('.')
3981
stored_submit_branch = branch.get_submit_branch()
3982
if submit_branch is None:
3983
submit_branch = stored_submit_branch
3985
if stored_submit_branch is None:
3986
branch.set_submit_branch(submit_branch)
3987
if submit_branch is None:
3988
submit_branch = branch.get_parent()
3989
if submit_branch is None:
3990
raise errors.BzrCommandError('No submit branch specified or known')
3992
stored_public_branch = branch.get_public_branch()
3993
if public_branch is None:
3994
public_branch = stored_public_branch
3995
elif stored_public_branch is None:
3996
branch.set_public_branch(public_branch)
3997
if not include_bundle and public_branch is None:
3998
raise errors.BzrCommandError('No public branch specified or'
4000
base_revision_id = None
4001
if revision is not None:
4002
if len(revision) > 2:
4003
raise errors.BzrCommandError('bzr merge-directive takes '
4004
'at most two one revision identifiers')
4005
revision_id = revision[-1].as_revision_id(branch)
4006
if len(revision) == 2:
4007
base_revision_id = revision[0].as_revision_id(branch)
4009
revision_id = branch.last_revision()
4010
revision_id = ensure_null(revision_id)
4011
if revision_id == NULL_REVISION:
4012
raise errors.BzrCommandError('No revisions to bundle.')
4013
directive = merge_directive.MergeDirective2.from_objects(
4014
branch.repository, revision_id, time.time(),
4015
osutils.local_time_offset(), submit_branch,
4016
public_branch=public_branch, include_patch=include_patch,
4017
include_bundle=include_bundle, message=message,
4018
base_revision_id=base_revision_id)
4021
self.outf.write(directive.to_signed(branch))
4023
self.outf.writelines(directive.to_lines())
4025
message = directive.to_email(mail_to, branch, sign)
4026
s = SMTPConnection(branch.get_config())
4027
s.send_email(message)
4030
class cmd_send(Command):
4031
"""Mail or create a merge-directive for submiting changes.
4033
A merge directive provides many things needed for requesting merges:
4035
* A machine-readable description of the merge to perform
4037
* An optional patch that is a preview of the changes requested
4039
* An optional bundle of revision data, so that the changes can be applied
4040
directly from the merge directive, without retrieving data from a
4043
If --no-bundle is specified, then public_branch is needed (and must be
4044
up-to-date), so that the receiver can perform the merge using the
4045
public_branch. The public_branch is always included if known, so that
4046
people can check it later.
4048
The submit branch defaults to the parent, but can be overridden. Both
4049
submit branch and public branch will be remembered if supplied.
4051
If a public_branch is known for the submit_branch, that public submit
4052
branch is used in the merge instructions. This means that a local mirror
4053
can be used as your actual submit branch, once you have set public_branch
4056
Mail is sent using your preferred mail program. This should be transparent
4057
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4058
If the preferred client can't be found (or used), your editor will be used.
4060
To use a specific mail program, set the mail_client configuration option.
4061
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4062
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4063
generic options are "default", "editor", "mapi", and "xdg-email".
4065
If mail is being sent, a to address is required. This can be supplied
4066
either on the commandline, by setting the submit_to configuration
4067
option in the branch itself or the child_submit_to configuration option
4068
in the submit branch.
4070
Two formats are currently supported: "4" uses revision bundle format 4 and
4071
merge directive format 2. It is significantly faster and smaller than
4072
older formats. It is compatible with Bazaar 0.19 and later. It is the
4073
default. "0.9" uses revision bundle format 0.9 and merge directive
4074
format 1. It is compatible with Bazaar 0.12 - 0.18.
4077
encoding_type = 'exact'
4079
_see_also = ['merge']
4081
takes_args = ['submit_branch?', 'public_branch?']
4085
help='Do not include a bundle in the merge directive.'),
4086
Option('no-patch', help='Do not include a preview patch in the merge'
4089
help='Remember submit and public branch.'),
4091
help='Branch to generate the submission from, '
4092
'rather than the one containing the working directory.',
4095
Option('output', short_name='o', help='Write directive to this file.',
4097
Option('mail-to', help='Mail the request to this address.',
4101
RegistryOption.from_kwargs('format',
4102
'Use the specified output format.',
4103
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4104
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4107
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4108
no_patch=False, revision=None, remember=False, output=None,
4109
format='4', mail_to=None, message=None, **kwargs):
4110
return self._run(submit_branch, revision, public_branch, remember,
4111
format, no_bundle, no_patch, output,
4112
kwargs.get('from', '.'), mail_to, message)
4114
def _run(self, submit_branch, revision, public_branch, remember, format,
4115
no_bundle, no_patch, output, from_, mail_to, message):
4116
from bzrlib.revision import NULL_REVISION
4117
branch = Branch.open_containing(from_)[0]
4119
outfile = StringIO()
4123
outfile = open(output, 'wb')
4124
# we may need to write data into branch's repository to calculate
4129
config = branch.get_config()
4131
mail_to = config.get_user_option('submit_to')
4132
mail_client = config.get_mail_client()
4133
if remember and submit_branch is None:
4134
raise errors.BzrCommandError(
4135
'--remember requires a branch to be specified.')
4136
stored_submit_branch = branch.get_submit_branch()
4137
remembered_submit_branch = False
4138
if submit_branch is None:
4139
submit_branch = stored_submit_branch
4140
remembered_submit_branch = True
4142
if stored_submit_branch is None or remember:
4143
branch.set_submit_branch(submit_branch)
4144
if submit_branch is None:
4145
submit_branch = branch.get_parent()
4146
remembered_submit_branch = True
4147
if submit_branch is None:
4148
raise errors.BzrCommandError('No submit branch known or'
4150
if remembered_submit_branch:
4151
note('Using saved location: %s', submit_branch)
4154
submit_config = Branch.open(submit_branch).get_config()
4155
mail_to = submit_config.get_user_option("child_submit_to")
4157
stored_public_branch = branch.get_public_branch()
4158
if public_branch is None:
4159
public_branch = stored_public_branch
4160
elif stored_public_branch is None or remember:
4161
branch.set_public_branch(public_branch)
4162
if no_bundle and public_branch is None:
4163
raise errors.BzrCommandError('No public branch specified or'
4165
base_revision_id = None
4167
if revision is not None:
4168
if len(revision) > 2:
4169
raise errors.BzrCommandError('bzr send takes '
4170
'at most two one revision identifiers')
4171
revision_id = revision[-1].as_revision_id(branch)
4172
if len(revision) == 2:
4173
base_revision_id = revision[0].as_revision_id(branch)
4174
if revision_id is None:
4175
revision_id = branch.last_revision()
4176
if revision_id == NULL_REVISION:
4177
raise errors.BzrCommandError('No revisions to submit.')
4179
directive = merge_directive.MergeDirective2.from_objects(
4180
branch.repository, revision_id, time.time(),
4181
osutils.local_time_offset(), submit_branch,
4182
public_branch=public_branch, include_patch=not no_patch,
4183
include_bundle=not no_bundle, message=message,
4184
base_revision_id=base_revision_id)
4185
elif format == '0.9':
4188
patch_type = 'bundle'
4190
raise errors.BzrCommandError('Format 0.9 does not'
4191
' permit bundle with no patch')
4197
directive = merge_directive.MergeDirective.from_objects(
4198
branch.repository, revision_id, time.time(),
4199
osutils.local_time_offset(), submit_branch,
4200
public_branch=public_branch, patch_type=patch_type,
4203
outfile.writelines(directive.to_lines())
4205
subject = '[MERGE] '
4206
if message is not None:
4209
revision = branch.repository.get_revision(revision_id)
4210
subject += revision.get_summary()
4211
basename = directive.get_disk_name(branch)
4212
mail_client.compose_merge_request(mail_to, subject,
4213
outfile.getvalue(), basename)
4220
class cmd_bundle_revisions(cmd_send):
4222
"""Create a merge-directive for submiting changes.
4224
A merge directive provides many things needed for requesting merges:
4226
* A machine-readable description of the merge to perform
4228
* An optional patch that is a preview of the changes requested
4230
* An optional bundle of revision data, so that the changes can be applied
4231
directly from the merge directive, without retrieving data from a
4234
If --no-bundle is specified, then public_branch is needed (and must be
4235
up-to-date), so that the receiver can perform the merge using the
4236
public_branch. The public_branch is always included if known, so that
4237
people can check it later.
4239
The submit branch defaults to the parent, but can be overridden. Both
4240
submit branch and public branch will be remembered if supplied.
4242
If a public_branch is known for the submit_branch, that public submit
4243
branch is used in the merge instructions. This means that a local mirror
4244
can be used as your actual submit branch, once you have set public_branch
4247
Two formats are currently supported: "4" uses revision bundle format 4 and
4248
merge directive format 2. It is significantly faster and smaller than
4249
older formats. It is compatible with Bazaar 0.19 and later. It is the
4250
default. "0.9" uses revision bundle format 0.9 and merge directive
4251
format 1. It is compatible with Bazaar 0.12 - 0.18.
4256
help='Do not include a bundle in the merge directive.'),
4257
Option('no-patch', help='Do not include a preview patch in the merge'
4260
help='Remember submit and public branch.'),
4262
help='Branch to generate the submission from, '
4263
'rather than the one containing the working directory.',
4266
Option('output', short_name='o', help='Write directive to this file.',
4269
RegistryOption.from_kwargs('format',
4270
'Use the specified output format.',
4271
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4272
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4274
aliases = ['bundle']
4276
_see_also = ['send', 'merge']
4280
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4281
no_patch=False, revision=None, remember=False, output=None,
4282
format='4', **kwargs):
4285
return self._run(submit_branch, revision, public_branch, remember,
4286
format, no_bundle, no_patch, output,
4287
kwargs.get('from', '.'), None, None)
4290
class cmd_tag(Command):
4291
"""Create, remove or modify a tag naming a revision.
4293
Tags give human-meaningful names to revisions. Commands that take a -r
4294
(--revision) option can be given -rtag:X, where X is any previously
4297
Tags are stored in the branch. Tags are copied from one branch to another
4298
along when you branch, push, pull or merge.
4300
It is an error to give a tag name that already exists unless you pass
4301
--force, in which case the tag is moved to point to the new revision.
4304
_see_also = ['commit', 'tags']
4305
takes_args = ['tag_name']
4308
help='Delete this tag rather than placing it.',
4311
help='Branch in which to place the tag.',
4316
help='Replace existing tags.',
4321
def run(self, tag_name,
4327
branch, relpath = Branch.open_containing(directory)
4331
branch.tags.delete_tag(tag_name)
4332
self.outf.write('Deleted tag %s.\n' % tag_name)
4335
if len(revision) != 1:
4336
raise errors.BzrCommandError(
4337
"Tags can only be placed on a single revision, "
4339
revision_id = revision[0].as_revision_id(branch)
4341
revision_id = branch.last_revision()
4342
if (not force) and branch.tags.has_tag(tag_name):
4343
raise errors.TagAlreadyExists(tag_name)
4344
branch.tags.set_tag(tag_name, revision_id)
4345
self.outf.write('Created tag %s.\n' % tag_name)
4350
class cmd_tags(Command):
4353
This command shows a table of tag names and the revisions they reference.
4359
help='Branch whose tags should be displayed.',
4363
RegistryOption.from_kwargs('sort',
4364
'Sort tags by different criteria.', title='Sorting',
4365
alpha='Sort tags lexicographically (default).',
4366
time='Sort tags chronologically.',
4377
branch, relpath = Branch.open_containing(directory)
4378
tags = branch.tags.get_tag_dict().items()
4381
elif sort == 'time':
4383
for tag, revid in tags:
4385
revobj = branch.repository.get_revision(revid)
4386
except errors.NoSuchRevision:
4387
timestamp = sys.maxint # place them at the end
4389
timestamp = revobj.timestamp
4390
timestamps[revid] = timestamp
4391
tags.sort(key=lambda x: timestamps[x[1]])
4393
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4394
revno_map = branch.get_revision_id_to_revno_map()
4395
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4396
for tag, revid in tags ]
4397
for tag, revspec in tags:
4398
self.outf.write('%-20s %s\n' % (tag, revspec))
4401
class cmd_reconfigure(Command):
4402
"""Reconfigure the type of a bzr directory.
4404
A target configuration must be specified.
4406
For checkouts, the bind-to location will be auto-detected if not specified.
4407
The order of preference is
4408
1. For a lightweight checkout, the current bound location.
4409
2. For branches that used to be checkouts, the previously-bound location.
4410
3. The push location.
4411
4. The parent location.
4412
If none of these is available, --bind-to must be specified.
4415
takes_args = ['location?']
4416
takes_options = [RegistryOption.from_kwargs('target_type',
4417
title='Target type',
4418
help='The type to reconfigure the directory to.',
4419
value_switches=True, enum_switch=False,
4420
branch='Reconfigure to a branch.',
4421
tree='Reconfigure to a tree.',
4422
checkout='Reconfigure to a checkout.',
4423
lightweight_checkout='Reconfigure to a lightweight'
4425
Option('bind-to', help='Branch to bind checkout to.',
4428
help='Perform reconfiguration even if local changes'
4432
def run(self, location=None, target_type=None, bind_to=None, force=False):
4433
directory = bzrdir.BzrDir.open(location)
4434
if target_type is None:
4435
raise errors.BzrCommandError('No target configuration specified')
4436
elif target_type == 'branch':
4437
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4438
elif target_type == 'tree':
4439
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4440
elif target_type == 'checkout':
4441
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4443
elif target_type == 'lightweight-checkout':
4444
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4446
reconfiguration.apply(force)
4449
class cmd_switch(Command):
4450
"""Set the branch of a checkout and update.
4452
For lightweight checkouts, this changes the branch being referenced.
4453
For heavyweight checkouts, this checks that there are no local commits
4454
versus the current bound branch, then it makes the local branch a mirror
4455
of the new location and binds to it.
4457
In both cases, the working tree is updated and uncommitted changes
4458
are merged. The user can commit or revert these as they desire.
4460
Pending merges need to be committed or reverted before using switch.
4463
takes_args = ['to_location']
4464
takes_options = [Option('force',
4465
help='Switch even if local commits will be lost.')
4468
def run(self, to_location, force=False):
4469
from bzrlib import switch
4470
to_branch = Branch.open(to_location)
4472
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4473
switch.switch(control_dir, to_branch, force)
4474
note('Switched to branch: %s',
4475
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4478
class cmd_hooks(Command):
4479
"""Show a branch's currently registered hooks.
4483
takes_args = ['path?']
4485
def run(self, path=None):
4488
branch_hooks = Branch.open(path).hooks
4489
for hook_type in branch_hooks:
4490
hooks = branch_hooks[hook_type]
4491
self.outf.write("%s:\n" % (hook_type,))
4494
self.outf.write(" %s\n" %
4495
(branch_hooks.get_hook_name(hook),))
4497
self.outf.write(" <no hooks installed>\n")
4500
def _create_prefix(cur_transport):
4501
needed = [cur_transport]
4502
# Recurse upwards until we can create a directory successfully
4504
new_transport = cur_transport.clone('..')
4505
if new_transport.base == cur_transport.base:
4506
raise errors.BzrCommandError(
4507
"Failed to create path prefix for %s."
4508
% cur_transport.base)
4510
new_transport.mkdir('.')
4511
except errors.NoSuchFile:
4512
needed.append(new_transport)
4513
cur_transport = new_transport
4516
# Now we only need to create child directories
4518
cur_transport = needed.pop()
4519
cur_transport.ensure_base()
4522
# these get imported and then picked up by the scan for cmd_*
4523
# TODO: Some more consistent way to split command definitions across files;
4524
# we do need to load at least some information about them to know of
4525
# aliases. ideally we would avoid loading the implementation until the
4526
# details were needed.
4527
from bzrlib.cmd_version_info import cmd_version_info
4528
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4529
from bzrlib.bundle.commands import (
4532
from bzrlib.sign_my_commits import cmd_sign_my_commits
4533
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4534
cmd_weave_plan_merge, cmd_weave_merge_text