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',
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,
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
753
# The destination doesn't exist; create it.
754
# XXX: Refactor the create_prefix/no_create_prefix code into a
755
# common helper function
757
def make_directory(transport):
761
def redirected(redirected_transport, e, redirection_notice):
762
return transport.get_transport(e.get_target_url())
765
to_transport = transport.do_catching_redirections(
766
make_directory, to_transport, redirected)
767
except errors.FileExists:
768
if not use_existing_dir:
769
raise errors.BzrCommandError("Target directory %s"
770
" already exists, but does not have a valid .bzr"
771
" directory. Supply --use-existing-dir to push"
772
" there anyway." % location)
773
except errors.NoSuchFile:
774
if not create_prefix:
775
raise errors.BzrCommandError("Parent directory of %s"
777
"\nYou may supply --create-prefix to create all"
778
" leading parent directories."
780
_create_prefix(to_transport)
781
except errors.TooManyRedirections:
782
raise errors.BzrCommandError("Too many redirections trying "
783
"to make %s." % location)
785
# Now the target directory exists, but doesn't have a .bzr
786
# directory. So we need to create it, along with any work to create
787
# all of the dependent branches, etc.
788
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
789
revision_id=br_from.last_revision())
790
br_to = dir_to.open_branch()
791
# TODO: Some more useful message about what was copied
792
note('Created new branch.')
793
# We successfully created the target, remember it
794
if br_from.get_push_location() is None or remember:
795
br_from.set_push_location(br_to.base)
796
elif repository_to is None:
797
# we have a bzrdir but no branch or repository
798
# XXX: Figure out what to do other than complain.
799
raise errors.BzrCommandError("At %s you have a valid .bzr control"
800
" directory, but not a branch or repository. This is an"
801
" unsupported configuration. Please move the target directory"
802
" out of the way and try again."
805
# We have a repository but no branch, copy the revisions, and then
807
last_revision_id = br_from.last_revision()
808
repository_to.fetch(br_from.repository,
809
revision_id=last_revision_id)
810
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
811
note('Created new branch.')
812
if br_from.get_push_location() is None or remember:
813
br_from.set_push_location(br_to.base)
814
else: # We have a valid to branch
815
# We were able to connect to the remote location, so remember it
816
# we don't need to successfully push because of possible divergence.
817
if br_from.get_push_location() is None or remember:
818
br_from.set_push_location(br_to.base)
820
old_rh = br_to.revision_history()
823
tree_to = dir_to.open_workingtree()
824
except errors.NotLocalUrl:
825
warning("This transport does not update the working "
826
"tree of: %s. See 'bzr help working-trees' for "
827
"more information." % br_to.base)
828
push_result = br_from.push(br_to, overwrite)
829
except errors.NoWorkingTree:
830
push_result = br_from.push(br_to, overwrite)
834
push_result = br_from.push(tree_to.branch, overwrite)
838
except errors.DivergedBranches:
839
raise errors.BzrCommandError('These branches have diverged.'
840
' Try using "merge" and then "push".')
841
if push_result is not None:
842
push_result.report(self.outf)
844
new_rh = br_to.revision_history()
847
from bzrlib.log import show_changed_revisions
848
show_changed_revisions(br_to, old_rh, new_rh,
851
# we probably did a clone rather than a push, so a message was
856
class cmd_branch(Command):
857
"""Create a new copy of a branch.
859
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
860
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
861
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
862
is derived from the FROM_LOCATION by stripping a leading scheme or drive
863
identifier, if any. For example, "branch lp:foo-bar" will attempt to
866
To retrieve the branch as of a particular revision, supply the --revision
867
parameter, as in "branch foo/bar -r 5".
870
_see_also = ['checkout']
871
takes_args = ['from_location', 'to_location?']
872
takes_options = ['revision', Option('hardlink',
873
help='Hard-link working tree files where possible.')]
874
aliases = ['get', 'clone']
876
def run(self, from_location, to_location=None, revision=None,
878
from bzrlib.tag import _merge_tags_if_possible
881
elif len(revision) > 1:
882
raise errors.BzrCommandError(
883
'bzr branch --revision takes exactly 1 revision value')
885
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
889
if len(revision) == 1 and revision[0] is not None:
890
revision_id = revision[0].in_history(br_from)[1]
892
# FIXME - wt.last_revision, fallback to branch, fall back to
893
# None or perhaps NULL_REVISION to mean copy nothing
895
revision_id = br_from.last_revision()
896
if to_location is None:
897
to_location = urlutils.derive_to_location(from_location)
900
name = os.path.basename(to_location) + '\n'
902
to_transport = transport.get_transport(to_location)
904
to_transport.mkdir('.')
905
except errors.FileExists:
906
raise errors.BzrCommandError('Target directory "%s" already'
907
' exists.' % to_location)
908
except errors.NoSuchFile:
909
raise errors.BzrCommandError('Parent of "%s" does not exist.'
912
# preserve whatever source format we have.
913
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
914
possible_transports=[to_transport],
915
accelerator_tree=accelerator_tree,
917
branch = dir.open_branch()
918
except errors.NoSuchRevision:
919
to_transport.delete_tree('.')
920
msg = "The branch %s has no revision %s." % (from_location, revision[0])
921
raise errors.BzrCommandError(msg)
923
branch.control_files.put_utf8('branch-name', name)
924
_merge_tags_if_possible(br_from, branch)
925
note('Branched %d revision(s).' % branch.revno())
930
class cmd_checkout(Command):
931
"""Create a new checkout of an existing branch.
933
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
934
the branch found in '.'. This is useful if you have removed the working tree
935
or if it was never created - i.e. if you pushed the branch to its current
938
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
939
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
940
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
941
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
942
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
945
To retrieve the branch as of a particular revision, supply the --revision
946
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
947
out of date [so you cannot commit] but it may be useful (i.e. to examine old
951
_see_also = ['checkouts', 'branch']
952
takes_args = ['branch_location?', 'to_location?']
953
takes_options = ['revision',
954
Option('lightweight',
955
help="Perform a lightweight checkout. Lightweight "
956
"checkouts depend on access to the branch for "
957
"every operation. Normal checkouts can perform "
958
"common operations like diff and status without "
959
"such access, and also support local commits."
961
Option('files-from', type=str,
962
help="Get file contents from this tree."),
964
help='Hard-link working tree files where possible.'
969
def run(self, branch_location=None, to_location=None, revision=None,
970
lightweight=False, files_from=None, hardlink=False):
973
elif len(revision) > 1:
974
raise errors.BzrCommandError(
975
'bzr checkout --revision takes exactly 1 revision value')
976
if branch_location is None:
977
branch_location = osutils.getcwd()
978
to_location = branch_location
979
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
981
if files_from is not None:
982
accelerator_tree = WorkingTree.open(files_from)
983
if len(revision) == 1 and revision[0] is not None:
984
revision_id = _mod_revision.ensure_null(
985
revision[0].in_history(source)[1])
988
if to_location is None:
989
to_location = urlutils.derive_to_location(branch_location)
990
# if the source and to_location are the same,
991
# and there is no working tree,
992
# then reconstitute a branch
993
if (osutils.abspath(to_location) ==
994
osutils.abspath(branch_location)):
996
source.bzrdir.open_workingtree()
997
except errors.NoWorkingTree:
998
source.bzrdir.create_workingtree(revision_id)
1000
source.create_checkout(to_location, revision_id, lightweight,
1001
accelerator_tree, hardlink)
1004
class cmd_renames(Command):
1005
"""Show list of renamed files.
1007
# TODO: Option to show renames between two historical versions.
1009
# TODO: Only show renames under dir, rather than in the whole branch.
1010
_see_also = ['status']
1011
takes_args = ['dir?']
1014
def run(self, dir=u'.'):
1015
tree = WorkingTree.open_containing(dir)[0]
1018
new_inv = tree.inventory
1019
old_tree = tree.basis_tree()
1020
old_tree.lock_read()
1022
old_inv = old_tree.inventory
1023
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1025
for old_name, new_name in renames:
1026
self.outf.write("%s => %s\n" % (old_name, new_name))
1033
class cmd_update(Command):
1034
"""Update a tree to have the latest code committed to its branch.
1036
This will perform a merge into the working tree, and may generate
1037
conflicts. If you have any local changes, you will still
1038
need to commit them after the update for the update to be complete.
1040
If you want to discard your local changes, you can just do a
1041
'bzr revert' instead of 'bzr commit' after the update.
1044
_see_also = ['pull', 'working-trees', 'status-flags']
1045
takes_args = ['dir?']
1048
def run(self, dir='.'):
1049
tree = WorkingTree.open_containing(dir)[0]
1050
possible_transports = []
1051
master = tree.branch.get_master_branch(
1052
possible_transports=possible_transports)
1053
if master is not None:
1056
tree.lock_tree_write()
1058
existing_pending_merges = tree.get_parent_ids()[1:]
1059
last_rev = _mod_revision.ensure_null(tree.last_revision())
1060
if last_rev == _mod_revision.ensure_null(
1061
tree.branch.last_revision()):
1062
# may be up to date, check master too.
1063
if master is None or last_rev == _mod_revision.ensure_null(
1064
master.last_revision()):
1065
revno = tree.branch.revision_id_to_revno(last_rev)
1066
note("Tree is up to date at revision %d." % (revno,))
1068
conflicts = tree.update(
1069
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1070
possible_transports=possible_transports)
1071
revno = tree.branch.revision_id_to_revno(
1072
_mod_revision.ensure_null(tree.last_revision()))
1073
note('Updated to revision %d.' % (revno,))
1074
if tree.get_parent_ids()[1:] != existing_pending_merges:
1075
note('Your local commits will now show as pending merges with '
1076
"'bzr status', and can be committed with 'bzr commit'.")
1085
class cmd_info(Command):
1086
"""Show information about a working tree, branch or repository.
1088
This command will show all known locations and formats associated to the
1089
tree, branch or repository. Statistical information is included with
1092
Branches and working trees will also report any missing revisions.
1094
_see_also = ['revno', 'working-trees', 'repositories']
1095
takes_args = ['location?']
1096
takes_options = ['verbose']
1097
encoding_type = 'replace'
1100
def run(self, location=None, verbose=False):
1105
from bzrlib.info import show_bzrdir_info
1106
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1107
verbose=noise_level, outfile=self.outf)
1110
class cmd_remove(Command):
1111
"""Remove files or directories.
1113
This makes bzr stop tracking changes to the specified files and
1114
delete them if they can easily be recovered using revert.
1116
You can specify one or more files, and/or --new. If you specify --new,
1117
only 'added' files will be removed. If you specify both, then new files
1118
in the specified directories will be removed. If the directories are
1119
also new, they will also be removed.
1121
takes_args = ['file*']
1122
takes_options = ['verbose',
1123
Option('new', help='Remove newly-added files.'),
1124
RegistryOption.from_kwargs('file-deletion-strategy',
1125
'The file deletion mode to be used.',
1126
title='Deletion Strategy', value_switches=True, enum_switch=False,
1127
safe='Only delete files if they can be'
1128
' safely recovered (default).',
1129
keep="Don't delete any files.",
1130
force='Delete all the specified files, even if they can not be '
1131
'recovered and even if they are non-empty directories.')]
1133
encoding_type = 'replace'
1135
def run(self, file_list, verbose=False, new=False,
1136
file_deletion_strategy='safe'):
1137
tree, file_list = tree_files(file_list)
1139
if file_list is not None:
1140
file_list = [f for f in file_list]
1142
raise errors.BzrCommandError('Specify one or more files to'
1143
' remove, or use --new.')
1146
added = tree.changes_from(tree.basis_tree(),
1147
specific_files=file_list).added
1148
file_list = sorted([f[0] for f in added], reverse=True)
1149
if len(file_list) == 0:
1150
raise errors.BzrCommandError('No matching files.')
1151
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1152
keep_files=file_deletion_strategy=='keep',
1153
force=file_deletion_strategy=='force')
1156
class cmd_file_id(Command):
1157
"""Print file_id of a particular file or directory.
1159
The file_id is assigned when the file is first added and remains the
1160
same through all revisions where the file exists, even when it is
1165
_see_also = ['inventory', 'ls']
1166
takes_args = ['filename']
1169
def run(self, filename):
1170
tree, relpath = WorkingTree.open_containing(filename)
1171
i = tree.path2id(relpath)
1173
raise errors.NotVersionedError(filename)
1175
self.outf.write(i + '\n')
1178
class cmd_file_path(Command):
1179
"""Print path of file_ids to a file or directory.
1181
This prints one line for each directory down to the target,
1182
starting at the branch root.
1186
takes_args = ['filename']
1189
def run(self, filename):
1190
tree, relpath = WorkingTree.open_containing(filename)
1191
fid = tree.path2id(relpath)
1193
raise errors.NotVersionedError(filename)
1194
segments = osutils.splitpath(relpath)
1195
for pos in range(1, len(segments) + 1):
1196
path = osutils.joinpath(segments[:pos])
1197
self.outf.write("%s\n" % tree.path2id(path))
1200
class cmd_reconcile(Command):
1201
"""Reconcile bzr metadata in a branch.
1203
This can correct data mismatches that may have been caused by
1204
previous ghost operations or bzr upgrades. You should only
1205
need to run this command if 'bzr check' or a bzr developer
1206
advises you to run it.
1208
If a second branch is provided, cross-branch reconciliation is
1209
also attempted, which will check that data like the tree root
1210
id which was not present in very early bzr versions is represented
1211
correctly in both branches.
1213
At the same time it is run it may recompress data resulting in
1214
a potential saving in disk space or performance gain.
1216
The branch *MUST* be on a listable system such as local disk or sftp.
1219
_see_also = ['check']
1220
takes_args = ['branch?']
1222
def run(self, branch="."):
1223
from bzrlib.reconcile import reconcile
1224
dir = bzrdir.BzrDir.open(branch)
1228
class cmd_revision_history(Command):
1229
"""Display the list of revision ids on a branch."""
1232
takes_args = ['location?']
1237
def run(self, location="."):
1238
branch = Branch.open_containing(location)[0]
1239
for revid in branch.revision_history():
1240
self.outf.write(revid)
1241
self.outf.write('\n')
1244
class cmd_ancestry(Command):
1245
"""List all revisions merged into this branch."""
1247
_see_also = ['log', 'revision-history']
1248
takes_args = ['location?']
1253
def run(self, location="."):
1255
wt = WorkingTree.open_containing(location)[0]
1256
except errors.NoWorkingTree:
1257
b = Branch.open(location)
1258
last_revision = b.last_revision()
1261
last_revision = wt.last_revision()
1263
revision_ids = b.repository.get_ancestry(last_revision)
1264
assert revision_ids[0] is None
1266
for revision_id in revision_ids:
1267
self.outf.write(revision_id + '\n')
1270
class cmd_init(Command):
1271
"""Make a directory into a versioned branch.
1273
Use this to create an empty branch, or before importing an
1276
If there is a repository in a parent directory of the location, then
1277
the history of the branch will be stored in the repository. Otherwise
1278
init creates a standalone branch which carries its own history
1279
in the .bzr directory.
1281
If there is already a branch at the location but it has no working tree,
1282
the tree can be populated with 'bzr checkout'.
1284
Recipe for importing a tree of files::
1290
bzr commit -m "imported project"
1293
_see_also = ['init-repository', 'branch', 'checkout']
1294
takes_args = ['location?']
1296
Option('create-prefix',
1297
help='Create the path leading up to the branch '
1298
'if it does not already exist.'),
1299
RegistryOption('format',
1300
help='Specify a format for this branch. '
1301
'See "help formats".',
1302
registry=bzrdir.format_registry,
1303
converter=bzrdir.format_registry.make_bzrdir,
1304
value_switches=True,
1305
title="Branch Format",
1307
Option('append-revisions-only',
1308
help='Never change revnos or the existing log.'
1309
' Append revisions to it only.')
1311
def run(self, location=None, format=None, append_revisions_only=False,
1312
create_prefix=False):
1314
format = bzrdir.format_registry.make_bzrdir('default')
1315
if location is None:
1318
to_transport = transport.get_transport(location)
1320
# The path has to exist to initialize a
1321
# branch inside of it.
1322
# Just using os.mkdir, since I don't
1323
# believe that we want to create a bunch of
1324
# locations if the user supplies an extended path
1326
to_transport.ensure_base()
1327
except errors.NoSuchFile:
1328
if not create_prefix:
1329
raise errors.BzrCommandError("Parent directory of %s"
1331
"\nYou may supply --create-prefix to create all"
1332
" leading parent directories."
1334
_create_prefix(to_transport)
1337
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1338
except errors.NotBranchError:
1339
# really a NotBzrDir error...
1340
create_branch = bzrdir.BzrDir.create_branch_convenience
1341
branch = create_branch(to_transport.base, format=format,
1342
possible_transports=[to_transport])
1344
from bzrlib.transport.local import LocalTransport
1345
if existing_bzrdir.has_branch():
1346
if (isinstance(to_transport, LocalTransport)
1347
and not existing_bzrdir.has_workingtree()):
1348
raise errors.BranchExistsWithoutWorkingTree(location)
1349
raise errors.AlreadyBranchError(location)
1351
branch = existing_bzrdir.create_branch()
1352
existing_bzrdir.create_workingtree()
1353
if append_revisions_only:
1355
branch.set_append_revisions_only(True)
1356
except errors.UpgradeRequired:
1357
raise errors.BzrCommandError('This branch format cannot be set'
1358
' to append-revisions-only. Try --experimental-branch6')
1361
class cmd_init_repository(Command):
1362
"""Create a shared repository to hold branches.
1364
New branches created under the repository directory will store their
1365
revisions in the repository, not in the branch directory.
1367
If the --no-trees option is used then the branches in the repository
1368
will not have working trees by default.
1371
Create a shared repositories holding just branches::
1373
bzr init-repo --no-trees repo
1376
Make a lightweight checkout elsewhere::
1378
bzr checkout --lightweight repo/trunk trunk-checkout
1383
_see_also = ['init', 'branch', 'checkout', 'repositories']
1384
takes_args = ["location"]
1385
takes_options = [RegistryOption('format',
1386
help='Specify a format for this repository. See'
1387
' "bzr help formats" for details.',
1388
registry=bzrdir.format_registry,
1389
converter=bzrdir.format_registry.make_bzrdir,
1390
value_switches=True, title='Repository format'),
1392
help='Branches in the repository will default to'
1393
' not having a working tree.'),
1395
aliases = ["init-repo"]
1397
def run(self, location, format=None, no_trees=False):
1399
format = bzrdir.format_registry.make_bzrdir('default')
1401
if location is None:
1404
to_transport = transport.get_transport(location)
1405
to_transport.ensure_base()
1407
newdir = format.initialize_on_transport(to_transport)
1408
repo = newdir.create_repository(shared=True)
1409
repo.set_make_working_trees(not no_trees)
1412
class cmd_diff(Command):
1413
"""Show differences in the working tree, between revisions or branches.
1415
If no arguments are given, all changes for the current tree are listed.
1416
If files are given, only the changes in those files are listed.
1417
Remote and multiple branches can be compared by using the --old and
1418
--new options. If not provided, the default for both is derived from
1419
the first argument, if any, or the current tree if no arguments are
1422
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1423
produces patches suitable for "patch -p1".
1427
2 - unrepresentable changes
1432
Shows the difference in the working tree versus the last commit::
1436
Difference between the working tree and revision 1::
1440
Difference between revision 2 and revision 1::
1444
Difference between revision 2 and revision 1 for branch xxx::
1448
Show just the differences for file NEWS::
1452
Show the differences in working tree xxx for file NEWS::
1456
Show the differences from branch xxx to this working tree:
1460
Show the differences between two branches for file NEWS::
1462
bzr diff --old xxx --new yyy NEWS
1464
Same as 'bzr diff' but prefix paths with old/ and new/::
1466
bzr diff --prefix old/:new/
1468
_see_also = ['status']
1469
takes_args = ['file*']
1471
Option('diff-options', type=str,
1472
help='Pass these options to the external diff program.'),
1473
Option('prefix', type=str,
1475
help='Set prefixes added to old and new filenames, as '
1476
'two values separated by a colon. (eg "old/:new/").'),
1478
help='Branch/tree to compare from.',
1482
help='Branch/tree to compare to.',
1488
help='Use this command to compare files.',
1492
aliases = ['di', 'dif']
1493
encoding_type = 'exact'
1496
def run(self, revision=None, file_list=None, diff_options=None,
1497
prefix=None, old=None, new=None, using=None):
1498
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1500
if (prefix is None) or (prefix == '0'):
1508
old_label, new_label = prefix.split(":")
1510
raise errors.BzrCommandError(
1511
'--prefix expects two values separated by a colon'
1512
' (eg "old/:new/")')
1514
if revision and len(revision) > 2:
1515
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1516
' one or two revision specifiers')
1518
old_tree, new_tree, specific_files, extra_trees = \
1519
_get_trees_to_diff(file_list, revision, old, new)
1520
return show_diff_trees(old_tree, new_tree, sys.stdout,
1521
specific_files=specific_files,
1522
external_diff_options=diff_options,
1523
old_label=old_label, new_label=new_label,
1524
extra_trees=extra_trees, using=using)
1527
class cmd_deleted(Command):
1528
"""List files deleted in the working tree.
1530
# TODO: Show files deleted since a previous revision, or
1531
# between two revisions.
1532
# TODO: Much more efficient way to do this: read in new
1533
# directories with readdir, rather than stating each one. Same
1534
# level of effort but possibly much less IO. (Or possibly not,
1535
# if the directories are very large...)
1536
_see_also = ['status', 'ls']
1537
takes_options = ['show-ids']
1540
def run(self, show_ids=False):
1541
tree = WorkingTree.open_containing(u'.')[0]
1544
old = tree.basis_tree()
1547
for path, ie in old.inventory.iter_entries():
1548
if not tree.has_id(ie.file_id):
1549
self.outf.write(path)
1551
self.outf.write(' ')
1552
self.outf.write(ie.file_id)
1553
self.outf.write('\n')
1560
class cmd_modified(Command):
1561
"""List files modified in working tree.
1565
_see_also = ['status', 'ls']
1569
tree = WorkingTree.open_containing(u'.')[0]
1570
td = tree.changes_from(tree.basis_tree())
1571
for path, id, kind, text_modified, meta_modified in td.modified:
1572
self.outf.write(path + '\n')
1575
class cmd_added(Command):
1576
"""List files added in working tree.
1580
_see_also = ['status', 'ls']
1584
wt = WorkingTree.open_containing(u'.')[0]
1587
basis = wt.basis_tree()
1590
basis_inv = basis.inventory
1593
if file_id in basis_inv:
1595
if inv.is_root(file_id) and len(basis_inv) == 0:
1597
path = inv.id2path(file_id)
1598
if not os.access(osutils.abspath(path), os.F_OK):
1600
self.outf.write(path + '\n')
1607
class cmd_root(Command):
1608
"""Show the tree root directory.
1610
The root is the nearest enclosing directory with a .bzr control
1613
takes_args = ['filename?']
1615
def run(self, filename=None):
1616
"""Print the branch root."""
1617
tree = WorkingTree.open_containing(filename)[0]
1618
self.outf.write(tree.basedir + '\n')
1621
def _parse_limit(limitstring):
1623
return int(limitstring)
1625
msg = "The limit argument must be an integer."
1626
raise errors.BzrCommandError(msg)
1629
class cmd_log(Command):
1630
"""Show log of a branch, file, or directory.
1632
By default show the log of the branch containing the working directory.
1634
To request a range of logs, you can use the command -r begin..end
1635
-r revision requests a specific revision, -r ..end or -r begin.. are
1639
Log the current branch::
1647
Log the last 10 revisions of a branch::
1649
bzr log -r -10.. http://server/branch
1652
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1654
takes_args = ['location?']
1657
help='Show from oldest to newest.'),
1660
help='Display timezone as local, original, or utc.'),
1661
custom_help('verbose',
1662
help='Show files changed in each revision.'),
1668
help='Show revisions whose message matches this '
1669
'regular expression.',
1673
help='Limit the output to the first N revisions.',
1677
encoding_type = 'replace'
1680
def run(self, location=None, timezone='original',
1688
from bzrlib.log import show_log
1689
assert message is None or isinstance(message, basestring), \
1690
"invalid message argument %r" % message
1691
direction = (forward and 'forward') or 'reverse'
1696
# find the file id to log:
1698
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1702
tree = b.basis_tree()
1703
file_id = tree.path2id(fp)
1705
raise errors.BzrCommandError(
1706
"Path does not have any revision history: %s" %
1710
# FIXME ? log the current subdir only RBC 20060203
1711
if revision is not None \
1712
and len(revision) > 0 and revision[0].get_branch():
1713
location = revision[0].get_branch()
1716
dir, relpath = bzrdir.BzrDir.open_containing(location)
1717
b = dir.open_branch()
1721
if revision is None:
1724
elif len(revision) == 1:
1725
rev1 = rev2 = revision[0].in_history(b)
1726
elif len(revision) == 2:
1727
if revision[1].get_branch() != revision[0].get_branch():
1728
# b is taken from revision[0].get_branch(), and
1729
# show_log will use its revision_history. Having
1730
# different branches will lead to weird behaviors.
1731
raise errors.BzrCommandError(
1732
"Log doesn't accept two revisions in different"
1734
rev1 = revision[0].in_history(b)
1735
rev2 = revision[1].in_history(b)
1737
raise errors.BzrCommandError(
1738
'bzr log --revision takes one or two values.')
1740
if log_format is None:
1741
log_format = log.log_formatter_registry.get_default(b)
1743
lf = log_format(show_ids=show_ids, to_file=self.outf,
1744
show_timezone=timezone)
1750
direction=direction,
1751
start_revision=rev1,
1759
def get_log_format(long=False, short=False, line=False, default='long'):
1760
log_format = default
1764
log_format = 'short'
1770
class cmd_touching_revisions(Command):
1771
"""Return revision-ids which affected a particular file.
1773
A more user-friendly interface is "bzr log FILE".
1777
takes_args = ["filename"]
1780
def run(self, filename):
1781
tree, relpath = WorkingTree.open_containing(filename)
1783
file_id = tree.path2id(relpath)
1784
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1785
self.outf.write("%6d %s\n" % (revno, what))
1788
class cmd_ls(Command):
1789
"""List files in a tree.
1792
_see_also = ['status', 'cat']
1793
takes_args = ['path?']
1794
# TODO: Take a revision or remote path and list that tree instead.
1798
Option('non-recursive',
1799
help='Don\'t recurse into subdirectories.'),
1801
help='Print paths relative to the root of the branch.'),
1802
Option('unknown', help='Print unknown files.'),
1803
Option('versioned', help='Print versioned files.'),
1804
Option('ignored', help='Print ignored files.'),
1806
help='Write an ascii NUL (\\0) separator '
1807
'between files rather than a newline.'),
1809
help='List entries of a particular kind: file, directory, symlink.',
1814
def run(self, revision=None, verbose=False,
1815
non_recursive=False, from_root=False,
1816
unknown=False, versioned=False, ignored=False,
1817
null=False, kind=None, show_ids=False, path=None):
1819
if kind and kind not in ('file', 'directory', 'symlink'):
1820
raise errors.BzrCommandError('invalid kind specified')
1822
if verbose and null:
1823
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1824
all = not (unknown or versioned or ignored)
1826
selection = {'I':ignored, '?':unknown, 'V':versioned}
1833
raise errors.BzrCommandError('cannot specify both --from-root'
1837
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1843
if revision is not None:
1844
tree = branch.repository.revision_tree(
1845
revision[0].in_history(branch).rev_id)
1847
tree = branch.basis_tree()
1851
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1852
if fp.startswith(relpath):
1853
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1854
if non_recursive and '/' in fp:
1856
if not all and not selection[fc]:
1858
if kind is not None and fkind != kind:
1861
kindch = entry.kind_character()
1862
outstring = '%-8s %s%s' % (fc, fp, kindch)
1863
if show_ids and fid is not None:
1864
outstring = "%-50s %s" % (outstring, fid)
1865
self.outf.write(outstring + '\n')
1867
self.outf.write(fp + '\0')
1870
self.outf.write(fid)
1871
self.outf.write('\0')
1879
self.outf.write('%-50s %s\n' % (fp, my_id))
1881
self.outf.write(fp + '\n')
1886
class cmd_unknowns(Command):
1887
"""List unknown files.
1895
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1896
self.outf.write(osutils.quotefn(f) + '\n')
1899
class cmd_ignore(Command):
1900
"""Ignore specified files or patterns.
1902
To remove patterns from the ignore list, edit the .bzrignore file.
1904
Trailing slashes on patterns are ignored.
1905
If the pattern contains a slash or is a regular expression, it is compared
1906
to the whole path from the branch root. Otherwise, it is compared to only
1907
the last component of the path. To match a file only in the root
1908
directory, prepend './'.
1910
Ignore patterns specifying absolute paths are not allowed.
1912
Ignore patterns may include globbing wildcards such as::
1914
? - Matches any single character except '/'
1915
* - Matches 0 or more characters except '/'
1916
/**/ - Matches 0 or more directories in a path
1917
[a-z] - Matches a single character from within a group of characters
1919
Ignore patterns may also be Python regular expressions.
1920
Regular expression ignore patterns are identified by a 'RE:' prefix
1921
followed by the regular expression. Regular expression ignore patterns
1922
may not include named or numbered groups.
1924
Note: ignore patterns containing shell wildcards must be quoted from
1928
Ignore the top level Makefile::
1930
bzr ignore ./Makefile
1932
Ignore class files in all directories::
1934
bzr ignore "*.class"
1936
Ignore .o files under the lib directory::
1938
bzr ignore "lib/**/*.o"
1940
Ignore .o files under the lib directory::
1942
bzr ignore "RE:lib/.*\.o"
1945
_see_also = ['status', 'ignored']
1946
takes_args = ['name_pattern*']
1948
Option('old-default-rules',
1949
help='Write out the ignore rules bzr < 0.9 always used.')
1952
def run(self, name_pattern_list=None, old_default_rules=None):
1953
from bzrlib.atomicfile import AtomicFile
1954
if old_default_rules is not None:
1955
# dump the rules and exit
1956
for pattern in ignores.OLD_DEFAULTS:
1959
if not name_pattern_list:
1960
raise errors.BzrCommandError("ignore requires at least one "
1961
"NAME_PATTERN or --old-default-rules")
1962
name_pattern_list = [globbing.normalize_pattern(p)
1963
for p in name_pattern_list]
1964
for name_pattern in name_pattern_list:
1965
if (name_pattern[0] == '/' or
1966
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1967
raise errors.BzrCommandError(
1968
"NAME_PATTERN should not be an absolute path")
1969
tree, relpath = WorkingTree.open_containing(u'.')
1970
ifn = tree.abspath('.bzrignore')
1971
if os.path.exists(ifn):
1974
igns = f.read().decode('utf-8')
1980
# TODO: If the file already uses crlf-style termination, maybe
1981
# we should use that for the newly added lines?
1983
if igns and igns[-1] != '\n':
1985
for name_pattern in name_pattern_list:
1986
igns += name_pattern + '\n'
1988
f = AtomicFile(ifn, 'wb')
1990
f.write(igns.encode('utf-8'))
1995
if not tree.path2id('.bzrignore'):
1996
tree.add(['.bzrignore'])
1998
ignored = globbing.Globster(name_pattern_list)
2001
for entry in tree.list_files():
2005
if ignored.match(filename):
2006
matches.append(filename.encode('utf-8'))
2008
if len(matches) > 0:
2009
print "Warning: the following files are version controlled and" \
2010
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2012
class cmd_ignored(Command):
2013
"""List ignored files and the patterns that matched them.
2016
encoding_type = 'replace'
2017
_see_also = ['ignore']
2021
tree = WorkingTree.open_containing(u'.')[0]
2024
for path, file_class, kind, file_id, entry in tree.list_files():
2025
if file_class != 'I':
2027
## XXX: Slightly inefficient since this was already calculated
2028
pat = tree.is_ignored(path)
2029
self.outf.write('%-50s %s\n' % (path, pat))
2034
class cmd_lookup_revision(Command):
2035
"""Lookup the revision-id from a revision-number
2038
bzr lookup-revision 33
2041
takes_args = ['revno']
2044
def run(self, revno):
2048
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2050
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2053
class cmd_export(Command):
2054
"""Export current or past revision to a destination directory or archive.
2056
If no revision is specified this exports the last committed revision.
2058
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2059
given, try to find the format with the extension. If no extension
2060
is found exports to a directory (equivalent to --format=dir).
2062
If root is supplied, it will be used as the root directory inside
2063
container formats (tar, zip, etc). If it is not supplied it will default
2064
to the exported filename. The root option has no effect for 'dir' format.
2066
If branch is omitted then the branch containing the current working
2067
directory will be used.
2069
Note: Export of tree with non-ASCII filenames to zip is not supported.
2071
================= =========================
2072
Supported formats Autodetected by extension
2073
================= =========================
2076
tbz2 .tar.bz2, .tbz2
2079
================= =========================
2081
takes_args = ['dest', 'branch?']
2084
help="Type of file to export to.",
2089
help="Name of the root directory inside the exported file."),
2091
def run(self, dest, branch=None, revision=None, format=None, root=None):
2092
from bzrlib.export import export
2095
tree = WorkingTree.open_containing(u'.')[0]
2098
b = Branch.open(branch)
2100
if revision is None:
2101
# should be tree.last_revision FIXME
2102
rev_id = b.last_revision()
2104
if len(revision) != 1:
2105
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2106
rev_id = revision[0].in_history(b).rev_id
2107
t = b.repository.revision_tree(rev_id)
2109
export(t, dest, format, root)
2110
except errors.NoSuchExportFormat, e:
2111
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2114
class cmd_cat(Command):
2115
"""Write the contents of a file as of a given revision to standard output.
2117
If no revision is nominated, the last revision is used.
2119
Note: Take care to redirect standard output when using this command on a
2125
Option('name-from-revision', help='The path name in the old tree.'),
2128
takes_args = ['filename']
2129
encoding_type = 'exact'
2132
def run(self, filename, revision=None, name_from_revision=False):
2133
if revision is not None and len(revision) != 1:
2134
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2135
" one revision specifier")
2136
tree, branch, relpath = \
2137
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2140
return self._run(tree, branch, relpath, filename, revision,
2145
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2147
tree = b.basis_tree()
2148
if revision is None:
2149
revision_id = b.last_revision()
2151
revision_id = revision[0].in_history(b).rev_id
2153
cur_file_id = tree.path2id(relpath)
2154
rev_tree = b.repository.revision_tree(revision_id)
2155
old_file_id = rev_tree.path2id(relpath)
2157
if name_from_revision:
2158
if old_file_id is None:
2159
raise errors.BzrCommandError("%r is not present in revision %s"
2160
% (filename, revision_id))
2162
rev_tree.print_file(old_file_id)
2163
elif cur_file_id is not None:
2164
rev_tree.print_file(cur_file_id)
2165
elif old_file_id is not None:
2166
rev_tree.print_file(old_file_id)
2168
raise errors.BzrCommandError("%r is not present in revision %s" %
2169
(filename, revision_id))
2172
class cmd_local_time_offset(Command):
2173
"""Show the offset in seconds from GMT to local time."""
2177
print osutils.local_time_offset()
2181
class cmd_commit(Command):
2182
"""Commit changes into a new revision.
2184
If no arguments are given, the entire tree is committed.
2186
If selected files are specified, only changes to those files are
2187
committed. If a directory is specified then the directory and everything
2188
within it is committed.
2190
If author of the change is not the same person as the committer, you can
2191
specify the author's name using the --author option. The name should be
2192
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2194
A selected-file commit may fail in some cases where the committed
2195
tree would be invalid. Consider::
2200
bzr commit foo -m "committing foo"
2201
bzr mv foo/bar foo/baz
2204
bzr commit foo/bar -m "committing bar but not baz"
2206
In the example above, the last commit will fail by design. This gives
2207
the user the opportunity to decide whether they want to commit the
2208
rename at the same time, separately first, or not at all. (As a general
2209
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2211
Note: A selected-file commit after a merge is not yet supported.
2213
# TODO: Run hooks on tree to-be-committed, and after commit.
2215
# TODO: Strict commit that fails if there are deleted files.
2216
# (what does "deleted files" mean ??)
2218
# TODO: Give better message for -s, --summary, used by tla people
2220
# XXX: verbose currently does nothing
2222
_see_also = ['bugs', 'uncommit']
2223
takes_args = ['selected*']
2225
Option('message', type=unicode,
2227
help="Description of the new revision."),
2230
help='Commit even if nothing has changed.'),
2231
Option('file', type=str,
2234
help='Take commit message from this file.'),
2236
help="Refuse to commit if there are unknown "
2237
"files in the working tree."),
2238
ListOption('fixes', type=str,
2239
help="Mark a bug as being fixed by this revision."),
2240
Option('author', type=unicode,
2241
help="Set the author's name, if it's different "
2242
"from the committer."),
2244
help="Perform a local commit in a bound "
2245
"branch. Local commits are not pushed to "
2246
"the master branch until a normal commit "
2250
help='When no message is supplied, show the diff along'
2251
' with the status summary in the message editor.'),
2253
aliases = ['ci', 'checkin']
2255
def _get_bug_fix_properties(self, fixes, branch):
2257
# Configure the properties for bug fixing attributes.
2258
for fixed_bug in fixes:
2259
tokens = fixed_bug.split(':')
2260
if len(tokens) != 2:
2261
raise errors.BzrCommandError(
2262
"Invalid bug %s. Must be in the form of 'tag:id'. "
2263
"Commit refused." % fixed_bug)
2264
tag, bug_id = tokens
2266
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2267
except errors.UnknownBugTrackerAbbreviation:
2268
raise errors.BzrCommandError(
2269
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2270
except errors.MalformedBugIdentifier:
2271
raise errors.BzrCommandError(
2272
"Invalid bug identifier for %s. Commit refused."
2274
properties.append('%s fixed' % bug_url)
2275
return '\n'.join(properties)
2277
def run(self, message=None, file=None, verbose=False, selected_list=None,
2278
unchanged=False, strict=False, local=False, fixes=None,
2279
author=None, show_diff=False):
2280
from bzrlib.errors import (
2285
from bzrlib.msgeditor import (
2286
edit_commit_message_encoded,
2287
make_commit_message_template_encoded
2290
# TODO: Need a blackbox test for invoking the external editor; may be
2291
# slightly problematic to run this cross-platform.
2293
# TODO: do more checks that the commit will succeed before
2294
# spending the user's valuable time typing a commit message.
2298
tree, selected_list = tree_files(selected_list)
2299
if selected_list == ['']:
2300
# workaround - commit of root of tree should be exactly the same
2301
# as just default commit in that tree, and succeed even though
2302
# selected-file merge commit is not done yet
2307
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2309
properties['bugs'] = bug_property
2311
if local and not tree.branch.get_bound_location():
2312
raise errors.LocalRequiresBoundBranch()
2314
def get_message(commit_obj):
2315
"""Callback to get commit message"""
2316
my_message = message
2317
if my_message is None and not file:
2318
t = make_commit_message_template_encoded(tree,
2319
selected_list, diff=show_diff,
2320
output_encoding=bzrlib.user_encoding)
2321
my_message = edit_commit_message_encoded(t)
2322
if my_message is None:
2323
raise errors.BzrCommandError("please specify a commit"
2324
" message with either --message or --file")
2325
elif my_message and file:
2326
raise errors.BzrCommandError(
2327
"please specify either --message or --file")
2329
my_message = codecs.open(file, 'rt',
2330
bzrlib.user_encoding).read()
2331
if my_message == "":
2332
raise errors.BzrCommandError("empty commit message specified")
2336
tree.commit(message_callback=get_message,
2337
specific_files=selected_list,
2338
allow_pointless=unchanged, strict=strict, local=local,
2339
reporter=None, verbose=verbose, revprops=properties,
2341
except PointlessCommit:
2342
# FIXME: This should really happen before the file is read in;
2343
# perhaps prepare the commit; get the message; then actually commit
2344
raise errors.BzrCommandError("no changes to commit."
2345
" use --unchanged to commit anyhow")
2346
except ConflictsInTree:
2347
raise errors.BzrCommandError('Conflicts detected in working '
2348
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2350
except StrictCommitFailed:
2351
raise errors.BzrCommandError("Commit refused because there are"
2352
" unknown files in the working tree.")
2353
except errors.BoundBranchOutOfDate, e:
2354
raise errors.BzrCommandError(str(e) + "\n"
2355
'To commit to master branch, run update and then commit.\n'
2356
'You can also pass --local to commit to continue working '
2360
class cmd_check(Command):
2361
"""Validate consistency of branch history.
2363
This command checks various invariants about the branch storage to
2364
detect data corruption or bzr bugs.
2368
revisions: This is just the number of revisions checked. It doesn't
2370
versionedfiles: This is just the number of versionedfiles checked. It
2371
doesn't indicate a problem.
2372
unreferenced ancestors: Texts that are ancestors of other texts, but
2373
are not properly referenced by the revision ancestry. This is a
2374
subtle problem that Bazaar can work around.
2375
unique file texts: This is the total number of unique file contents
2376
seen in the checked revisions. It does not indicate a problem.
2377
repeated file texts: This is the total number of repeated texts seen
2378
in the checked revisions. Texts can be repeated when their file
2379
entries are modified, but the file contents are not. It does not
2383
_see_also = ['reconcile']
2384
takes_args = ['branch?']
2385
takes_options = ['verbose']
2387
def run(self, branch=None, verbose=False):
2388
from bzrlib.check import check
2390
branch_obj = Branch.open_containing('.')[0]
2392
branch_obj = Branch.open(branch)
2393
check(branch_obj, verbose)
2394
# bit hacky, check the tree parent is accurate
2397
tree = WorkingTree.open_containing('.')[0]
2399
tree = WorkingTree.open(branch)
2400
except (errors.NoWorkingTree, errors.NotLocalUrl):
2403
# This is a primitive 'check' for tree state. Currently this is not
2404
# integrated into the main check logic as yet.
2407
tree_basis = tree.basis_tree()
2408
tree_basis.lock_read()
2410
repo_basis = tree.branch.repository.revision_tree(
2411
tree.last_revision())
2412
if len(list(repo_basis._iter_changes(tree_basis))):
2413
raise errors.BzrCheckError(
2414
"Mismatched basis inventory content.")
2422
class cmd_upgrade(Command):
2423
"""Upgrade branch storage to current format.
2425
The check command or bzr developers may sometimes advise you to run
2426
this command. When the default format has changed you may also be warned
2427
during other operations to upgrade.
2430
_see_also = ['check']
2431
takes_args = ['url?']
2433
RegistryOption('format',
2434
help='Upgrade to a specific format. See "bzr help'
2435
' formats" for details.',
2436
registry=bzrdir.format_registry,
2437
converter=bzrdir.format_registry.make_bzrdir,
2438
value_switches=True, title='Branch format'),
2441
def run(self, url='.', format=None):
2442
from bzrlib.upgrade import upgrade
2444
format = bzrdir.format_registry.make_bzrdir('default')
2445
upgrade(url, format)
2448
class cmd_whoami(Command):
2449
"""Show or set bzr user id.
2452
Show the email of the current user::
2456
Set the current user::
2458
bzr whoami "Frank Chu <fchu@example.com>"
2460
takes_options = [ Option('email',
2461
help='Display email address only.'),
2463
help='Set identity for the current branch instead of '
2466
takes_args = ['name?']
2467
encoding_type = 'replace'
2470
def run(self, email=False, branch=False, name=None):
2472
# use branch if we're inside one; otherwise global config
2474
c = Branch.open_containing('.')[0].get_config()
2475
except errors.NotBranchError:
2476
c = config.GlobalConfig()
2478
self.outf.write(c.user_email() + '\n')
2480
self.outf.write(c.username() + '\n')
2483
# display a warning if an email address isn't included in the given name.
2485
config.extract_email_address(name)
2486
except errors.NoEmailInUsername, e:
2487
warning('"%s" does not seem to contain an email address. '
2488
'This is allowed, but not recommended.', name)
2490
# use global config unless --branch given
2492
c = Branch.open_containing('.')[0].get_config()
2494
c = config.GlobalConfig()
2495
c.set_user_option('email', name)
2498
class cmd_nick(Command):
2499
"""Print or set the branch nickname.
2501
If unset, the tree root directory name is used as the nickname
2502
To print the current nickname, execute with no argument.
2505
_see_also = ['info']
2506
takes_args = ['nickname?']
2507
def run(self, nickname=None):
2508
branch = Branch.open_containing(u'.')[0]
2509
if nickname is None:
2510
self.printme(branch)
2512
branch.nick = nickname
2515
def printme(self, branch):
2519
class cmd_selftest(Command):
2520
"""Run internal test suite.
2522
If arguments are given, they are regular expressions that say which tests
2523
should run. Tests matching any expression are run, and other tests are
2526
Alternatively if --first is given, matching tests are run first and then
2527
all other tests are run. This is useful if you have been working in a
2528
particular area, but want to make sure nothing else was broken.
2530
If --exclude is given, tests that match that regular expression are
2531
excluded, regardless of whether they match --first or not.
2533
To help catch accidential dependencies between tests, the --randomize
2534
option is useful. In most cases, the argument used is the word 'now'.
2535
Note that the seed used for the random number generator is displayed
2536
when this option is used. The seed can be explicitly passed as the
2537
argument to this option if required. This enables reproduction of the
2538
actual ordering used if and when an order sensitive problem is encountered.
2540
If --list-only is given, the tests that would be run are listed. This is
2541
useful when combined with --first, --exclude and/or --randomize to
2542
understand their impact. The test harness reports "Listed nn tests in ..."
2543
instead of "Ran nn tests in ..." when list mode is enabled.
2545
If the global option '--no-plugins' is given, plugins are not loaded
2546
before running the selftests. This has two effects: features provided or
2547
modified by plugins will not be tested, and tests provided by plugins will
2550
Tests that need working space on disk use a common temporary directory,
2551
typically inside $TMPDIR or /tmp.
2554
Run only tests relating to 'ignore'::
2558
Disable plugins and list tests as they're run::
2560
bzr --no-plugins selftest -v
2562
# NB: this is used from the class without creating an instance, which is
2563
# why it does not have a self parameter.
2564
def get_transport_type(typestring):
2565
"""Parse and return a transport specifier."""
2566
if typestring == "sftp":
2567
from bzrlib.transport.sftp import SFTPAbsoluteServer
2568
return SFTPAbsoluteServer
2569
if typestring == "memory":
2570
from bzrlib.transport.memory import MemoryServer
2572
if typestring == "fakenfs":
2573
from bzrlib.transport.fakenfs import FakeNFSServer
2574
return FakeNFSServer
2575
msg = "No known transport type %s. Supported types are: sftp\n" %\
2577
raise errors.BzrCommandError(msg)
2580
takes_args = ['testspecs*']
2581
takes_options = ['verbose',
2583
help='Stop when one test fails.',
2587
help='Use a different transport by default '
2588
'throughout the test suite.',
2589
type=get_transport_type),
2591
help='Run the benchmarks rather than selftests.'),
2592
Option('lsprof-timed',
2593
help='Generate lsprof output for benchmarked'
2594
' sections of code.'),
2595
Option('cache-dir', type=str,
2596
help='Cache intermediate benchmark output in this '
2599
help='Run all tests, but run specified tests first.',
2603
help='List the tests instead of running them.'),
2604
Option('randomize', type=str, argname="SEED",
2605
help='Randomize the order of tests using the given'
2606
' seed or "now" for the current time.'),
2607
Option('exclude', type=str, argname="PATTERN",
2609
help='Exclude tests that match this regular'
2611
Option('strict', help='Fail on missing dependencies or '
2613
Option('load-list', type=str, argname='TESTLISTFILE',
2614
help='Load a test id list from a text file.'),
2616
encoding_type = 'replace'
2618
def run(self, testspecs_list=None, verbose=False, one=False,
2619
transport=None, benchmark=None,
2620
lsprof_timed=None, cache_dir=None,
2621
first=False, list_only=False,
2622
randomize=None, exclude=None, strict=False,
2625
from bzrlib.tests import selftest
2626
import bzrlib.benchmarks as benchmarks
2627
from bzrlib.benchmarks import tree_creator
2629
if cache_dir is not None:
2630
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2632
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2633
print ' %s (%s python%s)' % (
2635
bzrlib.version_string,
2636
'.'.join(map(str, sys.version_info)),
2639
if testspecs_list is not None:
2640
pattern = '|'.join(testspecs_list)
2644
test_suite_factory = benchmarks.test_suite
2645
# Unless user explicitly asks for quiet, be verbose in benchmarks
2646
verbose = not is_quiet()
2647
# TODO: should possibly lock the history file...
2648
benchfile = open(".perf_history", "at", buffering=1)
2650
test_suite_factory = None
2653
result = selftest(verbose=verbose,
2655
stop_on_failure=one,
2656
transport=transport,
2657
test_suite_factory=test_suite_factory,
2658
lsprof_timed=lsprof_timed,
2659
bench_history=benchfile,
2660
matching_tests_first=first,
2661
list_only=list_only,
2662
random_seed=randomize,
2663
exclude_pattern=exclude,
2665
load_list=load_list,
2668
if benchfile is not None:
2671
note('tests passed')
2673
note('tests failed')
2674
return int(not result)
2677
class cmd_version(Command):
2678
"""Show version of bzr."""
2680
encoding_type = 'replace'
2684
from bzrlib.version import show_version
2685
show_version(to_file=self.outf)
2688
class cmd_rocks(Command):
2689
"""Statement of optimism."""
2695
print "It sure does!"
2698
class cmd_find_merge_base(Command):
2699
"""Find and print a base revision for merging two branches."""
2700
# TODO: Options to specify revisions on either side, as if
2701
# merging only part of the history.
2702
takes_args = ['branch', 'other']
2706
def run(self, branch, other):
2707
from bzrlib.revision import ensure_null
2709
branch1 = Branch.open_containing(branch)[0]
2710
branch2 = Branch.open_containing(other)[0]
2715
last1 = ensure_null(branch1.last_revision())
2716
last2 = ensure_null(branch2.last_revision())
2718
graph = branch1.repository.get_graph(branch2.repository)
2719
base_rev_id = graph.find_unique_lca(last1, last2)
2721
print 'merge base is revision %s' % base_rev_id
2728
class cmd_merge(Command):
2729
"""Perform a three-way merge.
2731
The branch is the branch you will merge from. By default, it will merge
2732
the latest revision. If you specify a revision, that revision will be
2733
merged. If you specify two revisions, the first will be used as a BASE,
2734
and the second one as OTHER. Revision numbers are always relative to the
2737
By default, bzr will try to merge in all new work from the other
2738
branch, automatically determining an appropriate base. If this
2739
fails, you may need to give an explicit base.
2741
Merge will do its best to combine the changes in two branches, but there
2742
are some kinds of problems only a human can fix. When it encounters those,
2743
it will mark a conflict. A conflict means that you need to fix something,
2744
before you should commit.
2746
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2748
If there is no default branch set, the first merge will set it. After
2749
that, you can omit the branch to use the default. To change the
2750
default, use --remember. The value will only be saved if the remote
2751
location can be accessed.
2753
The results of the merge are placed into the destination working
2754
directory, where they can be reviewed (with bzr diff), tested, and then
2755
committed to record the result of the merge.
2757
merge refuses to run if there are any uncommitted changes, unless
2761
To merge the latest revision from bzr.dev::
2763
bzr merge ../bzr.dev
2765
To merge changes up to and including revision 82 from bzr.dev::
2767
bzr merge -r 82 ../bzr.dev
2769
To merge the changes introduced by 82, without previous changes::
2771
bzr merge -r 81..82 ../bzr.dev
2774
encoding_type = 'exact'
2775
_see_also = ['update', 'remerge', 'status-flags']
2776
takes_args = ['branch?']
2781
help='Merge even if the destination tree has uncommitted changes.'),
2785
Option('show-base', help="Show base revision text in "
2787
Option('uncommitted', help='Apply uncommitted changes'
2788
' from a working copy, instead of branch changes.'),
2789
Option('pull', help='If the destination is already'
2790
' completely merged into the source, pull from the'
2791
' source rather than merging. When this happens,'
2792
' you do not need to commit the result.'),
2794
help='Branch to merge into, '
2795
'rather than the one containing the working directory.',
2799
Option('preview', help='Instead of merging, show a diff of the merge.')
2802
def run(self, branch=None, revision=None, force=False, merge_type=None,
2803
show_base=False, reprocess=False, remember=False,
2804
uncommitted=False, pull=False,
2808
# This is actually a branch (or merge-directive) *location*.
2812
if merge_type is None:
2813
merge_type = _mod_merge.Merge3Merger
2815
if directory is None: directory = u'.'
2816
possible_transports = []
2818
allow_pending = True
2819
verified = 'inapplicable'
2820
tree = WorkingTree.open_containing(directory)[0]
2821
change_reporter = delta._ChangeReporter(
2822
unversioned_filter=tree.is_ignored)
2825
pb = ui.ui_factory.nested_progress_bar()
2826
cleanups.append(pb.finished)
2828
cleanups.append(tree.unlock)
2829
if location is not None:
2830
mergeable, other_transport = _get_mergeable_helper(location)
2833
raise errors.BzrCommandError('Cannot use --uncommitted'
2834
' with bundles or merge directives.')
2836
if revision is not None:
2837
raise errors.BzrCommandError(
2838
'Cannot use -r with merge directives or bundles')
2839
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2841
possible_transports.append(other_transport)
2843
if merger is None and uncommitted:
2844
if revision is not None and len(revision) > 0:
2845
raise errors.BzrCommandError('Cannot use --uncommitted and'
2846
' --revision at the same time.')
2847
location = self._select_branch_location(tree, location)[0]
2848
other_tree, other_path = WorkingTree.open_containing(location)
2849
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2851
allow_pending = False
2852
if other_path != '':
2853
merger.interesting_files = [other_path]
2856
merger, allow_pending = self._get_merger_from_branch(tree,
2857
location, revision, remember, possible_transports, pb)
2859
merger.merge_type = merge_type
2860
merger.reprocess = reprocess
2861
merger.show_base = show_base
2862
self.sanity_check_merger(merger)
2863
if (merger.base_rev_id == merger.other_rev_id and
2864
merger.other_rev_id != None):
2865
note('Nothing to do.')
2868
if merger.interesting_files is not None:
2869
raise errors.BzrCommandError('Cannot pull individual files')
2870
if (merger.base_rev_id == tree.last_revision()):
2871
result = tree.pull(merger.other_branch, False,
2872
merger.other_rev_id)
2873
result.report(self.outf)
2875
merger.check_basis(not force)
2877
return self._do_preview(merger)
2879
return self._do_merge(merger, change_reporter, allow_pending,
2882
for cleanup in reversed(cleanups):
2885
def _do_preview(self, merger):
2886
from bzrlib.diff import show_diff_trees
2887
tree_merger = merger.make_merger()
2888
tt = tree_merger.make_preview_transform()
2890
result_tree = tt.get_preview_tree()
2891
show_diff_trees(merger.this_tree, result_tree, self.outf,
2892
old_label='', new_label='')
2896
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2897
merger.change_reporter = change_reporter
2898
conflict_count = merger.do_merge()
2900
merger.set_pending()
2901
if verified == 'failed':
2902
warning('Preview patch does not match changes')
2903
if conflict_count != 0:
2908
def sanity_check_merger(self, merger):
2909
if (merger.show_base and
2910
not merger.merge_type is _mod_merge.Merge3Merger):
2911
raise errors.BzrCommandError("Show-base is not supported for this"
2912
" merge type. %s" % merger.merge_type)
2913
if merger.reprocess and not merger.merge_type.supports_reprocess:
2914
raise errors.BzrCommandError("Conflict reduction is not supported"
2915
" for merge type %s." %
2917
if merger.reprocess and merger.show_base:
2918
raise errors.BzrCommandError("Cannot do conflict reduction and"
2921
def _get_merger_from_branch(self, tree, location, revision, remember,
2922
possible_transports, pb):
2923
"""Produce a merger from a location, assuming it refers to a branch."""
2924
from bzrlib.tag import _merge_tags_if_possible
2925
assert revision is None or len(revision) < 3
2926
# find the branch locations
2927
other_loc, user_location = self._select_branch_location(tree, location,
2929
if revision is not None and len(revision) == 2:
2930
base_loc, _unused = self._select_branch_location(tree,
2931
location, revision, 0)
2933
base_loc = other_loc
2935
other_branch, other_path = Branch.open_containing(other_loc,
2936
possible_transports)
2937
if base_loc == other_loc:
2938
base_branch = other_branch
2940
base_branch, base_path = Branch.open_containing(base_loc,
2941
possible_transports)
2942
# Find the revision ids
2943
if revision is None or len(revision) < 1 or revision[-1] is None:
2944
other_revision_id = _mod_revision.ensure_null(
2945
other_branch.last_revision())
2947
other_revision_id = \
2948
_mod_revision.ensure_null(
2949
revision[-1].in_history(other_branch).rev_id)
2950
if (revision is not None and len(revision) == 2
2951
and revision[0] is not None):
2952
base_revision_id = \
2953
_mod_revision.ensure_null(
2954
revision[0].in_history(base_branch).rev_id)
2956
base_revision_id = None
2957
# Remember where we merge from
2958
if ((remember or tree.branch.get_submit_branch() is None) and
2959
user_location is not None):
2960
tree.branch.set_submit_branch(other_branch.base)
2961
_merge_tags_if_possible(other_branch, tree.branch)
2962
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2963
other_revision_id, base_revision_id, other_branch, base_branch)
2964
if other_path != '':
2965
allow_pending = False
2966
merger.interesting_files = [other_path]
2968
allow_pending = True
2969
return merger, allow_pending
2971
def _select_branch_location(self, tree, user_location, revision=None,
2973
"""Select a branch location, according to possible inputs.
2975
If provided, branches from ``revision`` are preferred. (Both
2976
``revision`` and ``index`` must be supplied.)
2978
Otherwise, the ``location`` parameter is used. If it is None, then the
2979
``submit`` or ``parent`` location is used, and a note is printed.
2981
:param tree: The working tree to select a branch for merging into
2982
:param location: The location entered by the user
2983
:param revision: The revision parameter to the command
2984
:param index: The index to use for the revision parameter. Negative
2985
indices are permitted.
2986
:return: (selected_location, user_location). The default location
2987
will be the user-entered location.
2989
if (revision is not None and index is not None
2990
and revision[index] is not None):
2991
branch = revision[index].get_branch()
2992
if branch is not None:
2993
return branch, branch
2994
if user_location is None:
2995
location = self._get_remembered(tree, 'Merging from')
2997
location = user_location
2998
return location, user_location
3000
def _get_remembered(self, tree, verb_string):
3001
"""Use tree.branch's parent if none was supplied.
3003
Report if the remembered location was used.
3005
stored_location = tree.branch.get_submit_branch()
3006
if stored_location is None:
3007
stored_location = tree.branch.get_parent()
3008
mutter("%s", stored_location)
3009
if stored_location is None:
3010
raise errors.BzrCommandError("No location specified or remembered")
3011
display_url = urlutils.unescape_for_display(stored_location,
3013
self.outf.write("%s remembered location %s\n" % (verb_string,
3015
return stored_location
3018
class cmd_remerge(Command):
3021
Use this if you want to try a different merge technique while resolving
3022
conflicts. Some merge techniques are better than others, and remerge
3023
lets you try different ones on different files.
3025
The options for remerge have the same meaning and defaults as the ones for
3026
merge. The difference is that remerge can (only) be run when there is a
3027
pending merge, and it lets you specify particular files.
3030
Re-do the merge of all conflicted files, and show the base text in
3031
conflict regions, in addition to the usual THIS and OTHER texts::
3033
bzr remerge --show-base
3035
Re-do the merge of "foobar", using the weave merge algorithm, with
3036
additional processing to reduce the size of conflict regions::
3038
bzr remerge --merge-type weave --reprocess foobar
3040
takes_args = ['file*']
3045
help="Show base revision text in conflicts."),
3048
def run(self, file_list=None, merge_type=None, show_base=False,
3050
if merge_type is None:
3051
merge_type = _mod_merge.Merge3Merger
3052
tree, file_list = tree_files(file_list)
3055
parents = tree.get_parent_ids()
3056
if len(parents) != 2:
3057
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3058
" merges. Not cherrypicking or"
3060
repository = tree.branch.repository
3061
interesting_ids = None
3063
conflicts = tree.conflicts()
3064
if file_list is not None:
3065
interesting_ids = set()
3066
for filename in file_list:
3067
file_id = tree.path2id(filename)
3069
raise errors.NotVersionedError(filename)
3070
interesting_ids.add(file_id)
3071
if tree.kind(file_id) != "directory":
3074
for name, ie in tree.inventory.iter_entries(file_id):
3075
interesting_ids.add(ie.file_id)
3076
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3078
# Remerge only supports resolving contents conflicts
3079
allowed_conflicts = ('text conflict', 'contents conflict')
3080
restore_files = [c.path for c in conflicts
3081
if c.typestring in allowed_conflicts]
3082
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3083
tree.set_conflicts(ConflictList(new_conflicts))
3084
if file_list is not None:
3085
restore_files = file_list
3086
for filename in restore_files:
3088
restore(tree.abspath(filename))
3089
except errors.NotConflicted:
3091
# Disable pending merges, because the file texts we are remerging
3092
# have not had those merges performed. If we use the wrong parents
3093
# list, we imply that the working tree text has seen and rejected
3094
# all the changes from the other tree, when in fact those changes
3095
# have not yet been seen.
3096
pb = ui.ui_factory.nested_progress_bar()
3097
tree.set_parent_ids(parents[:1])
3099
merger = _mod_merge.Merger.from_revision_ids(pb,
3101
merger.interesting_ids = interesting_ids
3102
merger.merge_type = merge_type
3103
merger.show_base = show_base
3104
merger.reprocess = reprocess
3105
conflicts = merger.do_merge()
3107
tree.set_parent_ids(parents)
3117
class cmd_revert(Command):
3118
"""Revert files to a previous revision.
3120
Giving a list of files will revert only those files. Otherwise, all files
3121
will be reverted. If the revision is not specified with '--revision', the
3122
last committed revision is used.
3124
To remove only some changes, without reverting to a prior version, use
3125
merge instead. For example, "merge . --revision -2..-3" will remove the
3126
changes introduced by -2, without affecting the changes introduced by -1.
3127
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3129
By default, any files that have been manually changed will be backed up
3130
first. (Files changed only by merge are not backed up.) Backup files have
3131
'.~#~' appended to their name, where # is a number.
3133
When you provide files, you can use their current pathname or the pathname
3134
from the target revision. So you can use revert to "undelete" a file by
3135
name. If you name a directory, all the contents of that directory will be
3138
Any files that have been newly added since that revision will be deleted,
3139
with a backup kept if appropriate. Directories containing unknown files
3140
will not be deleted.
3142
The working tree contains a list of pending merged revisions, which will
3143
be included as parents in the next commit. Normally, revert clears that
3144
list as well as reverting the files. If any files are specified, revert
3145
leaves the pending merge list alone and reverts only the files. Use "bzr
3146
revert ." in the tree root to revert all files but keep the merge record,
3147
and "bzr revert --forget-merges" to clear the pending merge list without
3148
reverting any files.
3151
_see_also = ['cat', 'export']
3154
Option('no-backup', "Do not save backups of reverted files."),
3155
Option('forget-merges',
3156
'Remove pending merge marker, without changing any files.'),
3158
takes_args = ['file*']
3160
def run(self, revision=None, no_backup=False, file_list=None,
3161
forget_merges=None):
3162
tree, file_list = tree_files(file_list)
3164
tree.set_parent_ids(tree.get_parent_ids()[:1])
3166
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3169
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3170
if revision is None:
3171
rev_id = tree.last_revision()
3172
elif len(revision) != 1:
3173
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3175
rev_id = revision[0].in_history(tree.branch).rev_id
3176
pb = ui.ui_factory.nested_progress_bar()
3178
tree.revert(file_list,
3179
tree.branch.repository.revision_tree(rev_id),
3180
not no_backup, pb, report_changes=True)
3185
class cmd_assert_fail(Command):
3186
"""Test reporting of assertion failures"""
3187
# intended just for use in testing
3192
raise AssertionError("always fails")
3195
class cmd_help(Command):
3196
"""Show help on a command or other topic.
3199
_see_also = ['topics']
3201
Option('long', 'Show help on all commands.'),
3203
takes_args = ['topic?']
3204
aliases = ['?', '--help', '-?', '-h']
3207
def run(self, topic=None, long=False):
3209
if topic is None and long:
3211
bzrlib.help.help(topic)
3214
class cmd_shell_complete(Command):
3215
"""Show appropriate completions for context.
3217
For a list of all available commands, say 'bzr shell-complete'.
3219
takes_args = ['context?']
3224
def run(self, context=None):
3225
import shellcomplete
3226
shellcomplete.shellcomplete(context)
3229
class cmd_fetch(Command):
3230
"""Copy in history from another branch but don't merge it.
3232
This is an internal method used for pull and merge.
3235
takes_args = ['from_branch', 'to_branch']
3236
def run(self, from_branch, to_branch):
3237
from bzrlib.fetch import Fetcher
3238
from_b = Branch.open(from_branch)
3239
to_b = Branch.open(to_branch)
3240
Fetcher(to_b, from_b)
3243
class cmd_missing(Command):
3244
"""Show unmerged/unpulled revisions between two branches.
3246
OTHER_BRANCH may be local or remote.
3249
_see_also = ['merge', 'pull']
3250
takes_args = ['other_branch?']
3252
Option('reverse', 'Reverse the order of revisions.'),
3254
'Display changes in the local branch only.'),
3255
Option('this' , 'Same as --mine-only.'),
3256
Option('theirs-only',
3257
'Display changes in the remote branch only.'),
3258
Option('other', 'Same as --theirs-only.'),
3263
encoding_type = 'replace'
3266
def run(self, other_branch=None, reverse=False, mine_only=False,
3267
theirs_only=False, log_format=None, long=False, short=False, line=False,
3268
show_ids=False, verbose=False, this=False, other=False):
3269
from bzrlib.missing import find_unmerged, iter_log_revisions
3276
local_branch = Branch.open_containing(u".")[0]
3277
parent = local_branch.get_parent()
3278
if other_branch is None:
3279
other_branch = parent
3280
if other_branch is None:
3281
raise errors.BzrCommandError("No peer location known"
3283
display_url = urlutils.unescape_for_display(parent,
3285
self.outf.write("Using last location: " + display_url + "\n")
3287
remote_branch = Branch.open(other_branch)
3288
if remote_branch.base == local_branch.base:
3289
remote_branch = local_branch
3290
local_branch.lock_read()
3292
remote_branch.lock_read()
3294
local_extra, remote_extra = find_unmerged(local_branch,
3296
if log_format is None:
3297
registry = log.log_formatter_registry
3298
log_format = registry.get_default(local_branch)
3299
lf = log_format(to_file=self.outf,
3301
show_timezone='original')
3302
if reverse is False:
3303
local_extra.reverse()
3304
remote_extra.reverse()
3305
if local_extra and not theirs_only:
3306
self.outf.write("You have %d extra revision(s):\n" %
3308
for revision in iter_log_revisions(local_extra,
3309
local_branch.repository,
3311
lf.log_revision(revision)
3312
printed_local = True
3314
printed_local = False
3315
if remote_extra and not mine_only:
3316
if printed_local is True:
3317
self.outf.write("\n\n\n")
3318
self.outf.write("You are missing %d revision(s):\n" %
3320
for revision in iter_log_revisions(remote_extra,
3321
remote_branch.repository,
3323
lf.log_revision(revision)
3324
if not remote_extra and not local_extra:
3326
self.outf.write("Branches are up to date.\n")
3330
remote_branch.unlock()
3332
local_branch.unlock()
3333
if not status_code and parent is None and other_branch is not None:
3334
local_branch.lock_write()
3336
# handle race conditions - a parent might be set while we run.
3337
if local_branch.get_parent() is None:
3338
local_branch.set_parent(remote_branch.base)
3340
local_branch.unlock()
3344
class cmd_pack(Command):
3345
"""Compress the data within a repository."""
3347
_see_also = ['repositories']
3348
takes_args = ['branch_or_repo?']
3350
def run(self, branch_or_repo='.'):
3351
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3353
branch = dir.open_branch()
3354
repository = branch.repository
3355
except errors.NotBranchError:
3356
repository = dir.open_repository()
3360
class cmd_plugins(Command):
3361
"""List the installed plugins.
3363
This command displays the list of installed plugins including
3364
version of plugin and a short description of each.
3366
--verbose shows the path where each plugin is located.
3368
A plugin is an external component for Bazaar that extends the
3369
revision control system, by adding or replacing code in Bazaar.
3370
Plugins can do a variety of things, including overriding commands,
3371
adding new commands, providing additional network transports and
3372
customizing log output.
3374
See the Bazaar web site, http://bazaar-vcs.org, for further
3375
information on plugins including where to find them and how to
3376
install them. Instructions are also provided there on how to
3377
write new plugins using the Python programming language.
3379
takes_options = ['verbose']
3382
def run(self, verbose=False):
3383
import bzrlib.plugin
3384
from inspect import getdoc
3386
for name, plugin in bzrlib.plugin.plugins().items():
3387
version = plugin.__version__
3388
if version == 'unknown':
3390
name_ver = '%s %s' % (name, version)
3391
d = getdoc(plugin.module)
3393
doc = d.split('\n')[0]
3395
doc = '(no description)'
3396
result.append((name_ver, doc, plugin.path()))
3397
for name_ver, doc, path in sorted(result):
3405
class cmd_testament(Command):
3406
"""Show testament (signing-form) of a revision."""
3409
Option('long', help='Produce long-format testament.'),
3411
help='Produce a strict-format testament.')]
3412
takes_args = ['branch?']
3414
def run(self, branch=u'.', revision=None, long=False, strict=False):
3415
from bzrlib.testament import Testament, StrictTestament
3417
testament_class = StrictTestament
3419
testament_class = Testament
3420
b = WorkingTree.open_containing(branch)[0].branch
3423
if revision is None:
3424
rev_id = b.last_revision()
3426
rev_id = revision[0].in_history(b).rev_id
3427
t = testament_class.from_revision(b.repository, rev_id)
3429
sys.stdout.writelines(t.as_text_lines())
3431
sys.stdout.write(t.as_short_text())
3436
class cmd_annotate(Command):
3437
"""Show the origin of each line in a file.
3439
This prints out the given file with an annotation on the left side
3440
indicating which revision, author and date introduced the change.
3442
If the origin is the same for a run of consecutive lines, it is
3443
shown only at the top, unless the --all option is given.
3445
# TODO: annotate directories; showing when each file was last changed
3446
# TODO: if the working copy is modified, show annotations on that
3447
# with new uncommitted lines marked
3448
aliases = ['ann', 'blame', 'praise']
3449
takes_args = ['filename']
3450
takes_options = [Option('all', help='Show annotations on all lines.'),
3451
Option('long', help='Show commit date in annotations.'),
3455
encoding_type = 'exact'
3458
def run(self, filename, all=False, long=False, revision=None,
3460
from bzrlib.annotate import annotate_file
3461
wt, branch, relpath = \
3462
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3468
if revision is None:
3469
revision_id = branch.last_revision()
3470
elif len(revision) != 1:
3471
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3473
revision_id = revision[0].in_history(branch).rev_id
3474
tree = branch.repository.revision_tree(revision_id)
3476
file_id = wt.path2id(relpath)
3478
file_id = tree.path2id(relpath)
3480
raise errors.NotVersionedError(filename)
3481
file_version = tree.inventory[file_id].revision
3482
annotate_file(branch, file_version, file_id, long, all, self.outf,
3491
class cmd_re_sign(Command):
3492
"""Create a digital signature for an existing revision."""
3493
# TODO be able to replace existing ones.
3495
hidden = True # is this right ?
3496
takes_args = ['revision_id*']
3497
takes_options = ['revision']
3499
def run(self, revision_id_list=None, revision=None):
3500
if revision_id_list is not None and revision is not None:
3501
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3502
if revision_id_list is None and revision is None:
3503
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3504
b = WorkingTree.open_containing(u'.')[0].branch
3507
return self._run(b, revision_id_list, revision)
3511
def _run(self, b, revision_id_list, revision):
3512
import bzrlib.gpg as gpg
3513
gpg_strategy = gpg.GPGStrategy(b.get_config())
3514
if revision_id_list is not None:
3515
b.repository.start_write_group()
3517
for revision_id in revision_id_list:
3518
b.repository.sign_revision(revision_id, gpg_strategy)
3520
b.repository.abort_write_group()
3523
b.repository.commit_write_group()
3524
elif revision is not None:
3525
if len(revision) == 1:
3526
revno, rev_id = revision[0].in_history(b)
3527
b.repository.start_write_group()
3529
b.repository.sign_revision(rev_id, gpg_strategy)
3531
b.repository.abort_write_group()
3534
b.repository.commit_write_group()
3535
elif len(revision) == 2:
3536
# are they both on rh- if so we can walk between them
3537
# might be nice to have a range helper for arbitrary
3538
# revision paths. hmm.
3539
from_revno, from_revid = revision[0].in_history(b)
3540
to_revno, to_revid = revision[1].in_history(b)
3541
if to_revid is None:
3542
to_revno = b.revno()
3543
if from_revno is None or to_revno is None:
3544
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3545
b.repository.start_write_group()
3547
for revno in range(from_revno, to_revno + 1):
3548
b.repository.sign_revision(b.get_rev_id(revno),
3551
b.repository.abort_write_group()
3554
b.repository.commit_write_group()
3556
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3559
class cmd_bind(Command):
3560
"""Convert the current branch into a checkout of the supplied branch.
3562
Once converted into a checkout, commits must succeed on the master branch
3563
before they will be applied to the local branch.
3566
_see_also = ['checkouts', 'unbind']
3567
takes_args = ['location?']
3570
def run(self, location=None):
3571
b, relpath = Branch.open_containing(u'.')
3572
if location is None:
3574
location = b.get_old_bound_location()
3575
except errors.UpgradeRequired:
3576
raise errors.BzrCommandError('No location supplied. '
3577
'This format does not remember old locations.')
3579
if location is None:
3580
raise errors.BzrCommandError('No location supplied and no '
3581
'previous location known')
3582
b_other = Branch.open(location)
3585
except errors.DivergedBranches:
3586
raise errors.BzrCommandError('These branches have diverged.'
3587
' Try merging, and then bind again.')
3590
class cmd_unbind(Command):
3591
"""Convert the current checkout into a regular branch.
3593
After unbinding, the local branch is considered independent and subsequent
3594
commits will be local only.
3597
_see_also = ['checkouts', 'bind']
3602
b, relpath = Branch.open_containing(u'.')
3604
raise errors.BzrCommandError('Local branch is not bound')
3607
class cmd_uncommit(Command):
3608
"""Remove the last committed revision.
3610
--verbose will print out what is being removed.
3611
--dry-run will go through all the motions, but not actually
3614
If --revision is specified, uncommit revisions to leave the branch at the
3615
specified revision. For example, "bzr uncommit -r 15" will leave the
3616
branch at revision 15.
3618
In the future, uncommit will create a revision bundle, which can then
3622
# TODO: jam 20060108 Add an option to allow uncommit to remove
3623
# unreferenced information in 'branch-as-repository' branches.
3624
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3625
# information in shared branches as well.
3626
_see_also = ['commit']
3627
takes_options = ['verbose', 'revision',
3628
Option('dry-run', help='Don\'t actually make changes.'),
3629
Option('force', help='Say yes to all questions.')]
3630
takes_args = ['location?']
3632
encoding_type = 'replace'
3634
def run(self, location=None,
3635
dry_run=False, verbose=False,
3636
revision=None, force=False):
3637
if location is None:
3639
control, relpath = bzrdir.BzrDir.open_containing(location)
3641
tree = control.open_workingtree()
3643
except (errors.NoWorkingTree, errors.NotLocalUrl):
3645
b = control.open_branch()
3647
if tree is not None:
3652
return self._run(b, tree, dry_run, verbose, revision, force)
3654
if tree is not None:
3659
def _run(self, b, tree, dry_run, verbose, revision, force):
3660
from bzrlib.log import log_formatter, show_log
3661
from bzrlib.uncommit import uncommit
3663
last_revno, last_rev_id = b.last_revision_info()
3666
if revision is None:
3668
rev_id = last_rev_id
3670
# 'bzr uncommit -r 10' actually means uncommit
3671
# so that the final tree is at revno 10.
3672
# but bzrlib.uncommit.uncommit() actually uncommits
3673
# the revisions that are supplied.
3674
# So we need to offset it by one
3675
revno = revision[0].in_history(b).revno + 1
3676
if revno <= last_revno:
3677
rev_id = b.get_rev_id(revno)
3679
if rev_id is None or _mod_revision.is_null(rev_id):
3680
self.outf.write('No revisions to uncommit.\n')
3683
lf = log_formatter('short',
3685
show_timezone='original')
3690
direction='forward',
3691
start_revision=revno,
3692
end_revision=last_revno)
3695
print 'Dry-run, pretending to remove the above revisions.'
3697
val = raw_input('Press <enter> to continue')
3699
print 'The above revision(s) will be removed.'
3701
val = raw_input('Are you sure [y/N]? ')
3702
if val.lower() not in ('y', 'yes'):
3706
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3710
class cmd_break_lock(Command):
3711
"""Break a dead lock on a repository, branch or working directory.
3713
CAUTION: Locks should only be broken when you are sure that the process
3714
holding the lock has been stopped.
3716
You can get information on what locks are open via the 'bzr info' command.
3721
takes_args = ['location?']
3723
def run(self, location=None, show=False):
3724
if location is None:
3726
control, relpath = bzrdir.BzrDir.open_containing(location)
3728
control.break_lock()
3729
except NotImplementedError:
3733
class cmd_wait_until_signalled(Command):
3734
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3736
This just prints a line to signal when it is ready, then blocks on stdin.
3742
sys.stdout.write("running\n")
3744
sys.stdin.readline()
3747
class cmd_serve(Command):
3748
"""Run the bzr server."""
3750
aliases = ['server']
3754
help='Serve on stdin/out for use from inetd or sshd.'),
3756
help='Listen for connections on nominated port of the form '
3757
'[hostname:]portnumber. Passing 0 as the port number will '
3758
'result in a dynamically allocated port. The default port is '
3762
help='Serve contents of this directory.',
3764
Option('allow-writes',
3765
help='By default the server is a readonly server. Supplying '
3766
'--allow-writes enables write access to the contents of '
3767
'the served directory and below.'
3771
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3772
from bzrlib import lockdir
3773
from bzrlib.smart import medium, server
3774
from bzrlib.transport import get_transport
3775
from bzrlib.transport.chroot import ChrootServer
3776
if directory is None:
3777
directory = os.getcwd()
3778
url = urlutils.local_path_to_url(directory)
3779
if not allow_writes:
3780
url = 'readonly+' + url
3781
chroot_server = ChrootServer(get_transport(url))
3782
chroot_server.setUp()
3783
t = get_transport(chroot_server.get_url())
3785
smart_server = medium.SmartServerPipeStreamMedium(
3786
sys.stdin, sys.stdout, t)
3788
host = medium.BZR_DEFAULT_INTERFACE
3790
port = medium.BZR_DEFAULT_PORT
3793
host, port = port.split(':')
3795
smart_server = server.SmartTCPServer(t, host=host, port=port)
3796
print 'listening on port: ', smart_server.port
3798
# for the duration of this server, no UI output is permitted.
3799
# note that this may cause problems with blackbox tests. This should
3800
# be changed with care though, as we dont want to use bandwidth sending
3801
# progress over stderr to smart server clients!
3802
old_factory = ui.ui_factory
3803
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3805
ui.ui_factory = ui.SilentUIFactory()
3806
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3807
smart_server.serve()
3809
ui.ui_factory = old_factory
3810
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3813
class cmd_join(Command):
3814
"""Combine a subtree into its containing tree.
3816
This command is for experimental use only. It requires the target tree
3817
to be in dirstate-with-subtree format, which cannot be converted into
3820
The TREE argument should be an independent tree, inside another tree, but
3821
not part of it. (Such trees can be produced by "bzr split", but also by
3822
running "bzr branch" with the target inside a tree.)
3824
The result is a combined tree, with the subtree no longer an independant
3825
part. This is marked as a merge of the subtree into the containing tree,
3826
and all history is preserved.
3828
If --reference is specified, the subtree retains its independence. It can
3829
be branched by itself, and can be part of multiple projects at the same
3830
time. But operations performed in the containing tree, such as commit
3831
and merge, will recurse into the subtree.
3834
_see_also = ['split']
3835
takes_args = ['tree']
3837
Option('reference', help='Join by reference.'),
3841
def run(self, tree, reference=False):
3842
sub_tree = WorkingTree.open(tree)
3843
parent_dir = osutils.dirname(sub_tree.basedir)
3844
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3845
repo = containing_tree.branch.repository
3846
if not repo.supports_rich_root():
3847
raise errors.BzrCommandError(
3848
"Can't join trees because %s doesn't support rich root data.\n"
3849
"You can use bzr upgrade on the repository."
3853
containing_tree.add_reference(sub_tree)
3854
except errors.BadReferenceTarget, e:
3855
# XXX: Would be better to just raise a nicely printable
3856
# exception from the real origin. Also below. mbp 20070306
3857
raise errors.BzrCommandError("Cannot join %s. %s" %
3861
containing_tree.subsume(sub_tree)
3862
except errors.BadSubsumeSource, e:
3863
raise errors.BzrCommandError("Cannot join %s. %s" %
3867
class cmd_split(Command):
3868
"""Split a subdirectory of a tree into a separate tree.
3870
This command will produce a target tree in a format that supports
3871
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3872
converted into earlier formats like 'dirstate-tags'.
3874
The TREE argument should be a subdirectory of a working tree. That
3875
subdirectory will be converted into an independent tree, with its own
3876
branch. Commits in the top-level tree will not apply to the new subtree.
3879
# join is not un-hidden yet
3880
#_see_also = ['join']
3881
takes_args = ['tree']
3883
def run(self, tree):
3884
containing_tree, subdir = WorkingTree.open_containing(tree)
3885
sub_id = containing_tree.path2id(subdir)
3887
raise errors.NotVersionedError(subdir)
3889
containing_tree.extract(sub_id)
3890
except errors.RootNotRich:
3891
raise errors.UpgradeRequired(containing_tree.branch.base)
3894
class cmd_merge_directive(Command):
3895
"""Generate a merge directive for auto-merge tools.
3897
A directive requests a merge to be performed, and also provides all the
3898
information necessary to do so. This means it must either include a
3899
revision bundle, or the location of a branch containing the desired
3902
A submit branch (the location to merge into) must be supplied the first
3903
time the command is issued. After it has been supplied once, it will
3904
be remembered as the default.
3906
A public branch is optional if a revision bundle is supplied, but required
3907
if --diff or --plain is specified. It will be remembered as the default
3908
after the first use.
3911
takes_args = ['submit_branch?', 'public_branch?']
3915
_see_also = ['send']
3918
RegistryOption.from_kwargs('patch-type',
3919
'The type of patch to include in the directive.',
3921
value_switches=True,
3923
bundle='Bazaar revision bundle (default).',
3924
diff='Normal unified diff.',
3925
plain='No patch, just directive.'),
3926
Option('sign', help='GPG-sign the directive.'), 'revision',
3927
Option('mail-to', type=str,
3928
help='Instead of printing the directive, email to this address.'),
3929
Option('message', type=str, short_name='m',
3930
help='Message to use when committing this merge.')
3933
encoding_type = 'exact'
3935
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3936
sign=False, revision=None, mail_to=None, message=None):
3937
from bzrlib.revision import ensure_null, NULL_REVISION
3938
include_patch, include_bundle = {
3939
'plain': (False, False),
3940
'diff': (True, False),
3941
'bundle': (True, True),
3943
branch = Branch.open('.')
3944
stored_submit_branch = branch.get_submit_branch()
3945
if submit_branch is None:
3946
submit_branch = stored_submit_branch
3948
if stored_submit_branch is None:
3949
branch.set_submit_branch(submit_branch)
3950
if submit_branch is None:
3951
submit_branch = branch.get_parent()
3952
if submit_branch is None:
3953
raise errors.BzrCommandError('No submit branch specified or known')
3955
stored_public_branch = branch.get_public_branch()
3956
if public_branch is None:
3957
public_branch = stored_public_branch
3958
elif stored_public_branch is None:
3959
branch.set_public_branch(public_branch)
3960
if not include_bundle and public_branch is None:
3961
raise errors.BzrCommandError('No public branch specified or'
3963
base_revision_id = None
3964
if revision is not None:
3965
if len(revision) > 2:
3966
raise errors.BzrCommandError('bzr merge-directive takes '
3967
'at most two one revision identifiers')
3968
revision_id = revision[-1].in_history(branch).rev_id
3969
if len(revision) == 2:
3970
base_revision_id = revision[0].in_history(branch).rev_id
3971
base_revision_id = ensure_null(base_revision_id)
3973
revision_id = branch.last_revision()
3974
revision_id = ensure_null(revision_id)
3975
if revision_id == NULL_REVISION:
3976
raise errors.BzrCommandError('No revisions to bundle.')
3977
directive = merge_directive.MergeDirective2.from_objects(
3978
branch.repository, revision_id, time.time(),
3979
osutils.local_time_offset(), submit_branch,
3980
public_branch=public_branch, include_patch=include_patch,
3981
include_bundle=include_bundle, message=message,
3982
base_revision_id=base_revision_id)
3985
self.outf.write(directive.to_signed(branch))
3987
self.outf.writelines(directive.to_lines())
3989
message = directive.to_email(mail_to, branch, sign)
3990
s = SMTPConnection(branch.get_config())
3991
s.send_email(message)
3994
class cmd_send(Command):
3995
"""Mail or create a merge-directive for submiting changes.
3997
A merge directive provides many things needed for requesting merges:
3999
* A machine-readable description of the merge to perform
4001
* An optional patch that is a preview of the changes requested
4003
* An optional bundle of revision data, so that the changes can be applied
4004
directly from the merge directive, without retrieving data from a
4007
If --no-bundle is specified, then public_branch is needed (and must be
4008
up-to-date), so that the receiver can perform the merge using the
4009
public_branch. The public_branch is always included if known, so that
4010
people can check it later.
4012
The submit branch defaults to the parent, but can be overridden. Both
4013
submit branch and public branch will be remembered if supplied.
4015
If a public_branch is known for the submit_branch, that public submit
4016
branch is used in the merge instructions. This means that a local mirror
4017
can be used as your actual submit branch, once you have set public_branch
4020
Mail is sent using your preferred mail program. This should be transparent
4021
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4022
If the preferred client can't be found (or used), your editor will be used.
4024
To use a specific mail program, set the mail_client configuration option.
4025
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4026
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4027
generic options are "default", "editor", "mapi", and "xdg-email".
4029
If mail is being sent, a to address is required. This can be supplied
4030
either on the commandline, or by setting the submit_to configuration
4033
Two formats are currently supported: "4" uses revision bundle format 4 and
4034
merge directive format 2. It is significantly faster and smaller than
4035
older formats. It is compatible with Bazaar 0.19 and later. It is the
4036
default. "0.9" uses revision bundle format 0.9 and merge directive
4037
format 1. It is compatible with Bazaar 0.12 - 0.18.
4040
encoding_type = 'exact'
4042
_see_also = ['merge']
4044
takes_args = ['submit_branch?', 'public_branch?']
4048
help='Do not include a bundle in the merge directive.'),
4049
Option('no-patch', help='Do not include a preview patch in the merge'
4052
help='Remember submit and public branch.'),
4054
help='Branch to generate the submission from, '
4055
'rather than the one containing the working directory.',
4058
Option('output', short_name='o', help='Write directive to this file.',
4060
Option('mail-to', help='Mail the request to this address.',
4064
RegistryOption.from_kwargs('format',
4065
'Use the specified output format.',
4066
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4067
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4070
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4071
no_patch=False, revision=None, remember=False, output=None,
4072
format='4', mail_to=None, message=None, **kwargs):
4073
return self._run(submit_branch, revision, public_branch, remember,
4074
format, no_bundle, no_patch, output,
4075
kwargs.get('from', '.'), mail_to, message)
4077
def _run(self, submit_branch, revision, public_branch, remember, format,
4078
no_bundle, no_patch, output, from_, mail_to, message):
4079
from bzrlib.revision import NULL_REVISION
4080
branch = Branch.open_containing(from_)[0]
4082
outfile = StringIO()
4086
outfile = open(output, 'wb')
4087
# we may need to write data into branch's repository to calculate
4092
config = branch.get_config()
4094
mail_to = config.get_user_option('submit_to')
4095
mail_client = config.get_mail_client()
4096
if remember and submit_branch is None:
4097
raise errors.BzrCommandError(
4098
'--remember requires a branch to be specified.')
4099
stored_submit_branch = branch.get_submit_branch()
4100
remembered_submit_branch = False
4101
if submit_branch is None:
4102
submit_branch = stored_submit_branch
4103
remembered_submit_branch = True
4105
if stored_submit_branch is None or remember:
4106
branch.set_submit_branch(submit_branch)
4107
if submit_branch is None:
4108
submit_branch = branch.get_parent()
4109
remembered_submit_branch = True
4110
if submit_branch is None:
4111
raise errors.BzrCommandError('No submit branch known or'
4113
if remembered_submit_branch:
4114
note('Using saved location: %s', submit_branch)
4116
stored_public_branch = branch.get_public_branch()
4117
if public_branch is None:
4118
public_branch = stored_public_branch
4119
elif stored_public_branch is None or remember:
4120
branch.set_public_branch(public_branch)
4121
if no_bundle and public_branch is None:
4122
raise errors.BzrCommandError('No public branch specified or'
4124
base_revision_id = None
4126
if revision is not None:
4127
if len(revision) > 2:
4128
raise errors.BzrCommandError('bzr send takes '
4129
'at most two one revision identifiers')
4130
revision_id = revision[-1].in_history(branch).rev_id
4131
if len(revision) == 2:
4132
base_revision_id = revision[0].in_history(branch).rev_id
4133
if revision_id is None:
4134
revision_id = branch.last_revision()
4135
if revision_id == NULL_REVISION:
4136
raise errors.BzrCommandError('No revisions to submit.')
4138
directive = merge_directive.MergeDirective2.from_objects(
4139
branch.repository, revision_id, time.time(),
4140
osutils.local_time_offset(), submit_branch,
4141
public_branch=public_branch, include_patch=not no_patch,
4142
include_bundle=not no_bundle, message=message,
4143
base_revision_id=base_revision_id)
4144
elif format == '0.9':
4147
patch_type = 'bundle'
4149
raise errors.BzrCommandError('Format 0.9 does not'
4150
' permit bundle with no patch')
4156
directive = merge_directive.MergeDirective.from_objects(
4157
branch.repository, revision_id, time.time(),
4158
osutils.local_time_offset(), submit_branch,
4159
public_branch=public_branch, patch_type=patch_type,
4162
outfile.writelines(directive.to_lines())
4164
subject = '[MERGE] '
4165
if message is not None:
4168
revision = branch.repository.get_revision(revision_id)
4169
subject += revision.get_summary()
4170
mail_client.compose_merge_request(mail_to, subject,
4178
class cmd_bundle_revisions(cmd_send):
4180
"""Create a merge-directive for submiting changes.
4182
A merge directive provides many things needed for requesting merges:
4184
* A machine-readable description of the merge to perform
4186
* An optional patch that is a preview of the changes requested
4188
* An optional bundle of revision data, so that the changes can be applied
4189
directly from the merge directive, without retrieving data from a
4192
If --no-bundle is specified, then public_branch is needed (and must be
4193
up-to-date), so that the receiver can perform the merge using the
4194
public_branch. The public_branch is always included if known, so that
4195
people can check it later.
4197
The submit branch defaults to the parent, but can be overridden. Both
4198
submit branch and public branch will be remembered if supplied.
4200
If a public_branch is known for the submit_branch, that public submit
4201
branch is used in the merge instructions. This means that a local mirror
4202
can be used as your actual submit branch, once you have set public_branch
4205
Two formats are currently supported: "4" uses revision bundle format 4 and
4206
merge directive format 2. It is significantly faster and smaller than
4207
older formats. It is compatible with Bazaar 0.19 and later. It is the
4208
default. "0.9" uses revision bundle format 0.9 and merge directive
4209
format 1. It is compatible with Bazaar 0.12 - 0.18.
4214
help='Do not include a bundle in the merge directive.'),
4215
Option('no-patch', help='Do not include a preview patch in the merge'
4218
help='Remember submit and public branch.'),
4220
help='Branch to generate the submission from, '
4221
'rather than the one containing the working directory.',
4224
Option('output', short_name='o', help='Write directive to this file.',
4227
RegistryOption.from_kwargs('format',
4228
'Use the specified output format.',
4229
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4230
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4232
aliases = ['bundle']
4234
_see_also = ['send', 'merge']
4238
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4239
no_patch=False, revision=None, remember=False, output=None,
4240
format='4', **kwargs):
4243
return self._run(submit_branch, revision, public_branch, remember,
4244
format, no_bundle, no_patch, output,
4245
kwargs.get('from', '.'), None, None)
4248
class cmd_tag(Command):
4249
"""Create, remove or modify a tag naming a revision.
4251
Tags give human-meaningful names to revisions. Commands that take a -r
4252
(--revision) option can be given -rtag:X, where X is any previously
4255
Tags are stored in the branch. Tags are copied from one branch to another
4256
along when you branch, push, pull or merge.
4258
It is an error to give a tag name that already exists unless you pass
4259
--force, in which case the tag is moved to point to the new revision.
4262
_see_also = ['commit', 'tags']
4263
takes_args = ['tag_name']
4266
help='Delete this tag rather than placing it.',
4269
help='Branch in which to place the tag.',
4274
help='Replace existing tags.',
4279
def run(self, tag_name,
4285
branch, relpath = Branch.open_containing(directory)
4289
branch.tags.delete_tag(tag_name)
4290
self.outf.write('Deleted tag %s.\n' % tag_name)
4293
if len(revision) != 1:
4294
raise errors.BzrCommandError(
4295
"Tags can only be placed on a single revision, "
4297
revision_id = revision[0].in_history(branch).rev_id
4299
revision_id = branch.last_revision()
4300
if (not force) and branch.tags.has_tag(tag_name):
4301
raise errors.TagAlreadyExists(tag_name)
4302
branch.tags.set_tag(tag_name, revision_id)
4303
self.outf.write('Created tag %s.\n' % tag_name)
4308
class cmd_tags(Command):
4311
This command shows a table of tag names and the revisions they reference.
4317
help='Branch whose tags should be displayed.',
4321
RegistryOption.from_kwargs('sort',
4322
'Sort tags by different criteria.', title='Sorting',
4323
alpha='Sort tags lexicographically (default).',
4324
time='Sort tags chronologically.',
4335
branch, relpath = Branch.open_containing(directory)
4336
tags = branch.tags.get_tag_dict().items()
4339
elif sort == 'time':
4341
for tag, revid in tags:
4343
revobj = branch.repository.get_revision(revid)
4344
except errors.NoSuchRevision:
4345
timestamp = sys.maxint # place them at the end
4347
timestamp = revobj.timestamp
4348
timestamps[revid] = timestamp
4349
tags.sort(key=lambda x: timestamps[x[1]])
4351
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4352
revno_map = branch.get_revision_id_to_revno_map()
4353
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4354
for tag, revid in tags ]
4355
for tag, revspec in tags:
4356
self.outf.write('%-20s %s\n' % (tag, revspec))
4359
class cmd_reconfigure(Command):
4360
"""Reconfigure the type of a bzr directory.
4362
A target configuration must be specified.
4364
For checkouts, the bind-to location will be auto-detected if not specified.
4365
The order of preference is
4366
1. For a lightweight checkout, the current bound location.
4367
2. For branches that used to be checkouts, the previously-bound location.
4368
3. The push location.
4369
4. The parent location.
4370
If none of these is available, --bind-to must be specified.
4373
takes_args = ['location?']
4374
takes_options = [RegistryOption.from_kwargs('target_type',
4375
title='Target type',
4376
help='The type to reconfigure the directory to.',
4377
value_switches=True, enum_switch=False,
4378
branch='Reconfigure to a branch.',
4379
tree='Reconfigure to a tree.',
4380
checkout='Reconfigure to a checkout.',
4381
lightweight_checkout='Reconfigure to a lightweight'
4383
Option('bind-to', help='Branch to bind checkout to.',
4386
help='Perform reconfiguration even if local changes'
4390
def run(self, location=None, target_type=None, bind_to=None, force=False):
4391
directory = bzrdir.BzrDir.open(location)
4392
if target_type is None:
4393
raise errors.BzrCommandError('No target configuration specified')
4394
elif target_type == 'branch':
4395
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4396
elif target_type == 'tree':
4397
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4398
elif target_type == 'checkout':
4399
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4401
elif target_type == 'lightweight-checkout':
4402
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4404
reconfiguration.apply(force)
4407
class cmd_switch(Command):
4408
"""Set the branch of a checkout and update.
4410
For lightweight checkouts, this changes the branch being referenced.
4411
For heavyweight checkouts, this checks that there are no local commits
4412
versus the current bound branch, then it makes the local branch a mirror
4413
of the new location and binds to it.
4415
In both cases, the working tree is updated and uncommitted changes
4416
are merged. The user can commit or revert these as they desire.
4418
Pending merges need to be committed or reverted before using switch.
4421
takes_args = ['to_location']
4422
takes_options = [Option('force',
4423
help='Switch even if local commits will be lost.')
4426
def run(self, to_location, force=False):
4427
from bzrlib import switch
4428
to_branch = Branch.open(to_location)
4430
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4431
switch.switch(control_dir, to_branch, force)
4432
note('Switched to branch: %s',
4433
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4436
def _create_prefix(cur_transport):
4437
needed = [cur_transport]
4438
# Recurse upwards until we can create a directory successfully
4440
new_transport = cur_transport.clone('..')
4441
if new_transport.base == cur_transport.base:
4442
raise errors.BzrCommandError(
4443
"Failed to create path prefix for %s."
4444
% cur_transport.base)
4446
new_transport.mkdir('.')
4447
except errors.NoSuchFile:
4448
needed.append(new_transport)
4449
cur_transport = new_transport
4452
# Now we only need to create child directories
4454
cur_transport = needed.pop()
4455
cur_transport.ensure_base()
4458
def _get_mergeable_helper(location):
4459
"""Get a merge directive or bundle if 'location' points to one.
4461
Try try to identify a bundle and returns its mergeable form. If it's not,
4462
we return the tried transport anyway so that it can reused to access the
4465
:param location: can point to a bundle or a branch.
4467
:return: mergeable, transport
4470
url = urlutils.normalize_url(location)
4471
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4472
location_transport = transport.get_transport(url)
4475
# There may be redirections but we ignore the intermediate
4476
# and final transports used
4477
read = bundle.read_mergeable_from_transport
4478
mergeable, t = read(location_transport, filename)
4479
except errors.NotABundle:
4480
# Continue on considering this url a Branch but adjust the
4481
# location_transport
4482
location_transport = location_transport.clone(filename)
4483
return mergeable, location_transport
4486
# these get imported and then picked up by the scan for cmd_*
4487
# TODO: Some more consistent way to split command definitions across files;
4488
# we do need to load at least some information about them to know of
4489
# aliases. ideally we would avoid loading the implementation until the
4490
# details were needed.
4491
from bzrlib.cmd_version_info import cmd_version_info
4492
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4493
from bzrlib.bundle.commands import (
4496
from bzrlib.sign_my_commits import cmd_sign_my_commits
4497
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4498
cmd_weave_plan_merge, cmd_weave_merge_text