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].in_history(work_tree.branch).rev_id
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:
625
mergeable, location_transport = _get_mergeable_helper(location)
626
possible_transports.append(location_transport)
628
stored_loc = branch_to.get_parent()
630
if stored_loc is None:
631
raise errors.BzrCommandError("No pull location known or"
634
display_url = urlutils.unescape_for_display(stored_loc,
637
self.outf.write("Using saved location: %s\n" % display_url)
638
location = stored_loc
639
location_transport = transport.get_transport(
640
location, possible_transports=possible_transports)
642
if mergeable is not None:
643
if revision is not None:
644
raise errors.BzrCommandError(
645
'Cannot use -r with merge directives or bundles')
646
mergeable.install_revisions(branch_to.repository)
647
base_revision_id, revision_id, verified = \
648
mergeable.get_merge_request(branch_to.repository)
649
branch_from = branch_to
651
branch_from = Branch.open_from_transport(location_transport)
653
if branch_to.get_parent() is None or remember:
654
branch_to.set_parent(branch_from.base)
656
if revision is not None:
657
if len(revision) == 1:
658
revision_id = revision[0].in_history(branch_from).rev_id
660
raise errors.BzrCommandError(
661
'bzr pull --revision takes one value.')
664
old_rh = branch_to.revision_history()
665
if tree_to is not None:
666
change_reporter = delta._ChangeReporter(
667
unversioned_filter=tree_to.is_ignored)
668
result = tree_to.pull(branch_from, overwrite, revision_id,
670
possible_transports=possible_transports)
672
result = branch_to.pull(branch_from, overwrite, revision_id)
674
result.report(self.outf)
676
new_rh = branch_to.revision_history()
677
log.show_changed_revisions(branch_to, old_rh, new_rh,
681
class cmd_push(Command):
682
"""Update a mirror of this branch.
684
The target branch will not have its working tree populated because this
685
is both expensive, and is not supported on remote file systems.
687
Some smart servers or protocols *may* put the working tree in place in
690
This command only works on branches that have not diverged. Branches are
691
considered diverged if the destination branch's most recent commit is one
692
that has not been merged (directly or indirectly) by the source branch.
694
If branches have diverged, you can use 'bzr push --overwrite' to replace
695
the other branch completely, discarding its unmerged changes.
697
If you want to ensure you have the different changes in the other branch,
698
do a merge (see bzr help merge) from the other branch, and commit that.
699
After that you will be able to do a push without '--overwrite'.
701
If there is no default push location set, the first push will set it.
702
After that, you can omit the location to use the default. To change the
703
default, use --remember. The value will only be saved if the remote
704
location can be accessed.
707
_see_also = ['pull', 'update', 'working-trees']
708
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
709
Option('create-prefix',
710
help='Create the path leading up to the branch '
711
'if it does not already exist.'),
713
help='Branch to push from, '
714
'rather than the one containing the working directory.',
718
Option('use-existing-dir',
719
help='By default push will fail if the target'
720
' directory exists, but does not already'
721
' have a control directory. This flag will'
722
' allow push to proceed.'),
724
takes_args = ['location?']
725
encoding_type = 'replace'
727
def run(self, location=None, remember=False, overwrite=False,
728
create_prefix=False, verbose=False, revision=None,
729
use_existing_dir=False,
731
# FIXME: Way too big! Put this into a function called from the
733
if directory is None:
735
br_from = Branch.open_containing(directory)[0]
736
stored_loc = br_from.get_push_location()
738
if stored_loc is None:
739
raise errors.BzrCommandError("No push location known or specified.")
741
display_url = urlutils.unescape_for_display(stored_loc,
743
self.outf.write("Using saved location: %s\n" % display_url)
744
location = stored_loc
746
to_transport = transport.get_transport(location)
748
br_to = repository_to = dir_to = None
750
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
751
except errors.NotBranchError:
752
pass # Didn't find anything
754
# If we can open a branch, use its direct repository, otherwise see
755
# if there is a repository without a branch.
757
br_to = dir_to.open_branch()
758
except errors.NotBranchError:
759
# Didn't find a branch, can we find a repository?
761
repository_to = dir_to.find_repository()
762
except errors.NoRepositoryPresent:
765
# Found a branch, so we must have found a repository
766
repository_to = br_to.repository
768
if revision is not None:
769
if len(revision) == 1:
770
revision_id = revision[0].in_history(br_from).rev_id
772
raise errors.BzrCommandError(
773
'bzr push --revision takes one value.')
775
revision_id = br_from.last_revision()
781
# The destination doesn't exist; create it.
782
# XXX: Refactor the create_prefix/no_create_prefix code into a
783
# common helper function
785
def make_directory(transport):
789
def redirected(redirected_transport, e, redirection_notice):
790
return transport.get_transport(e.get_target_url())
793
to_transport = transport.do_catching_redirections(
794
make_directory, to_transport, redirected)
795
except errors.FileExists:
796
if not use_existing_dir:
797
raise errors.BzrCommandError("Target directory %s"
798
" already exists, but does not have a valid .bzr"
799
" directory. Supply --use-existing-dir to push"
800
" there anyway." % location)
801
except errors.NoSuchFile:
802
if not create_prefix:
803
raise errors.BzrCommandError("Parent directory of %s"
805
"\nYou may supply --create-prefix to create all"
806
" leading parent directories."
808
_create_prefix(to_transport)
809
except errors.TooManyRedirections:
810
raise errors.BzrCommandError("Too many redirections trying "
811
"to make %s." % location)
813
# Now the target directory exists, but doesn't have a .bzr
814
# directory. So we need to create it, along with any work to create
815
# all of the dependent branches, etc.
816
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
817
revision_id=revision_id)
818
br_to = dir_to.open_branch()
819
# TODO: Some more useful message about what was copied
820
note('Created new branch.')
821
# We successfully created the target, remember it
822
if br_from.get_push_location() is None or remember:
823
br_from.set_push_location(br_to.base)
824
elif repository_to is None:
825
# we have a bzrdir but no branch or repository
826
# XXX: Figure out what to do other than complain.
827
raise errors.BzrCommandError("At %s you have a valid .bzr control"
828
" directory, but not a branch or repository. This is an"
829
" unsupported configuration. Please move the target directory"
830
" out of the way and try again."
833
# We have a repository but no branch, copy the revisions, and then
835
repository_to.fetch(br_from.repository, revision_id=revision_id)
836
br_to = br_from.clone(dir_to, revision_id=revision_id)
837
note('Created new branch.')
838
if br_from.get_push_location() is None or remember:
839
br_from.set_push_location(br_to.base)
840
else: # We have a valid to branch
841
# We were able to connect to the remote location, so remember it
842
# we don't need to successfully push because of possible divergence.
843
if br_from.get_push_location() is None or remember:
844
br_from.set_push_location(br_to.base)
846
old_rh = br_to.revision_history()
849
tree_to = dir_to.open_workingtree()
850
except errors.NotLocalUrl:
851
warning("This transport does not update the working "
852
"tree of: %s. See 'bzr help working-trees' for "
853
"more information." % br_to.base)
854
push_result = br_from.push(br_to, overwrite,
855
stop_revision=revision_id)
856
except errors.NoWorkingTree:
857
push_result = br_from.push(br_to, overwrite,
858
stop_revision=revision_id)
862
push_result = br_from.push(tree_to.branch, overwrite,
863
stop_revision=revision_id)
867
except errors.DivergedBranches:
868
raise errors.BzrCommandError('These branches have diverged.'
869
' Try using "merge" and then "push".')
870
if push_result is not None:
871
push_result.report(self.outf)
873
new_rh = br_to.revision_history()
876
from bzrlib.log import show_changed_revisions
877
show_changed_revisions(br_to, old_rh, new_rh,
880
# we probably did a clone rather than a push, so a message was
885
class cmd_branch(Command):
886
"""Create a new copy of a branch.
888
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
889
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
890
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
891
is derived from the FROM_LOCATION by stripping a leading scheme or drive
892
identifier, if any. For example, "branch lp:foo-bar" will attempt to
895
To retrieve the branch as of a particular revision, supply the --revision
896
parameter, as in "branch foo/bar -r 5".
899
_see_also = ['checkout']
900
takes_args = ['from_location', 'to_location?']
901
takes_options = ['revision', Option('hardlink',
902
help='Hard-link working tree files where possible.')]
903
aliases = ['get', 'clone']
905
def run(self, from_location, to_location=None, revision=None,
907
from bzrlib.tag import _merge_tags_if_possible
910
elif len(revision) > 1:
911
raise errors.BzrCommandError(
912
'bzr branch --revision takes exactly 1 revision value')
914
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
918
if len(revision) == 1 and revision[0] is not None:
919
revision_id = revision[0].in_history(br_from)[1]
921
# FIXME - wt.last_revision, fallback to branch, fall back to
922
# None or perhaps NULL_REVISION to mean copy nothing
924
revision_id = br_from.last_revision()
925
if to_location is None:
926
to_location = urlutils.derive_to_location(from_location)
929
name = os.path.basename(to_location) + '\n'
931
to_transport = transport.get_transport(to_location)
933
to_transport.mkdir('.')
934
except errors.FileExists:
935
raise errors.BzrCommandError('Target directory "%s" already'
936
' exists.' % to_location)
937
except errors.NoSuchFile:
938
raise errors.BzrCommandError('Parent of "%s" does not exist.'
941
# preserve whatever source format we have.
942
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
943
possible_transports=[to_transport],
944
accelerator_tree=accelerator_tree,
946
branch = dir.open_branch()
947
except errors.NoSuchRevision:
948
to_transport.delete_tree('.')
949
msg = "The branch %s has no revision %s." % (from_location, revision[0])
950
raise errors.BzrCommandError(msg)
952
branch.control_files.put_utf8('branch-name', name)
953
_merge_tags_if_possible(br_from, branch)
954
note('Branched %d revision(s).' % branch.revno())
959
class cmd_checkout(Command):
960
"""Create a new checkout of an existing branch.
962
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
963
the branch found in '.'. This is useful if you have removed the working tree
964
or if it was never created - i.e. if you pushed the branch to its current
967
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
968
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
969
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
970
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
971
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
974
To retrieve the branch as of a particular revision, supply the --revision
975
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
976
out of date [so you cannot commit] but it may be useful (i.e. to examine old
980
_see_also = ['checkouts', 'branch']
981
takes_args = ['branch_location?', 'to_location?']
982
takes_options = ['revision',
983
Option('lightweight',
984
help="Perform a lightweight checkout. Lightweight "
985
"checkouts depend on access to the branch for "
986
"every operation. Normal checkouts can perform "
987
"common operations like diff and status without "
988
"such access, and also support local commits."
990
Option('files-from', type=str,
991
help="Get file contents from this tree."),
993
help='Hard-link working tree files where possible.'
998
def run(self, branch_location=None, to_location=None, revision=None,
999
lightweight=False, files_from=None, hardlink=False):
1000
if revision is None:
1002
elif len(revision) > 1:
1003
raise errors.BzrCommandError(
1004
'bzr checkout --revision takes exactly 1 revision value')
1005
if branch_location is None:
1006
branch_location = osutils.getcwd()
1007
to_location = branch_location
1008
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1010
if files_from is not None:
1011
accelerator_tree = WorkingTree.open(files_from)
1012
if len(revision) == 1 and revision[0] is not None:
1013
revision_id = _mod_revision.ensure_null(
1014
revision[0].in_history(source)[1])
1017
if to_location is None:
1018
to_location = urlutils.derive_to_location(branch_location)
1019
# if the source and to_location are the same,
1020
# and there is no working tree,
1021
# then reconstitute a branch
1022
if (osutils.abspath(to_location) ==
1023
osutils.abspath(branch_location)):
1025
source.bzrdir.open_workingtree()
1026
except errors.NoWorkingTree:
1027
source.bzrdir.create_workingtree(revision_id)
1029
source.create_checkout(to_location, revision_id, lightweight,
1030
accelerator_tree, hardlink)
1033
class cmd_renames(Command):
1034
"""Show list of renamed files.
1036
# TODO: Option to show renames between two historical versions.
1038
# TODO: Only show renames under dir, rather than in the whole branch.
1039
_see_also = ['status']
1040
takes_args = ['dir?']
1043
def run(self, dir=u'.'):
1044
tree = WorkingTree.open_containing(dir)[0]
1047
new_inv = tree.inventory
1048
old_tree = tree.basis_tree()
1049
old_tree.lock_read()
1051
old_inv = old_tree.inventory
1052
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1054
for old_name, new_name in renames:
1055
self.outf.write("%s => %s\n" % (old_name, new_name))
1062
class cmd_update(Command):
1063
"""Update a tree to have the latest code committed to its branch.
1065
This will perform a merge into the working tree, and may generate
1066
conflicts. If you have any local changes, you will still
1067
need to commit them after the update for the update to be complete.
1069
If you want to discard your local changes, you can just do a
1070
'bzr revert' instead of 'bzr commit' after the update.
1073
_see_also = ['pull', 'working-trees', 'status-flags']
1074
takes_args = ['dir?']
1077
def run(self, dir='.'):
1078
tree = WorkingTree.open_containing(dir)[0]
1079
possible_transports = []
1080
master = tree.branch.get_master_branch(
1081
possible_transports=possible_transports)
1082
if master is not None:
1085
tree.lock_tree_write()
1087
existing_pending_merges = tree.get_parent_ids()[1:]
1088
last_rev = _mod_revision.ensure_null(tree.last_revision())
1089
if last_rev == _mod_revision.ensure_null(
1090
tree.branch.last_revision()):
1091
# may be up to date, check master too.
1092
if master is None or last_rev == _mod_revision.ensure_null(
1093
master.last_revision()):
1094
revno = tree.branch.revision_id_to_revno(last_rev)
1095
note("Tree is up to date at revision %d." % (revno,))
1097
conflicts = tree.update(
1098
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1099
possible_transports=possible_transports)
1100
revno = tree.branch.revision_id_to_revno(
1101
_mod_revision.ensure_null(tree.last_revision()))
1102
note('Updated to revision %d.' % (revno,))
1103
if tree.get_parent_ids()[1:] != existing_pending_merges:
1104
note('Your local commits will now show as pending merges with '
1105
"'bzr status', and can be committed with 'bzr commit'.")
1114
class cmd_info(Command):
1115
"""Show information about a working tree, branch or repository.
1117
This command will show all known locations and formats associated to the
1118
tree, branch or repository. Statistical information is included with
1121
Branches and working trees will also report any missing revisions.
1123
_see_also = ['revno', 'working-trees', 'repositories']
1124
takes_args = ['location?']
1125
takes_options = ['verbose']
1126
encoding_type = 'replace'
1129
def run(self, location=None, verbose=False):
1134
from bzrlib.info import show_bzrdir_info
1135
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1136
verbose=noise_level, outfile=self.outf)
1139
class cmd_remove(Command):
1140
"""Remove files or directories.
1142
This makes bzr stop tracking changes to the specified files and
1143
delete them if they can easily be recovered using revert.
1145
You can specify one or more files, and/or --new. If you specify --new,
1146
only 'added' files will be removed. If you specify both, then new files
1147
in the specified directories will be removed. If the directories are
1148
also new, they will also be removed.
1150
takes_args = ['file*']
1151
takes_options = ['verbose',
1152
Option('new', help='Remove newly-added files.'),
1153
RegistryOption.from_kwargs('file-deletion-strategy',
1154
'The file deletion mode to be used.',
1155
title='Deletion Strategy', value_switches=True, enum_switch=False,
1156
safe='Only delete files if they can be'
1157
' safely recovered (default).',
1158
keep="Don't delete any files.",
1159
force='Delete all the specified files, even if they can not be '
1160
'recovered and even if they are non-empty directories.')]
1162
encoding_type = 'replace'
1164
def run(self, file_list, verbose=False, new=False,
1165
file_deletion_strategy='safe'):
1166
tree, file_list = tree_files(file_list)
1168
if file_list is not None:
1169
file_list = [f for f in file_list]
1171
raise errors.BzrCommandError('Specify one or more files to'
1172
' remove, or use --new.')
1175
added = tree.changes_from(tree.basis_tree(),
1176
specific_files=file_list).added
1177
file_list = sorted([f[0] for f in added], reverse=True)
1178
if len(file_list) == 0:
1179
raise errors.BzrCommandError('No matching files.')
1180
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1181
keep_files=file_deletion_strategy=='keep',
1182
force=file_deletion_strategy=='force')
1185
class cmd_file_id(Command):
1186
"""Print file_id of a particular file or directory.
1188
The file_id is assigned when the file is first added and remains the
1189
same through all revisions where the file exists, even when it is
1194
_see_also = ['inventory', 'ls']
1195
takes_args = ['filename']
1198
def run(self, filename):
1199
tree, relpath = WorkingTree.open_containing(filename)
1200
i = tree.path2id(relpath)
1202
raise errors.NotVersionedError(filename)
1204
self.outf.write(i + '\n')
1207
class cmd_file_path(Command):
1208
"""Print path of file_ids to a file or directory.
1210
This prints one line for each directory down to the target,
1211
starting at the branch root.
1215
takes_args = ['filename']
1218
def run(self, filename):
1219
tree, relpath = WorkingTree.open_containing(filename)
1220
fid = tree.path2id(relpath)
1222
raise errors.NotVersionedError(filename)
1223
segments = osutils.splitpath(relpath)
1224
for pos in range(1, len(segments) + 1):
1225
path = osutils.joinpath(segments[:pos])
1226
self.outf.write("%s\n" % tree.path2id(path))
1229
class cmd_reconcile(Command):
1230
"""Reconcile bzr metadata in a branch.
1232
This can correct data mismatches that may have been caused by
1233
previous ghost operations or bzr upgrades. You should only
1234
need to run this command if 'bzr check' or a bzr developer
1235
advises you to run it.
1237
If a second branch is provided, cross-branch reconciliation is
1238
also attempted, which will check that data like the tree root
1239
id which was not present in very early bzr versions is represented
1240
correctly in both branches.
1242
At the same time it is run it may recompress data resulting in
1243
a potential saving in disk space or performance gain.
1245
The branch *MUST* be on a listable system such as local disk or sftp.
1248
_see_also = ['check']
1249
takes_args = ['branch?']
1251
def run(self, branch="."):
1252
from bzrlib.reconcile import reconcile
1253
dir = bzrdir.BzrDir.open(branch)
1257
class cmd_revision_history(Command):
1258
"""Display the list of revision ids on a branch."""
1261
takes_args = ['location?']
1266
def run(self, location="."):
1267
branch = Branch.open_containing(location)[0]
1268
for revid in branch.revision_history():
1269
self.outf.write(revid)
1270
self.outf.write('\n')
1273
class cmd_ancestry(Command):
1274
"""List all revisions merged into this branch."""
1276
_see_also = ['log', 'revision-history']
1277
takes_args = ['location?']
1282
def run(self, location="."):
1284
wt = WorkingTree.open_containing(location)[0]
1285
except errors.NoWorkingTree:
1286
b = Branch.open(location)
1287
last_revision = b.last_revision()
1290
last_revision = wt.last_revision()
1292
revision_ids = b.repository.get_ancestry(last_revision)
1293
assert revision_ids[0] is None
1295
for revision_id in revision_ids:
1296
self.outf.write(revision_id + '\n')
1299
class cmd_init(Command):
1300
"""Make a directory into a versioned branch.
1302
Use this to create an empty branch, or before importing an
1305
If there is a repository in a parent directory of the location, then
1306
the history of the branch will be stored in the repository. Otherwise
1307
init creates a standalone branch which carries its own history
1308
in the .bzr directory.
1310
If there is already a branch at the location but it has no working tree,
1311
the tree can be populated with 'bzr checkout'.
1313
Recipe for importing a tree of files::
1319
bzr commit -m "imported project"
1322
_see_also = ['init-repository', 'branch', 'checkout']
1323
takes_args = ['location?']
1325
Option('create-prefix',
1326
help='Create the path leading up to the branch '
1327
'if it does not already exist.'),
1328
RegistryOption('format',
1329
help='Specify a format for this branch. '
1330
'See "help formats".',
1331
registry=bzrdir.format_registry,
1332
converter=bzrdir.format_registry.make_bzrdir,
1333
value_switches=True,
1334
title="Branch Format",
1336
Option('append-revisions-only',
1337
help='Never change revnos or the existing log.'
1338
' Append revisions to it only.')
1340
def run(self, location=None, format=None, append_revisions_only=False,
1341
create_prefix=False):
1343
format = bzrdir.format_registry.make_bzrdir('default')
1344
if location is None:
1347
to_transport = transport.get_transport(location)
1349
# The path has to exist to initialize a
1350
# branch inside of it.
1351
# Just using os.mkdir, since I don't
1352
# believe that we want to create a bunch of
1353
# locations if the user supplies an extended path
1355
to_transport.ensure_base()
1356
except errors.NoSuchFile:
1357
if not create_prefix:
1358
raise errors.BzrCommandError("Parent directory of %s"
1360
"\nYou may supply --create-prefix to create all"
1361
" leading parent directories."
1363
_create_prefix(to_transport)
1366
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1367
except errors.NotBranchError:
1368
# really a NotBzrDir error...
1369
create_branch = bzrdir.BzrDir.create_branch_convenience
1370
branch = create_branch(to_transport.base, format=format,
1371
possible_transports=[to_transport])
1373
from bzrlib.transport.local import LocalTransport
1374
if existing_bzrdir.has_branch():
1375
if (isinstance(to_transport, LocalTransport)
1376
and not existing_bzrdir.has_workingtree()):
1377
raise errors.BranchExistsWithoutWorkingTree(location)
1378
raise errors.AlreadyBranchError(location)
1380
branch = existing_bzrdir.create_branch()
1381
existing_bzrdir.create_workingtree()
1382
if append_revisions_only:
1384
branch.set_append_revisions_only(True)
1385
except errors.UpgradeRequired:
1386
raise errors.BzrCommandError('This branch format cannot be set'
1387
' to append-revisions-only. Try --experimental-branch6')
1390
class cmd_init_repository(Command):
1391
"""Create a shared repository to hold branches.
1393
New branches created under the repository directory will store their
1394
revisions in the repository, not in the branch directory.
1396
If the --no-trees option is used then the branches in the repository
1397
will not have working trees by default.
1400
Create a shared repositories holding just branches::
1402
bzr init-repo --no-trees repo
1405
Make a lightweight checkout elsewhere::
1407
bzr checkout --lightweight repo/trunk trunk-checkout
1412
_see_also = ['init', 'branch', 'checkout', 'repositories']
1413
takes_args = ["location"]
1414
takes_options = [RegistryOption('format',
1415
help='Specify a format for this repository. See'
1416
' "bzr help formats" for details.',
1417
registry=bzrdir.format_registry,
1418
converter=bzrdir.format_registry.make_bzrdir,
1419
value_switches=True, title='Repository format'),
1421
help='Branches in the repository will default to'
1422
' not having a working tree.'),
1424
aliases = ["init-repo"]
1426
def run(self, location, format=None, no_trees=False):
1428
format = bzrdir.format_registry.make_bzrdir('default')
1430
if location is None:
1433
to_transport = transport.get_transport(location)
1434
to_transport.ensure_base()
1436
newdir = format.initialize_on_transport(to_transport)
1437
repo = newdir.create_repository(shared=True)
1438
repo.set_make_working_trees(not no_trees)
1441
class cmd_diff(Command):
1442
"""Show differences in the working tree, between revisions or branches.
1444
If no arguments are given, all changes for the current tree are listed.
1445
If files are given, only the changes in those files are listed.
1446
Remote and multiple branches can be compared by using the --old and
1447
--new options. If not provided, the default for both is derived from
1448
the first argument, if any, or the current tree if no arguments are
1451
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1452
produces patches suitable for "patch -p1".
1456
2 - unrepresentable changes
1461
Shows the difference in the working tree versus the last commit::
1465
Difference between the working tree and revision 1::
1469
Difference between revision 2 and revision 1::
1473
Difference between revision 2 and revision 1 for branch xxx::
1477
Show just the differences for file NEWS::
1481
Show the differences in working tree xxx for file NEWS::
1485
Show the differences from branch xxx to this working tree:
1489
Show the differences between two branches for file NEWS::
1491
bzr diff --old xxx --new yyy NEWS
1493
Same as 'bzr diff' but prefix paths with old/ and new/::
1495
bzr diff --prefix old/:new/
1497
_see_also = ['status']
1498
takes_args = ['file*']
1500
Option('diff-options', type=str,
1501
help='Pass these options to the external diff program.'),
1502
Option('prefix', type=str,
1504
help='Set prefixes added to old and new filenames, as '
1505
'two values separated by a colon. (eg "old/:new/").'),
1507
help='Branch/tree to compare from.',
1511
help='Branch/tree to compare to.',
1517
help='Use this command to compare files.',
1521
aliases = ['di', 'dif']
1522
encoding_type = 'exact'
1525
def run(self, revision=None, file_list=None, diff_options=None,
1526
prefix=None, old=None, new=None, using=None):
1527
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1529
if (prefix is None) or (prefix == '0'):
1537
old_label, new_label = prefix.split(":")
1539
raise errors.BzrCommandError(
1540
'--prefix expects two values separated by a colon'
1541
' (eg "old/:new/")')
1543
if revision and len(revision) > 2:
1544
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1545
' one or two revision specifiers')
1547
old_tree, new_tree, specific_files, extra_trees = \
1548
_get_trees_to_diff(file_list, revision, old, new)
1549
return show_diff_trees(old_tree, new_tree, sys.stdout,
1550
specific_files=specific_files,
1551
external_diff_options=diff_options,
1552
old_label=old_label, new_label=new_label,
1553
extra_trees=extra_trees, using=using)
1556
class cmd_deleted(Command):
1557
"""List files deleted in the working tree.
1559
# TODO: Show files deleted since a previous revision, or
1560
# between two revisions.
1561
# TODO: Much more efficient way to do this: read in new
1562
# directories with readdir, rather than stating each one. Same
1563
# level of effort but possibly much less IO. (Or possibly not,
1564
# if the directories are very large...)
1565
_see_also = ['status', 'ls']
1566
takes_options = ['show-ids']
1569
def run(self, show_ids=False):
1570
tree = WorkingTree.open_containing(u'.')[0]
1573
old = tree.basis_tree()
1576
for path, ie in old.inventory.iter_entries():
1577
if not tree.has_id(ie.file_id):
1578
self.outf.write(path)
1580
self.outf.write(' ')
1581
self.outf.write(ie.file_id)
1582
self.outf.write('\n')
1589
class cmd_modified(Command):
1590
"""List files modified in working tree.
1594
_see_also = ['status', 'ls']
1598
tree = WorkingTree.open_containing(u'.')[0]
1599
td = tree.changes_from(tree.basis_tree())
1600
for path, id, kind, text_modified, meta_modified in td.modified:
1601
self.outf.write(path + '\n')
1604
class cmd_added(Command):
1605
"""List files added in working tree.
1609
_see_also = ['status', 'ls']
1613
wt = WorkingTree.open_containing(u'.')[0]
1616
basis = wt.basis_tree()
1619
basis_inv = basis.inventory
1622
if file_id in basis_inv:
1624
if inv.is_root(file_id) and len(basis_inv) == 0:
1626
path = inv.id2path(file_id)
1627
if not os.access(osutils.abspath(path), os.F_OK):
1629
self.outf.write(path + '\n')
1636
class cmd_root(Command):
1637
"""Show the tree root directory.
1639
The root is the nearest enclosing directory with a .bzr control
1642
takes_args = ['filename?']
1644
def run(self, filename=None):
1645
"""Print the branch root."""
1646
tree = WorkingTree.open_containing(filename)[0]
1647
self.outf.write(tree.basedir + '\n')
1650
def _parse_limit(limitstring):
1652
return int(limitstring)
1654
msg = "The limit argument must be an integer."
1655
raise errors.BzrCommandError(msg)
1658
class cmd_log(Command):
1659
"""Show log of a branch, file, or directory.
1661
By default show the log of the branch containing the working directory.
1663
To request a range of logs, you can use the command -r begin..end
1664
-r revision requests a specific revision, -r ..end or -r begin.. are
1668
Log the current branch::
1676
Log the last 10 revisions of a branch::
1678
bzr log -r -10.. http://server/branch
1681
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1683
takes_args = ['location?']
1686
help='Show from oldest to newest.'),
1689
help='Display timezone as local, original, or utc.'),
1690
custom_help('verbose',
1691
help='Show files changed in each revision.'),
1697
help='Show revisions whose message matches this '
1698
'regular expression.',
1702
help='Limit the output to the first N revisions.',
1706
encoding_type = 'replace'
1709
def run(self, location=None, timezone='original',
1717
from bzrlib.log import show_log
1718
assert message is None or isinstance(message, basestring), \
1719
"invalid message argument %r" % message
1720
direction = (forward and 'forward') or 'reverse'
1725
# find the file id to log:
1727
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1731
tree = b.basis_tree()
1732
file_id = tree.path2id(fp)
1734
raise errors.BzrCommandError(
1735
"Path does not have any revision history: %s" %
1739
# FIXME ? log the current subdir only RBC 20060203
1740
if revision is not None \
1741
and len(revision) > 0 and revision[0].get_branch():
1742
location = revision[0].get_branch()
1745
dir, relpath = bzrdir.BzrDir.open_containing(location)
1746
b = dir.open_branch()
1750
if revision is None:
1753
elif len(revision) == 1:
1754
rev1 = rev2 = revision[0].in_history(b)
1755
elif len(revision) == 2:
1756
if revision[1].get_branch() != revision[0].get_branch():
1757
# b is taken from revision[0].get_branch(), and
1758
# show_log will use its revision_history. Having
1759
# different branches will lead to weird behaviors.
1760
raise errors.BzrCommandError(
1761
"Log doesn't accept two revisions in different"
1763
rev1 = revision[0].in_history(b)
1764
rev2 = revision[1].in_history(b)
1766
raise errors.BzrCommandError(
1767
'bzr log --revision takes one or two values.')
1769
if log_format is None:
1770
log_format = log.log_formatter_registry.get_default(b)
1772
lf = log_format(show_ids=show_ids, to_file=self.outf,
1773
show_timezone=timezone)
1779
direction=direction,
1780
start_revision=rev1,
1788
def get_log_format(long=False, short=False, line=False, default='long'):
1789
log_format = default
1793
log_format = 'short'
1799
class cmd_touching_revisions(Command):
1800
"""Return revision-ids which affected a particular file.
1802
A more user-friendly interface is "bzr log FILE".
1806
takes_args = ["filename"]
1809
def run(self, filename):
1810
tree, relpath = WorkingTree.open_containing(filename)
1812
file_id = tree.path2id(relpath)
1813
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1814
self.outf.write("%6d %s\n" % (revno, what))
1817
class cmd_ls(Command):
1818
"""List files in a tree.
1821
_see_also = ['status', 'cat']
1822
takes_args = ['path?']
1823
# TODO: Take a revision or remote path and list that tree instead.
1827
Option('non-recursive',
1828
help='Don\'t recurse into subdirectories.'),
1830
help='Print paths relative to the root of the branch.'),
1831
Option('unknown', help='Print unknown files.'),
1832
Option('versioned', help='Print versioned files.'),
1833
Option('ignored', help='Print ignored files.'),
1835
help='Write an ascii NUL (\\0) separator '
1836
'between files rather than a newline.'),
1838
help='List entries of a particular kind: file, directory, symlink.',
1843
def run(self, revision=None, verbose=False,
1844
non_recursive=False, from_root=False,
1845
unknown=False, versioned=False, ignored=False,
1846
null=False, kind=None, show_ids=False, path=None):
1848
if kind and kind not in ('file', 'directory', 'symlink'):
1849
raise errors.BzrCommandError('invalid kind specified')
1851
if verbose and null:
1852
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1853
all = not (unknown or versioned or ignored)
1855
selection = {'I':ignored, '?':unknown, 'V':versioned}
1862
raise errors.BzrCommandError('cannot specify both --from-root'
1866
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1872
if revision is not None:
1873
tree = branch.repository.revision_tree(
1874
revision[0].in_history(branch).rev_id)
1876
tree = branch.basis_tree()
1880
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1881
if fp.startswith(relpath):
1882
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1883
if non_recursive and '/' in fp:
1885
if not all and not selection[fc]:
1887
if kind is not None and fkind != kind:
1890
kindch = entry.kind_character()
1891
outstring = '%-8s %s%s' % (fc, fp, kindch)
1892
if show_ids and fid is not None:
1893
outstring = "%-50s %s" % (outstring, fid)
1894
self.outf.write(outstring + '\n')
1896
self.outf.write(fp + '\0')
1899
self.outf.write(fid)
1900
self.outf.write('\0')
1908
self.outf.write('%-50s %s\n' % (fp, my_id))
1910
self.outf.write(fp + '\n')
1915
class cmd_unknowns(Command):
1916
"""List unknown files.
1924
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1925
self.outf.write(osutils.quotefn(f) + '\n')
1928
class cmd_ignore(Command):
1929
"""Ignore specified files or patterns.
1931
To remove patterns from the ignore list, edit the .bzrignore file.
1933
Trailing slashes on patterns are ignored.
1934
If the pattern contains a slash or is a regular expression, it is compared
1935
to the whole path from the branch root. Otherwise, it is compared to only
1936
the last component of the path. To match a file only in the root
1937
directory, prepend './'.
1939
Ignore patterns specifying absolute paths are not allowed.
1941
Ignore patterns may include globbing wildcards such as::
1943
? - Matches any single character except '/'
1944
* - Matches 0 or more characters except '/'
1945
/**/ - Matches 0 or more directories in a path
1946
[a-z] - Matches a single character from within a group of characters
1948
Ignore patterns may also be Python regular expressions.
1949
Regular expression ignore patterns are identified by a 'RE:' prefix
1950
followed by the regular expression. Regular expression ignore patterns
1951
may not include named or numbered groups.
1953
Note: ignore patterns containing shell wildcards must be quoted from
1957
Ignore the top level Makefile::
1959
bzr ignore ./Makefile
1961
Ignore class files in all directories::
1963
bzr ignore "*.class"
1965
Ignore .o files under the lib directory::
1967
bzr ignore "lib/**/*.o"
1969
Ignore .o files under the lib directory::
1971
bzr ignore "RE:lib/.*\.o"
1973
Ignore everything but the "debian" toplevel directory::
1975
bzr ignore "RE:(?!debian/).*"
1978
_see_also = ['status', 'ignored']
1979
takes_args = ['name_pattern*']
1981
Option('old-default-rules',
1982
help='Write out the ignore rules bzr < 0.9 always used.')
1985
def run(self, name_pattern_list=None, old_default_rules=None):
1986
from bzrlib.atomicfile import AtomicFile
1987
if old_default_rules is not None:
1988
# dump the rules and exit
1989
for pattern in ignores.OLD_DEFAULTS:
1992
if not name_pattern_list:
1993
raise errors.BzrCommandError("ignore requires at least one "
1994
"NAME_PATTERN or --old-default-rules")
1995
name_pattern_list = [globbing.normalize_pattern(p)
1996
for p in name_pattern_list]
1997
for name_pattern in name_pattern_list:
1998
if (name_pattern[0] == '/' or
1999
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2000
raise errors.BzrCommandError(
2001
"NAME_PATTERN should not be an absolute path")
2002
tree, relpath = WorkingTree.open_containing(u'.')
2003
ifn = tree.abspath('.bzrignore')
2004
if os.path.exists(ifn):
2007
igns = f.read().decode('utf-8')
2013
# TODO: If the file already uses crlf-style termination, maybe
2014
# we should use that for the newly added lines?
2016
if igns and igns[-1] != '\n':
2018
for name_pattern in name_pattern_list:
2019
igns += name_pattern + '\n'
2021
f = AtomicFile(ifn, 'wb')
2023
f.write(igns.encode('utf-8'))
2028
if not tree.path2id('.bzrignore'):
2029
tree.add(['.bzrignore'])
2031
ignored = globbing.Globster(name_pattern_list)
2034
for entry in tree.list_files():
2038
if ignored.match(filename):
2039
matches.append(filename.encode('utf-8'))
2041
if len(matches) > 0:
2042
print "Warning: the following files are version controlled and" \
2043
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2045
class cmd_ignored(Command):
2046
"""List ignored files and the patterns that matched them.
2049
encoding_type = 'replace'
2050
_see_also = ['ignore']
2054
tree = WorkingTree.open_containing(u'.')[0]
2057
for path, file_class, kind, file_id, entry in tree.list_files():
2058
if file_class != 'I':
2060
## XXX: Slightly inefficient since this was already calculated
2061
pat = tree.is_ignored(path)
2062
self.outf.write('%-50s %s\n' % (path, pat))
2067
class cmd_lookup_revision(Command):
2068
"""Lookup the revision-id from a revision-number
2071
bzr lookup-revision 33
2074
takes_args = ['revno']
2077
def run(self, revno):
2081
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2083
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2086
class cmd_export(Command):
2087
"""Export current or past revision to a destination directory or archive.
2089
If no revision is specified this exports the last committed revision.
2091
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2092
given, try to find the format with the extension. If no extension
2093
is found exports to a directory (equivalent to --format=dir).
2095
If root is supplied, it will be used as the root directory inside
2096
container formats (tar, zip, etc). If it is not supplied it will default
2097
to the exported filename. The root option has no effect for 'dir' format.
2099
If branch is omitted then the branch containing the current working
2100
directory will be used.
2102
Note: Export of tree with non-ASCII filenames to zip is not supported.
2104
================= =========================
2105
Supported formats Autodetected by extension
2106
================= =========================
2109
tbz2 .tar.bz2, .tbz2
2112
================= =========================
2114
takes_args = ['dest', 'branch?']
2117
help="Type of file to export to.",
2122
help="Name of the root directory inside the exported file."),
2124
def run(self, dest, branch=None, revision=None, format=None, root=None):
2125
from bzrlib.export import export
2128
tree = WorkingTree.open_containing(u'.')[0]
2131
b = Branch.open(branch)
2133
if revision is None:
2134
# should be tree.last_revision FIXME
2135
rev_id = b.last_revision()
2137
if len(revision) != 1:
2138
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2139
rev_id = revision[0].in_history(b).rev_id
2140
t = b.repository.revision_tree(rev_id)
2142
export(t, dest, format, root)
2143
except errors.NoSuchExportFormat, e:
2144
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2147
class cmd_cat(Command):
2148
"""Write the contents of a file as of a given revision to standard output.
2150
If no revision is nominated, the last revision is used.
2152
Note: Take care to redirect standard output when using this command on a
2158
Option('name-from-revision', help='The path name in the old tree.'),
2161
takes_args = ['filename']
2162
encoding_type = 'exact'
2165
def run(self, filename, revision=None, name_from_revision=False):
2166
if revision is not None and len(revision) != 1:
2167
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2168
" one revision specifier")
2169
tree, branch, relpath = \
2170
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2173
return self._run(tree, branch, relpath, filename, revision,
2178
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2180
tree = b.basis_tree()
2181
if revision is None:
2182
revision_id = b.last_revision()
2184
revision_id = revision[0].in_history(b).rev_id
2186
cur_file_id = tree.path2id(relpath)
2187
rev_tree = b.repository.revision_tree(revision_id)
2188
old_file_id = rev_tree.path2id(relpath)
2190
if name_from_revision:
2191
if old_file_id is None:
2192
raise errors.BzrCommandError("%r is not present in revision %s"
2193
% (filename, revision_id))
2195
rev_tree.print_file(old_file_id)
2196
elif cur_file_id is not None:
2197
rev_tree.print_file(cur_file_id)
2198
elif old_file_id is not None:
2199
rev_tree.print_file(old_file_id)
2201
raise errors.BzrCommandError("%r is not present in revision %s" %
2202
(filename, revision_id))
2205
class cmd_local_time_offset(Command):
2206
"""Show the offset in seconds from GMT to local time."""
2210
print osutils.local_time_offset()
2214
class cmd_commit(Command):
2215
"""Commit changes into a new revision.
2217
If no arguments are given, the entire tree is committed.
2219
If selected files are specified, only changes to those files are
2220
committed. If a directory is specified then the directory and everything
2221
within it is committed.
2223
If author of the change is not the same person as the committer, you can
2224
specify the author's name using the --author option. The name should be
2225
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2227
A selected-file commit may fail in some cases where the committed
2228
tree would be invalid. Consider::
2233
bzr commit foo -m "committing foo"
2234
bzr mv foo/bar foo/baz
2237
bzr commit foo/bar -m "committing bar but not baz"
2239
In the example above, the last commit will fail by design. This gives
2240
the user the opportunity to decide whether they want to commit the
2241
rename at the same time, separately first, or not at all. (As a general
2242
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2244
Note: A selected-file commit after a merge is not yet supported.
2246
# TODO: Run hooks on tree to-be-committed, and after commit.
2248
# TODO: Strict commit that fails if there are deleted files.
2249
# (what does "deleted files" mean ??)
2251
# TODO: Give better message for -s, --summary, used by tla people
2253
# XXX: verbose currently does nothing
2255
_see_also = ['bugs', 'uncommit']
2256
takes_args = ['selected*']
2258
Option('message', type=unicode,
2260
help="Description of the new revision."),
2263
help='Commit even if nothing has changed.'),
2264
Option('file', type=str,
2267
help='Take commit message from this file.'),
2269
help="Refuse to commit if there are unknown "
2270
"files in the working tree."),
2271
ListOption('fixes', type=str,
2272
help="Mark a bug as being fixed by this revision."),
2273
Option('author', type=unicode,
2274
help="Set the author's name, if it's different "
2275
"from the committer."),
2277
help="Perform a local commit in a bound "
2278
"branch. Local commits are not pushed to "
2279
"the master branch until a normal commit "
2283
help='When no message is supplied, show the diff along'
2284
' with the status summary in the message editor.'),
2286
aliases = ['ci', 'checkin']
2288
def _get_bug_fix_properties(self, fixes, branch):
2290
# Configure the properties for bug fixing attributes.
2291
for fixed_bug in fixes:
2292
tokens = fixed_bug.split(':')
2293
if len(tokens) != 2:
2294
raise errors.BzrCommandError(
2295
"Invalid bug %s. Must be in the form of 'tag:id'. "
2296
"Commit refused." % fixed_bug)
2297
tag, bug_id = tokens
2299
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2300
except errors.UnknownBugTrackerAbbreviation:
2301
raise errors.BzrCommandError(
2302
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2303
except errors.MalformedBugIdentifier:
2304
raise errors.BzrCommandError(
2305
"Invalid bug identifier for %s. Commit refused."
2307
properties.append('%s fixed' % bug_url)
2308
return '\n'.join(properties)
2310
def run(self, message=None, file=None, verbose=False, selected_list=None,
2311
unchanged=False, strict=False, local=False, fixes=None,
2312
author=None, show_diff=False):
2313
from bzrlib.errors import (
2318
from bzrlib.msgeditor import (
2319
edit_commit_message_encoded,
2320
make_commit_message_template_encoded
2323
# TODO: Need a blackbox test for invoking the external editor; may be
2324
# slightly problematic to run this cross-platform.
2326
# TODO: do more checks that the commit will succeed before
2327
# spending the user's valuable time typing a commit message.
2331
tree, selected_list = tree_files(selected_list)
2332
if selected_list == ['']:
2333
# workaround - commit of root of tree should be exactly the same
2334
# as just default commit in that tree, and succeed even though
2335
# selected-file merge commit is not done yet
2340
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2342
properties['bugs'] = bug_property
2344
if local and not tree.branch.get_bound_location():
2345
raise errors.LocalRequiresBoundBranch()
2347
def get_message(commit_obj):
2348
"""Callback to get commit message"""
2349
my_message = message
2350
if my_message is None and not file:
2351
t = make_commit_message_template_encoded(tree,
2352
selected_list, diff=show_diff,
2353
output_encoding=bzrlib.user_encoding)
2354
my_message = edit_commit_message_encoded(t)
2355
if my_message is None:
2356
raise errors.BzrCommandError("please specify a commit"
2357
" message with either --message or --file")
2358
elif my_message and file:
2359
raise errors.BzrCommandError(
2360
"please specify either --message or --file")
2362
my_message = codecs.open(file, 'rt',
2363
bzrlib.user_encoding).read()
2364
if my_message == "":
2365
raise errors.BzrCommandError("empty commit message specified")
2369
tree.commit(message_callback=get_message,
2370
specific_files=selected_list,
2371
allow_pointless=unchanged, strict=strict, local=local,
2372
reporter=None, verbose=verbose, revprops=properties,
2374
except PointlessCommit:
2375
# FIXME: This should really happen before the file is read in;
2376
# perhaps prepare the commit; get the message; then actually commit
2377
raise errors.BzrCommandError("no changes to commit."
2378
" use --unchanged to commit anyhow")
2379
except ConflictsInTree:
2380
raise errors.BzrCommandError('Conflicts detected in working '
2381
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2383
except StrictCommitFailed:
2384
raise errors.BzrCommandError("Commit refused because there are"
2385
" unknown files in the working tree.")
2386
except errors.BoundBranchOutOfDate, e:
2387
raise errors.BzrCommandError(str(e) + "\n"
2388
'To commit to master branch, run update and then commit.\n'
2389
'You can also pass --local to commit to continue working '
2393
class cmd_check(Command):
2394
"""Validate consistency of branch history.
2396
This command checks various invariants about the branch storage to
2397
detect data corruption or bzr bugs.
2401
revisions: This is just the number of revisions checked. It doesn't
2403
versionedfiles: This is just the number of versionedfiles checked. It
2404
doesn't indicate a problem.
2405
unreferenced ancestors: Texts that are ancestors of other texts, but
2406
are not properly referenced by the revision ancestry. This is a
2407
subtle problem that Bazaar can work around.
2408
unique file texts: This is the total number of unique file contents
2409
seen in the checked revisions. It does not indicate a problem.
2410
repeated file texts: This is the total number of repeated texts seen
2411
in the checked revisions. Texts can be repeated when their file
2412
entries are modified, but the file contents are not. It does not
2416
_see_also = ['reconcile']
2417
takes_args = ['branch?']
2418
takes_options = ['verbose']
2420
def run(self, branch=None, verbose=False):
2421
from bzrlib.check import check
2423
branch_obj = Branch.open_containing('.')[0]
2425
branch_obj = Branch.open(branch)
2426
check(branch_obj, verbose)
2427
# bit hacky, check the tree parent is accurate
2430
tree = WorkingTree.open_containing('.')[0]
2432
tree = WorkingTree.open(branch)
2433
except (errors.NoWorkingTree, errors.NotLocalUrl):
2436
# This is a primitive 'check' for tree state. Currently this is not
2437
# integrated into the main check logic as yet.
2440
tree_basis = tree.basis_tree()
2441
tree_basis.lock_read()
2443
repo_basis = tree.branch.repository.revision_tree(
2444
tree.last_revision())
2445
if len(list(repo_basis.iter_changes(tree_basis))):
2446
raise errors.BzrCheckError(
2447
"Mismatched basis inventory content.")
2455
class cmd_upgrade(Command):
2456
"""Upgrade branch storage to current format.
2458
The check command or bzr developers may sometimes advise you to run
2459
this command. When the default format has changed you may also be warned
2460
during other operations to upgrade.
2463
_see_also = ['check']
2464
takes_args = ['url?']
2466
RegistryOption('format',
2467
help='Upgrade to a specific format. See "bzr help'
2468
' formats" for details.',
2469
registry=bzrdir.format_registry,
2470
converter=bzrdir.format_registry.make_bzrdir,
2471
value_switches=True, title='Branch format'),
2474
def run(self, url='.', format=None):
2475
from bzrlib.upgrade import upgrade
2477
format = bzrdir.format_registry.make_bzrdir('default')
2478
upgrade(url, format)
2481
class cmd_whoami(Command):
2482
"""Show or set bzr user id.
2485
Show the email of the current user::
2489
Set the current user::
2491
bzr whoami "Frank Chu <fchu@example.com>"
2493
takes_options = [ Option('email',
2494
help='Display email address only.'),
2496
help='Set identity for the current branch instead of '
2499
takes_args = ['name?']
2500
encoding_type = 'replace'
2503
def run(self, email=False, branch=False, name=None):
2505
# use branch if we're inside one; otherwise global config
2507
c = Branch.open_containing('.')[0].get_config()
2508
except errors.NotBranchError:
2509
c = config.GlobalConfig()
2511
self.outf.write(c.user_email() + '\n')
2513
self.outf.write(c.username() + '\n')
2516
# display a warning if an email address isn't included in the given name.
2518
config.extract_email_address(name)
2519
except errors.NoEmailInUsername, e:
2520
warning('"%s" does not seem to contain an email address. '
2521
'This is allowed, but not recommended.', name)
2523
# use global config unless --branch given
2525
c = Branch.open_containing('.')[0].get_config()
2527
c = config.GlobalConfig()
2528
c.set_user_option('email', name)
2531
class cmd_nick(Command):
2532
"""Print or set the branch nickname.
2534
If unset, the tree root directory name is used as the nickname
2535
To print the current nickname, execute with no argument.
2538
_see_also = ['info']
2539
takes_args = ['nickname?']
2540
def run(self, nickname=None):
2541
branch = Branch.open_containing(u'.')[0]
2542
if nickname is None:
2543
self.printme(branch)
2545
branch.nick = nickname
2548
def printme(self, branch):
2552
class cmd_selftest(Command):
2553
"""Run internal test suite.
2555
If arguments are given, they are regular expressions that say which tests
2556
should run. Tests matching any expression are run, and other tests are
2559
Alternatively if --first is given, matching tests are run first and then
2560
all other tests are run. This is useful if you have been working in a
2561
particular area, but want to make sure nothing else was broken.
2563
If --exclude is given, tests that match that regular expression are
2564
excluded, regardless of whether they match --first or not.
2566
To help catch accidential dependencies between tests, the --randomize
2567
option is useful. In most cases, the argument used is the word 'now'.
2568
Note that the seed used for the random number generator is displayed
2569
when this option is used. The seed can be explicitly passed as the
2570
argument to this option if required. This enables reproduction of the
2571
actual ordering used if and when an order sensitive problem is encountered.
2573
If --list-only is given, the tests that would be run are listed. This is
2574
useful when combined with --first, --exclude and/or --randomize to
2575
understand their impact. The test harness reports "Listed nn tests in ..."
2576
instead of "Ran nn tests in ..." when list mode is enabled.
2578
If the global option '--no-plugins' is given, plugins are not loaded
2579
before running the selftests. This has two effects: features provided or
2580
modified by plugins will not be tested, and tests provided by plugins will
2583
Tests that need working space on disk use a common temporary directory,
2584
typically inside $TMPDIR or /tmp.
2587
Run only tests relating to 'ignore'::
2591
Disable plugins and list tests as they're run::
2593
bzr --no-plugins selftest -v
2595
# NB: this is used from the class without creating an instance, which is
2596
# why it does not have a self parameter.
2597
def get_transport_type(typestring):
2598
"""Parse and return a transport specifier."""
2599
if typestring == "sftp":
2600
from bzrlib.transport.sftp import SFTPAbsoluteServer
2601
return SFTPAbsoluteServer
2602
if typestring == "memory":
2603
from bzrlib.transport.memory import MemoryServer
2605
if typestring == "fakenfs":
2606
from bzrlib.transport.fakenfs import FakeNFSServer
2607
return FakeNFSServer
2608
msg = "No known transport type %s. Supported types are: sftp\n" %\
2610
raise errors.BzrCommandError(msg)
2613
takes_args = ['testspecs*']
2614
takes_options = ['verbose',
2616
help='Stop when one test fails.',
2620
help='Use a different transport by default '
2621
'throughout the test suite.',
2622
type=get_transport_type),
2624
help='Run the benchmarks rather than selftests.'),
2625
Option('lsprof-timed',
2626
help='Generate lsprof output for benchmarked'
2627
' sections of code.'),
2628
Option('cache-dir', type=str,
2629
help='Cache intermediate benchmark output in this '
2632
help='Run all tests, but run specified tests first.',
2636
help='List the tests instead of running them.'),
2637
Option('randomize', type=str, argname="SEED",
2638
help='Randomize the order of tests using the given'
2639
' seed or "now" for the current time.'),
2640
Option('exclude', type=str, argname="PATTERN",
2642
help='Exclude tests that match this regular'
2644
Option('strict', help='Fail on missing dependencies or '
2646
Option('load-list', type=str, argname='TESTLISTFILE',
2647
help='Load a test id list from a text file.'),
2649
encoding_type = 'replace'
2651
def run(self, testspecs_list=None, verbose=False, one=False,
2652
transport=None, benchmark=None,
2653
lsprof_timed=None, cache_dir=None,
2654
first=False, list_only=False,
2655
randomize=None, exclude=None, strict=False,
2658
from bzrlib.tests import selftest
2659
import bzrlib.benchmarks as benchmarks
2660
from bzrlib.benchmarks import tree_creator
2662
if cache_dir is not None:
2663
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2665
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2666
print ' %s (%s python%s)' % (
2668
bzrlib.version_string,
2669
bzrlib._format_version_tuple(sys.version_info),
2672
if testspecs_list is not None:
2673
pattern = '|'.join(testspecs_list)
2677
test_suite_factory = benchmarks.test_suite
2678
# Unless user explicitly asks for quiet, be verbose in benchmarks
2679
verbose = not is_quiet()
2680
# TODO: should possibly lock the history file...
2681
benchfile = open(".perf_history", "at", buffering=1)
2683
test_suite_factory = None
2686
result = selftest(verbose=verbose,
2688
stop_on_failure=one,
2689
transport=transport,
2690
test_suite_factory=test_suite_factory,
2691
lsprof_timed=lsprof_timed,
2692
bench_history=benchfile,
2693
matching_tests_first=first,
2694
list_only=list_only,
2695
random_seed=randomize,
2696
exclude_pattern=exclude,
2698
load_list=load_list,
2701
if benchfile is not None:
2704
note('tests passed')
2706
note('tests failed')
2707
return int(not result)
2710
class cmd_version(Command):
2711
"""Show version of bzr."""
2713
encoding_type = 'replace'
2717
from bzrlib.version import show_version
2718
show_version(to_file=self.outf)
2721
class cmd_rocks(Command):
2722
"""Statement of optimism."""
2728
print "It sure does!"
2731
class cmd_find_merge_base(Command):
2732
"""Find and print a base revision for merging two branches."""
2733
# TODO: Options to specify revisions on either side, as if
2734
# merging only part of the history.
2735
takes_args = ['branch', 'other']
2739
def run(self, branch, other):
2740
from bzrlib.revision import ensure_null
2742
branch1 = Branch.open_containing(branch)[0]
2743
branch2 = Branch.open_containing(other)[0]
2748
last1 = ensure_null(branch1.last_revision())
2749
last2 = ensure_null(branch2.last_revision())
2751
graph = branch1.repository.get_graph(branch2.repository)
2752
base_rev_id = graph.find_unique_lca(last1, last2)
2754
print 'merge base is revision %s' % base_rev_id
2761
class cmd_merge(Command):
2762
"""Perform a three-way merge.
2764
The branch is the branch you will merge from. By default, it will merge
2765
the latest revision. If you specify a revision, that revision will be
2766
merged. If you specify two revisions, the first will be used as a BASE,
2767
and the second one as OTHER. Revision numbers are always relative to the
2770
By default, bzr will try to merge in all new work from the other
2771
branch, automatically determining an appropriate base. If this
2772
fails, you may need to give an explicit base.
2774
Merge will do its best to combine the changes in two branches, but there
2775
are some kinds of problems only a human can fix. When it encounters those,
2776
it will mark a conflict. A conflict means that you need to fix something,
2777
before you should commit.
2779
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2781
If there is no default branch set, the first merge will set it. After
2782
that, you can omit the branch to use the default. To change the
2783
default, use --remember. The value will only be saved if the remote
2784
location can be accessed.
2786
The results of the merge are placed into the destination working
2787
directory, where they can be reviewed (with bzr diff), tested, and then
2788
committed to record the result of the merge.
2790
merge refuses to run if there are any uncommitted changes, unless
2794
To merge the latest revision from bzr.dev::
2796
bzr merge ../bzr.dev
2798
To merge changes up to and including revision 82 from bzr.dev::
2800
bzr merge -r 82 ../bzr.dev
2802
To merge the changes introduced by 82, without previous changes::
2804
bzr merge -r 81..82 ../bzr.dev
2807
encoding_type = 'exact'
2808
_see_also = ['update', 'remerge', 'status-flags']
2809
takes_args = ['branch?']
2814
help='Merge even if the destination tree has uncommitted changes.'),
2818
Option('show-base', help="Show base revision text in "
2820
Option('uncommitted', help='Apply uncommitted changes'
2821
' from a working copy, instead of branch changes.'),
2822
Option('pull', help='If the destination is already'
2823
' completely merged into the source, pull from the'
2824
' source rather than merging. When this happens,'
2825
' you do not need to commit the result.'),
2827
help='Branch to merge into, '
2828
'rather than the one containing the working directory.',
2832
Option('preview', help='Instead of merging, show a diff of the merge.')
2835
def run(self, branch=None, revision=None, force=False, merge_type=None,
2836
show_base=False, reprocess=False, remember=False,
2837
uncommitted=False, pull=False,
2841
# This is actually a branch (or merge-directive) *location*.
2845
if merge_type is None:
2846
merge_type = _mod_merge.Merge3Merger
2848
if directory is None: directory = u'.'
2849
possible_transports = []
2851
allow_pending = True
2852
verified = 'inapplicable'
2853
tree = WorkingTree.open_containing(directory)[0]
2854
change_reporter = delta._ChangeReporter(
2855
unversioned_filter=tree.is_ignored)
2858
pb = ui.ui_factory.nested_progress_bar()
2859
cleanups.append(pb.finished)
2861
cleanups.append(tree.unlock)
2862
if location is not None:
2863
mergeable, other_transport = _get_mergeable_helper(location)
2866
raise errors.BzrCommandError('Cannot use --uncommitted'
2867
' with bundles or merge directives.')
2869
if revision is not None:
2870
raise errors.BzrCommandError(
2871
'Cannot use -r with merge directives or bundles')
2872
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2874
possible_transports.append(other_transport)
2876
if merger is None and uncommitted:
2877
if revision is not None and len(revision) > 0:
2878
raise errors.BzrCommandError('Cannot use --uncommitted and'
2879
' --revision at the same time.')
2880
location = self._select_branch_location(tree, location)[0]
2881
other_tree, other_path = WorkingTree.open_containing(location)
2882
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2884
allow_pending = False
2885
if other_path != '':
2886
merger.interesting_files = [other_path]
2889
merger, allow_pending = self._get_merger_from_branch(tree,
2890
location, revision, remember, possible_transports, pb)
2892
merger.merge_type = merge_type
2893
merger.reprocess = reprocess
2894
merger.show_base = show_base
2895
self.sanity_check_merger(merger)
2896
if (merger.base_rev_id == merger.other_rev_id and
2897
merger.other_rev_id != None):
2898
note('Nothing to do.')
2901
if merger.interesting_files is not None:
2902
raise errors.BzrCommandError('Cannot pull individual files')
2903
if (merger.base_rev_id == tree.last_revision()):
2904
result = tree.pull(merger.other_branch, False,
2905
merger.other_rev_id)
2906
result.report(self.outf)
2908
merger.check_basis(not force)
2910
return self._do_preview(merger)
2912
return self._do_merge(merger, change_reporter, allow_pending,
2915
for cleanup in reversed(cleanups):
2918
def _do_preview(self, merger):
2919
from bzrlib.diff import show_diff_trees
2920
tree_merger = merger.make_merger()
2921
tt = tree_merger.make_preview_transform()
2923
result_tree = tt.get_preview_tree()
2924
show_diff_trees(merger.this_tree, result_tree, self.outf,
2925
old_label='', new_label='')
2929
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2930
merger.change_reporter = change_reporter
2931
conflict_count = merger.do_merge()
2933
merger.set_pending()
2934
if verified == 'failed':
2935
warning('Preview patch does not match changes')
2936
if conflict_count != 0:
2941
def sanity_check_merger(self, merger):
2942
if (merger.show_base and
2943
not merger.merge_type is _mod_merge.Merge3Merger):
2944
raise errors.BzrCommandError("Show-base is not supported for this"
2945
" merge type. %s" % merger.merge_type)
2946
if merger.reprocess and not merger.merge_type.supports_reprocess:
2947
raise errors.BzrCommandError("Conflict reduction is not supported"
2948
" for merge type %s." %
2950
if merger.reprocess and merger.show_base:
2951
raise errors.BzrCommandError("Cannot do conflict reduction and"
2954
def _get_merger_from_branch(self, tree, location, revision, remember,
2955
possible_transports, pb):
2956
"""Produce a merger from a location, assuming it refers to a branch."""
2957
from bzrlib.tag import _merge_tags_if_possible
2958
assert revision is None or len(revision) < 3
2959
# find the branch locations
2960
other_loc, user_location = self._select_branch_location(tree, location,
2962
if revision is not None and len(revision) == 2:
2963
base_loc, _unused = self._select_branch_location(tree,
2964
location, revision, 0)
2966
base_loc = other_loc
2968
other_branch, other_path = Branch.open_containing(other_loc,
2969
possible_transports)
2970
if base_loc == other_loc:
2971
base_branch = other_branch
2973
base_branch, base_path = Branch.open_containing(base_loc,
2974
possible_transports)
2975
# Find the revision ids
2976
if revision is None or len(revision) < 1 or revision[-1] is None:
2977
other_revision_id = _mod_revision.ensure_null(
2978
other_branch.last_revision())
2980
other_revision_id = \
2981
_mod_revision.ensure_null(
2982
revision[-1].in_history(other_branch).rev_id)
2983
if (revision is not None and len(revision) == 2
2984
and revision[0] is not None):
2985
base_revision_id = \
2986
_mod_revision.ensure_null(
2987
revision[0].in_history(base_branch).rev_id)
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].in_history(tree.branch).rev_id
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].in_history(b).rev_id
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].in_history(branch).rev_id
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.')]
3661
takes_args = ['location?']
3663
encoding_type = 'replace'
3665
def run(self, location=None,
3666
dry_run=False, verbose=False,
3667
revision=None, force=False):
3668
if location is None:
3670
control, relpath = bzrdir.BzrDir.open_containing(location)
3672
tree = control.open_workingtree()
3674
except (errors.NoWorkingTree, errors.NotLocalUrl):
3676
b = control.open_branch()
3678
if tree is not None:
3683
return self._run(b, tree, dry_run, verbose, revision, force)
3685
if tree is not None:
3690
def _run(self, b, tree, dry_run, verbose, revision, force):
3691
from bzrlib.log import log_formatter, show_log
3692
from bzrlib.uncommit import uncommit
3694
last_revno, last_rev_id = b.last_revision_info()
3697
if revision is None:
3699
rev_id = last_rev_id
3701
# 'bzr uncommit -r 10' actually means uncommit
3702
# so that the final tree is at revno 10.
3703
# but bzrlib.uncommit.uncommit() actually uncommits
3704
# the revisions that are supplied.
3705
# So we need to offset it by one
3706
revno = revision[0].in_history(b).revno + 1
3707
if revno <= last_revno:
3708
rev_id = b.get_rev_id(revno)
3710
if rev_id is None or _mod_revision.is_null(rev_id):
3711
self.outf.write('No revisions to uncommit.\n')
3714
lf = log_formatter('short',
3716
show_timezone='original')
3721
direction='forward',
3722
start_revision=revno,
3723
end_revision=last_revno)
3726
print 'Dry-run, pretending to remove the above revisions.'
3728
val = raw_input('Press <enter> to continue')
3730
print 'The above revision(s) will be removed.'
3732
val = raw_input('Are you sure [y/N]? ')
3733
if val.lower() not in ('y', 'yes'):
3737
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3741
class cmd_break_lock(Command):
3742
"""Break a dead lock on a repository, branch or working directory.
3744
CAUTION: Locks should only be broken when you are sure that the process
3745
holding the lock has been stopped.
3747
You can get information on what locks are open via the 'bzr info' command.
3752
takes_args = ['location?']
3754
def run(self, location=None, show=False):
3755
if location is None:
3757
control, relpath = bzrdir.BzrDir.open_containing(location)
3759
control.break_lock()
3760
except NotImplementedError:
3764
class cmd_wait_until_signalled(Command):
3765
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3767
This just prints a line to signal when it is ready, then blocks on stdin.
3773
sys.stdout.write("running\n")
3775
sys.stdin.readline()
3778
class cmd_serve(Command):
3779
"""Run the bzr server."""
3781
aliases = ['server']
3785
help='Serve on stdin/out for use from inetd or sshd.'),
3787
help='Listen for connections on nominated port of the form '
3788
'[hostname:]portnumber. Passing 0 as the port number will '
3789
'result in a dynamically allocated port. The default port is '
3793
help='Serve contents of this directory.',
3795
Option('allow-writes',
3796
help='By default the server is a readonly server. Supplying '
3797
'--allow-writes enables write access to the contents of '
3798
'the served directory and below.'
3802
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3803
from bzrlib import lockdir
3804
from bzrlib.smart import medium, server
3805
from bzrlib.transport import get_transport
3806
from bzrlib.transport.chroot import ChrootServer
3807
if directory is None:
3808
directory = os.getcwd()
3809
url = urlutils.local_path_to_url(directory)
3810
if not allow_writes:
3811
url = 'readonly+' + url
3812
chroot_server = ChrootServer(get_transport(url))
3813
chroot_server.setUp()
3814
t = get_transport(chroot_server.get_url())
3816
smart_server = medium.SmartServerPipeStreamMedium(
3817
sys.stdin, sys.stdout, t)
3819
host = medium.BZR_DEFAULT_INTERFACE
3821
port = medium.BZR_DEFAULT_PORT
3824
host, port = port.split(':')
3826
smart_server = server.SmartTCPServer(t, host=host, port=port)
3827
print 'listening on port: ', smart_server.port
3829
# for the duration of this server, no UI output is permitted.
3830
# note that this may cause problems with blackbox tests. This should
3831
# be changed with care though, as we dont want to use bandwidth sending
3832
# progress over stderr to smart server clients!
3833
old_factory = ui.ui_factory
3834
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3836
ui.ui_factory = ui.SilentUIFactory()
3837
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3838
smart_server.serve()
3840
ui.ui_factory = old_factory
3841
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3844
class cmd_join(Command):
3845
"""Combine a subtree into its containing tree.
3847
This command is for experimental use only. It requires the target tree
3848
to be in dirstate-with-subtree format, which cannot be converted into
3851
The TREE argument should be an independent tree, inside another tree, but
3852
not part of it. (Such trees can be produced by "bzr split", but also by
3853
running "bzr branch" with the target inside a tree.)
3855
The result is a combined tree, with the subtree no longer an independant
3856
part. This is marked as a merge of the subtree into the containing tree,
3857
and all history is preserved.
3859
If --reference is specified, the subtree retains its independence. It can
3860
be branched by itself, and can be part of multiple projects at the same
3861
time. But operations performed in the containing tree, such as commit
3862
and merge, will recurse into the subtree.
3865
_see_also = ['split']
3866
takes_args = ['tree']
3868
Option('reference', help='Join by reference.'),
3872
def run(self, tree, reference=False):
3873
sub_tree = WorkingTree.open(tree)
3874
parent_dir = osutils.dirname(sub_tree.basedir)
3875
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3876
repo = containing_tree.branch.repository
3877
if not repo.supports_rich_root():
3878
raise errors.BzrCommandError(
3879
"Can't join trees because %s doesn't support rich root data.\n"
3880
"You can use bzr upgrade on the repository."
3884
containing_tree.add_reference(sub_tree)
3885
except errors.BadReferenceTarget, e:
3886
# XXX: Would be better to just raise a nicely printable
3887
# exception from the real origin. Also below. mbp 20070306
3888
raise errors.BzrCommandError("Cannot join %s. %s" %
3892
containing_tree.subsume(sub_tree)
3893
except errors.BadSubsumeSource, e:
3894
raise errors.BzrCommandError("Cannot join %s. %s" %
3898
class cmd_split(Command):
3899
"""Split a subdirectory of a tree into a separate tree.
3901
This command will produce a target tree in a format that supports
3902
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3903
converted into earlier formats like 'dirstate-tags'.
3905
The TREE argument should be a subdirectory of a working tree. That
3906
subdirectory will be converted into an independent tree, with its own
3907
branch. Commits in the top-level tree will not apply to the new subtree.
3910
# join is not un-hidden yet
3911
#_see_also = ['join']
3912
takes_args = ['tree']
3914
def run(self, tree):
3915
containing_tree, subdir = WorkingTree.open_containing(tree)
3916
sub_id = containing_tree.path2id(subdir)
3918
raise errors.NotVersionedError(subdir)
3920
containing_tree.extract(sub_id)
3921
except errors.RootNotRich:
3922
raise errors.UpgradeRequired(containing_tree.branch.base)
3925
class cmd_merge_directive(Command):
3926
"""Generate a merge directive for auto-merge tools.
3928
A directive requests a merge to be performed, and also provides all the
3929
information necessary to do so. This means it must either include a
3930
revision bundle, or the location of a branch containing the desired
3933
A submit branch (the location to merge into) must be supplied the first
3934
time the command is issued. After it has been supplied once, it will
3935
be remembered as the default.
3937
A public branch is optional if a revision bundle is supplied, but required
3938
if --diff or --plain is specified. It will be remembered as the default
3939
after the first use.
3942
takes_args = ['submit_branch?', 'public_branch?']
3946
_see_also = ['send']
3949
RegistryOption.from_kwargs('patch-type',
3950
'The type of patch to include in the directive.',
3952
value_switches=True,
3954
bundle='Bazaar revision bundle (default).',
3955
diff='Normal unified diff.',
3956
plain='No patch, just directive.'),
3957
Option('sign', help='GPG-sign the directive.'), 'revision',
3958
Option('mail-to', type=str,
3959
help='Instead of printing the directive, email to this address.'),
3960
Option('message', type=str, short_name='m',
3961
help='Message to use when committing this merge.')
3964
encoding_type = 'exact'
3966
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3967
sign=False, revision=None, mail_to=None, message=None):
3968
from bzrlib.revision import ensure_null, NULL_REVISION
3969
include_patch, include_bundle = {
3970
'plain': (False, False),
3971
'diff': (True, False),
3972
'bundle': (True, True),
3974
branch = Branch.open('.')
3975
stored_submit_branch = branch.get_submit_branch()
3976
if submit_branch is None:
3977
submit_branch = stored_submit_branch
3979
if stored_submit_branch is None:
3980
branch.set_submit_branch(submit_branch)
3981
if submit_branch is None:
3982
submit_branch = branch.get_parent()
3983
if submit_branch is None:
3984
raise errors.BzrCommandError('No submit branch specified or known')
3986
stored_public_branch = branch.get_public_branch()
3987
if public_branch is None:
3988
public_branch = stored_public_branch
3989
elif stored_public_branch is None:
3990
branch.set_public_branch(public_branch)
3991
if not include_bundle and public_branch is None:
3992
raise errors.BzrCommandError('No public branch specified or'
3994
base_revision_id = None
3995
if revision is not None:
3996
if len(revision) > 2:
3997
raise errors.BzrCommandError('bzr merge-directive takes '
3998
'at most two one revision identifiers')
3999
revision_id = revision[-1].in_history(branch).rev_id
4000
if len(revision) == 2:
4001
base_revision_id = revision[0].in_history(branch).rev_id
4002
base_revision_id = ensure_null(base_revision_id)
4004
revision_id = branch.last_revision()
4005
revision_id = ensure_null(revision_id)
4006
if revision_id == NULL_REVISION:
4007
raise errors.BzrCommandError('No revisions to bundle.')
4008
directive = merge_directive.MergeDirective2.from_objects(
4009
branch.repository, revision_id, time.time(),
4010
osutils.local_time_offset(), submit_branch,
4011
public_branch=public_branch, include_patch=include_patch,
4012
include_bundle=include_bundle, message=message,
4013
base_revision_id=base_revision_id)
4016
self.outf.write(directive.to_signed(branch))
4018
self.outf.writelines(directive.to_lines())
4020
message = directive.to_email(mail_to, branch, sign)
4021
s = SMTPConnection(branch.get_config())
4022
s.send_email(message)
4025
class cmd_send(Command):
4026
"""Mail or create a merge-directive for submiting changes.
4028
A merge directive provides many things needed for requesting merges:
4030
* A machine-readable description of the merge to perform
4032
* An optional patch that is a preview of the changes requested
4034
* An optional bundle of revision data, so that the changes can be applied
4035
directly from the merge directive, without retrieving data from a
4038
If --no-bundle is specified, then public_branch is needed (and must be
4039
up-to-date), so that the receiver can perform the merge using the
4040
public_branch. The public_branch is always included if known, so that
4041
people can check it later.
4043
The submit branch defaults to the parent, but can be overridden. Both
4044
submit branch and public branch will be remembered if supplied.
4046
If a public_branch is known for the submit_branch, that public submit
4047
branch is used in the merge instructions. This means that a local mirror
4048
can be used as your actual submit branch, once you have set public_branch
4051
Mail is sent using your preferred mail program. This should be transparent
4052
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4053
If the preferred client can't be found (or used), your editor will be used.
4055
To use a specific mail program, set the mail_client configuration option.
4056
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4057
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4058
generic options are "default", "editor", "mapi", and "xdg-email".
4060
If mail is being sent, a to address is required. This can be supplied
4061
either on the commandline, by setting the submit_to configuration
4062
option in the branch itself or the child_submit_to configuration option
4063
in the submit branch.
4065
Two formats are currently supported: "4" uses revision bundle format 4 and
4066
merge directive format 2. It is significantly faster and smaller than
4067
older formats. It is compatible with Bazaar 0.19 and later. It is the
4068
default. "0.9" uses revision bundle format 0.9 and merge directive
4069
format 1. It is compatible with Bazaar 0.12 - 0.18.
4072
encoding_type = 'exact'
4074
_see_also = ['merge']
4076
takes_args = ['submit_branch?', 'public_branch?']
4080
help='Do not include a bundle in the merge directive.'),
4081
Option('no-patch', help='Do not include a preview patch in the merge'
4084
help='Remember submit and public branch.'),
4086
help='Branch to generate the submission from, '
4087
'rather than the one containing the working directory.',
4090
Option('output', short_name='o', help='Write directive to this file.',
4092
Option('mail-to', help='Mail the request to this address.',
4096
RegistryOption.from_kwargs('format',
4097
'Use the specified output format.',
4098
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4099
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4102
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4103
no_patch=False, revision=None, remember=False, output=None,
4104
format='4', mail_to=None, message=None, **kwargs):
4105
return self._run(submit_branch, revision, public_branch, remember,
4106
format, no_bundle, no_patch, output,
4107
kwargs.get('from', '.'), mail_to, message)
4109
def _run(self, submit_branch, revision, public_branch, remember, format,
4110
no_bundle, no_patch, output, from_, mail_to, message):
4111
from bzrlib.revision import NULL_REVISION
4112
branch = Branch.open_containing(from_)[0]
4114
outfile = StringIO()
4118
outfile = open(output, 'wb')
4119
# we may need to write data into branch's repository to calculate
4124
config = branch.get_config()
4126
mail_to = config.get_user_option('submit_to')
4127
mail_client = config.get_mail_client()
4128
if remember and submit_branch is None:
4129
raise errors.BzrCommandError(
4130
'--remember requires a branch to be specified.')
4131
stored_submit_branch = branch.get_submit_branch()
4132
remembered_submit_branch = False
4133
if submit_branch is None:
4134
submit_branch = stored_submit_branch
4135
remembered_submit_branch = True
4137
if stored_submit_branch is None or remember:
4138
branch.set_submit_branch(submit_branch)
4139
if submit_branch is None:
4140
submit_branch = branch.get_parent()
4141
remembered_submit_branch = True
4142
if submit_branch is None:
4143
raise errors.BzrCommandError('No submit branch known or'
4145
if remembered_submit_branch:
4146
note('Using saved location: %s', submit_branch)
4149
submit_config = Branch.open(submit_branch).get_config()
4150
mail_to = submit_config.get_user_option("child_submit_to")
4152
stored_public_branch = branch.get_public_branch()
4153
if public_branch is None:
4154
public_branch = stored_public_branch
4155
elif stored_public_branch is None or remember:
4156
branch.set_public_branch(public_branch)
4157
if no_bundle and public_branch is None:
4158
raise errors.BzrCommandError('No public branch specified or'
4160
base_revision_id = None
4162
if revision is not None:
4163
if len(revision) > 2:
4164
raise errors.BzrCommandError('bzr send takes '
4165
'at most two one revision identifiers')
4166
revision_id = revision[-1].in_history(branch).rev_id
4167
if len(revision) == 2:
4168
base_revision_id = revision[0].in_history(branch).rev_id
4169
if revision_id is None:
4170
revision_id = branch.last_revision()
4171
if revision_id == NULL_REVISION:
4172
raise errors.BzrCommandError('No revisions to submit.')
4174
directive = merge_directive.MergeDirective2.from_objects(
4175
branch.repository, revision_id, time.time(),
4176
osutils.local_time_offset(), submit_branch,
4177
public_branch=public_branch, include_patch=not no_patch,
4178
include_bundle=not no_bundle, message=message,
4179
base_revision_id=base_revision_id)
4180
elif format == '0.9':
4183
patch_type = 'bundle'
4185
raise errors.BzrCommandError('Format 0.9 does not'
4186
' permit bundle with no patch')
4192
directive = merge_directive.MergeDirective.from_objects(
4193
branch.repository, revision_id, time.time(),
4194
osutils.local_time_offset(), submit_branch,
4195
public_branch=public_branch, patch_type=patch_type,
4198
outfile.writelines(directive.to_lines())
4200
subject = '[MERGE] '
4201
if message is not None:
4204
revision = branch.repository.get_revision(revision_id)
4205
subject += revision.get_summary()
4206
basename = directive.get_disk_name(branch)
4207
mail_client.compose_merge_request(mail_to, subject,
4208
outfile.getvalue(), basename)
4215
class cmd_bundle_revisions(cmd_send):
4217
"""Create a merge-directive for submiting changes.
4219
A merge directive provides many things needed for requesting merges:
4221
* A machine-readable description of the merge to perform
4223
* An optional patch that is a preview of the changes requested
4225
* An optional bundle of revision data, so that the changes can be applied
4226
directly from the merge directive, without retrieving data from a
4229
If --no-bundle is specified, then public_branch is needed (and must be
4230
up-to-date), so that the receiver can perform the merge using the
4231
public_branch. The public_branch is always included if known, so that
4232
people can check it later.
4234
The submit branch defaults to the parent, but can be overridden. Both
4235
submit branch and public branch will be remembered if supplied.
4237
If a public_branch is known for the submit_branch, that public submit
4238
branch is used in the merge instructions. This means that a local mirror
4239
can be used as your actual submit branch, once you have set public_branch
4242
Two formats are currently supported: "4" uses revision bundle format 4 and
4243
merge directive format 2. It is significantly faster and smaller than
4244
older formats. It is compatible with Bazaar 0.19 and later. It is the
4245
default. "0.9" uses revision bundle format 0.9 and merge directive
4246
format 1. It is compatible with Bazaar 0.12 - 0.18.
4251
help='Do not include a bundle in the merge directive.'),
4252
Option('no-patch', help='Do not include a preview patch in the merge'
4255
help='Remember submit and public branch.'),
4257
help='Branch to generate the submission from, '
4258
'rather than the one containing the working directory.',
4261
Option('output', short_name='o', help='Write directive to this file.',
4264
RegistryOption.from_kwargs('format',
4265
'Use the specified output format.',
4266
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4267
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4269
aliases = ['bundle']
4271
_see_also = ['send', 'merge']
4275
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4276
no_patch=False, revision=None, remember=False, output=None,
4277
format='4', **kwargs):
4280
return self._run(submit_branch, revision, public_branch, remember,
4281
format, no_bundle, no_patch, output,
4282
kwargs.get('from', '.'), None, None)
4285
class cmd_tag(Command):
4286
"""Create, remove or modify a tag naming a revision.
4288
Tags give human-meaningful names to revisions. Commands that take a -r
4289
(--revision) option can be given -rtag:X, where X is any previously
4292
Tags are stored in the branch. Tags are copied from one branch to another
4293
along when you branch, push, pull or merge.
4295
It is an error to give a tag name that already exists unless you pass
4296
--force, in which case the tag is moved to point to the new revision.
4299
_see_also = ['commit', 'tags']
4300
takes_args = ['tag_name']
4303
help='Delete this tag rather than placing it.',
4306
help='Branch in which to place the tag.',
4311
help='Replace existing tags.',
4316
def run(self, tag_name,
4322
branch, relpath = Branch.open_containing(directory)
4326
branch.tags.delete_tag(tag_name)
4327
self.outf.write('Deleted tag %s.\n' % tag_name)
4330
if len(revision) != 1:
4331
raise errors.BzrCommandError(
4332
"Tags can only be placed on a single revision, "
4334
revision_id = revision[0].in_history(branch).rev_id
4336
revision_id = branch.last_revision()
4337
if (not force) and branch.tags.has_tag(tag_name):
4338
raise errors.TagAlreadyExists(tag_name)
4339
branch.tags.set_tag(tag_name, revision_id)
4340
self.outf.write('Created tag %s.\n' % tag_name)
4345
class cmd_tags(Command):
4348
This command shows a table of tag names and the revisions they reference.
4354
help='Branch whose tags should be displayed.',
4358
RegistryOption.from_kwargs('sort',
4359
'Sort tags by different criteria.', title='Sorting',
4360
alpha='Sort tags lexicographically (default).',
4361
time='Sort tags chronologically.',
4372
branch, relpath = Branch.open_containing(directory)
4373
tags = branch.tags.get_tag_dict().items()
4376
elif sort == 'time':
4378
for tag, revid in tags:
4380
revobj = branch.repository.get_revision(revid)
4381
except errors.NoSuchRevision:
4382
timestamp = sys.maxint # place them at the end
4384
timestamp = revobj.timestamp
4385
timestamps[revid] = timestamp
4386
tags.sort(key=lambda x: timestamps[x[1]])
4388
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4389
revno_map = branch.get_revision_id_to_revno_map()
4390
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4391
for tag, revid in tags ]
4392
for tag, revspec in tags:
4393
self.outf.write('%-20s %s\n' % (tag, revspec))
4396
class cmd_reconfigure(Command):
4397
"""Reconfigure the type of a bzr directory.
4399
A target configuration must be specified.
4401
For checkouts, the bind-to location will be auto-detected if not specified.
4402
The order of preference is
4403
1. For a lightweight checkout, the current bound location.
4404
2. For branches that used to be checkouts, the previously-bound location.
4405
3. The push location.
4406
4. The parent location.
4407
If none of these is available, --bind-to must be specified.
4410
takes_args = ['location?']
4411
takes_options = [RegistryOption.from_kwargs('target_type',
4412
title='Target type',
4413
help='The type to reconfigure the directory to.',
4414
value_switches=True, enum_switch=False,
4415
branch='Reconfigure to a branch.',
4416
tree='Reconfigure to a tree.',
4417
checkout='Reconfigure to a checkout.',
4418
lightweight_checkout='Reconfigure to a lightweight'
4420
Option('bind-to', help='Branch to bind checkout to.',
4423
help='Perform reconfiguration even if local changes'
4427
def run(self, location=None, target_type=None, bind_to=None, force=False):
4428
directory = bzrdir.BzrDir.open(location)
4429
if target_type is None:
4430
raise errors.BzrCommandError('No target configuration specified')
4431
elif target_type == 'branch':
4432
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4433
elif target_type == 'tree':
4434
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4435
elif target_type == 'checkout':
4436
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4438
elif target_type == 'lightweight-checkout':
4439
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4441
reconfiguration.apply(force)
4444
class cmd_switch(Command):
4445
"""Set the branch of a checkout and update.
4447
For lightweight checkouts, this changes the branch being referenced.
4448
For heavyweight checkouts, this checks that there are no local commits
4449
versus the current bound branch, then it makes the local branch a mirror
4450
of the new location and binds to it.
4452
In both cases, the working tree is updated and uncommitted changes
4453
are merged. The user can commit or revert these as they desire.
4455
Pending merges need to be committed or reverted before using switch.
4458
takes_args = ['to_location']
4459
takes_options = [Option('force',
4460
help='Switch even if local commits will be lost.')
4463
def run(self, to_location, force=False):
4464
from bzrlib import switch
4465
to_branch = Branch.open(to_location)
4467
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4468
switch.switch(control_dir, to_branch, force)
4469
note('Switched to branch: %s',
4470
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4473
class cmd_hooks(Command):
4474
"""Show a branch's currently registered hooks.
4478
takes_args = ['path?']
4480
def run(self, path=None):
4483
branch_hooks = Branch.open(path).hooks
4484
for hook_type in branch_hooks:
4485
hooks = branch_hooks[hook_type]
4486
self.outf.write("%s:\n" % (hook_type,))
4489
self.outf.write(" %s\n" %
4490
(branch_hooks.get_hook_name(hook),))
4492
self.outf.write(" <no hooks installed>\n")
4495
def _create_prefix(cur_transport):
4496
needed = [cur_transport]
4497
# Recurse upwards until we can create a directory successfully
4499
new_transport = cur_transport.clone('..')
4500
if new_transport.base == cur_transport.base:
4501
raise errors.BzrCommandError(
4502
"Failed to create path prefix for %s."
4503
% cur_transport.base)
4505
new_transport.mkdir('.')
4506
except errors.NoSuchFile:
4507
needed.append(new_transport)
4508
cur_transport = new_transport
4511
# Now we only need to create child directories
4513
cur_transport = needed.pop()
4514
cur_transport.ensure_base()
4517
def _get_mergeable_helper(location):
4518
"""Get a merge directive or bundle if 'location' points to one.
4520
Try try to identify a bundle and returns its mergeable form. If it's not,
4521
we return the tried transport anyway so that it can reused to access the
4524
:param location: can point to a bundle or a branch.
4526
:return: mergeable, transport
4529
url = urlutils.normalize_url(location)
4530
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4531
location_transport = transport.get_transport(url)
4534
# There may be redirections but we ignore the intermediate
4535
# and final transports used
4536
read = bundle.read_mergeable_from_transport
4537
mergeable, t = read(location_transport, filename)
4538
except errors.NotABundle:
4539
# Continue on considering this url a Branch but adjust the
4540
# location_transport
4541
location_transport = location_transport.clone(filename)
4542
return mergeable, location_transport
4545
# these get imported and then picked up by the scan for cmd_*
4546
# TODO: Some more consistent way to split command definitions across files;
4547
# we do need to load at least some information about them to know of
4548
# aliases. ideally we would avoid loading the implementation until the
4549
# details were needed.
4550
from bzrlib.cmd_version_info import cmd_version_info
4551
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4552
from bzrlib.bundle.commands import (
4555
from bzrlib.sign_my_commits import cmd_sign_my_commits
4556
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4557
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
