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)
538
dest = names_list[-1]
539
isdir = os.path.isdir(dest)
540
if (isdir and not tree.case_sensitive and len(rel_names) == 2
541
and rel_names[0].lower() == rel_names[1].lower()):
544
# move into existing directory
545
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
546
self.outf.write("%s => %s\n" % pair)
548
if len(names_list) != 2:
549
raise errors.BzrCommandError('to mv multiple files the'
550
' destination must be a versioned'
552
tree.rename_one(rel_names[0], rel_names[1], after=after)
553
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
556
class cmd_pull(Command):
557
"""Turn this branch into a mirror of another branch.
559
This command only works on branches that have not diverged. Branches are
560
considered diverged if the destination branch's most recent commit is one
561
that has not been merged (directly or indirectly) into the parent.
563
If branches have diverged, you can use 'bzr merge' to integrate the changes
564
from one into the other. Once one branch has merged, the other should
565
be able to pull it again.
567
If you want to forget your local changes and just update your branch to
568
match the remote one, use pull --overwrite.
570
If there is no default location set, the first pull will set it. After
571
that, you can omit the location to use the default. To change the
572
default, use --remember. The value will only be saved if the remote
573
location can be accessed.
576
_see_also = ['push', 'update', 'status-flags']
577
takes_options = ['remember', 'overwrite', 'revision',
578
custom_help('verbose',
579
help='Show logs of pulled revisions.'),
581
help='Branch to pull into, '
582
'rather than the one containing the working directory.',
587
takes_args = ['location?']
588
encoding_type = 'replace'
590
def run(self, location=None, remember=False, overwrite=False,
591
revision=None, verbose=False,
593
# FIXME: too much stuff is in the command class
596
if directory is None:
599
tree_to = WorkingTree.open_containing(directory)[0]
600
branch_to = tree_to.branch
601
except errors.NoWorkingTree:
603
branch_to = Branch.open_containing(directory)[0]
605
possible_transports = []
606
if location is not None:
607
mergeable, location_transport = _get_mergeable_helper(location)
608
possible_transports.append(location_transport)
610
stored_loc = branch_to.get_parent()
612
if stored_loc is None:
613
raise errors.BzrCommandError("No pull location known or"
616
display_url = urlutils.unescape_for_display(stored_loc,
619
self.outf.write("Using saved location: %s\n" % display_url)
620
location = stored_loc
621
location_transport = transport.get_transport(
622
location, possible_transports=possible_transports)
624
if mergeable is not None:
625
if revision is not None:
626
raise errors.BzrCommandError(
627
'Cannot use -r with merge directives or bundles')
628
mergeable.install_revisions(branch_to.repository)
629
base_revision_id, revision_id, verified = \
630
mergeable.get_merge_request(branch_to.repository)
631
branch_from = branch_to
633
branch_from = Branch.open_from_transport(location_transport)
635
if branch_to.get_parent() is None or remember:
636
branch_to.set_parent(branch_from.base)
638
if revision is not None:
639
if len(revision) == 1:
640
revision_id = revision[0].in_history(branch_from).rev_id
642
raise errors.BzrCommandError(
643
'bzr pull --revision takes one value.')
646
old_rh = branch_to.revision_history()
647
if tree_to is not None:
648
change_reporter = delta._ChangeReporter(
649
unversioned_filter=tree_to.is_ignored)
650
result = tree_to.pull(branch_from, overwrite, revision_id,
652
possible_transports=possible_transports)
654
result = branch_to.pull(branch_from, overwrite, revision_id)
656
result.report(self.outf)
658
new_rh = branch_to.revision_history()
659
log.show_changed_revisions(branch_to, old_rh, new_rh,
663
class cmd_push(Command):
664
"""Update a mirror of this branch.
666
The target branch will not have its working tree populated because this
667
is both expensive, and is not supported on remote file systems.
669
Some smart servers or protocols *may* put the working tree in place in
672
This command only works on branches that have not diverged. Branches are
673
considered diverged if the destination branch's most recent commit is one
674
that has not been merged (directly or indirectly) by the source branch.
676
If branches have diverged, you can use 'bzr push --overwrite' to replace
677
the other branch completely, discarding its unmerged changes.
679
If you want to ensure you have the different changes in the other branch,
680
do a merge (see bzr help merge) from the other branch, and commit that.
681
After that you will be able to do a push without '--overwrite'.
683
If there is no default push location set, the first push will set it.
684
After that, you can omit the location to use the default. To change the
685
default, use --remember. The value will only be saved if the remote
686
location can be accessed.
689
_see_also = ['pull', 'update', 'working-trees']
690
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
691
Option('create-prefix',
692
help='Create the path leading up to the branch '
693
'if it does not already exist.'),
695
help='Branch to push from, '
696
'rather than the one containing the working directory.',
700
Option('use-existing-dir',
701
help='By default push will fail if the target'
702
' directory exists, but does not already'
703
' have a control directory. This flag will'
704
' allow push to proceed.'),
706
takes_args = ['location?']
707
encoding_type = 'replace'
709
def run(self, location=None, remember=False, overwrite=False,
710
create_prefix=False, verbose=False, revision=None,
711
use_existing_dir=False,
713
# FIXME: Way too big! Put this into a function called from the
715
if directory is None:
717
br_from = Branch.open_containing(directory)[0]
718
stored_loc = br_from.get_push_location()
720
if stored_loc is None:
721
raise errors.BzrCommandError("No push location known or specified.")
723
display_url = urlutils.unescape_for_display(stored_loc,
725
self.outf.write("Using saved location: %s\n" % display_url)
726
location = stored_loc
728
to_transport = transport.get_transport(location)
730
br_to = repository_to = dir_to = None
732
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
733
except errors.NotBranchError:
734
pass # Didn't find anything
736
# If we can open a branch, use its direct repository, otherwise see
737
# if there is a repository without a branch.
739
br_to = dir_to.open_branch()
740
except errors.NotBranchError:
741
# Didn't find a branch, can we find a repository?
743
repository_to = dir_to.find_repository()
744
except errors.NoRepositoryPresent:
747
# Found a branch, so we must have found a repository
748
repository_to = br_to.repository
750
if revision is not None:
751
if len(revision) == 1:
752
revision_id = revision[0].in_history(br_from).rev_id
754
raise errors.BzrCommandError(
755
'bzr push --revision takes one value.')
757
revision_id = br_from.last_revision()
763
# The destination doesn't exist; create it.
764
# XXX: Refactor the create_prefix/no_create_prefix code into a
765
# common helper function
767
def make_directory(transport):
771
def redirected(redirected_transport, e, redirection_notice):
772
return transport.get_transport(e.get_target_url())
775
to_transport = transport.do_catching_redirections(
776
make_directory, to_transport, redirected)
777
except errors.FileExists:
778
if not use_existing_dir:
779
raise errors.BzrCommandError("Target directory %s"
780
" already exists, but does not have a valid .bzr"
781
" directory. Supply --use-existing-dir to push"
782
" there anyway." % location)
783
except errors.NoSuchFile:
784
if not create_prefix:
785
raise errors.BzrCommandError("Parent directory of %s"
787
"\nYou may supply --create-prefix to create all"
788
" leading parent directories."
790
_create_prefix(to_transport)
791
except errors.TooManyRedirections:
792
raise errors.BzrCommandError("Too many redirections trying "
793
"to make %s." % location)
795
# Now the target directory exists, but doesn't have a .bzr
796
# directory. So we need to create it, along with any work to create
797
# all of the dependent branches, etc.
798
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
799
revision_id=revision_id)
800
br_to = dir_to.open_branch()
801
# TODO: Some more useful message about what was copied
802
note('Created new branch.')
803
# We successfully created the target, remember it
804
if br_from.get_push_location() is None or remember:
805
br_from.set_push_location(br_to.base)
806
elif repository_to is None:
807
# we have a bzrdir but no branch or repository
808
# XXX: Figure out what to do other than complain.
809
raise errors.BzrCommandError("At %s you have a valid .bzr control"
810
" directory, but not a branch or repository. This is an"
811
" unsupported configuration. Please move the target directory"
812
" out of the way and try again."
815
# We have a repository but no branch, copy the revisions, and then
817
repository_to.fetch(br_from.repository, revision_id=revision_id)
818
br_to = br_from.clone(dir_to, revision_id=revision_id)
819
note('Created new branch.')
820
if br_from.get_push_location() is None or remember:
821
br_from.set_push_location(br_to.base)
822
else: # We have a valid to branch
823
# We were able to connect to the remote location, so remember it
824
# we don't need to successfully push because of possible divergence.
825
if br_from.get_push_location() is None or remember:
826
br_from.set_push_location(br_to.base)
828
old_rh = br_to.revision_history()
831
tree_to = dir_to.open_workingtree()
832
except errors.NotLocalUrl:
833
warning("This transport does not update the working "
834
"tree of: %s. See 'bzr help working-trees' for "
835
"more information." % br_to.base)
836
push_result = br_from.push(br_to, overwrite,
837
stop_revision=revision_id)
838
except errors.NoWorkingTree:
839
push_result = br_from.push(br_to, overwrite,
840
stop_revision=revision_id)
844
push_result = br_from.push(tree_to.branch, overwrite,
845
stop_revision=revision_id)
849
except errors.DivergedBranches:
850
raise errors.BzrCommandError('These branches have diverged.'
851
' Try using "merge" and then "push".')
852
if push_result is not None:
853
push_result.report(self.outf)
855
new_rh = br_to.revision_history()
858
from bzrlib.log import show_changed_revisions
859
show_changed_revisions(br_to, old_rh, new_rh,
862
# we probably did a clone rather than a push, so a message was
867
class cmd_branch(Command):
868
"""Create a new copy of a branch.
870
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
871
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
872
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
873
is derived from the FROM_LOCATION by stripping a leading scheme or drive
874
identifier, if any. For example, "branch lp:foo-bar" will attempt to
877
To retrieve the branch as of a particular revision, supply the --revision
878
parameter, as in "branch foo/bar -r 5".
881
_see_also = ['checkout']
882
takes_args = ['from_location', 'to_location?']
883
takes_options = ['revision', Option('hardlink',
884
help='Hard-link working tree files where possible.')]
885
aliases = ['get', 'clone']
887
def run(self, from_location, to_location=None, revision=None,
889
from bzrlib.tag import _merge_tags_if_possible
892
elif len(revision) > 1:
893
raise errors.BzrCommandError(
894
'bzr branch --revision takes exactly 1 revision value')
896
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
900
if len(revision) == 1 and revision[0] is not None:
901
revision_id = revision[0].in_history(br_from)[1]
903
# FIXME - wt.last_revision, fallback to branch, fall back to
904
# None or perhaps NULL_REVISION to mean copy nothing
906
revision_id = br_from.last_revision()
907
if to_location is None:
908
to_location = urlutils.derive_to_location(from_location)
911
name = os.path.basename(to_location) + '\n'
913
to_transport = transport.get_transport(to_location)
915
to_transport.mkdir('.')
916
except errors.FileExists:
917
raise errors.BzrCommandError('Target directory "%s" already'
918
' exists.' % to_location)
919
except errors.NoSuchFile:
920
raise errors.BzrCommandError('Parent of "%s" does not exist.'
923
# preserve whatever source format we have.
924
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
925
possible_transports=[to_transport],
926
accelerator_tree=accelerator_tree,
928
branch = dir.open_branch()
929
except errors.NoSuchRevision:
930
to_transport.delete_tree('.')
931
msg = "The branch %s has no revision %s." % (from_location, revision[0])
932
raise errors.BzrCommandError(msg)
934
branch.control_files.put_utf8('branch-name', name)
935
_merge_tags_if_possible(br_from, branch)
936
note('Branched %d revision(s).' % branch.revno())
941
class cmd_checkout(Command):
942
"""Create a new checkout of an existing branch.
944
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
945
the branch found in '.'. This is useful if you have removed the working tree
946
or if it was never created - i.e. if you pushed the branch to its current
949
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
950
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
951
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
952
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
953
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
956
To retrieve the branch as of a particular revision, supply the --revision
957
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
958
out of date [so you cannot commit] but it may be useful (i.e. to examine old
962
_see_also = ['checkouts', 'branch']
963
takes_args = ['branch_location?', 'to_location?']
964
takes_options = ['revision',
965
Option('lightweight',
966
help="Perform a lightweight checkout. Lightweight "
967
"checkouts depend on access to the branch for "
968
"every operation. Normal checkouts can perform "
969
"common operations like diff and status without "
970
"such access, and also support local commits."
972
Option('files-from', type=str,
973
help="Get file contents from this tree."),
975
help='Hard-link working tree files where possible.'
980
def run(self, branch_location=None, to_location=None, revision=None,
981
lightweight=False, files_from=None, hardlink=False):
984
elif len(revision) > 1:
985
raise errors.BzrCommandError(
986
'bzr checkout --revision takes exactly 1 revision value')
987
if branch_location is None:
988
branch_location = osutils.getcwd()
989
to_location = branch_location
990
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
992
if files_from is not None:
993
accelerator_tree = WorkingTree.open(files_from)
994
if len(revision) == 1 and revision[0] is not None:
995
revision_id = _mod_revision.ensure_null(
996
revision[0].in_history(source)[1])
999
if to_location is None:
1000
to_location = urlutils.derive_to_location(branch_location)
1001
# if the source and to_location are the same,
1002
# and there is no working tree,
1003
# then reconstitute a branch
1004
if (osutils.abspath(to_location) ==
1005
osutils.abspath(branch_location)):
1007
source.bzrdir.open_workingtree()
1008
except errors.NoWorkingTree:
1009
source.bzrdir.create_workingtree(revision_id)
1011
source.create_checkout(to_location, revision_id, lightweight,
1012
accelerator_tree, hardlink)
1015
class cmd_renames(Command):
1016
"""Show list of renamed files.
1018
# TODO: Option to show renames between two historical versions.
1020
# TODO: Only show renames under dir, rather than in the whole branch.
1021
_see_also = ['status']
1022
takes_args = ['dir?']
1025
def run(self, dir=u'.'):
1026
tree = WorkingTree.open_containing(dir)[0]
1029
new_inv = tree.inventory
1030
old_tree = tree.basis_tree()
1031
old_tree.lock_read()
1033
old_inv = old_tree.inventory
1034
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1036
for old_name, new_name in renames:
1037
self.outf.write("%s => %s\n" % (old_name, new_name))
1044
class cmd_update(Command):
1045
"""Update a tree to have the latest code committed to its branch.
1047
This will perform a merge into the working tree, and may generate
1048
conflicts. If you have any local changes, you will still
1049
need to commit them after the update for the update to be complete.
1051
If you want to discard your local changes, you can just do a
1052
'bzr revert' instead of 'bzr commit' after the update.
1055
_see_also = ['pull', 'working-trees', 'status-flags']
1056
takes_args = ['dir?']
1059
def run(self, dir='.'):
1060
tree = WorkingTree.open_containing(dir)[0]
1061
possible_transports = []
1062
master = tree.branch.get_master_branch(
1063
possible_transports=possible_transports)
1064
if master is not None:
1067
tree.lock_tree_write()
1069
existing_pending_merges = tree.get_parent_ids()[1:]
1070
last_rev = _mod_revision.ensure_null(tree.last_revision())
1071
if last_rev == _mod_revision.ensure_null(
1072
tree.branch.last_revision()):
1073
# may be up to date, check master too.
1074
if master is None or last_rev == _mod_revision.ensure_null(
1075
master.last_revision()):
1076
revno = tree.branch.revision_id_to_revno(last_rev)
1077
note("Tree is up to date at revision %d." % (revno,))
1079
conflicts = tree.update(
1080
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1081
possible_transports=possible_transports)
1082
revno = tree.branch.revision_id_to_revno(
1083
_mod_revision.ensure_null(tree.last_revision()))
1084
note('Updated to revision %d.' % (revno,))
1085
if tree.get_parent_ids()[1:] != existing_pending_merges:
1086
note('Your local commits will now show as pending merges with '
1087
"'bzr status', and can be committed with 'bzr commit'.")
1096
class cmd_info(Command):
1097
"""Show information about a working tree, branch or repository.
1099
This command will show all known locations and formats associated to the
1100
tree, branch or repository. Statistical information is included with
1103
Branches and working trees will also report any missing revisions.
1105
_see_also = ['revno', 'working-trees', 'repositories']
1106
takes_args = ['location?']
1107
takes_options = ['verbose']
1108
encoding_type = 'replace'
1111
def run(self, location=None, verbose=False):
1116
from bzrlib.info import show_bzrdir_info
1117
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1118
verbose=noise_level, outfile=self.outf)
1121
class cmd_remove(Command):
1122
"""Remove files or directories.
1124
This makes bzr stop tracking changes to the specified files and
1125
delete them if they can easily be recovered using revert.
1127
You can specify one or more files, and/or --new. If you specify --new,
1128
only 'added' files will be removed. If you specify both, then new files
1129
in the specified directories will be removed. If the directories are
1130
also new, they will also be removed.
1132
takes_args = ['file*']
1133
takes_options = ['verbose',
1134
Option('new', help='Remove newly-added files.'),
1135
RegistryOption.from_kwargs('file-deletion-strategy',
1136
'The file deletion mode to be used.',
1137
title='Deletion Strategy', value_switches=True, enum_switch=False,
1138
safe='Only delete files if they can be'
1139
' safely recovered (default).',
1140
keep="Don't delete any files.",
1141
force='Delete all the specified files, even if they can not be '
1142
'recovered and even if they are non-empty directories.')]
1144
encoding_type = 'replace'
1146
def run(self, file_list, verbose=False, new=False,
1147
file_deletion_strategy='safe'):
1148
tree, file_list = tree_files(file_list)
1150
if file_list is not None:
1151
file_list = [f for f in file_list]
1153
raise errors.BzrCommandError('Specify one or more files to'
1154
' remove, or use --new.')
1157
added = tree.changes_from(tree.basis_tree(),
1158
specific_files=file_list).added
1159
file_list = sorted([f[0] for f in added], reverse=True)
1160
if len(file_list) == 0:
1161
raise errors.BzrCommandError('No matching files.')
1162
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1163
keep_files=file_deletion_strategy=='keep',
1164
force=file_deletion_strategy=='force')
1167
class cmd_file_id(Command):
1168
"""Print file_id of a particular file or directory.
1170
The file_id is assigned when the file is first added and remains the
1171
same through all revisions where the file exists, even when it is
1176
_see_also = ['inventory', 'ls']
1177
takes_args = ['filename']
1180
def run(self, filename):
1181
tree, relpath = WorkingTree.open_containing(filename)
1182
i = tree.path2id(relpath)
1184
raise errors.NotVersionedError(filename)
1186
self.outf.write(i + '\n')
1189
class cmd_file_path(Command):
1190
"""Print path of file_ids to a file or directory.
1192
This prints one line for each directory down to the target,
1193
starting at the branch root.
1197
takes_args = ['filename']
1200
def run(self, filename):
1201
tree, relpath = WorkingTree.open_containing(filename)
1202
fid = tree.path2id(relpath)
1204
raise errors.NotVersionedError(filename)
1205
segments = osutils.splitpath(relpath)
1206
for pos in range(1, len(segments) + 1):
1207
path = osutils.joinpath(segments[:pos])
1208
self.outf.write("%s\n" % tree.path2id(path))
1211
class cmd_reconcile(Command):
1212
"""Reconcile bzr metadata in a branch.
1214
This can correct data mismatches that may have been caused by
1215
previous ghost operations or bzr upgrades. You should only
1216
need to run this command if 'bzr check' or a bzr developer
1217
advises you to run it.
1219
If a second branch is provided, cross-branch reconciliation is
1220
also attempted, which will check that data like the tree root
1221
id which was not present in very early bzr versions is represented
1222
correctly in both branches.
1224
At the same time it is run it may recompress data resulting in
1225
a potential saving in disk space or performance gain.
1227
The branch *MUST* be on a listable system such as local disk or sftp.
1230
_see_also = ['check']
1231
takes_args = ['branch?']
1233
def run(self, branch="."):
1234
from bzrlib.reconcile import reconcile
1235
dir = bzrdir.BzrDir.open(branch)
1239
class cmd_revision_history(Command):
1240
"""Display the list of revision ids on a branch."""
1243
takes_args = ['location?']
1248
def run(self, location="."):
1249
branch = Branch.open_containing(location)[0]
1250
for revid in branch.revision_history():
1251
self.outf.write(revid)
1252
self.outf.write('\n')
1255
class cmd_ancestry(Command):
1256
"""List all revisions merged into this branch."""
1258
_see_also = ['log', 'revision-history']
1259
takes_args = ['location?']
1264
def run(self, location="."):
1266
wt = WorkingTree.open_containing(location)[0]
1267
except errors.NoWorkingTree:
1268
b = Branch.open(location)
1269
last_revision = b.last_revision()
1272
last_revision = wt.last_revision()
1274
revision_ids = b.repository.get_ancestry(last_revision)
1275
assert revision_ids[0] is None
1277
for revision_id in revision_ids:
1278
self.outf.write(revision_id + '\n')
1281
class cmd_init(Command):
1282
"""Make a directory into a versioned branch.
1284
Use this to create an empty branch, or before importing an
1287
If there is a repository in a parent directory of the location, then
1288
the history of the branch will be stored in the repository. Otherwise
1289
init creates a standalone branch which carries its own history
1290
in the .bzr directory.
1292
If there is already a branch at the location but it has no working tree,
1293
the tree can be populated with 'bzr checkout'.
1295
Recipe for importing a tree of files::
1301
bzr commit -m "imported project"
1304
_see_also = ['init-repository', 'branch', 'checkout']
1305
takes_args = ['location?']
1307
Option('create-prefix',
1308
help='Create the path leading up to the branch '
1309
'if it does not already exist.'),
1310
RegistryOption('format',
1311
help='Specify a format for this branch. '
1312
'See "help formats".',
1313
registry=bzrdir.format_registry,
1314
converter=bzrdir.format_registry.make_bzrdir,
1315
value_switches=True,
1316
title="Branch Format",
1318
Option('append-revisions-only',
1319
help='Never change revnos or the existing log.'
1320
' Append revisions to it only.')
1322
def run(self, location=None, format=None, append_revisions_only=False,
1323
create_prefix=False):
1325
format = bzrdir.format_registry.make_bzrdir('default')
1326
if location is None:
1329
to_transport = transport.get_transport(location)
1331
# The path has to exist to initialize a
1332
# branch inside of it.
1333
# Just using os.mkdir, since I don't
1334
# believe that we want to create a bunch of
1335
# locations if the user supplies an extended path
1337
to_transport.ensure_base()
1338
except errors.NoSuchFile:
1339
if not create_prefix:
1340
raise errors.BzrCommandError("Parent directory of %s"
1342
"\nYou may supply --create-prefix to create all"
1343
" leading parent directories."
1345
_create_prefix(to_transport)
1348
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1349
except errors.NotBranchError:
1350
# really a NotBzrDir error...
1351
create_branch = bzrdir.BzrDir.create_branch_convenience
1352
branch = create_branch(to_transport.base, format=format,
1353
possible_transports=[to_transport])
1355
from bzrlib.transport.local import LocalTransport
1356
if existing_bzrdir.has_branch():
1357
if (isinstance(to_transport, LocalTransport)
1358
and not existing_bzrdir.has_workingtree()):
1359
raise errors.BranchExistsWithoutWorkingTree(location)
1360
raise errors.AlreadyBranchError(location)
1362
branch = existing_bzrdir.create_branch()
1363
existing_bzrdir.create_workingtree()
1364
if append_revisions_only:
1366
branch.set_append_revisions_only(True)
1367
except errors.UpgradeRequired:
1368
raise errors.BzrCommandError('This branch format cannot be set'
1369
' to append-revisions-only. Try --experimental-branch6')
1372
class cmd_init_repository(Command):
1373
"""Create a shared repository to hold branches.
1375
New branches created under the repository directory will store their
1376
revisions in the repository, not in the branch directory.
1378
If the --no-trees option is used then the branches in the repository
1379
will not have working trees by default.
1382
Create a shared repositories holding just branches::
1384
bzr init-repo --no-trees repo
1387
Make a lightweight checkout elsewhere::
1389
bzr checkout --lightweight repo/trunk trunk-checkout
1394
_see_also = ['init', 'branch', 'checkout', 'repositories']
1395
takes_args = ["location"]
1396
takes_options = [RegistryOption('format',
1397
help='Specify a format for this repository. See'
1398
' "bzr help formats" for details.',
1399
registry=bzrdir.format_registry,
1400
converter=bzrdir.format_registry.make_bzrdir,
1401
value_switches=True, title='Repository format'),
1403
help='Branches in the repository will default to'
1404
' not having a working tree.'),
1406
aliases = ["init-repo"]
1408
def run(self, location, format=None, no_trees=False):
1410
format = bzrdir.format_registry.make_bzrdir('default')
1412
if location is None:
1415
to_transport = transport.get_transport(location)
1416
to_transport.ensure_base()
1418
newdir = format.initialize_on_transport(to_transport)
1419
repo = newdir.create_repository(shared=True)
1420
repo.set_make_working_trees(not no_trees)
1423
class cmd_diff(Command):
1424
"""Show differences in the working tree, between revisions or branches.
1426
If no arguments are given, all changes for the current tree are listed.
1427
If files are given, only the changes in those files are listed.
1428
Remote and multiple branches can be compared by using the --old and
1429
--new options. If not provided, the default for both is derived from
1430
the first argument, if any, or the current tree if no arguments are
1433
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1434
produces patches suitable for "patch -p1".
1438
2 - unrepresentable changes
1443
Shows the difference in the working tree versus the last commit::
1447
Difference between the working tree and revision 1::
1451
Difference between revision 2 and revision 1::
1455
Difference between revision 2 and revision 1 for branch xxx::
1459
Show just the differences for file NEWS::
1463
Show the differences in working tree xxx for file NEWS::
1467
Show the differences from branch xxx to this working tree:
1471
Show the differences between two branches for file NEWS::
1473
bzr diff --old xxx --new yyy NEWS
1475
Same as 'bzr diff' but prefix paths with old/ and new/::
1477
bzr diff --prefix old/:new/
1479
_see_also = ['status']
1480
takes_args = ['file*']
1482
Option('diff-options', type=str,
1483
help='Pass these options to the external diff program.'),
1484
Option('prefix', type=str,
1486
help='Set prefixes added to old and new filenames, as '
1487
'two values separated by a colon. (eg "old/:new/").'),
1489
help='Branch/tree to compare from.',
1493
help='Branch/tree to compare to.',
1499
help='Use this command to compare files.',
1503
aliases = ['di', 'dif']
1504
encoding_type = 'exact'
1507
def run(self, revision=None, file_list=None, diff_options=None,
1508
prefix=None, old=None, new=None, using=None):
1509
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1511
if (prefix is None) or (prefix == '0'):
1519
old_label, new_label = prefix.split(":")
1521
raise errors.BzrCommandError(
1522
'--prefix expects two values separated by a colon'
1523
' (eg "old/:new/")')
1525
if revision and len(revision) > 2:
1526
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1527
' one or two revision specifiers')
1529
old_tree, new_tree, specific_files, extra_trees = \
1530
_get_trees_to_diff(file_list, revision, old, new)
1531
return show_diff_trees(old_tree, new_tree, sys.stdout,
1532
specific_files=specific_files,
1533
external_diff_options=diff_options,
1534
old_label=old_label, new_label=new_label,
1535
extra_trees=extra_trees, using=using)
1538
class cmd_deleted(Command):
1539
"""List files deleted in the working tree.
1541
# TODO: Show files deleted since a previous revision, or
1542
# between two revisions.
1543
# TODO: Much more efficient way to do this: read in new
1544
# directories with readdir, rather than stating each one. Same
1545
# level of effort but possibly much less IO. (Or possibly not,
1546
# if the directories are very large...)
1547
_see_also = ['status', 'ls']
1548
takes_options = ['show-ids']
1551
def run(self, show_ids=False):
1552
tree = WorkingTree.open_containing(u'.')[0]
1555
old = tree.basis_tree()
1558
for path, ie in old.inventory.iter_entries():
1559
if not tree.has_id(ie.file_id):
1560
self.outf.write(path)
1562
self.outf.write(' ')
1563
self.outf.write(ie.file_id)
1564
self.outf.write('\n')
1571
class cmd_modified(Command):
1572
"""List files modified in working tree.
1576
_see_also = ['status', 'ls']
1580
tree = WorkingTree.open_containing(u'.')[0]
1581
td = tree.changes_from(tree.basis_tree())
1582
for path, id, kind, text_modified, meta_modified in td.modified:
1583
self.outf.write(path + '\n')
1586
class cmd_added(Command):
1587
"""List files added in working tree.
1591
_see_also = ['status', 'ls']
1595
wt = WorkingTree.open_containing(u'.')[0]
1598
basis = wt.basis_tree()
1601
basis_inv = basis.inventory
1604
if file_id in basis_inv:
1606
if inv.is_root(file_id) and len(basis_inv) == 0:
1608
path = inv.id2path(file_id)
1609
if not os.access(osutils.abspath(path), os.F_OK):
1611
self.outf.write(path + '\n')
1618
class cmd_root(Command):
1619
"""Show the tree root directory.
1621
The root is the nearest enclosing directory with a .bzr control
1624
takes_args = ['filename?']
1626
def run(self, filename=None):
1627
"""Print the branch root."""
1628
tree = WorkingTree.open_containing(filename)[0]
1629
self.outf.write(tree.basedir + '\n')
1632
def _parse_limit(limitstring):
1634
return int(limitstring)
1636
msg = "The limit argument must be an integer."
1637
raise errors.BzrCommandError(msg)
1640
class cmd_log(Command):
1641
"""Show log of a branch, file, or directory.
1643
By default show the log of the branch containing the working directory.
1645
To request a range of logs, you can use the command -r begin..end
1646
-r revision requests a specific revision, -r ..end or -r begin.. are
1650
Log the current branch::
1658
Log the last 10 revisions of a branch::
1660
bzr log -r -10.. http://server/branch
1663
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1665
takes_args = ['location?']
1668
help='Show from oldest to newest.'),
1671
help='Display timezone as local, original, or utc.'),
1672
custom_help('verbose',
1673
help='Show files changed in each revision.'),
1679
help='Show revisions whose message matches this '
1680
'regular expression.',
1684
help='Limit the output to the first N revisions.',
1688
encoding_type = 'replace'
1691
def run(self, location=None, timezone='original',
1699
from bzrlib.log import show_log
1700
assert message is None or isinstance(message, basestring), \
1701
"invalid message argument %r" % message
1702
direction = (forward and 'forward') or 'reverse'
1707
# find the file id to log:
1709
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1713
tree = b.basis_tree()
1714
file_id = tree.path2id(fp)
1716
raise errors.BzrCommandError(
1717
"Path does not have any revision history: %s" %
1721
# FIXME ? log the current subdir only RBC 20060203
1722
if revision is not None \
1723
and len(revision) > 0 and revision[0].get_branch():
1724
location = revision[0].get_branch()
1727
dir, relpath = bzrdir.BzrDir.open_containing(location)
1728
b = dir.open_branch()
1732
if revision is None:
1735
elif len(revision) == 1:
1736
rev1 = rev2 = revision[0].in_history(b)
1737
elif len(revision) == 2:
1738
if revision[1].get_branch() != revision[0].get_branch():
1739
# b is taken from revision[0].get_branch(), and
1740
# show_log will use its revision_history. Having
1741
# different branches will lead to weird behaviors.
1742
raise errors.BzrCommandError(
1743
"Log doesn't accept two revisions in different"
1745
rev1 = revision[0].in_history(b)
1746
rev2 = revision[1].in_history(b)
1748
raise errors.BzrCommandError(
1749
'bzr log --revision takes one or two values.')
1751
if log_format is None:
1752
log_format = log.log_formatter_registry.get_default(b)
1754
lf = log_format(show_ids=show_ids, to_file=self.outf,
1755
show_timezone=timezone)
1761
direction=direction,
1762
start_revision=rev1,
1770
def get_log_format(long=False, short=False, line=False, default='long'):
1771
log_format = default
1775
log_format = 'short'
1781
class cmd_touching_revisions(Command):
1782
"""Return revision-ids which affected a particular file.
1784
A more user-friendly interface is "bzr log FILE".
1788
takes_args = ["filename"]
1791
def run(self, filename):
1792
tree, relpath = WorkingTree.open_containing(filename)
1794
file_id = tree.path2id(relpath)
1795
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1796
self.outf.write("%6d %s\n" % (revno, what))
1799
class cmd_ls(Command):
1800
"""List files in a tree.
1803
_see_also = ['status', 'cat']
1804
takes_args = ['path?']
1805
# TODO: Take a revision or remote path and list that tree instead.
1809
Option('non-recursive',
1810
help='Don\'t recurse into subdirectories.'),
1812
help='Print paths relative to the root of the branch.'),
1813
Option('unknown', help='Print unknown files.'),
1814
Option('versioned', help='Print versioned files.'),
1815
Option('ignored', help='Print ignored files.'),
1817
help='Write an ascii NUL (\\0) separator '
1818
'between files rather than a newline.'),
1820
help='List entries of a particular kind: file, directory, symlink.',
1825
def run(self, revision=None, verbose=False,
1826
non_recursive=False, from_root=False,
1827
unknown=False, versioned=False, ignored=False,
1828
null=False, kind=None, show_ids=False, path=None):
1830
if kind and kind not in ('file', 'directory', 'symlink'):
1831
raise errors.BzrCommandError('invalid kind specified')
1833
if verbose and null:
1834
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1835
all = not (unknown or versioned or ignored)
1837
selection = {'I':ignored, '?':unknown, 'V':versioned}
1844
raise errors.BzrCommandError('cannot specify both --from-root'
1848
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1854
if revision is not None:
1855
tree = branch.repository.revision_tree(
1856
revision[0].in_history(branch).rev_id)
1858
tree = branch.basis_tree()
1862
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1863
if fp.startswith(relpath):
1864
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1865
if non_recursive and '/' in fp:
1867
if not all and not selection[fc]:
1869
if kind is not None and fkind != kind:
1872
kindch = entry.kind_character()
1873
outstring = '%-8s %s%s' % (fc, fp, kindch)
1874
if show_ids and fid is not None:
1875
outstring = "%-50s %s" % (outstring, fid)
1876
self.outf.write(outstring + '\n')
1878
self.outf.write(fp + '\0')
1881
self.outf.write(fid)
1882
self.outf.write('\0')
1890
self.outf.write('%-50s %s\n' % (fp, my_id))
1892
self.outf.write(fp + '\n')
1897
class cmd_unknowns(Command):
1898
"""List unknown files.
1906
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1907
self.outf.write(osutils.quotefn(f) + '\n')
1910
class cmd_ignore(Command):
1911
"""Ignore specified files or patterns.
1913
To remove patterns from the ignore list, edit the .bzrignore file.
1915
Trailing slashes on patterns are ignored.
1916
If the pattern contains a slash or is a regular expression, it is compared
1917
to the whole path from the branch root. Otherwise, it is compared to only
1918
the last component of the path. To match a file only in the root
1919
directory, prepend './'.
1921
Ignore patterns specifying absolute paths are not allowed.
1923
Ignore patterns may include globbing wildcards such as::
1925
? - Matches any single character except '/'
1926
* - Matches 0 or more characters except '/'
1927
/**/ - Matches 0 or more directories in a path
1928
[a-z] - Matches a single character from within a group of characters
1930
Ignore patterns may also be Python regular expressions.
1931
Regular expression ignore patterns are identified by a 'RE:' prefix
1932
followed by the regular expression. Regular expression ignore patterns
1933
may not include named or numbered groups.
1935
Note: ignore patterns containing shell wildcards must be quoted from
1939
Ignore the top level Makefile::
1941
bzr ignore ./Makefile
1943
Ignore class files in all directories::
1945
bzr ignore "*.class"
1947
Ignore .o files under the lib directory::
1949
bzr ignore "lib/**/*.o"
1951
Ignore .o files under the lib directory::
1953
bzr ignore "RE:lib/.*\.o"
1955
Ignore everything but the "debian" toplevel directory::
1957
bzr ignore "RE:(?!debian/).*"
1960
_see_also = ['status', 'ignored']
1961
takes_args = ['name_pattern*']
1963
Option('old-default-rules',
1964
help='Write out the ignore rules bzr < 0.9 always used.')
1967
def run(self, name_pattern_list=None, old_default_rules=None):
1968
from bzrlib.atomicfile import AtomicFile
1969
if old_default_rules is not None:
1970
# dump the rules and exit
1971
for pattern in ignores.OLD_DEFAULTS:
1974
if not name_pattern_list:
1975
raise errors.BzrCommandError("ignore requires at least one "
1976
"NAME_PATTERN or --old-default-rules")
1977
name_pattern_list = [globbing.normalize_pattern(p)
1978
for p in name_pattern_list]
1979
for name_pattern in name_pattern_list:
1980
if (name_pattern[0] == '/' or
1981
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1982
raise errors.BzrCommandError(
1983
"NAME_PATTERN should not be an absolute path")
1984
tree, relpath = WorkingTree.open_containing(u'.')
1985
ifn = tree.abspath('.bzrignore')
1986
if os.path.exists(ifn):
1989
igns = f.read().decode('utf-8')
1995
# TODO: If the file already uses crlf-style termination, maybe
1996
# we should use that for the newly added lines?
1998
if igns and igns[-1] != '\n':
2000
for name_pattern in name_pattern_list:
2001
igns += name_pattern + '\n'
2003
f = AtomicFile(ifn, 'wb')
2005
f.write(igns.encode('utf-8'))
2010
if not tree.path2id('.bzrignore'):
2011
tree.add(['.bzrignore'])
2013
ignored = globbing.Globster(name_pattern_list)
2016
for entry in tree.list_files():
2020
if ignored.match(filename):
2021
matches.append(filename.encode('utf-8'))
2023
if len(matches) > 0:
2024
print "Warning: the following files are version controlled and" \
2025
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2027
class cmd_ignored(Command):
2028
"""List ignored files and the patterns that matched them.
2031
encoding_type = 'replace'
2032
_see_also = ['ignore']
2036
tree = WorkingTree.open_containing(u'.')[0]
2039
for path, file_class, kind, file_id, entry in tree.list_files():
2040
if file_class != 'I':
2042
## XXX: Slightly inefficient since this was already calculated
2043
pat = tree.is_ignored(path)
2044
self.outf.write('%-50s %s\n' % (path, pat))
2049
class cmd_lookup_revision(Command):
2050
"""Lookup the revision-id from a revision-number
2053
bzr lookup-revision 33
2056
takes_args = ['revno']
2059
def run(self, revno):
2063
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2065
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2068
class cmd_export(Command):
2069
"""Export current or past revision to a destination directory or archive.
2071
If no revision is specified this exports the last committed revision.
2073
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2074
given, try to find the format with the extension. If no extension
2075
is found exports to a directory (equivalent to --format=dir).
2077
If root is supplied, it will be used as the root directory inside
2078
container formats (tar, zip, etc). If it is not supplied it will default
2079
to the exported filename. The root option has no effect for 'dir' format.
2081
If branch is omitted then the branch containing the current working
2082
directory will be used.
2084
Note: Export of tree with non-ASCII filenames to zip is not supported.
2086
================= =========================
2087
Supported formats Autodetected by extension
2088
================= =========================
2091
tbz2 .tar.bz2, .tbz2
2094
================= =========================
2096
takes_args = ['dest', 'branch?']
2099
help="Type of file to export to.",
2104
help="Name of the root directory inside the exported file."),
2106
def run(self, dest, branch=None, revision=None, format=None, root=None):
2107
from bzrlib.export import export
2110
tree = WorkingTree.open_containing(u'.')[0]
2113
b = Branch.open(branch)
2115
if revision is None:
2116
# should be tree.last_revision FIXME
2117
rev_id = b.last_revision()
2119
if len(revision) != 1:
2120
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2121
rev_id = revision[0].in_history(b).rev_id
2122
t = b.repository.revision_tree(rev_id)
2124
export(t, dest, format, root)
2125
except errors.NoSuchExportFormat, e:
2126
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2129
class cmd_cat(Command):
2130
"""Write the contents of a file as of a given revision to standard output.
2132
If no revision is nominated, the last revision is used.
2134
Note: Take care to redirect standard output when using this command on a
2140
Option('name-from-revision', help='The path name in the old tree.'),
2143
takes_args = ['filename']
2144
encoding_type = 'exact'
2147
def run(self, filename, revision=None, name_from_revision=False):
2148
if revision is not None and len(revision) != 1:
2149
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2150
" one revision specifier")
2151
tree, branch, relpath = \
2152
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2155
return self._run(tree, branch, relpath, filename, revision,
2160
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2162
tree = b.basis_tree()
2163
if revision is None:
2164
revision_id = b.last_revision()
2166
revision_id = revision[0].in_history(b).rev_id
2168
cur_file_id = tree.path2id(relpath)
2169
rev_tree = b.repository.revision_tree(revision_id)
2170
old_file_id = rev_tree.path2id(relpath)
2172
if name_from_revision:
2173
if old_file_id is None:
2174
raise errors.BzrCommandError("%r is not present in revision %s"
2175
% (filename, revision_id))
2177
rev_tree.print_file(old_file_id)
2178
elif cur_file_id is not None:
2179
rev_tree.print_file(cur_file_id)
2180
elif old_file_id is not None:
2181
rev_tree.print_file(old_file_id)
2183
raise errors.BzrCommandError("%r is not present in revision %s" %
2184
(filename, revision_id))
2187
class cmd_local_time_offset(Command):
2188
"""Show the offset in seconds from GMT to local time."""
2192
print osutils.local_time_offset()
2196
class cmd_commit(Command):
2197
"""Commit changes into a new revision.
2199
If no arguments are given, the entire tree is committed.
2201
If selected files are specified, only changes to those files are
2202
committed. If a directory is specified then the directory and everything
2203
within it is committed.
2205
If author of the change is not the same person as the committer, you can
2206
specify the author's name using the --author option. The name should be
2207
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2209
A selected-file commit may fail in some cases where the committed
2210
tree would be invalid. Consider::
2215
bzr commit foo -m "committing foo"
2216
bzr mv foo/bar foo/baz
2219
bzr commit foo/bar -m "committing bar but not baz"
2221
In the example above, the last commit will fail by design. This gives
2222
the user the opportunity to decide whether they want to commit the
2223
rename at the same time, separately first, or not at all. (As a general
2224
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2226
Note: A selected-file commit after a merge is not yet supported.
2228
# TODO: Run hooks on tree to-be-committed, and after commit.
2230
# TODO: Strict commit that fails if there are deleted files.
2231
# (what does "deleted files" mean ??)
2233
# TODO: Give better message for -s, --summary, used by tla people
2235
# XXX: verbose currently does nothing
2237
_see_also = ['bugs', 'uncommit']
2238
takes_args = ['selected*']
2240
Option('message', type=unicode,
2242
help="Description of the new revision."),
2245
help='Commit even if nothing has changed.'),
2246
Option('file', type=str,
2249
help='Take commit message from this file.'),
2251
help="Refuse to commit if there are unknown "
2252
"files in the working tree."),
2253
ListOption('fixes', type=str,
2254
help="Mark a bug as being fixed by this revision."),
2255
Option('author', type=unicode,
2256
help="Set the author's name, if it's different "
2257
"from the committer."),
2259
help="Perform a local commit in a bound "
2260
"branch. Local commits are not pushed to "
2261
"the master branch until a normal commit "
2265
help='When no message is supplied, show the diff along'
2266
' with the status summary in the message editor.'),
2268
aliases = ['ci', 'checkin']
2270
def _get_bug_fix_properties(self, fixes, branch):
2272
# Configure the properties for bug fixing attributes.
2273
for fixed_bug in fixes:
2274
tokens = fixed_bug.split(':')
2275
if len(tokens) != 2:
2276
raise errors.BzrCommandError(
2277
"Invalid bug %s. Must be in the form of 'tag:id'. "
2278
"Commit refused." % fixed_bug)
2279
tag, bug_id = tokens
2281
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2282
except errors.UnknownBugTrackerAbbreviation:
2283
raise errors.BzrCommandError(
2284
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2285
except errors.MalformedBugIdentifier:
2286
raise errors.BzrCommandError(
2287
"Invalid bug identifier for %s. Commit refused."
2289
properties.append('%s fixed' % bug_url)
2290
return '\n'.join(properties)
2292
def run(self, message=None, file=None, verbose=False, selected_list=None,
2293
unchanged=False, strict=False, local=False, fixes=None,
2294
author=None, show_diff=False):
2295
from bzrlib.errors import (
2300
from bzrlib.msgeditor import (
2301
edit_commit_message_encoded,
2302
make_commit_message_template_encoded
2305
# TODO: Need a blackbox test for invoking the external editor; may be
2306
# slightly problematic to run this cross-platform.
2308
# TODO: do more checks that the commit will succeed before
2309
# spending the user's valuable time typing a commit message.
2313
tree, selected_list = tree_files(selected_list)
2314
if selected_list == ['']:
2315
# workaround - commit of root of tree should be exactly the same
2316
# as just default commit in that tree, and succeed even though
2317
# selected-file merge commit is not done yet
2322
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2324
properties['bugs'] = bug_property
2326
if local and not tree.branch.get_bound_location():
2327
raise errors.LocalRequiresBoundBranch()
2329
def get_message(commit_obj):
2330
"""Callback to get commit message"""
2331
my_message = message
2332
if my_message is None and not file:
2333
t = make_commit_message_template_encoded(tree,
2334
selected_list, diff=show_diff,
2335
output_encoding=bzrlib.user_encoding)
2336
my_message = edit_commit_message_encoded(t)
2337
if my_message is None:
2338
raise errors.BzrCommandError("please specify a commit"
2339
" message with either --message or --file")
2340
elif my_message and file:
2341
raise errors.BzrCommandError(
2342
"please specify either --message or --file")
2344
my_message = codecs.open(file, 'rt',
2345
bzrlib.user_encoding).read()
2346
if my_message == "":
2347
raise errors.BzrCommandError("empty commit message specified")
2351
tree.commit(message_callback=get_message,
2352
specific_files=selected_list,
2353
allow_pointless=unchanged, strict=strict, local=local,
2354
reporter=None, verbose=verbose, revprops=properties,
2356
except PointlessCommit:
2357
# FIXME: This should really happen before the file is read in;
2358
# perhaps prepare the commit; get the message; then actually commit
2359
raise errors.BzrCommandError("no changes to commit."
2360
" use --unchanged to commit anyhow")
2361
except ConflictsInTree:
2362
raise errors.BzrCommandError('Conflicts detected in working '
2363
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2365
except StrictCommitFailed:
2366
raise errors.BzrCommandError("Commit refused because there are"
2367
" unknown files in the working tree.")
2368
except errors.BoundBranchOutOfDate, e:
2369
raise errors.BzrCommandError(str(e) + "\n"
2370
'To commit to master branch, run update and then commit.\n'
2371
'You can also pass --local to commit to continue working '
2375
class cmd_check(Command):
2376
"""Validate consistency of branch history.
2378
This command checks various invariants about the branch storage to
2379
detect data corruption or bzr bugs.
2383
revisions: This is just the number of revisions checked. It doesn't
2385
versionedfiles: This is just the number of versionedfiles checked. It
2386
doesn't indicate a problem.
2387
unreferenced ancestors: Texts that are ancestors of other texts, but
2388
are not properly referenced by the revision ancestry. This is a
2389
subtle problem that Bazaar can work around.
2390
unique file texts: This is the total number of unique file contents
2391
seen in the checked revisions. It does not indicate a problem.
2392
repeated file texts: This is the total number of repeated texts seen
2393
in the checked revisions. Texts can be repeated when their file
2394
entries are modified, but the file contents are not. It does not
2398
_see_also = ['reconcile']
2399
takes_args = ['branch?']
2400
takes_options = ['verbose']
2402
def run(self, branch=None, verbose=False):
2403
from bzrlib.check import check
2405
branch_obj = Branch.open_containing('.')[0]
2407
branch_obj = Branch.open(branch)
2408
check(branch_obj, verbose)
2409
# bit hacky, check the tree parent is accurate
2412
tree = WorkingTree.open_containing('.')[0]
2414
tree = WorkingTree.open(branch)
2415
except (errors.NoWorkingTree, errors.NotLocalUrl):
2418
# This is a primitive 'check' for tree state. Currently this is not
2419
# integrated into the main check logic as yet.
2422
tree_basis = tree.basis_tree()
2423
tree_basis.lock_read()
2425
repo_basis = tree.branch.repository.revision_tree(
2426
tree.last_revision())
2427
if len(list(repo_basis.iter_changes(tree_basis))):
2428
raise errors.BzrCheckError(
2429
"Mismatched basis inventory content.")
2437
class cmd_upgrade(Command):
2438
"""Upgrade branch storage to current format.
2440
The check command or bzr developers may sometimes advise you to run
2441
this command. When the default format has changed you may also be warned
2442
during other operations to upgrade.
2445
_see_also = ['check']
2446
takes_args = ['url?']
2448
RegistryOption('format',
2449
help='Upgrade to a specific format. See "bzr help'
2450
' formats" for details.',
2451
registry=bzrdir.format_registry,
2452
converter=bzrdir.format_registry.make_bzrdir,
2453
value_switches=True, title='Branch format'),
2456
def run(self, url='.', format=None):
2457
from bzrlib.upgrade import upgrade
2459
format = bzrdir.format_registry.make_bzrdir('default')
2460
upgrade(url, format)
2463
class cmd_whoami(Command):
2464
"""Show or set bzr user id.
2467
Show the email of the current user::
2471
Set the current user::
2473
bzr whoami "Frank Chu <fchu@example.com>"
2475
takes_options = [ Option('email',
2476
help='Display email address only.'),
2478
help='Set identity for the current branch instead of '
2481
takes_args = ['name?']
2482
encoding_type = 'replace'
2485
def run(self, email=False, branch=False, name=None):
2487
# use branch if we're inside one; otherwise global config
2489
c = Branch.open_containing('.')[0].get_config()
2490
except errors.NotBranchError:
2491
c = config.GlobalConfig()
2493
self.outf.write(c.user_email() + '\n')
2495
self.outf.write(c.username() + '\n')
2498
# display a warning if an email address isn't included in the given name.
2500
config.extract_email_address(name)
2501
except errors.NoEmailInUsername, e:
2502
warning('"%s" does not seem to contain an email address. '
2503
'This is allowed, but not recommended.', name)
2505
# use global config unless --branch given
2507
c = Branch.open_containing('.')[0].get_config()
2509
c = config.GlobalConfig()
2510
c.set_user_option('email', name)
2513
class cmd_nick(Command):
2514
"""Print or set the branch nickname.
2516
If unset, the tree root directory name is used as the nickname
2517
To print the current nickname, execute with no argument.
2520
_see_also = ['info']
2521
takes_args = ['nickname?']
2522
def run(self, nickname=None):
2523
branch = Branch.open_containing(u'.')[0]
2524
if nickname is None:
2525
self.printme(branch)
2527
branch.nick = nickname
2530
def printme(self, branch):
2534
class cmd_selftest(Command):
2535
"""Run internal test suite.
2537
If arguments are given, they are regular expressions that say which tests
2538
should run. Tests matching any expression are run, and other tests are
2541
Alternatively if --first is given, matching tests are run first and then
2542
all other tests are run. This is useful if you have been working in a
2543
particular area, but want to make sure nothing else was broken.
2545
If --exclude is given, tests that match that regular expression are
2546
excluded, regardless of whether they match --first or not.
2548
To help catch accidential dependencies between tests, the --randomize
2549
option is useful. In most cases, the argument used is the word 'now'.
2550
Note that the seed used for the random number generator is displayed
2551
when this option is used. The seed can be explicitly passed as the
2552
argument to this option if required. This enables reproduction of the
2553
actual ordering used if and when an order sensitive problem is encountered.
2555
If --list-only is given, the tests that would be run are listed. This is
2556
useful when combined with --first, --exclude and/or --randomize to
2557
understand their impact. The test harness reports "Listed nn tests in ..."
2558
instead of "Ran nn tests in ..." when list mode is enabled.
2560
If the global option '--no-plugins' is given, plugins are not loaded
2561
before running the selftests. This has two effects: features provided or
2562
modified by plugins will not be tested, and tests provided by plugins will
2565
Tests that need working space on disk use a common temporary directory,
2566
typically inside $TMPDIR or /tmp.
2569
Run only tests relating to 'ignore'::
2573
Disable plugins and list tests as they're run::
2575
bzr --no-plugins selftest -v
2577
# NB: this is used from the class without creating an instance, which is
2578
# why it does not have a self parameter.
2579
def get_transport_type(typestring):
2580
"""Parse and return a transport specifier."""
2581
if typestring == "sftp":
2582
from bzrlib.transport.sftp import SFTPAbsoluteServer
2583
return SFTPAbsoluteServer
2584
if typestring == "memory":
2585
from bzrlib.transport.memory import MemoryServer
2587
if typestring == "fakenfs":
2588
from bzrlib.transport.fakenfs import FakeNFSServer
2589
return FakeNFSServer
2590
msg = "No known transport type %s. Supported types are: sftp\n" %\
2592
raise errors.BzrCommandError(msg)
2595
takes_args = ['testspecs*']
2596
takes_options = ['verbose',
2598
help='Stop when one test fails.',
2602
help='Use a different transport by default '
2603
'throughout the test suite.',
2604
type=get_transport_type),
2606
help='Run the benchmarks rather than selftests.'),
2607
Option('lsprof-timed',
2608
help='Generate lsprof output for benchmarked'
2609
' sections of code.'),
2610
Option('cache-dir', type=str,
2611
help='Cache intermediate benchmark output in this '
2614
help='Run all tests, but run specified tests first.',
2618
help='List the tests instead of running them.'),
2619
Option('randomize', type=str, argname="SEED",
2620
help='Randomize the order of tests using the given'
2621
' seed or "now" for the current time.'),
2622
Option('exclude', type=str, argname="PATTERN",
2624
help='Exclude tests that match this regular'
2626
Option('strict', help='Fail on missing dependencies or '
2628
Option('load-list', type=str, argname='TESTLISTFILE',
2629
help='Load a test id list from a text file.'),
2631
encoding_type = 'replace'
2633
def run(self, testspecs_list=None, verbose=False, one=False,
2634
transport=None, benchmark=None,
2635
lsprof_timed=None, cache_dir=None,
2636
first=False, list_only=False,
2637
randomize=None, exclude=None, strict=False,
2640
from bzrlib.tests import selftest
2641
import bzrlib.benchmarks as benchmarks
2642
from bzrlib.benchmarks import tree_creator
2644
if cache_dir is not None:
2645
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2647
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2648
print ' %s (%s python%s)' % (
2650
bzrlib.version_string,
2651
'.'.join(map(str, sys.version_info)),
2654
if testspecs_list is not None:
2655
pattern = '|'.join(testspecs_list)
2659
test_suite_factory = benchmarks.test_suite
2660
# Unless user explicitly asks for quiet, be verbose in benchmarks
2661
verbose = not is_quiet()
2662
# TODO: should possibly lock the history file...
2663
benchfile = open(".perf_history", "at", buffering=1)
2665
test_suite_factory = None
2668
result = selftest(verbose=verbose,
2670
stop_on_failure=one,
2671
transport=transport,
2672
test_suite_factory=test_suite_factory,
2673
lsprof_timed=lsprof_timed,
2674
bench_history=benchfile,
2675
matching_tests_first=first,
2676
list_only=list_only,
2677
random_seed=randomize,
2678
exclude_pattern=exclude,
2680
load_list=load_list,
2683
if benchfile is not None:
2686
note('tests passed')
2688
note('tests failed')
2689
return int(not result)
2692
class cmd_version(Command):
2693
"""Show version of bzr."""
2695
encoding_type = 'replace'
2699
from bzrlib.version import show_version
2700
show_version(to_file=self.outf)
2703
class cmd_rocks(Command):
2704
"""Statement of optimism."""
2710
print "It sure does!"
2713
class cmd_find_merge_base(Command):
2714
"""Find and print a base revision for merging two branches."""
2715
# TODO: Options to specify revisions on either side, as if
2716
# merging only part of the history.
2717
takes_args = ['branch', 'other']
2721
def run(self, branch, other):
2722
from bzrlib.revision import ensure_null
2724
branch1 = Branch.open_containing(branch)[0]
2725
branch2 = Branch.open_containing(other)[0]
2730
last1 = ensure_null(branch1.last_revision())
2731
last2 = ensure_null(branch2.last_revision())
2733
graph = branch1.repository.get_graph(branch2.repository)
2734
base_rev_id = graph.find_unique_lca(last1, last2)
2736
print 'merge base is revision %s' % base_rev_id
2743
class cmd_merge(Command):
2744
"""Perform a three-way merge.
2746
The branch is the branch you will merge from. By default, it will merge
2747
the latest revision. If you specify a revision, that revision will be
2748
merged. If you specify two revisions, the first will be used as a BASE,
2749
and the second one as OTHER. Revision numbers are always relative to the
2752
By default, bzr will try to merge in all new work from the other
2753
branch, automatically determining an appropriate base. If this
2754
fails, you may need to give an explicit base.
2756
Merge will do its best to combine the changes in two branches, but there
2757
are some kinds of problems only a human can fix. When it encounters those,
2758
it will mark a conflict. A conflict means that you need to fix something,
2759
before you should commit.
2761
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2763
If there is no default branch set, the first merge will set it. After
2764
that, you can omit the branch to use the default. To change the
2765
default, use --remember. The value will only be saved if the remote
2766
location can be accessed.
2768
The results of the merge are placed into the destination working
2769
directory, where they can be reviewed (with bzr diff), tested, and then
2770
committed to record the result of the merge.
2772
merge refuses to run if there are any uncommitted changes, unless
2776
To merge the latest revision from bzr.dev::
2778
bzr merge ../bzr.dev
2780
To merge changes up to and including revision 82 from bzr.dev::
2782
bzr merge -r 82 ../bzr.dev
2784
To merge the changes introduced by 82, without previous changes::
2786
bzr merge -r 81..82 ../bzr.dev
2789
encoding_type = 'exact'
2790
_see_also = ['update', 'remerge', 'status-flags']
2791
takes_args = ['branch?']
2796
help='Merge even if the destination tree has uncommitted changes.'),
2800
Option('show-base', help="Show base revision text in "
2802
Option('uncommitted', help='Apply uncommitted changes'
2803
' from a working copy, instead of branch changes.'),
2804
Option('pull', help='If the destination is already'
2805
' completely merged into the source, pull from the'
2806
' source rather than merging. When this happens,'
2807
' you do not need to commit the result.'),
2809
help='Branch to merge into, '
2810
'rather than the one containing the working directory.',
2814
Option('preview', help='Instead of merging, show a diff of the merge.')
2817
def run(self, branch=None, revision=None, force=False, merge_type=None,
2818
show_base=False, reprocess=False, remember=False,
2819
uncommitted=False, pull=False,
2823
# This is actually a branch (or merge-directive) *location*.
2827
if merge_type is None:
2828
merge_type = _mod_merge.Merge3Merger
2830
if directory is None: directory = u'.'
2831
possible_transports = []
2833
allow_pending = True
2834
verified = 'inapplicable'
2835
tree = WorkingTree.open_containing(directory)[0]
2836
change_reporter = delta._ChangeReporter(
2837
unversioned_filter=tree.is_ignored)
2840
pb = ui.ui_factory.nested_progress_bar()
2841
cleanups.append(pb.finished)
2843
cleanups.append(tree.unlock)
2844
if location is not None:
2845
mergeable, other_transport = _get_mergeable_helper(location)
2848
raise errors.BzrCommandError('Cannot use --uncommitted'
2849
' with bundles or merge directives.')
2851
if revision is not None:
2852
raise errors.BzrCommandError(
2853
'Cannot use -r with merge directives or bundles')
2854
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2856
possible_transports.append(other_transport)
2858
if merger is None and uncommitted:
2859
if revision is not None and len(revision) > 0:
2860
raise errors.BzrCommandError('Cannot use --uncommitted and'
2861
' --revision at the same time.')
2862
location = self._select_branch_location(tree, location)[0]
2863
other_tree, other_path = WorkingTree.open_containing(location)
2864
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2866
allow_pending = False
2867
if other_path != '':
2868
merger.interesting_files = [other_path]
2871
merger, allow_pending = self._get_merger_from_branch(tree,
2872
location, revision, remember, possible_transports, pb)
2874
merger.merge_type = merge_type
2875
merger.reprocess = reprocess
2876
merger.show_base = show_base
2877
self.sanity_check_merger(merger)
2878
if (merger.base_rev_id == merger.other_rev_id and
2879
merger.other_rev_id != None):
2880
note('Nothing to do.')
2883
if merger.interesting_files is not None:
2884
raise errors.BzrCommandError('Cannot pull individual files')
2885
if (merger.base_rev_id == tree.last_revision()):
2886
result = tree.pull(merger.other_branch, False,
2887
merger.other_rev_id)
2888
result.report(self.outf)
2890
merger.check_basis(not force)
2892
return self._do_preview(merger)
2894
return self._do_merge(merger, change_reporter, allow_pending,
2897
for cleanup in reversed(cleanups):
2900
def _do_preview(self, merger):
2901
from bzrlib.diff import show_diff_trees
2902
tree_merger = merger.make_merger()
2903
tt = tree_merger.make_preview_transform()
2905
result_tree = tt.get_preview_tree()
2906
show_diff_trees(merger.this_tree, result_tree, self.outf,
2907
old_label='', new_label='')
2911
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2912
merger.change_reporter = change_reporter
2913
conflict_count = merger.do_merge()
2915
merger.set_pending()
2916
if verified == 'failed':
2917
warning('Preview patch does not match changes')
2918
if conflict_count != 0:
2923
def sanity_check_merger(self, merger):
2924
if (merger.show_base and
2925
not merger.merge_type is _mod_merge.Merge3Merger):
2926
raise errors.BzrCommandError("Show-base is not supported for this"
2927
" merge type. %s" % merger.merge_type)
2928
if merger.reprocess and not merger.merge_type.supports_reprocess:
2929
raise errors.BzrCommandError("Conflict reduction is not supported"
2930
" for merge type %s." %
2932
if merger.reprocess and merger.show_base:
2933
raise errors.BzrCommandError("Cannot do conflict reduction and"
2936
def _get_merger_from_branch(self, tree, location, revision, remember,
2937
possible_transports, pb):
2938
"""Produce a merger from a location, assuming it refers to a branch."""
2939
from bzrlib.tag import _merge_tags_if_possible
2940
assert revision is None or len(revision) < 3
2941
# find the branch locations
2942
other_loc, user_location = self._select_branch_location(tree, location,
2944
if revision is not None and len(revision) == 2:
2945
base_loc, _unused = self._select_branch_location(tree,
2946
location, revision, 0)
2948
base_loc = other_loc
2950
other_branch, other_path = Branch.open_containing(other_loc,
2951
possible_transports)
2952
if base_loc == other_loc:
2953
base_branch = other_branch
2955
base_branch, base_path = Branch.open_containing(base_loc,
2956
possible_transports)
2957
# Find the revision ids
2958
if revision is None or len(revision) < 1 or revision[-1] is None:
2959
other_revision_id = _mod_revision.ensure_null(
2960
other_branch.last_revision())
2962
other_revision_id = \
2963
_mod_revision.ensure_null(
2964
revision[-1].in_history(other_branch).rev_id)
2965
if (revision is not None and len(revision) == 2
2966
and revision[0] is not None):
2967
base_revision_id = \
2968
_mod_revision.ensure_null(
2969
revision[0].in_history(base_branch).rev_id)
2971
base_revision_id = None
2972
# Remember where we merge from
2973
if ((remember or tree.branch.get_submit_branch() is None) and
2974
user_location is not None):
2975
tree.branch.set_submit_branch(other_branch.base)
2976
_merge_tags_if_possible(other_branch, tree.branch)
2977
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2978
other_revision_id, base_revision_id, other_branch, base_branch)
2979
if other_path != '':
2980
allow_pending = False
2981
merger.interesting_files = [other_path]
2983
allow_pending = True
2984
return merger, allow_pending
2986
def _select_branch_location(self, tree, user_location, revision=None,
2988
"""Select a branch location, according to possible inputs.
2990
If provided, branches from ``revision`` are preferred. (Both
2991
``revision`` and ``index`` must be supplied.)
2993
Otherwise, the ``location`` parameter is used. If it is None, then the
2994
``submit`` or ``parent`` location is used, and a note is printed.
2996
:param tree: The working tree to select a branch for merging into
2997
:param location: The location entered by the user
2998
:param revision: The revision parameter to the command
2999
:param index: The index to use for the revision parameter. Negative
3000
indices are permitted.
3001
:return: (selected_location, user_location). The default location
3002
will be the user-entered location.
3004
if (revision is not None and index is not None
3005
and revision[index] is not None):
3006
branch = revision[index].get_branch()
3007
if branch is not None:
3008
return branch, branch
3009
if user_location is None:
3010
location = self._get_remembered(tree, 'Merging from')
3012
location = user_location
3013
return location, user_location
3015
def _get_remembered(self, tree, verb_string):
3016
"""Use tree.branch's parent if none was supplied.
3018
Report if the remembered location was used.
3020
stored_location = tree.branch.get_submit_branch()
3021
if stored_location is None:
3022
stored_location = tree.branch.get_parent()
3023
mutter("%s", stored_location)
3024
if stored_location is None:
3025
raise errors.BzrCommandError("No location specified or remembered")
3026
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3027
note(u"%s remembered location %s", verb_string, display_url)
3028
return stored_location
3031
class cmd_remerge(Command):
3034
Use this if you want to try a different merge technique while resolving
3035
conflicts. Some merge techniques are better than others, and remerge
3036
lets you try different ones on different files.
3038
The options for remerge have the same meaning and defaults as the ones for
3039
merge. The difference is that remerge can (only) be run when there is a
3040
pending merge, and it lets you specify particular files.
3043
Re-do the merge of all conflicted files, and show the base text in
3044
conflict regions, in addition to the usual THIS and OTHER texts::
3046
bzr remerge --show-base
3048
Re-do the merge of "foobar", using the weave merge algorithm, with
3049
additional processing to reduce the size of conflict regions::
3051
bzr remerge --merge-type weave --reprocess foobar
3053
takes_args = ['file*']
3058
help="Show base revision text in conflicts."),
3061
def run(self, file_list=None, merge_type=None, show_base=False,
3063
if merge_type is None:
3064
merge_type = _mod_merge.Merge3Merger
3065
tree, file_list = tree_files(file_list)
3068
parents = tree.get_parent_ids()
3069
if len(parents) != 2:
3070
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3071
" merges. Not cherrypicking or"
3073
repository = tree.branch.repository
3074
interesting_ids = None
3076
conflicts = tree.conflicts()
3077
if file_list is not None:
3078
interesting_ids = set()
3079
for filename in file_list:
3080
file_id = tree.path2id(filename)
3082
raise errors.NotVersionedError(filename)
3083
interesting_ids.add(file_id)
3084
if tree.kind(file_id) != "directory":
3087
for name, ie in tree.inventory.iter_entries(file_id):
3088
interesting_ids.add(ie.file_id)
3089
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3091
# Remerge only supports resolving contents conflicts
3092
allowed_conflicts = ('text conflict', 'contents conflict')
3093
restore_files = [c.path for c in conflicts
3094
if c.typestring in allowed_conflicts]
3095
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3096
tree.set_conflicts(ConflictList(new_conflicts))
3097
if file_list is not None:
3098
restore_files = file_list
3099
for filename in restore_files:
3101
restore(tree.abspath(filename))
3102
except errors.NotConflicted:
3104
# Disable pending merges, because the file texts we are remerging
3105
# have not had those merges performed. If we use the wrong parents
3106
# list, we imply that the working tree text has seen and rejected
3107
# all the changes from the other tree, when in fact those changes
3108
# have not yet been seen.
3109
pb = ui.ui_factory.nested_progress_bar()
3110
tree.set_parent_ids(parents[:1])
3112
merger = _mod_merge.Merger.from_revision_ids(pb,
3114
merger.interesting_ids = interesting_ids
3115
merger.merge_type = merge_type
3116
merger.show_base = show_base
3117
merger.reprocess = reprocess
3118
conflicts = merger.do_merge()
3120
tree.set_parent_ids(parents)
3130
class cmd_revert(Command):
3131
"""Revert files to a previous revision.
3133
Giving a list of files will revert only those files. Otherwise, all files
3134
will be reverted. If the revision is not specified with '--revision', the
3135
last committed revision is used.
3137
To remove only some changes, without reverting to a prior version, use
3138
merge instead. For example, "merge . --revision -2..-3" will remove the
3139
changes introduced by -2, without affecting the changes introduced by -1.
3140
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3142
By default, any files that have been manually changed will be backed up
3143
first. (Files changed only by merge are not backed up.) Backup files have
3144
'.~#~' appended to their name, where # is a number.
3146
When you provide files, you can use their current pathname or the pathname
3147
from the target revision. So you can use revert to "undelete" a file by
3148
name. If you name a directory, all the contents of that directory will be
3151
Any files that have been newly added since that revision will be deleted,
3152
with a backup kept if appropriate. Directories containing unknown files
3153
will not be deleted.
3155
The working tree contains a list of pending merged revisions, which will
3156
be included as parents in the next commit. Normally, revert clears that
3157
list as well as reverting the files. If any files are specified, revert
3158
leaves the pending merge list alone and reverts only the files. Use "bzr
3159
revert ." in the tree root to revert all files but keep the merge record,
3160
and "bzr revert --forget-merges" to clear the pending merge list without
3161
reverting any files.
3164
_see_also = ['cat', 'export']
3167
Option('no-backup', "Do not save backups of reverted files."),
3168
Option('forget-merges',
3169
'Remove pending merge marker, without changing any files.'),
3171
takes_args = ['file*']
3173
def run(self, revision=None, no_backup=False, file_list=None,
3174
forget_merges=None):
3175
tree, file_list = tree_files(file_list)
3177
tree.set_parent_ids(tree.get_parent_ids()[:1])
3179
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3182
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3183
if revision is None:
3184
rev_id = tree.last_revision()
3185
elif len(revision) != 1:
3186
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3188
rev_id = revision[0].in_history(tree.branch).rev_id
3189
pb = ui.ui_factory.nested_progress_bar()
3191
tree.revert(file_list,
3192
tree.branch.repository.revision_tree(rev_id),
3193
not no_backup, pb, report_changes=True)
3198
class cmd_assert_fail(Command):
3199
"""Test reporting of assertion failures"""
3200
# intended just for use in testing
3205
raise AssertionError("always fails")
3208
class cmd_help(Command):
3209
"""Show help on a command or other topic.
3212
_see_also = ['topics']
3214
Option('long', 'Show help on all commands.'),
3216
takes_args = ['topic?']
3217
aliases = ['?', '--help', '-?', '-h']
3220
def run(self, topic=None, long=False):
3222
if topic is None and long:
3224
bzrlib.help.help(topic)
3227
class cmd_shell_complete(Command):
3228
"""Show appropriate completions for context.
3230
For a list of all available commands, say 'bzr shell-complete'.
3232
takes_args = ['context?']
3237
def run(self, context=None):
3238
import shellcomplete
3239
shellcomplete.shellcomplete(context)
3242
class cmd_fetch(Command):
3243
"""Copy in history from another branch but don't merge it.
3245
This is an internal method used for pull and merge.
3248
takes_args = ['from_branch', 'to_branch']
3249
def run(self, from_branch, to_branch):
3250
from bzrlib.fetch import Fetcher
3251
from_b = Branch.open(from_branch)
3252
to_b = Branch.open(to_branch)
3253
Fetcher(to_b, from_b)
3256
class cmd_missing(Command):
3257
"""Show unmerged/unpulled revisions between two branches.
3259
OTHER_BRANCH may be local or remote.
3262
_see_also = ['merge', 'pull']
3263
takes_args = ['other_branch?']
3265
Option('reverse', 'Reverse the order of revisions.'),
3267
'Display changes in the local branch only.'),
3268
Option('this' , 'Same as --mine-only.'),
3269
Option('theirs-only',
3270
'Display changes in the remote branch only.'),
3271
Option('other', 'Same as --theirs-only.'),
3276
encoding_type = 'replace'
3279
def run(self, other_branch=None, reverse=False, mine_only=False,
3280
theirs_only=False, log_format=None, long=False, short=False, line=False,
3281
show_ids=False, verbose=False, this=False, other=False):
3282
from bzrlib.missing import find_unmerged, iter_log_revisions
3289
local_branch = Branch.open_containing(u".")[0]
3290
parent = local_branch.get_parent()
3291
if other_branch is None:
3292
other_branch = parent
3293
if other_branch is None:
3294
raise errors.BzrCommandError("No peer location known"
3296
display_url = urlutils.unescape_for_display(parent,
3298
self.outf.write("Using last location: " + display_url + "\n")
3300
remote_branch = Branch.open(other_branch)
3301
if remote_branch.base == local_branch.base:
3302
remote_branch = local_branch
3303
local_branch.lock_read()
3305
remote_branch.lock_read()
3307
local_extra, remote_extra = find_unmerged(local_branch,
3309
if log_format is None:
3310
registry = log.log_formatter_registry
3311
log_format = registry.get_default(local_branch)
3312
lf = log_format(to_file=self.outf,
3314
show_timezone='original')
3315
if reverse is False:
3316
local_extra.reverse()
3317
remote_extra.reverse()
3318
if local_extra and not theirs_only:
3319
self.outf.write("You have %d extra revision(s):\n" %
3321
for revision in iter_log_revisions(local_extra,
3322
local_branch.repository,
3324
lf.log_revision(revision)
3325
printed_local = True
3327
printed_local = False
3328
if remote_extra and not mine_only:
3329
if printed_local is True:
3330
self.outf.write("\n\n\n")
3331
self.outf.write("You are missing %d revision(s):\n" %
3333
for revision in iter_log_revisions(remote_extra,
3334
remote_branch.repository,
3336
lf.log_revision(revision)
3337
if not remote_extra and not local_extra:
3339
self.outf.write("Branches are up to date.\n")
3343
remote_branch.unlock()
3345
local_branch.unlock()
3346
if not status_code and parent is None and other_branch is not None:
3347
local_branch.lock_write()
3349
# handle race conditions - a parent might be set while we run.
3350
if local_branch.get_parent() is None:
3351
local_branch.set_parent(remote_branch.base)
3353
local_branch.unlock()
3357
class cmd_pack(Command):
3358
"""Compress the data within a repository."""
3360
_see_also = ['repositories']
3361
takes_args = ['branch_or_repo?']
3363
def run(self, branch_or_repo='.'):
3364
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3366
branch = dir.open_branch()
3367
repository = branch.repository
3368
except errors.NotBranchError:
3369
repository = dir.open_repository()
3373
class cmd_plugins(Command):
3374
"""List the installed plugins.
3376
This command displays the list of installed plugins including
3377
version of plugin and a short description of each.
3379
--verbose shows the path where each plugin is located.
3381
A plugin is an external component for Bazaar that extends the
3382
revision control system, by adding or replacing code in Bazaar.
3383
Plugins can do a variety of things, including overriding commands,
3384
adding new commands, providing additional network transports and
3385
customizing log output.
3387
See the Bazaar web site, http://bazaar-vcs.org, for further
3388
information on plugins including where to find them and how to
3389
install them. Instructions are also provided there on how to
3390
write new plugins using the Python programming language.
3392
takes_options = ['verbose']
3395
def run(self, verbose=False):
3396
import bzrlib.plugin
3397
from inspect import getdoc
3399
for name, plugin in bzrlib.plugin.plugins().items():
3400
version = plugin.__version__
3401
if version == 'unknown':
3403
name_ver = '%s %s' % (name, version)
3404
d = getdoc(plugin.module)
3406
doc = d.split('\n')[0]
3408
doc = '(no description)'
3409
result.append((name_ver, doc, plugin.path()))
3410
for name_ver, doc, path in sorted(result):
3418
class cmd_testament(Command):
3419
"""Show testament (signing-form) of a revision."""
3422
Option('long', help='Produce long-format testament.'),
3424
help='Produce a strict-format testament.')]
3425
takes_args = ['branch?']
3427
def run(self, branch=u'.', revision=None, long=False, strict=False):
3428
from bzrlib.testament import Testament, StrictTestament
3430
testament_class = StrictTestament
3432
testament_class = Testament
3433
b = WorkingTree.open_containing(branch)[0].branch
3436
if revision is None:
3437
rev_id = b.last_revision()
3439
rev_id = revision[0].in_history(b).rev_id
3440
t = testament_class.from_revision(b.repository, rev_id)
3442
sys.stdout.writelines(t.as_text_lines())
3444
sys.stdout.write(t.as_short_text())
3449
class cmd_annotate(Command):
3450
"""Show the origin of each line in a file.
3452
This prints out the given file with an annotation on the left side
3453
indicating which revision, author and date introduced the change.
3455
If the origin is the same for a run of consecutive lines, it is
3456
shown only at the top, unless the --all option is given.
3458
# TODO: annotate directories; showing when each file was last changed
3459
# TODO: if the working copy is modified, show annotations on that
3460
# with new uncommitted lines marked
3461
aliases = ['ann', 'blame', 'praise']
3462
takes_args = ['filename']
3463
takes_options = [Option('all', help='Show annotations on all lines.'),
3464
Option('long', help='Show commit date in annotations.'),
3468
encoding_type = 'exact'
3471
def run(self, filename, all=False, long=False, revision=None,
3473
from bzrlib.annotate import annotate_file
3474
wt, branch, relpath = \
3475
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3481
if revision is None:
3482
revision_id = branch.last_revision()
3483
elif len(revision) != 1:
3484
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3486
revision_id = revision[0].in_history(branch).rev_id
3487
tree = branch.repository.revision_tree(revision_id)
3489
file_id = wt.path2id(relpath)
3491
file_id = tree.path2id(relpath)
3493
raise errors.NotVersionedError(filename)
3494
file_version = tree.inventory[file_id].revision
3495
annotate_file(branch, file_version, file_id, long, all, self.outf,
3504
class cmd_re_sign(Command):
3505
"""Create a digital signature for an existing revision."""
3506
# TODO be able to replace existing ones.
3508
hidden = True # is this right ?
3509
takes_args = ['revision_id*']
3510
takes_options = ['revision']
3512
def run(self, revision_id_list=None, revision=None):
3513
if revision_id_list is not None and revision is not None:
3514
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3515
if revision_id_list is None and revision is None:
3516
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3517
b = WorkingTree.open_containing(u'.')[0].branch
3520
return self._run(b, revision_id_list, revision)
3524
def _run(self, b, revision_id_list, revision):
3525
import bzrlib.gpg as gpg
3526
gpg_strategy = gpg.GPGStrategy(b.get_config())
3527
if revision_id_list is not None:
3528
b.repository.start_write_group()
3530
for revision_id in revision_id_list:
3531
b.repository.sign_revision(revision_id, gpg_strategy)
3533
b.repository.abort_write_group()
3536
b.repository.commit_write_group()
3537
elif revision is not None:
3538
if len(revision) == 1:
3539
revno, rev_id = revision[0].in_history(b)
3540
b.repository.start_write_group()
3542
b.repository.sign_revision(rev_id, gpg_strategy)
3544
b.repository.abort_write_group()
3547
b.repository.commit_write_group()
3548
elif len(revision) == 2:
3549
# are they both on rh- if so we can walk between them
3550
# might be nice to have a range helper for arbitrary
3551
# revision paths. hmm.
3552
from_revno, from_revid = revision[0].in_history(b)
3553
to_revno, to_revid = revision[1].in_history(b)
3554
if to_revid is None:
3555
to_revno = b.revno()
3556
if from_revno is None or to_revno is None:
3557
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3558
b.repository.start_write_group()
3560
for revno in range(from_revno, to_revno + 1):
3561
b.repository.sign_revision(b.get_rev_id(revno),
3564
b.repository.abort_write_group()
3567
b.repository.commit_write_group()
3569
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3572
class cmd_bind(Command):
3573
"""Convert the current branch into a checkout of the supplied branch.
3575
Once converted into a checkout, commits must succeed on the master branch
3576
before they will be applied to the local branch.
3579
_see_also = ['checkouts', 'unbind']
3580
takes_args = ['location?']
3583
def run(self, location=None):
3584
b, relpath = Branch.open_containing(u'.')
3585
if location is None:
3587
location = b.get_old_bound_location()
3588
except errors.UpgradeRequired:
3589
raise errors.BzrCommandError('No location supplied. '
3590
'This format does not remember old locations.')
3592
if location is None:
3593
raise errors.BzrCommandError('No location supplied and no '
3594
'previous location known')
3595
b_other = Branch.open(location)
3598
except errors.DivergedBranches:
3599
raise errors.BzrCommandError('These branches have diverged.'
3600
' Try merging, and then bind again.')
3603
class cmd_unbind(Command):
3604
"""Convert the current checkout into a regular branch.
3606
After unbinding, the local branch is considered independent and subsequent
3607
commits will be local only.
3610
_see_also = ['checkouts', 'bind']
3615
b, relpath = Branch.open_containing(u'.')
3617
raise errors.BzrCommandError('Local branch is not bound')
3620
class cmd_uncommit(Command):
3621
"""Remove the last committed revision.
3623
--verbose will print out what is being removed.
3624
--dry-run will go through all the motions, but not actually
3627
If --revision is specified, uncommit revisions to leave the branch at the
3628
specified revision. For example, "bzr uncommit -r 15" will leave the
3629
branch at revision 15.
3631
In the future, uncommit will create a revision bundle, which can then
3635
# TODO: jam 20060108 Add an option to allow uncommit to remove
3636
# unreferenced information in 'branch-as-repository' branches.
3637
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3638
# information in shared branches as well.
3639
_see_also = ['commit']
3640
takes_options = ['verbose', 'revision',
3641
Option('dry-run', help='Don\'t actually make changes.'),
3642
Option('force', help='Say yes to all questions.')]
3643
takes_args = ['location?']
3645
encoding_type = 'replace'
3647
def run(self, location=None,
3648
dry_run=False, verbose=False,
3649
revision=None, force=False):
3650
if location is None:
3652
control, relpath = bzrdir.BzrDir.open_containing(location)
3654
tree = control.open_workingtree()
3656
except (errors.NoWorkingTree, errors.NotLocalUrl):
3658
b = control.open_branch()
3660
if tree is not None:
3665
return self._run(b, tree, dry_run, verbose, revision, force)
3667
if tree is not None:
3672
def _run(self, b, tree, dry_run, verbose, revision, force):
3673
from bzrlib.log import log_formatter, show_log
3674
from bzrlib.uncommit import uncommit
3676
last_revno, last_rev_id = b.last_revision_info()
3679
if revision is None:
3681
rev_id = last_rev_id
3683
# 'bzr uncommit -r 10' actually means uncommit
3684
# so that the final tree is at revno 10.
3685
# but bzrlib.uncommit.uncommit() actually uncommits
3686
# the revisions that are supplied.
3687
# So we need to offset it by one
3688
revno = revision[0].in_history(b).revno + 1
3689
if revno <= last_revno:
3690
rev_id = b.get_rev_id(revno)
3692
if rev_id is None or _mod_revision.is_null(rev_id):
3693
self.outf.write('No revisions to uncommit.\n')
3696
lf = log_formatter('short',
3698
show_timezone='original')
3703
direction='forward',
3704
start_revision=revno,
3705
end_revision=last_revno)
3708
print 'Dry-run, pretending to remove the above revisions.'
3710
val = raw_input('Press <enter> to continue')
3712
print 'The above revision(s) will be removed.'
3714
val = raw_input('Are you sure [y/N]? ')
3715
if val.lower() not in ('y', 'yes'):
3719
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3723
class cmd_break_lock(Command):
3724
"""Break a dead lock on a repository, branch or working directory.
3726
CAUTION: Locks should only be broken when you are sure that the process
3727
holding the lock has been stopped.
3729
You can get information on what locks are open via the 'bzr info' command.
3734
takes_args = ['location?']
3736
def run(self, location=None, show=False):
3737
if location is None:
3739
control, relpath = bzrdir.BzrDir.open_containing(location)
3741
control.break_lock()
3742
except NotImplementedError:
3746
class cmd_wait_until_signalled(Command):
3747
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3749
This just prints a line to signal when it is ready, then blocks on stdin.
3755
sys.stdout.write("running\n")
3757
sys.stdin.readline()
3760
class cmd_serve(Command):
3761
"""Run the bzr server."""
3763
aliases = ['server']
3767
help='Serve on stdin/out for use from inetd or sshd.'),
3769
help='Listen for connections on nominated port of the form '
3770
'[hostname:]portnumber. Passing 0 as the port number will '
3771
'result in a dynamically allocated port. The default port is '
3775
help='Serve contents of this directory.',
3777
Option('allow-writes',
3778
help='By default the server is a readonly server. Supplying '
3779
'--allow-writes enables write access to the contents of '
3780
'the served directory and below.'
3784
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3785
from bzrlib import lockdir
3786
from bzrlib.smart import medium, server
3787
from bzrlib.transport import get_transport
3788
from bzrlib.transport.chroot import ChrootServer
3789
if directory is None:
3790
directory = os.getcwd()
3791
url = urlutils.local_path_to_url(directory)
3792
if not allow_writes:
3793
url = 'readonly+' + url
3794
chroot_server = ChrootServer(get_transport(url))
3795
chroot_server.setUp()
3796
t = get_transport(chroot_server.get_url())
3798
smart_server = medium.SmartServerPipeStreamMedium(
3799
sys.stdin, sys.stdout, t)
3801
host = medium.BZR_DEFAULT_INTERFACE
3803
port = medium.BZR_DEFAULT_PORT
3806
host, port = port.split(':')
3808
smart_server = server.SmartTCPServer(t, host=host, port=port)
3809
print 'listening on port: ', smart_server.port
3811
# for the duration of this server, no UI output is permitted.
3812
# note that this may cause problems with blackbox tests. This should
3813
# be changed with care though, as we dont want to use bandwidth sending
3814
# progress over stderr to smart server clients!
3815
old_factory = ui.ui_factory
3816
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3818
ui.ui_factory = ui.SilentUIFactory()
3819
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3820
smart_server.serve()
3822
ui.ui_factory = old_factory
3823
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3826
class cmd_join(Command):
3827
"""Combine a subtree into its containing tree.
3829
This command is for experimental use only. It requires the target tree
3830
to be in dirstate-with-subtree format, which cannot be converted into
3833
The TREE argument should be an independent tree, inside another tree, but
3834
not part of it. (Such trees can be produced by "bzr split", but also by
3835
running "bzr branch" with the target inside a tree.)
3837
The result is a combined tree, with the subtree no longer an independant
3838
part. This is marked as a merge of the subtree into the containing tree,
3839
and all history is preserved.
3841
If --reference is specified, the subtree retains its independence. It can
3842
be branched by itself, and can be part of multiple projects at the same
3843
time. But operations performed in the containing tree, such as commit
3844
and merge, will recurse into the subtree.
3847
_see_also = ['split']
3848
takes_args = ['tree']
3850
Option('reference', help='Join by reference.'),
3854
def run(self, tree, reference=False):
3855
sub_tree = WorkingTree.open(tree)
3856
parent_dir = osutils.dirname(sub_tree.basedir)
3857
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3858
repo = containing_tree.branch.repository
3859
if not repo.supports_rich_root():
3860
raise errors.BzrCommandError(
3861
"Can't join trees because %s doesn't support rich root data.\n"
3862
"You can use bzr upgrade on the repository."
3866
containing_tree.add_reference(sub_tree)
3867
except errors.BadReferenceTarget, e:
3868
# XXX: Would be better to just raise a nicely printable
3869
# exception from the real origin. Also below. mbp 20070306
3870
raise errors.BzrCommandError("Cannot join %s. %s" %
3874
containing_tree.subsume(sub_tree)
3875
except errors.BadSubsumeSource, e:
3876
raise errors.BzrCommandError("Cannot join %s. %s" %
3880
class cmd_split(Command):
3881
"""Split a subdirectory of a tree into a separate tree.
3883
This command will produce a target tree in a format that supports
3884
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3885
converted into earlier formats like 'dirstate-tags'.
3887
The TREE argument should be a subdirectory of a working tree. That
3888
subdirectory will be converted into an independent tree, with its own
3889
branch. Commits in the top-level tree will not apply to the new subtree.
3892
# join is not un-hidden yet
3893
#_see_also = ['join']
3894
takes_args = ['tree']
3896
def run(self, tree):
3897
containing_tree, subdir = WorkingTree.open_containing(tree)
3898
sub_id = containing_tree.path2id(subdir)
3900
raise errors.NotVersionedError(subdir)
3902
containing_tree.extract(sub_id)
3903
except errors.RootNotRich:
3904
raise errors.UpgradeRequired(containing_tree.branch.base)
3907
class cmd_merge_directive(Command):
3908
"""Generate a merge directive for auto-merge tools.
3910
A directive requests a merge to be performed, and also provides all the
3911
information necessary to do so. This means it must either include a
3912
revision bundle, or the location of a branch containing the desired
3915
A submit branch (the location to merge into) must be supplied the first
3916
time the command is issued. After it has been supplied once, it will
3917
be remembered as the default.
3919
A public branch is optional if a revision bundle is supplied, but required
3920
if --diff or --plain is specified. It will be remembered as the default
3921
after the first use.
3924
takes_args = ['submit_branch?', 'public_branch?']
3928
_see_also = ['send']
3931
RegistryOption.from_kwargs('patch-type',
3932
'The type of patch to include in the directive.',
3934
value_switches=True,
3936
bundle='Bazaar revision bundle (default).',
3937
diff='Normal unified diff.',
3938
plain='No patch, just directive.'),
3939
Option('sign', help='GPG-sign the directive.'), 'revision',
3940
Option('mail-to', type=str,
3941
help='Instead of printing the directive, email to this address.'),
3942
Option('message', type=str, short_name='m',
3943
help='Message to use when committing this merge.')
3946
encoding_type = 'exact'
3948
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3949
sign=False, revision=None, mail_to=None, message=None):
3950
from bzrlib.revision import ensure_null, NULL_REVISION
3951
include_patch, include_bundle = {
3952
'plain': (False, False),
3953
'diff': (True, False),
3954
'bundle': (True, True),
3956
branch = Branch.open('.')
3957
stored_submit_branch = branch.get_submit_branch()
3958
if submit_branch is None:
3959
submit_branch = stored_submit_branch
3961
if stored_submit_branch is None:
3962
branch.set_submit_branch(submit_branch)
3963
if submit_branch is None:
3964
submit_branch = branch.get_parent()
3965
if submit_branch is None:
3966
raise errors.BzrCommandError('No submit branch specified or known')
3968
stored_public_branch = branch.get_public_branch()
3969
if public_branch is None:
3970
public_branch = stored_public_branch
3971
elif stored_public_branch is None:
3972
branch.set_public_branch(public_branch)
3973
if not include_bundle and public_branch is None:
3974
raise errors.BzrCommandError('No public branch specified or'
3976
base_revision_id = None
3977
if revision is not None:
3978
if len(revision) > 2:
3979
raise errors.BzrCommandError('bzr merge-directive takes '
3980
'at most two one revision identifiers')
3981
revision_id = revision[-1].in_history(branch).rev_id
3982
if len(revision) == 2:
3983
base_revision_id = revision[0].in_history(branch).rev_id
3984
base_revision_id = ensure_null(base_revision_id)
3986
revision_id = branch.last_revision()
3987
revision_id = ensure_null(revision_id)
3988
if revision_id == NULL_REVISION:
3989
raise errors.BzrCommandError('No revisions to bundle.')
3990
directive = merge_directive.MergeDirective2.from_objects(
3991
branch.repository, revision_id, time.time(),
3992
osutils.local_time_offset(), submit_branch,
3993
public_branch=public_branch, include_patch=include_patch,
3994
include_bundle=include_bundle, message=message,
3995
base_revision_id=base_revision_id)
3998
self.outf.write(directive.to_signed(branch))
4000
self.outf.writelines(directive.to_lines())
4002
message = directive.to_email(mail_to, branch, sign)
4003
s = SMTPConnection(branch.get_config())
4004
s.send_email(message)
4007
class cmd_send(Command):
4008
"""Mail or create a merge-directive for submiting changes.
4010
A merge directive provides many things needed for requesting merges:
4012
* A machine-readable description of the merge to perform
4014
* An optional patch that is a preview of the changes requested
4016
* An optional bundle of revision data, so that the changes can be applied
4017
directly from the merge directive, without retrieving data from a
4020
If --no-bundle is specified, then public_branch is needed (and must be
4021
up-to-date), so that the receiver can perform the merge using the
4022
public_branch. The public_branch is always included if known, so that
4023
people can check it later.
4025
The submit branch defaults to the parent, but can be overridden. Both
4026
submit branch and public branch will be remembered if supplied.
4028
If a public_branch is known for the submit_branch, that public submit
4029
branch is used in the merge instructions. This means that a local mirror
4030
can be used as your actual submit branch, once you have set public_branch
4033
Mail is sent using your preferred mail program. This should be transparent
4034
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4035
If the preferred client can't be found (or used), your editor will be used.
4037
To use a specific mail program, set the mail_client configuration option.
4038
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4039
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4040
generic options are "default", "editor", "mapi", and "xdg-email".
4042
If mail is being sent, a to address is required. This can be supplied
4043
either on the commandline, by setting the submit_to configuration
4044
option in the branch itself or the child_submit_to configuration option
4045
in the submit branch.
4047
Two formats are currently supported: "4" uses revision bundle format 4 and
4048
merge directive format 2. It is significantly faster and smaller than
4049
older formats. It is compatible with Bazaar 0.19 and later. It is the
4050
default. "0.9" uses revision bundle format 0.9 and merge directive
4051
format 1. It is compatible with Bazaar 0.12 - 0.18.
4054
encoding_type = 'exact'
4056
_see_also = ['merge']
4058
takes_args = ['submit_branch?', 'public_branch?']
4062
help='Do not include a bundle in the merge directive.'),
4063
Option('no-patch', help='Do not include a preview patch in the merge'
4066
help='Remember submit and public branch.'),
4068
help='Branch to generate the submission from, '
4069
'rather than the one containing the working directory.',
4072
Option('output', short_name='o', help='Write directive to this file.',
4074
Option('mail-to', help='Mail the request to this address.',
4078
RegistryOption.from_kwargs('format',
4079
'Use the specified output format.',
4080
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4081
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4084
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4085
no_patch=False, revision=None, remember=False, output=None,
4086
format='4', mail_to=None, message=None, **kwargs):
4087
return self._run(submit_branch, revision, public_branch, remember,
4088
format, no_bundle, no_patch, output,
4089
kwargs.get('from', '.'), mail_to, message)
4091
def _run(self, submit_branch, revision, public_branch, remember, format,
4092
no_bundle, no_patch, output, from_, mail_to, message):
4093
from bzrlib.revision import NULL_REVISION
4094
branch = Branch.open_containing(from_)[0]
4096
outfile = StringIO()
4100
outfile = open(output, 'wb')
4101
# we may need to write data into branch's repository to calculate
4106
config = branch.get_config()
4108
mail_to = config.get_user_option('submit_to')
4109
mail_client = config.get_mail_client()
4110
if remember and submit_branch is None:
4111
raise errors.BzrCommandError(
4112
'--remember requires a branch to be specified.')
4113
stored_submit_branch = branch.get_submit_branch()
4114
remembered_submit_branch = False
4115
if submit_branch is None:
4116
submit_branch = stored_submit_branch
4117
remembered_submit_branch = True
4119
if stored_submit_branch is None or remember:
4120
branch.set_submit_branch(submit_branch)
4121
if submit_branch is None:
4122
submit_branch = branch.get_parent()
4123
remembered_submit_branch = True
4124
if submit_branch is None:
4125
raise errors.BzrCommandError('No submit branch known or'
4127
if remembered_submit_branch:
4128
note('Using saved location: %s', submit_branch)
4131
submit_config = Branch.open(submit_branch).get_config()
4132
mail_to = submit_config.get_user_option("child_submit_to")
4134
stored_public_branch = branch.get_public_branch()
4135
if public_branch is None:
4136
public_branch = stored_public_branch
4137
elif stored_public_branch is None or remember:
4138
branch.set_public_branch(public_branch)
4139
if no_bundle and public_branch is None:
4140
raise errors.BzrCommandError('No public branch specified or'
4142
base_revision_id = None
4144
if revision is not None:
4145
if len(revision) > 2:
4146
raise errors.BzrCommandError('bzr send takes '
4147
'at most two one revision identifiers')
4148
revision_id = revision[-1].in_history(branch).rev_id
4149
if len(revision) == 2:
4150
base_revision_id = revision[0].in_history(branch).rev_id
4151
if revision_id is None:
4152
revision_id = branch.last_revision()
4153
if revision_id == NULL_REVISION:
4154
raise errors.BzrCommandError('No revisions to submit.')
4156
directive = merge_directive.MergeDirective2.from_objects(
4157
branch.repository, revision_id, time.time(),
4158
osutils.local_time_offset(), submit_branch,
4159
public_branch=public_branch, include_patch=not no_patch,
4160
include_bundle=not no_bundle, message=message,
4161
base_revision_id=base_revision_id)
4162
elif format == '0.9':
4165
patch_type = 'bundle'
4167
raise errors.BzrCommandError('Format 0.9 does not'
4168
' permit bundle with no patch')
4174
directive = merge_directive.MergeDirective.from_objects(
4175
branch.repository, revision_id, time.time(),
4176
osutils.local_time_offset(), submit_branch,
4177
public_branch=public_branch, patch_type=patch_type,
4180
outfile.writelines(directive.to_lines())
4182
subject = '[MERGE] '
4183
if message is not None:
4186
revision = branch.repository.get_revision(revision_id)
4187
subject += revision.get_summary()
4188
basename = directive.get_disk_name(branch)
4189
mail_client.compose_merge_request(mail_to, subject,
4190
outfile.getvalue(), basename)
4197
class cmd_bundle_revisions(cmd_send):
4199
"""Create a merge-directive for submiting changes.
4201
A merge directive provides many things needed for requesting merges:
4203
* A machine-readable description of the merge to perform
4205
* An optional patch that is a preview of the changes requested
4207
* An optional bundle of revision data, so that the changes can be applied
4208
directly from the merge directive, without retrieving data from a
4211
If --no-bundle is specified, then public_branch is needed (and must be
4212
up-to-date), so that the receiver can perform the merge using the
4213
public_branch. The public_branch is always included if known, so that
4214
people can check it later.
4216
The submit branch defaults to the parent, but can be overridden. Both
4217
submit branch and public branch will be remembered if supplied.
4219
If a public_branch is known for the submit_branch, that public submit
4220
branch is used in the merge instructions. This means that a local mirror
4221
can be used as your actual submit branch, once you have set public_branch
4224
Two formats are currently supported: "4" uses revision bundle format 4 and
4225
merge directive format 2. It is significantly faster and smaller than
4226
older formats. It is compatible with Bazaar 0.19 and later. It is the
4227
default. "0.9" uses revision bundle format 0.9 and merge directive
4228
format 1. It is compatible with Bazaar 0.12 - 0.18.
4233
help='Do not include a bundle in the merge directive.'),
4234
Option('no-patch', help='Do not include a preview patch in the merge'
4237
help='Remember submit and public branch.'),
4239
help='Branch to generate the submission from, '
4240
'rather than the one containing the working directory.',
4243
Option('output', short_name='o', help='Write directive to this file.',
4246
RegistryOption.from_kwargs('format',
4247
'Use the specified output format.',
4248
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4249
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4251
aliases = ['bundle']
4253
_see_also = ['send', 'merge']
4257
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4258
no_patch=False, revision=None, remember=False, output=None,
4259
format='4', **kwargs):
4262
return self._run(submit_branch, revision, public_branch, remember,
4263
format, no_bundle, no_patch, output,
4264
kwargs.get('from', '.'), None, None)
4267
class cmd_tag(Command):
4268
"""Create, remove or modify a tag naming a revision.
4270
Tags give human-meaningful names to revisions. Commands that take a -r
4271
(--revision) option can be given -rtag:X, where X is any previously
4274
Tags are stored in the branch. Tags are copied from one branch to another
4275
along when you branch, push, pull or merge.
4277
It is an error to give a tag name that already exists unless you pass
4278
--force, in which case the tag is moved to point to the new revision.
4281
_see_also = ['commit', 'tags']
4282
takes_args = ['tag_name']
4285
help='Delete this tag rather than placing it.',
4288
help='Branch in which to place the tag.',
4293
help='Replace existing tags.',
4298
def run(self, tag_name,
4304
branch, relpath = Branch.open_containing(directory)
4308
branch.tags.delete_tag(tag_name)
4309
self.outf.write('Deleted tag %s.\n' % tag_name)
4312
if len(revision) != 1:
4313
raise errors.BzrCommandError(
4314
"Tags can only be placed on a single revision, "
4316
revision_id = revision[0].in_history(branch).rev_id
4318
revision_id = branch.last_revision()
4319
if (not force) and branch.tags.has_tag(tag_name):
4320
raise errors.TagAlreadyExists(tag_name)
4321
branch.tags.set_tag(tag_name, revision_id)
4322
self.outf.write('Created tag %s.\n' % tag_name)
4327
class cmd_tags(Command):
4330
This command shows a table of tag names and the revisions they reference.
4336
help='Branch whose tags should be displayed.',
4340
RegistryOption.from_kwargs('sort',
4341
'Sort tags by different criteria.', title='Sorting',
4342
alpha='Sort tags lexicographically (default).',
4343
time='Sort tags chronologically.',
4354
branch, relpath = Branch.open_containing(directory)
4355
tags = branch.tags.get_tag_dict().items()
4358
elif sort == 'time':
4360
for tag, revid in tags:
4362
revobj = branch.repository.get_revision(revid)
4363
except errors.NoSuchRevision:
4364
timestamp = sys.maxint # place them at the end
4366
timestamp = revobj.timestamp
4367
timestamps[revid] = timestamp
4368
tags.sort(key=lambda x: timestamps[x[1]])
4370
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4371
revno_map = branch.get_revision_id_to_revno_map()
4372
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4373
for tag, revid in tags ]
4374
for tag, revspec in tags:
4375
self.outf.write('%-20s %s\n' % (tag, revspec))
4378
class cmd_reconfigure(Command):
4379
"""Reconfigure the type of a bzr directory.
4381
A target configuration must be specified.
4383
For checkouts, the bind-to location will be auto-detected if not specified.
4384
The order of preference is
4385
1. For a lightweight checkout, the current bound location.
4386
2. For branches that used to be checkouts, the previously-bound location.
4387
3. The push location.
4388
4. The parent location.
4389
If none of these is available, --bind-to must be specified.
4392
takes_args = ['location?']
4393
takes_options = [RegistryOption.from_kwargs('target_type',
4394
title='Target type',
4395
help='The type to reconfigure the directory to.',
4396
value_switches=True, enum_switch=False,
4397
branch='Reconfigure to a branch.',
4398
tree='Reconfigure to a tree.',
4399
checkout='Reconfigure to a checkout.',
4400
lightweight_checkout='Reconfigure to a lightweight'
4402
Option('bind-to', help='Branch to bind checkout to.',
4405
help='Perform reconfiguration even if local changes'
4409
def run(self, location=None, target_type=None, bind_to=None, force=False):
4410
directory = bzrdir.BzrDir.open(location)
4411
if target_type is None:
4412
raise errors.BzrCommandError('No target configuration specified')
4413
elif target_type == 'branch':
4414
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4415
elif target_type == 'tree':
4416
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4417
elif target_type == 'checkout':
4418
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4420
elif target_type == 'lightweight-checkout':
4421
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4423
reconfiguration.apply(force)
4426
class cmd_switch(Command):
4427
"""Set the branch of a checkout and update.
4429
For lightweight checkouts, this changes the branch being referenced.
4430
For heavyweight checkouts, this checks that there are no local commits
4431
versus the current bound branch, then it makes the local branch a mirror
4432
of the new location and binds to it.
4434
In both cases, the working tree is updated and uncommitted changes
4435
are merged. The user can commit or revert these as they desire.
4437
Pending merges need to be committed or reverted before using switch.
4440
takes_args = ['to_location']
4441
takes_options = [Option('force',
4442
help='Switch even if local commits will be lost.')
4445
def run(self, to_location, force=False):
4446
from bzrlib import switch
4447
to_branch = Branch.open(to_location)
4449
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4450
switch.switch(control_dir, to_branch, force)
4451
note('Switched to branch: %s',
4452
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4455
class cmd_hooks(Command):
4456
"""Show a branch's currently registered hooks.
4460
takes_args = ['path?']
4462
def run(self, path=None):
4465
branch_hooks = Branch.open(path).hooks
4466
for hook_type in branch_hooks:
4467
hooks = branch_hooks[hook_type]
4468
self.outf.write("%s:\n" % (hook_type,))
4471
self.outf.write(" %s\n" %
4472
(branch_hooks.get_hook_name(hook),))
4474
self.outf.write(" <no hooks installed>\n")
4477
def _create_prefix(cur_transport):
4478
needed = [cur_transport]
4479
# Recurse upwards until we can create a directory successfully
4481
new_transport = cur_transport.clone('..')
4482
if new_transport.base == cur_transport.base:
4483
raise errors.BzrCommandError(
4484
"Failed to create path prefix for %s."
4485
% cur_transport.base)
4487
new_transport.mkdir('.')
4488
except errors.NoSuchFile:
4489
needed.append(new_transport)
4490
cur_transport = new_transport
4493
# Now we only need to create child directories
4495
cur_transport = needed.pop()
4496
cur_transport.ensure_base()
4499
def _get_mergeable_helper(location):
4500
"""Get a merge directive or bundle if 'location' points to one.
4502
Try try to identify a bundle and returns its mergeable form. If it's not,
4503
we return the tried transport anyway so that it can reused to access the
4506
:param location: can point to a bundle or a branch.
4508
:return: mergeable, transport
4511
url = urlutils.normalize_url(location)
4512
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4513
location_transport = transport.get_transport(url)
4516
# There may be redirections but we ignore the intermediate
4517
# and final transports used
4518
read = bundle.read_mergeable_from_transport
4519
mergeable, t = read(location_transport, filename)
4520
except errors.NotABundle:
4521
# Continue on considering this url a Branch but adjust the
4522
# location_transport
4523
location_transport = location_transport.clone(filename)
4524
return mergeable, location_transport
4527
# these get imported and then picked up by the scan for cmd_*
4528
# TODO: Some more consistent way to split command definitions across files;
4529
# we do need to load at least some information about them to know of
4530
# aliases. ideally we would avoid loading the implementation until the
4531
# details were needed.
4532
from bzrlib.cmd_version_info import cmd_version_info
4533
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4534
from bzrlib.bundle.commands import (
4537
from bzrlib.sign_my_commits import cmd_sign_my_commits
4538
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4539
cmd_weave_plan_merge, cmd_weave_merge_text