1
# Copyright (C) 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
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
19
At format 7 this was split out into Branch, Repository and Checkout control
23
# TODO: Can we move specific formats into separate modules to make this file
26
from cStringIO import StringIO
30
from bzrlib.lazy_import import lazy_import
31
lazy_import(globals(), """
32
from stat import S_ISDIR
41
revision as _mod_revision,
50
from bzrlib.osutils import (
54
from bzrlib.smart.client import _SmartClient
55
from bzrlib.smart import protocol
56
from bzrlib.store.revision.text import TextRevisionStore
57
from bzrlib.store.text import TextStore
58
from bzrlib.store.versioned import WeaveStore
59
from bzrlib.transactions import WriteTransaction
60
from bzrlib.transport import (
61
do_catching_redirections,
64
from bzrlib.weave import Weave
67
from bzrlib.trace import (
71
from bzrlib.transport.local import LocalTransport
75
"""A .bzr control diretory.
77
BzrDir instances let you create or open any of the things that can be
78
found within .bzr - checkouts, branches and repositories.
81
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
83
a transport connected to the directory this bzr was opened from.
87
"""Invoke break_lock on the first object in the bzrdir.
89
If there is a tree, the tree is opened and break_lock() called.
90
Otherwise, branch is tried, and finally repository.
92
# XXX: This seems more like a UI function than something that really
93
# belongs in this class.
95
thing_to_unlock = self.open_workingtree()
96
except (errors.NotLocalUrl, errors.NoWorkingTree):
98
thing_to_unlock = self.open_branch()
99
except errors.NotBranchError:
101
thing_to_unlock = self.open_repository()
102
except errors.NoRepositoryPresent:
104
thing_to_unlock.break_lock()
106
def can_convert_format(self):
107
"""Return true if this bzrdir is one whose format we can convert from."""
110
def check_conversion_target(self, target_format):
111
target_repo_format = target_format.repository_format
112
source_repo_format = self._format.repository_format
113
source_repo_format.check_conversion_target(target_repo_format)
116
def _check_supported(format, allow_unsupported,
117
recommend_upgrade=True,
119
"""Give an error or warning on old formats.
121
:param format: may be any kind of format - workingtree, branch,
124
:param allow_unsupported: If true, allow opening
125
formats that are strongly deprecated, and which may
126
have limited functionality.
128
:param recommend_upgrade: If true (default), warn
129
the user through the ui object that they may wish
130
to upgrade the object.
132
# TODO: perhaps move this into a base Format class; it's not BzrDir
133
# specific. mbp 20070323
134
if not allow_unsupported and not format.is_supported():
135
# see open_downlevel to open legacy branches.
136
raise errors.UnsupportedFormatError(format=format)
137
if recommend_upgrade \
138
and getattr(format, 'upgrade_recommended', False):
139
ui.ui_factory.recommend_upgrade(
140
format.get_format_description(),
143
def clone(self, url, revision_id=None, force_new_repo=False):
144
"""Clone this bzrdir and its contents to url verbatim.
146
If urls last component does not exist, it will be created.
148
if revision_id is not None, then the clone operation may tune
149
itself to download less data.
150
:param force_new_repo: Do not use a shared repository for the target
151
even if one is available.
153
return self.clone_on_transport(get_transport(url),
154
revision_id=revision_id,
155
force_new_repo=force_new_repo)
157
def clone_on_transport(self, transport, revision_id=None,
158
force_new_repo=False):
159
"""Clone this bzrdir and its contents to transport verbatim.
161
If the target directory does not exist, it will be created.
163
if revision_id is not None, then the clone operation may tune
164
itself to download less data.
165
:param force_new_repo: Do not use a shared repository for the target
166
even if one is available.
168
transport.ensure_base()
169
result = self._format.initialize_on_transport(transport)
171
local_repo = self.find_repository()
172
except errors.NoRepositoryPresent:
175
# may need to copy content in
177
result_repo = local_repo.clone(
179
revision_id=revision_id)
180
result_repo.set_make_working_trees(local_repo.make_working_trees())
183
result_repo = result.find_repository()
184
# fetch content this dir needs.
185
result_repo.fetch(local_repo, revision_id=revision_id)
186
except errors.NoRepositoryPresent:
187
# needed to make one anyway.
188
result_repo = local_repo.clone(
190
revision_id=revision_id)
191
result_repo.set_make_working_trees(local_repo.make_working_trees())
192
# 1 if there is a branch present
193
# make sure its content is available in the target repository
196
self.open_branch().clone(result, revision_id=revision_id)
197
except errors.NotBranchError:
200
self.open_workingtree().clone(result)
201
except (errors.NoWorkingTree, errors.NotLocalUrl):
205
# TODO: This should be given a Transport, and should chdir up; otherwise
206
# this will open a new connection.
207
def _make_tail(self, url):
208
t = get_transport(url)
212
def create(cls, base, format=None, possible_transports=None):
213
"""Create a new BzrDir at the url 'base'.
215
This will call the current default formats initialize with base
216
as the only parameter.
218
:param format: If supplied, the format of branch to create. If not
219
supplied, the default is used.
220
:param possible_transports: If supplied, a list of transports that
221
can be reused to share a remote connection.
223
if cls is not BzrDir:
224
raise AssertionError("BzrDir.create always creates the default"
225
" format, not one of %r" % cls)
226
t = get_transport(base, possible_transports)
229
format = BzrDirFormat.get_default_format()
230
return format.initialize(base, possible_transports)
232
def create_branch(self):
233
"""Create a branch in this BzrDir.
235
The bzrdirs format will control what branch format is created.
236
For more control see BranchFormatXX.create(a_bzrdir).
238
raise NotImplementedError(self.create_branch)
241
def create_branch_and_repo(base, force_new_repo=False, format=None):
242
"""Create a new BzrDir, Branch and Repository at the url 'base'.
244
This will use the current default BzrDirFormat, and use whatever
245
repository format that that uses via bzrdir.create_branch and
246
create_repository. If a shared repository is available that is used
249
The created Branch object is returned.
251
:param base: The URL to create the branch at.
252
:param force_new_repo: If True a new repository is always created.
254
bzrdir = BzrDir.create(base, format)
255
bzrdir._find_or_create_repository(force_new_repo)
256
return bzrdir.create_branch()
258
def _find_or_create_repository(self, force_new_repo):
259
"""Create a new repository if needed, returning the repository."""
261
return self.create_repository()
263
return self.find_repository()
264
except errors.NoRepositoryPresent:
265
return self.create_repository()
268
def create_branch_convenience(base, force_new_repo=False,
269
force_new_tree=None, format=None,
270
possible_transports=None):
271
"""Create a new BzrDir, Branch and Repository at the url 'base'.
273
This is a convenience function - it will use an existing repository
274
if possible, can be told explicitly whether to create a working tree or
277
This will use the current default BzrDirFormat, and use whatever
278
repository format that that uses via bzrdir.create_branch and
279
create_repository. If a shared repository is available that is used
280
preferentially. Whatever repository is used, its tree creation policy
283
The created Branch object is returned.
284
If a working tree cannot be made due to base not being a file:// url,
285
no error is raised unless force_new_tree is True, in which case no
286
data is created on disk and NotLocalUrl is raised.
288
:param base: The URL to create the branch at.
289
:param force_new_repo: If True a new repository is always created.
290
:param force_new_tree: If True or False force creation of a tree or
291
prevent such creation respectively.
292
:param format: Override for the for the bzrdir format to create.
293
:param possible_transports: An optional reusable transports list.
296
# check for non local urls
297
t = get_transport(base, possible_transports)
298
if not isinstance(t, LocalTransport):
299
raise errors.NotLocalUrl(base)
300
bzrdir = BzrDir.create(base, format, possible_transports)
301
repo = bzrdir._find_or_create_repository(force_new_repo)
302
result = bzrdir.create_branch()
303
if force_new_tree or (repo.make_working_trees() and
304
force_new_tree is None):
306
bzrdir.create_workingtree()
307
except errors.NotLocalUrl:
312
def create_repository(base, shared=False, format=None):
313
"""Create a new BzrDir and Repository at the url 'base'.
315
If no format is supplied, this will default to the current default
316
BzrDirFormat by default, and use whatever repository format that that
317
uses for bzrdirformat.create_repository.
319
:param shared: Create a shared repository rather than a standalone
321
The Repository object is returned.
323
This must be overridden as an instance method in child classes, where
324
it should take no parameters and construct whatever repository format
325
that child class desires.
327
bzrdir = BzrDir.create(base, format)
328
return bzrdir.create_repository(shared)
331
def create_standalone_workingtree(base, format=None):
332
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
334
'base' must be a local path or a file:// url.
336
This will use the current default BzrDirFormat, and use whatever
337
repository format that that uses for bzrdirformat.create_workingtree,
338
create_branch and create_repository.
340
:return: The WorkingTree object.
342
t = get_transport(base)
343
if not isinstance(t, LocalTransport):
344
raise errors.NotLocalUrl(base)
345
bzrdir = BzrDir.create_branch_and_repo(base,
347
format=format).bzrdir
348
return bzrdir.create_workingtree()
350
def create_workingtree(self, revision_id=None):
351
"""Create a working tree at this BzrDir.
353
revision_id: create it as of this revision id.
355
raise NotImplementedError(self.create_workingtree)
357
def retire_bzrdir(self):
358
"""Permanently disable the bzrdir.
360
This is done by renaming it to give the user some ability to recover
361
if there was a problem.
363
This will have horrible consequences if anyone has anything locked or
366
for i in xrange(10000):
368
to_path = '.bzr.retired.%d' % i
369
self.root_transport.rename('.bzr', to_path)
370
note("renamed %s to %s"
371
% (self.root_transport.abspath('.bzr'), to_path))
373
except (errors.TransportError, IOError, errors.PathError):
376
def destroy_workingtree(self):
377
"""Destroy the working tree at this BzrDir.
379
Formats that do not support this may raise UnsupportedOperation.
381
raise NotImplementedError(self.destroy_workingtree)
383
def destroy_workingtree_metadata(self):
384
"""Destroy the control files for the working tree at this BzrDir.
386
The contents of working tree files are not affected.
387
Formats that do not support this may raise UnsupportedOperation.
389
raise NotImplementedError(self.destroy_workingtree_metadata)
391
def find_repository(self):
392
"""Find the repository that should be used for a_bzrdir.
394
This does not require a branch as we use it to find the repo for
395
new branches as well as to hook existing branches up to their
399
return self.open_repository()
400
except errors.NoRepositoryPresent:
402
next_transport = self.root_transport.clone('..')
404
# find the next containing bzrdir
406
found_bzrdir = BzrDir.open_containing_from_transport(
408
except errors.NotBranchError:
410
raise errors.NoRepositoryPresent(self)
411
# does it have a repository ?
413
repository = found_bzrdir.open_repository()
414
except errors.NoRepositoryPresent:
415
next_transport = found_bzrdir.root_transport.clone('..')
416
if (found_bzrdir.root_transport.base == next_transport.base):
417
# top of the file system
421
if ((found_bzrdir.root_transport.base ==
422
self.root_transport.base) or repository.is_shared()):
425
raise errors.NoRepositoryPresent(self)
426
raise errors.NoRepositoryPresent(self)
428
def get_branch_reference(self):
429
"""Return the referenced URL for the branch in this bzrdir.
431
:raises NotBranchError: If there is no Branch.
432
:return: The URL the branch in this bzrdir references if it is a
433
reference branch, or None for regular branches.
437
def get_branch_transport(self, branch_format):
438
"""Get the transport for use by branch format in this BzrDir.
440
Note that bzr dirs that do not support format strings will raise
441
IncompatibleFormat if the branch format they are given has
442
a format string, and vice versa.
444
If branch_format is None, the transport is returned with no
445
checking. if it is not None, then the returned transport is
446
guaranteed to point to an existing directory ready for use.
448
raise NotImplementedError(self.get_branch_transport)
450
def get_repository_transport(self, repository_format):
451
"""Get the transport for use by repository format in this BzrDir.
453
Note that bzr dirs that do not support format strings will raise
454
IncompatibleFormat if the repository format they are given has
455
a format string, and vice versa.
457
If repository_format is None, the transport is returned with no
458
checking. if it is not None, then the returned transport is
459
guaranteed to point to an existing directory ready for use.
461
raise NotImplementedError(self.get_repository_transport)
463
def get_workingtree_transport(self, tree_format):
464
"""Get the transport for use by workingtree format in this BzrDir.
466
Note that bzr dirs that do not support format strings will raise
467
IncompatibleFormat if the workingtree format they are given has a
468
format string, and vice versa.
470
If workingtree_format is None, the transport is returned with no
471
checking. if it is not None, then the returned transport is
472
guaranteed to point to an existing directory ready for use.
474
raise NotImplementedError(self.get_workingtree_transport)
476
def __init__(self, _transport, _format):
477
"""Initialize a Bzr control dir object.
479
Only really common logic should reside here, concrete classes should be
480
made with varying behaviours.
482
:param _format: the format that is creating this BzrDir instance.
483
:param _transport: the transport this dir is based at.
485
self._format = _format
486
self.transport = _transport.clone('.bzr')
487
self.root_transport = _transport
489
def is_control_filename(self, filename):
490
"""True if filename is the name of a path which is reserved for bzrdir's.
492
:param filename: A filename within the root transport of this bzrdir.
494
This is true IF and ONLY IF the filename is part of the namespace reserved
495
for bzr control dirs. Currently this is the '.bzr' directory in the root
496
of the root_transport. it is expected that plugins will need to extend
497
this in the future - for instance to make bzr talk with svn working
500
# this might be better on the BzrDirFormat class because it refers to
501
# all the possible bzrdir disk formats.
502
# This method is tested via the workingtree is_control_filename tests-
503
# it was extracted from WorkingTree.is_control_filename. If the methods
504
# contract is extended beyond the current trivial implementation please
505
# add new tests for it to the appropriate place.
506
return filename == '.bzr' or filename.startswith('.bzr/')
508
def needs_format_conversion(self, format=None):
509
"""Return true if this bzrdir needs convert_format run on it.
511
For instance, if the repository format is out of date but the
512
branch and working tree are not, this should return True.
514
:param format: Optional parameter indicating a specific desired
515
format we plan to arrive at.
517
raise NotImplementedError(self.needs_format_conversion)
520
def open_unsupported(base):
521
"""Open a branch which is not supported."""
522
return BzrDir.open(base, _unsupported=True)
525
def open(base, _unsupported=False):
526
"""Open an existing bzrdir, rooted at 'base' (url)
528
_unsupported is a private parameter to the BzrDir class.
530
t = get_transport(base)
531
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
534
def open_from_transport(transport, _unsupported=False,
535
_server_formats=True):
536
"""Open a bzrdir within a particular directory.
538
:param transport: Transport containing the bzrdir.
539
:param _unsupported: private.
541
base = transport.base
543
def find_format(transport):
544
return transport, BzrDirFormat.find_format(
545
transport, _server_formats=_server_formats)
547
def redirected(transport, e, redirection_notice):
548
qualified_source = e.get_source_url()
549
relpath = transport.relpath(qualified_source)
550
if not e.target.endswith(relpath):
551
# Not redirected to a branch-format, not a branch
552
raise errors.NotBranchError(path=e.target)
553
target = e.target[:-len(relpath)]
554
note('%s is%s redirected to %s',
555
transport.base, e.permanently, target)
556
# Let's try with a new transport
557
qualified_target = e.get_target_url()[:-len(relpath)]
558
# FIXME: If 'transport' has a qualifier, this should
559
# be applied again to the new transport *iff* the
560
# schemes used are the same. It's a bit tricky to
561
# verify, so I'll punt for now
563
return get_transport(target)
566
transport, format = do_catching_redirections(find_format,
569
except errors.TooManyRedirections:
570
raise errors.NotBranchError(base)
572
BzrDir._check_supported(format, _unsupported)
573
return format.open(transport, _found=True)
575
def open_branch(self, unsupported=False):
576
"""Open the branch object at this BzrDir if one is present.
578
If unsupported is True, then no longer supported branch formats can
581
TODO: static convenience version of this?
583
raise NotImplementedError(self.open_branch)
586
def open_containing(url, possible_transports=None):
587
"""Open an existing branch which contains url.
589
:param url: url to search from.
590
See open_containing_from_transport for more detail.
592
transport = get_transport(url, possible_transports)
593
return BzrDir.open_containing_from_transport(transport)
596
def open_containing_from_transport(a_transport):
597
"""Open an existing branch which contains a_transport.base
599
This probes for a branch at a_transport, and searches upwards from there.
601
Basically we keep looking up until we find the control directory or
602
run into the root. If there isn't one, raises NotBranchError.
603
If there is one and it is either an unrecognised format or an unsupported
604
format, UnknownFormatError or UnsupportedFormatError are raised.
605
If there is one, it is returned, along with the unused portion of url.
607
:return: The BzrDir that contains the path, and a Unicode path
608
for the rest of the URL.
610
# this gets the normalised url back. I.e. '.' -> the full path.
611
url = a_transport.base
614
result = BzrDir.open_from_transport(a_transport)
615
return result, urlutils.unescape(a_transport.relpath(url))
616
except errors.NotBranchError, e:
619
new_t = a_transport.clone('..')
620
except errors.InvalidURLJoin:
621
# reached the root, whatever that may be
622
raise errors.NotBranchError(path=url)
623
if new_t.base == a_transport.base:
624
# reached the root, whatever that may be
625
raise errors.NotBranchError(path=url)
629
def open_containing_tree_or_branch(klass, location):
630
"""Return the branch and working tree contained by a location.
632
Returns (tree, branch, relpath).
633
If there is no tree at containing the location, tree will be None.
634
If there is no branch containing the location, an exception will be
636
relpath is the portion of the path that is contained by the branch.
638
bzrdir, relpath = klass.open_containing(location)
640
tree = bzrdir.open_workingtree()
641
except (errors.NoWorkingTree, errors.NotLocalUrl):
643
branch = bzrdir.open_branch()
646
return tree, branch, relpath
648
def open_repository(self, _unsupported=False):
649
"""Open the repository object at this BzrDir if one is present.
651
This will not follow the Branch object pointer - its strictly a direct
652
open facility. Most client code should use open_branch().repository to
655
_unsupported is a private parameter, not part of the api.
656
TODO: static convenience version of this?
658
raise NotImplementedError(self.open_repository)
660
def open_workingtree(self, _unsupported=False,
661
recommend_upgrade=True):
662
"""Open the workingtree object at this BzrDir if one is present.
664
:param recommend_upgrade: Optional keyword parameter, when True (the
665
default), emit through the ui module a recommendation that the user
666
upgrade the working tree when the workingtree being opened is old
667
(but still fully supported).
669
raise NotImplementedError(self.open_workingtree)
671
def has_branch(self):
672
"""Tell if this bzrdir contains a branch.
674
Note: if you're going to open the branch, you should just go ahead
675
and try, and not ask permission first. (This method just opens the
676
branch and discards it, and that's somewhat expensive.)
681
except errors.NotBranchError:
684
def has_workingtree(self):
685
"""Tell if this bzrdir contains a working tree.
687
This will still raise an exception if the bzrdir has a workingtree that
688
is remote & inaccessible.
690
Note: if you're going to open the working tree, you should just go ahead
691
and try, and not ask permission first. (This method just opens the
692
workingtree and discards it, and that's somewhat expensive.)
695
self.open_workingtree(recommend_upgrade=False)
697
except errors.NoWorkingTree:
700
def _cloning_metadir(self):
701
"""Produce a metadir suitable for cloning with"""
702
result_format = self._format.__class__()
705
branch = self.open_branch()
706
source_repository = branch.repository
707
except errors.NotBranchError:
709
source_repository = self.open_repository()
710
except errors.NoRepositoryPresent:
711
source_repository = None
713
# XXX TODO: This isinstance is here because we have not implemented
714
# the fix recommended in bug # 103195 - to delegate this choice the
716
repo_format = source_repository._format
717
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
718
result_format.repository_format = repo_format
720
# TODO: Couldn't we just probe for the format in these cases,
721
# rather than opening the whole tree? It would be a little
722
# faster. mbp 20070401
723
tree = self.open_workingtree(recommend_upgrade=False)
724
except (errors.NoWorkingTree, errors.NotLocalUrl):
725
result_format.workingtree_format = None
727
result_format.workingtree_format = tree._format.__class__()
728
return result_format, source_repository
730
def cloning_metadir(self):
731
"""Produce a metadir suitable for cloning or sprouting with.
733
These operations may produce workingtrees (yes, even though they're
734
"cloning" something that doesn't have a tree, so a viable workingtree
735
format must be selected.
737
format, repository = self._cloning_metadir()
738
if format._workingtree_format is None:
739
if repository is None:
741
tree_format = repository._format._matchingbzrdir.workingtree_format
742
format.workingtree_format = tree_format.__class__()
745
def checkout_metadir(self):
746
return self.cloning_metadir()
748
def sprout(self, url, revision_id=None, force_new_repo=False,
749
recurse='down', possible_transports=None):
750
"""Create a copy of this bzrdir prepared for use as a new line of
753
If urls last component does not exist, it will be created.
755
Attributes related to the identity of the source branch like
756
branch nickname will be cleaned, a working tree is created
757
whether one existed before or not; and a local branch is always
760
if revision_id is not None, then the clone operation may tune
761
itself to download less data.
763
target_transport = get_transport(url, possible_transports)
764
target_transport.ensure_base()
765
cloning_format = self.cloning_metadir()
766
result = cloning_format.initialize_on_transport(target_transport)
768
source_branch = self.open_branch()
769
source_repository = source_branch.repository
770
except errors.NotBranchError:
773
source_repository = self.open_repository()
774
except errors.NoRepositoryPresent:
775
source_repository = None
780
result_repo = result.find_repository()
781
except errors.NoRepositoryPresent:
783
if source_repository is None and result_repo is not None:
785
elif source_repository is None and result_repo is None:
786
# no repo available, make a new one
787
result.create_repository()
788
elif source_repository is not None and result_repo is None:
789
# have source, and want to make a new target repo
790
result_repo = source_repository.sprout(result,
791
revision_id=revision_id)
793
# fetch needed content into target.
794
if source_repository is not None:
796
# source_repository.copy_content_into(result_repo,
797
# revision_id=revision_id)
798
# so we can override the copy method
799
result_repo.fetch(source_repository, revision_id=revision_id)
800
if source_branch is not None:
801
source_branch.sprout(result, revision_id=revision_id)
803
result.create_branch()
804
if isinstance(target_transport, LocalTransport) and (
805
result_repo is None or result_repo.make_working_trees()):
806
wt = result.create_workingtree()
809
if wt.path2id('') is None:
811
wt.set_root_id(self.open_workingtree.get_root_id())
812
except errors.NoWorkingTree:
818
if recurse == 'down':
820
basis = wt.basis_tree()
822
subtrees = basis.iter_references()
823
recurse_branch = wt.branch
824
elif source_branch is not None:
825
basis = source_branch.basis_tree()
827
subtrees = basis.iter_references()
828
recurse_branch = source_branch
833
for path, file_id in subtrees:
834
target = urlutils.join(url, urlutils.escape(path))
835
sublocation = source_branch.reference_parent(file_id, path)
836
sublocation.bzrdir.sprout(target,
837
basis.get_reference_revision(file_id, path),
838
force_new_repo=force_new_repo, recurse=recurse)
840
if basis is not None:
845
class BzrDirPreSplitOut(BzrDir):
846
"""A common class for the all-in-one formats."""
848
def __init__(self, _transport, _format):
849
"""See BzrDir.__init__."""
850
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
851
assert self._format._lock_class == lockable_files.TransportLock
852
assert self._format._lock_file_name == 'branch-lock'
853
self._control_files = lockable_files.LockableFiles(
854
self.get_branch_transport(None),
855
self._format._lock_file_name,
856
self._format._lock_class)
858
def break_lock(self):
859
"""Pre-splitout bzrdirs do not suffer from stale locks."""
860
raise NotImplementedError(self.break_lock)
862
def clone(self, url, revision_id=None, force_new_repo=False):
863
"""See BzrDir.clone()."""
864
from bzrlib.workingtree import WorkingTreeFormat2
866
result = self._format._initialize_for_clone(url)
867
self.open_repository().clone(result, revision_id=revision_id)
868
from_branch = self.open_branch()
869
from_branch.clone(result, revision_id=revision_id)
871
self.open_workingtree().clone(result)
872
except errors.NotLocalUrl:
873
# make a new one, this format always has to have one.
875
WorkingTreeFormat2().initialize(result)
876
except errors.NotLocalUrl:
877
# but we cannot do it for remote trees.
878
to_branch = result.open_branch()
879
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
882
def create_branch(self):
883
"""See BzrDir.create_branch."""
884
return self.open_branch()
886
def create_repository(self, shared=False):
887
"""See BzrDir.create_repository."""
889
raise errors.IncompatibleFormat('shared repository', self._format)
890
return self.open_repository()
892
def create_workingtree(self, revision_id=None):
893
"""See BzrDir.create_workingtree."""
894
# this looks buggy but is not -really-
895
# because this format creates the workingtree when the bzrdir is
897
# clone and sprout will have set the revision_id
898
# and that will have set it for us, its only
899
# specific uses of create_workingtree in isolation
900
# that can do wonky stuff here, and that only
901
# happens for creating checkouts, which cannot be
902
# done on this format anyway. So - acceptable wart.
903
result = self.open_workingtree(recommend_upgrade=False)
904
if revision_id is not None:
905
if revision_id == _mod_revision.NULL_REVISION:
906
result.set_parent_ids([])
908
result.set_parent_ids([revision_id])
911
def destroy_workingtree(self):
912
"""See BzrDir.destroy_workingtree."""
913
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
915
def destroy_workingtree_metadata(self):
916
"""See BzrDir.destroy_workingtree_metadata."""
917
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
920
def get_branch_transport(self, branch_format):
921
"""See BzrDir.get_branch_transport()."""
922
if branch_format is None:
923
return self.transport
925
branch_format.get_format_string()
926
except NotImplementedError:
927
return self.transport
928
raise errors.IncompatibleFormat(branch_format, self._format)
930
def get_repository_transport(self, repository_format):
931
"""See BzrDir.get_repository_transport()."""
932
if repository_format is None:
933
return self.transport
935
repository_format.get_format_string()
936
except NotImplementedError:
937
return self.transport
938
raise errors.IncompatibleFormat(repository_format, self._format)
940
def get_workingtree_transport(self, workingtree_format):
941
"""See BzrDir.get_workingtree_transport()."""
942
if workingtree_format is None:
943
return self.transport
945
workingtree_format.get_format_string()
946
except NotImplementedError:
947
return self.transport
948
raise errors.IncompatibleFormat(workingtree_format, self._format)
950
def needs_format_conversion(self, format=None):
951
"""See BzrDir.needs_format_conversion()."""
952
# if the format is not the same as the system default,
953
# an upgrade is needed.
955
format = BzrDirFormat.get_default_format()
956
return not isinstance(self._format, format.__class__)
958
def open_branch(self, unsupported=False):
959
"""See BzrDir.open_branch."""
960
from bzrlib.branch import BzrBranchFormat4
961
format = BzrBranchFormat4()
962
self._check_supported(format, unsupported)
963
return format.open(self, _found=True)
965
def sprout(self, url, revision_id=None, force_new_repo=False,
966
possible_transports=None):
967
"""See BzrDir.sprout()."""
968
from bzrlib.workingtree import WorkingTreeFormat2
970
result = self._format._initialize_for_clone(url)
972
self.open_repository().clone(result, revision_id=revision_id)
973
except errors.NoRepositoryPresent:
976
self.open_branch().sprout(result, revision_id=revision_id)
977
except errors.NotBranchError:
979
# we always want a working tree
980
WorkingTreeFormat2().initialize(result)
984
class BzrDir4(BzrDirPreSplitOut):
985
"""A .bzr version 4 control object.
987
This is a deprecated format and may be removed after sept 2006.
990
def create_repository(self, shared=False):
991
"""See BzrDir.create_repository."""
992
return self._format.repository_format.initialize(self, shared)
994
def needs_format_conversion(self, format=None):
995
"""Format 4 dirs are always in need of conversion."""
998
def open_repository(self):
999
"""See BzrDir.open_repository."""
1000
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1001
return RepositoryFormat4().open(self, _found=True)
1004
class BzrDir5(BzrDirPreSplitOut):
1005
"""A .bzr version 5 control object.
1007
This is a deprecated format and may be removed after sept 2006.
1010
def open_repository(self):
1011
"""See BzrDir.open_repository."""
1012
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1013
return RepositoryFormat5().open(self, _found=True)
1015
def open_workingtree(self, _unsupported=False,
1016
recommend_upgrade=True):
1017
"""See BzrDir.create_workingtree."""
1018
from bzrlib.workingtree import WorkingTreeFormat2
1019
wt_format = WorkingTreeFormat2()
1020
# we don't warn here about upgrades; that ought to be handled for the
1022
return wt_format.open(self, _found=True)
1025
class BzrDir6(BzrDirPreSplitOut):
1026
"""A .bzr version 6 control object.
1028
This is a deprecated format and may be removed after sept 2006.
1031
def open_repository(self):
1032
"""See BzrDir.open_repository."""
1033
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1034
return RepositoryFormat6().open(self, _found=True)
1036
def open_workingtree(self, _unsupported=False,
1037
recommend_upgrade=True):
1038
"""See BzrDir.create_workingtree."""
1039
# we don't warn here about upgrades; that ought to be handled for the
1041
from bzrlib.workingtree import WorkingTreeFormat2
1042
return WorkingTreeFormat2().open(self, _found=True)
1045
class BzrDirMeta1(BzrDir):
1046
"""A .bzr meta version 1 control object.
1048
This is the first control object where the
1049
individual aspects are really split out: there are separate repository,
1050
workingtree and branch subdirectories and any subset of the three can be
1051
present within a BzrDir.
1054
def can_convert_format(self):
1055
"""See BzrDir.can_convert_format()."""
1058
def create_branch(self):
1059
"""See BzrDir.create_branch."""
1060
return self._format.get_branch_format().initialize(self)
1062
def create_repository(self, shared=False):
1063
"""See BzrDir.create_repository."""
1064
return self._format.repository_format.initialize(self, shared)
1066
def create_workingtree(self, revision_id=None):
1067
"""See BzrDir.create_workingtree."""
1068
from bzrlib.workingtree import WorkingTreeFormat
1069
return self._format.workingtree_format.initialize(self, revision_id)
1071
def destroy_workingtree(self):
1072
"""See BzrDir.destroy_workingtree."""
1073
wt = self.open_workingtree(recommend_upgrade=False)
1074
repository = wt.branch.repository
1075
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1076
wt.revert([], old_tree=empty)
1077
self.destroy_workingtree_metadata()
1079
def destroy_workingtree_metadata(self):
1080
self.transport.delete_tree('checkout')
1082
def find_branch_format(self):
1083
"""Find the branch 'format' for this bzrdir.
1085
This might be a synthetic object for e.g. RemoteBranch and SVN.
1087
from bzrlib.branch import BranchFormat
1088
return BranchFormat.find_format(self)
1090
def _get_mkdir_mode(self):
1091
"""Figure out the mode to use when creating a bzrdir subdir."""
1092
temp_control = lockable_files.LockableFiles(self.transport, '',
1093
lockable_files.TransportLock)
1094
return temp_control._dir_mode
1096
def get_branch_reference(self):
1097
"""See BzrDir.get_branch_reference()."""
1098
from bzrlib.branch import BranchFormat
1099
format = BranchFormat.find_format(self)
1100
return format.get_reference(self)
1102
def get_branch_transport(self, branch_format):
1103
"""See BzrDir.get_branch_transport()."""
1104
if branch_format is None:
1105
return self.transport.clone('branch')
1107
branch_format.get_format_string()
1108
except NotImplementedError:
1109
raise errors.IncompatibleFormat(branch_format, self._format)
1111
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1112
except errors.FileExists:
1114
return self.transport.clone('branch')
1116
def get_repository_transport(self, repository_format):
1117
"""See BzrDir.get_repository_transport()."""
1118
if repository_format is None:
1119
return self.transport.clone('repository')
1121
repository_format.get_format_string()
1122
except NotImplementedError:
1123
raise errors.IncompatibleFormat(repository_format, self._format)
1125
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1126
except errors.FileExists:
1128
return self.transport.clone('repository')
1130
def get_workingtree_transport(self, workingtree_format):
1131
"""See BzrDir.get_workingtree_transport()."""
1132
if workingtree_format is None:
1133
return self.transport.clone('checkout')
1135
workingtree_format.get_format_string()
1136
except NotImplementedError:
1137
raise errors.IncompatibleFormat(workingtree_format, self._format)
1139
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1140
except errors.FileExists:
1142
return self.transport.clone('checkout')
1144
def needs_format_conversion(self, format=None):
1145
"""See BzrDir.needs_format_conversion()."""
1147
format = BzrDirFormat.get_default_format()
1148
if not isinstance(self._format, format.__class__):
1149
# it is not a meta dir format, conversion is needed.
1151
# we might want to push this down to the repository?
1153
if not isinstance(self.open_repository()._format,
1154
format.repository_format.__class__):
1155
# the repository needs an upgrade.
1157
except errors.NoRepositoryPresent:
1160
if not isinstance(self.open_branch()._format,
1161
format.get_branch_format().__class__):
1162
# the branch needs an upgrade.
1164
except errors.NotBranchError:
1167
my_wt = self.open_workingtree(recommend_upgrade=False)
1168
if not isinstance(my_wt._format,
1169
format.workingtree_format.__class__):
1170
# the workingtree needs an upgrade.
1172
except (errors.NoWorkingTree, errors.NotLocalUrl):
1176
def open_branch(self, unsupported=False):
1177
"""See BzrDir.open_branch."""
1178
format = self.find_branch_format()
1179
self._check_supported(format, unsupported)
1180
return format.open(self, _found=True)
1182
def open_repository(self, unsupported=False):
1183
"""See BzrDir.open_repository."""
1184
from bzrlib.repository import RepositoryFormat
1185
format = RepositoryFormat.find_format(self)
1186
self._check_supported(format, unsupported)
1187
return format.open(self, _found=True)
1189
def open_workingtree(self, unsupported=False,
1190
recommend_upgrade=True):
1191
"""See BzrDir.open_workingtree."""
1192
from bzrlib.workingtree import WorkingTreeFormat
1193
format = WorkingTreeFormat.find_format(self)
1194
self._check_supported(format, unsupported,
1196
basedir=self.root_transport.base)
1197
return format.open(self, _found=True)
1200
class BzrDirFormat(object):
1201
"""An encapsulation of the initialization and open routines for a format.
1203
Formats provide three things:
1204
* An initialization routine,
1208
Formats are placed in an dict by their format string for reference
1209
during bzrdir opening. These should be subclasses of BzrDirFormat
1212
Once a format is deprecated, just deprecate the initialize and open
1213
methods on the format class. Do not deprecate the object, as the
1214
object will be created every system load.
1217
_default_format = None
1218
"""The default format used for new .bzr dirs."""
1221
"""The known formats."""
1223
_control_formats = []
1224
"""The registered control formats - .bzr, ....
1226
This is a list of BzrDirFormat objects.
1229
_control_server_formats = []
1230
"""The registered control server formats, e.g. RemoteBzrDirs.
1232
This is a list of BzrDirFormat objects.
1235
_lock_file_name = 'branch-lock'
1237
# _lock_class must be set in subclasses to the lock type, typ.
1238
# TransportLock or LockDir
1241
def find_format(klass, transport, _server_formats=True):
1242
"""Return the format present at transport."""
1244
formats = klass._control_server_formats + klass._control_formats
1246
formats = klass._control_formats
1247
for format in formats:
1249
return format.probe_transport(transport)
1250
except errors.NotBranchError:
1251
# this format does not find a control dir here.
1253
raise errors.NotBranchError(path=transport.base)
1256
def probe_transport(klass, transport):
1257
"""Return the .bzrdir style format present in a directory."""
1259
format_string = transport.get(".bzr/branch-format").read()
1260
except errors.NoSuchFile:
1261
raise errors.NotBranchError(path=transport.base)
1264
return klass._formats[format_string]
1266
raise errors.UnknownFormatError(format=format_string)
1269
def get_default_format(klass):
1270
"""Return the current default format."""
1271
return klass._default_format
1273
def get_format_string(self):
1274
"""Return the ASCII format string that identifies this format."""
1275
raise NotImplementedError(self.get_format_string)
1277
def get_format_description(self):
1278
"""Return the short description for this format."""
1279
raise NotImplementedError(self.get_format_description)
1281
def get_converter(self, format=None):
1282
"""Return the converter to use to convert bzrdirs needing converts.
1284
This returns a bzrlib.bzrdir.Converter object.
1286
This should return the best upgrader to step this format towards the
1287
current default format. In the case of plugins we can/should provide
1288
some means for them to extend the range of returnable converters.
1290
:param format: Optional format to override the default format of the
1293
raise NotImplementedError(self.get_converter)
1295
def initialize(self, url, possible_transports=None):
1296
"""Create a bzr control dir at this url and return an opened copy.
1298
Subclasses should typically override initialize_on_transport
1299
instead of this method.
1301
return self.initialize_on_transport(get_transport(url,
1302
possible_transports))
1304
def initialize_on_transport(self, transport):
1305
"""Initialize a new bzrdir in the base directory of a Transport."""
1306
# Since we don't have a .bzr directory, inherit the
1307
# mode from the root directory
1308
temp_control = lockable_files.LockableFiles(transport,
1309
'', lockable_files.TransportLock)
1310
temp_control._transport.mkdir('.bzr',
1311
# FIXME: RBC 20060121 don't peek under
1313
mode=temp_control._dir_mode)
1314
file_mode = temp_control._file_mode
1316
mutter('created control directory in ' + transport.base)
1317
control = transport.clone('.bzr')
1318
utf8_files = [('README',
1319
"This is a Bazaar-NG control directory.\n"
1320
"Do not change any files in this directory.\n"),
1321
('branch-format', self.get_format_string()),
1323
# NB: no need to escape relative paths that are url safe.
1324
control_files = lockable_files.LockableFiles(control,
1325
self._lock_file_name, self._lock_class)
1326
control_files.create_lock()
1327
control_files.lock_write()
1329
for file, content in utf8_files:
1330
control_files.put_utf8(file, content)
1332
control_files.unlock()
1333
return self.open(transport, _found=True)
1335
def is_supported(self):
1336
"""Is this format supported?
1338
Supported formats must be initializable and openable.
1339
Unsupported formats may not support initialization or committing or
1340
some other features depending on the reason for not being supported.
1344
def same_model(self, target_format):
1345
return (self.repository_format.rich_root_data ==
1346
target_format.rich_root_data)
1349
def known_formats(klass):
1350
"""Return all the known formats.
1352
Concrete formats should override _known_formats.
1354
# There is double indirection here to make sure that control
1355
# formats used by more than one dir format will only be probed
1356
# once. This can otherwise be quite expensive for remote connections.
1358
for format in klass._control_formats:
1359
result.update(format._known_formats())
1363
def _known_formats(klass):
1364
"""Return the known format instances for this control format."""
1365
return set(klass._formats.values())
1367
def open(self, transport, _found=False):
1368
"""Return an instance of this format for the dir transport points at.
1370
_found is a private parameter, do not use it.
1373
found_format = BzrDirFormat.find_format(transport)
1374
if not isinstance(found_format, self.__class__):
1375
raise AssertionError("%s was asked to open %s, but it seems to need "
1377
% (self, transport, found_format))
1378
return self._open(transport)
1380
def _open(self, transport):
1381
"""Template method helper for opening BzrDirectories.
1383
This performs the actual open and any additional logic or parameter
1386
raise NotImplementedError(self._open)
1389
def register_format(klass, format):
1390
klass._formats[format.get_format_string()] = format
1393
def register_control_format(klass, format):
1394
"""Register a format that does not use '.bzr' for its control dir.
1396
TODO: This should be pulled up into a 'ControlDirFormat' base class
1397
which BzrDirFormat can inherit from, and renamed to register_format
1398
there. It has been done without that for now for simplicity of
1401
klass._control_formats.append(format)
1404
def register_control_server_format(klass, format):
1405
"""Register a control format for client-server environments.
1407
These formats will be tried before ones registered with
1408
register_control_format. This gives implementations that decide to the
1409
chance to grab it before anything looks at the contents of the format
1412
klass._control_server_formats.append(format)
1415
@symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1416
def set_default_format(klass, format):
1417
klass._set_default_format(format)
1420
def _set_default_format(klass, format):
1421
"""Set default format (for testing behavior of defaults only)"""
1422
klass._default_format = format
1425
return self.get_format_string()[:-1]
1428
def unregister_format(klass, format):
1429
assert klass._formats[format.get_format_string()] is format
1430
del klass._formats[format.get_format_string()]
1433
def unregister_control_format(klass, format):
1434
klass._control_formats.remove(format)
1437
class BzrDirFormat4(BzrDirFormat):
1438
"""Bzr dir format 4.
1440
This format is a combined format for working tree, branch and repository.
1442
- Format 1 working trees [always]
1443
- Format 4 branches [always]
1444
- Format 4 repositories [always]
1446
This format is deprecated: it indexes texts using a text it which is
1447
removed in format 5; write support for this format has been removed.
1450
_lock_class = lockable_files.TransportLock
1452
def get_format_string(self):
1453
"""See BzrDirFormat.get_format_string()."""
1454
return "Bazaar-NG branch, format 0.0.4\n"
1456
def get_format_description(self):
1457
"""See BzrDirFormat.get_format_description()."""
1458
return "All-in-one format 4"
1460
def get_converter(self, format=None):
1461
"""See BzrDirFormat.get_converter()."""
1462
# there is one and only one upgrade path here.
1463
return ConvertBzrDir4To5()
1465
def initialize_on_transport(self, transport):
1466
"""Format 4 branches cannot be created."""
1467
raise errors.UninitializableFormat(self)
1469
def is_supported(self):
1470
"""Format 4 is not supported.
1472
It is not supported because the model changed from 4 to 5 and the
1473
conversion logic is expensive - so doing it on the fly was not
1478
def _open(self, transport):
1479
"""See BzrDirFormat._open."""
1480
return BzrDir4(transport, self)
1482
def __return_repository_format(self):
1483
"""Circular import protection."""
1484
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1485
return RepositoryFormat4()
1486
repository_format = property(__return_repository_format)
1489
class BzrDirFormat5(BzrDirFormat):
1490
"""Bzr control format 5.
1492
This format is a combined format for working tree, branch and repository.
1494
- Format 2 working trees [always]
1495
- Format 4 branches [always]
1496
- Format 5 repositories [always]
1497
Unhashed stores in the repository.
1500
_lock_class = lockable_files.TransportLock
1502
def get_format_string(self):
1503
"""See BzrDirFormat.get_format_string()."""
1504
return "Bazaar-NG branch, format 5\n"
1506
def get_format_description(self):
1507
"""See BzrDirFormat.get_format_description()."""
1508
return "All-in-one format 5"
1510
def get_converter(self, format=None):
1511
"""See BzrDirFormat.get_converter()."""
1512
# there is one and only one upgrade path here.
1513
return ConvertBzrDir5To6()
1515
def _initialize_for_clone(self, url):
1516
return self.initialize_on_transport(get_transport(url), _cloning=True)
1518
def initialize_on_transport(self, transport, _cloning=False):
1519
"""Format 5 dirs always have working tree, branch and repository.
1521
Except when they are being cloned.
1523
from bzrlib.branch import BzrBranchFormat4
1524
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1525
from bzrlib.workingtree import WorkingTreeFormat2
1526
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1527
RepositoryFormat5().initialize(result, _internal=True)
1529
branch = BzrBranchFormat4().initialize(result)
1531
WorkingTreeFormat2().initialize(result)
1532
except errors.NotLocalUrl:
1533
# Even though we can't access the working tree, we need to
1534
# create its control files.
1535
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1538
def _open(self, transport):
1539
"""See BzrDirFormat._open."""
1540
return BzrDir5(transport, self)
1542
def __return_repository_format(self):
1543
"""Circular import protection."""
1544
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1545
return RepositoryFormat5()
1546
repository_format = property(__return_repository_format)
1549
class BzrDirFormat6(BzrDirFormat):
1550
"""Bzr control format 6.
1552
This format is a combined format for working tree, branch and repository.
1554
- Format 2 working trees [always]
1555
- Format 4 branches [always]
1556
- Format 6 repositories [always]
1559
_lock_class = lockable_files.TransportLock
1561
def get_format_string(self):
1562
"""See BzrDirFormat.get_format_string()."""
1563
return "Bazaar-NG branch, format 6\n"
1565
def get_format_description(self):
1566
"""See BzrDirFormat.get_format_description()."""
1567
return "All-in-one format 6"
1569
def get_converter(self, format=None):
1570
"""See BzrDirFormat.get_converter()."""
1571
# there is one and only one upgrade path here.
1572
return ConvertBzrDir6ToMeta()
1574
def _initialize_for_clone(self, url):
1575
return self.initialize_on_transport(get_transport(url), _cloning=True)
1577
def initialize_on_transport(self, transport, _cloning=False):
1578
"""Format 6 dirs always have working tree, branch and repository.
1580
Except when they are being cloned.
1582
from bzrlib.branch import BzrBranchFormat4
1583
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1584
from bzrlib.workingtree import WorkingTreeFormat2
1585
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1586
RepositoryFormat6().initialize(result, _internal=True)
1588
branch = BzrBranchFormat4().initialize(result)
1590
WorkingTreeFormat2().initialize(result)
1591
except errors.NotLocalUrl:
1592
# Even though we can't access the working tree, we need to
1593
# create its control files.
1594
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1597
def _open(self, transport):
1598
"""See BzrDirFormat._open."""
1599
return BzrDir6(transport, self)
1601
def __return_repository_format(self):
1602
"""Circular import protection."""
1603
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1604
return RepositoryFormat6()
1605
repository_format = property(__return_repository_format)
1608
class BzrDirMetaFormat1(BzrDirFormat):
1609
"""Bzr meta control format 1
1611
This is the first format with split out working tree, branch and repository
1614
- Format 3 working trees [optional]
1615
- Format 5 branches [optional]
1616
- Format 7 repositories [optional]
1619
_lock_class = lockdir.LockDir
1622
self._workingtree_format = None
1623
self._branch_format = None
1625
def __eq__(self, other):
1626
if other.__class__ is not self.__class__:
1628
if other.repository_format != self.repository_format:
1630
if other.workingtree_format != self.workingtree_format:
1634
def __ne__(self, other):
1635
return not self == other
1637
def get_branch_format(self):
1638
if self._branch_format is None:
1639
from bzrlib.branch import BranchFormat
1640
self._branch_format = BranchFormat.get_default_format()
1641
return self._branch_format
1643
def set_branch_format(self, format):
1644
self._branch_format = format
1646
def get_converter(self, format=None):
1647
"""See BzrDirFormat.get_converter()."""
1649
format = BzrDirFormat.get_default_format()
1650
if not isinstance(self, format.__class__):
1651
# converting away from metadir is not implemented
1652
raise NotImplementedError(self.get_converter)
1653
return ConvertMetaToMeta(format)
1655
def get_format_string(self):
1656
"""See BzrDirFormat.get_format_string()."""
1657
return "Bazaar-NG meta directory, format 1\n"
1659
def get_format_description(self):
1660
"""See BzrDirFormat.get_format_description()."""
1661
return "Meta directory format 1"
1663
def _open(self, transport):
1664
"""See BzrDirFormat._open."""
1665
return BzrDirMeta1(transport, self)
1667
def __return_repository_format(self):
1668
"""Circular import protection."""
1669
if getattr(self, '_repository_format', None):
1670
return self._repository_format
1671
from bzrlib.repository import RepositoryFormat
1672
return RepositoryFormat.get_default_format()
1674
def __set_repository_format(self, value):
1675
"""Allow changint the repository format for metadir formats."""
1676
self._repository_format = value
1678
repository_format = property(__return_repository_format, __set_repository_format)
1680
def __get_workingtree_format(self):
1681
if self._workingtree_format is None:
1682
from bzrlib.workingtree import WorkingTreeFormat
1683
self._workingtree_format = WorkingTreeFormat.get_default_format()
1684
return self._workingtree_format
1686
def __set_workingtree_format(self, wt_format):
1687
self._workingtree_format = wt_format
1689
workingtree_format = property(__get_workingtree_format,
1690
__set_workingtree_format)
1693
# Register bzr control format
1694
BzrDirFormat.register_control_format(BzrDirFormat)
1696
# Register bzr formats
1697
BzrDirFormat.register_format(BzrDirFormat4())
1698
BzrDirFormat.register_format(BzrDirFormat5())
1699
BzrDirFormat.register_format(BzrDirFormat6())
1700
__default_format = BzrDirMetaFormat1()
1701
BzrDirFormat.register_format(__default_format)
1702
BzrDirFormat._default_format = __default_format
1705
class Converter(object):
1706
"""Converts a disk format object from one format to another."""
1708
def convert(self, to_convert, pb):
1709
"""Perform the conversion of to_convert, giving feedback via pb.
1711
:param to_convert: The disk object to convert.
1712
:param pb: a progress bar to use for progress information.
1715
def step(self, message):
1716
"""Update the pb by a step."""
1718
self.pb.update(message, self.count, self.total)
1721
class ConvertBzrDir4To5(Converter):
1722
"""Converts format 4 bzr dirs to format 5."""
1725
super(ConvertBzrDir4To5, self).__init__()
1726
self.converted_revs = set()
1727
self.absent_revisions = set()
1731
def convert(self, to_convert, pb):
1732
"""See Converter.convert()."""
1733
self.bzrdir = to_convert
1735
self.pb.note('starting upgrade from format 4 to 5')
1736
if isinstance(self.bzrdir.transport, LocalTransport):
1737
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1738
self._convert_to_weaves()
1739
return BzrDir.open(self.bzrdir.root_transport.base)
1741
def _convert_to_weaves(self):
1742
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1745
stat = self.bzrdir.transport.stat('weaves')
1746
if not S_ISDIR(stat.st_mode):
1747
self.bzrdir.transport.delete('weaves')
1748
self.bzrdir.transport.mkdir('weaves')
1749
except errors.NoSuchFile:
1750
self.bzrdir.transport.mkdir('weaves')
1751
# deliberately not a WeaveFile as we want to build it up slowly.
1752
self.inv_weave = Weave('inventory')
1753
# holds in-memory weaves for all files
1754
self.text_weaves = {}
1755
self.bzrdir.transport.delete('branch-format')
1756
self.branch = self.bzrdir.open_branch()
1757
self._convert_working_inv()
1758
rev_history = self.branch.revision_history()
1759
# to_read is a stack holding the revisions we still need to process;
1760
# appending to it adds new highest-priority revisions
1761
self.known_revisions = set(rev_history)
1762
self.to_read = rev_history[-1:]
1764
rev_id = self.to_read.pop()
1765
if (rev_id not in self.revisions
1766
and rev_id not in self.absent_revisions):
1767
self._load_one_rev(rev_id)
1769
to_import = self._make_order()
1770
for i, rev_id in enumerate(to_import):
1771
self.pb.update('converting revision', i, len(to_import))
1772
self._convert_one_rev(rev_id)
1774
self._write_all_weaves()
1775
self._write_all_revs()
1776
self.pb.note('upgraded to weaves:')
1777
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1778
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1779
self.pb.note(' %6d texts', self.text_count)
1780
self._cleanup_spare_files_after_format4()
1781
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1783
def _cleanup_spare_files_after_format4(self):
1784
# FIXME working tree upgrade foo.
1785
for n in 'merged-patches', 'pending-merged-patches':
1787
## assert os.path.getsize(p) == 0
1788
self.bzrdir.transport.delete(n)
1789
except errors.NoSuchFile:
1791
self.bzrdir.transport.delete_tree('inventory-store')
1792
self.bzrdir.transport.delete_tree('text-store')
1794
def _convert_working_inv(self):
1795
inv = xml4.serializer_v4.read_inventory(
1796
self.branch.control_files.get('inventory'))
1797
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1798
# FIXME inventory is a working tree change.
1799
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1801
def _write_all_weaves(self):
1802
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1803
weave_transport = self.bzrdir.transport.clone('weaves')
1804
weaves = WeaveStore(weave_transport, prefixed=False)
1805
transaction = WriteTransaction()
1809
for file_id, file_weave in self.text_weaves.items():
1810
self.pb.update('writing weave', i, len(self.text_weaves))
1811
weaves._put_weave(file_id, file_weave, transaction)
1813
self.pb.update('inventory', 0, 1)
1814
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1815
self.pb.update('inventory', 1, 1)
1819
def _write_all_revs(self):
1820
"""Write all revisions out in new form."""
1821
self.bzrdir.transport.delete_tree('revision-store')
1822
self.bzrdir.transport.mkdir('revision-store')
1823
revision_transport = self.bzrdir.transport.clone('revision-store')
1825
_revision_store = TextRevisionStore(TextStore(revision_transport,
1829
transaction = WriteTransaction()
1830
for i, rev_id in enumerate(self.converted_revs):
1831
self.pb.update('write revision', i, len(self.converted_revs))
1832
_revision_store.add_revision(self.revisions[rev_id], transaction)
1836
def _load_one_rev(self, rev_id):
1837
"""Load a revision object into memory.
1839
Any parents not either loaded or abandoned get queued to be
1841
self.pb.update('loading revision',
1842
len(self.revisions),
1843
len(self.known_revisions))
1844
if not self.branch.repository.has_revision(rev_id):
1846
self.pb.note('revision {%s} not present in branch; '
1847
'will be converted as a ghost',
1849
self.absent_revisions.add(rev_id)
1851
rev = self.branch.repository._revision_store.get_revision(rev_id,
1852
self.branch.repository.get_transaction())
1853
for parent_id in rev.parent_ids:
1854
self.known_revisions.add(parent_id)
1855
self.to_read.append(parent_id)
1856
self.revisions[rev_id] = rev
1858
def _load_old_inventory(self, rev_id):
1859
assert rev_id not in self.converted_revs
1860
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1861
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1862
inv.revision_id = rev_id
1863
rev = self.revisions[rev_id]
1864
if rev.inventory_sha1:
1865
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1866
'inventory sha mismatch for {%s}' % rev_id
1869
def _load_updated_inventory(self, rev_id):
1870
assert rev_id in self.converted_revs
1871
inv_xml = self.inv_weave.get_text(rev_id)
1872
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1875
def _convert_one_rev(self, rev_id):
1876
"""Convert revision and all referenced objects to new format."""
1877
rev = self.revisions[rev_id]
1878
inv = self._load_old_inventory(rev_id)
1879
present_parents = [p for p in rev.parent_ids
1880
if p not in self.absent_revisions]
1881
self._convert_revision_contents(rev, inv, present_parents)
1882
self._store_new_weave(rev, inv, present_parents)
1883
self.converted_revs.add(rev_id)
1885
def _store_new_weave(self, rev, inv, present_parents):
1886
# the XML is now updated with text versions
1888
entries = inv.iter_entries()
1890
for path, ie in entries:
1891
assert getattr(ie, 'revision', None) is not None, \
1892
'no revision on {%s} in {%s}' % \
1893
(file_id, rev.revision_id)
1894
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1895
new_inv_sha1 = sha_string(new_inv_xml)
1896
self.inv_weave.add_lines(rev.revision_id,
1898
new_inv_xml.splitlines(True))
1899
rev.inventory_sha1 = new_inv_sha1
1901
def _convert_revision_contents(self, rev, inv, present_parents):
1902
"""Convert all the files within a revision.
1904
Also upgrade the inventory to refer to the text revision ids."""
1905
rev_id = rev.revision_id
1906
mutter('converting texts of revision {%s}',
1908
parent_invs = map(self._load_updated_inventory, present_parents)
1909
entries = inv.iter_entries()
1911
for path, ie in entries:
1912
self._convert_file_version(rev, ie, parent_invs)
1914
def _convert_file_version(self, rev, ie, parent_invs):
1915
"""Convert one version of one file.
1917
The file needs to be added into the weave if it is a merge
1918
of >=2 parents or if it's changed from its parent.
1920
file_id = ie.file_id
1921
rev_id = rev.revision_id
1922
w = self.text_weaves.get(file_id)
1925
self.text_weaves[file_id] = w
1926
text_changed = False
1927
previous_entries = ie.find_previous_heads(parent_invs,
1931
for old_revision in previous_entries:
1932
# if this fails, its a ghost ?
1933
assert old_revision in self.converted_revs, \
1934
"Revision {%s} not in converted_revs" % old_revision
1935
self.snapshot_ie(previous_entries, ie, w, rev_id)
1937
assert getattr(ie, 'revision', None) is not None
1939
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1940
# TODO: convert this logic, which is ~= snapshot to
1941
# a call to:. This needs the path figured out. rather than a work_tree
1942
# a v4 revision_tree can be given, or something that looks enough like
1943
# one to give the file content to the entry if it needs it.
1944
# and we need something that looks like a weave store for snapshot to
1946
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
1947
if len(previous_revisions) == 1:
1948
previous_ie = previous_revisions.values()[0]
1949
if ie._unchanged(previous_ie):
1950
ie.revision = previous_ie.revision
1953
text = self.branch.repository.weave_store.get(ie.text_id)
1954
file_lines = text.readlines()
1955
assert sha_strings(file_lines) == ie.text_sha1
1956
assert sum(map(len, file_lines)) == ie.text_size
1957
w.add_lines(rev_id, previous_revisions, file_lines)
1958
self.text_count += 1
1960
w.add_lines(rev_id, previous_revisions, [])
1961
ie.revision = rev_id
1963
def _make_order(self):
1964
"""Return a suitable order for importing revisions.
1966
The order must be such that an revision is imported after all
1967
its (present) parents.
1969
todo = set(self.revisions.keys())
1970
done = self.absent_revisions.copy()
1973
# scan through looking for a revision whose parents
1975
for rev_id in sorted(list(todo)):
1976
rev = self.revisions[rev_id]
1977
parent_ids = set(rev.parent_ids)
1978
if parent_ids.issubset(done):
1979
# can take this one now
1980
order.append(rev_id)
1986
class ConvertBzrDir5To6(Converter):
1987
"""Converts format 5 bzr dirs to format 6."""
1989
def convert(self, to_convert, pb):
1990
"""See Converter.convert()."""
1991
self.bzrdir = to_convert
1993
self.pb.note('starting upgrade from format 5 to 6')
1994
self._convert_to_prefixed()
1995
return BzrDir.open(self.bzrdir.root_transport.base)
1997
def _convert_to_prefixed(self):
1998
from bzrlib.store import TransportStore
1999
self.bzrdir.transport.delete('branch-format')
2000
for store_name in ["weaves", "revision-store"]:
2001
self.pb.note("adding prefixes to %s" % store_name)
2002
store_transport = self.bzrdir.transport.clone(store_name)
2003
store = TransportStore(store_transport, prefixed=True)
2004
for urlfilename in store_transport.list_dir('.'):
2005
filename = urlutils.unescape(urlfilename)
2006
if (filename.endswith(".weave") or
2007
filename.endswith(".gz") or
2008
filename.endswith(".sig")):
2009
file_id = os.path.splitext(filename)[0]
2012
prefix_dir = store.hash_prefix(file_id)
2013
# FIXME keep track of the dirs made RBC 20060121
2015
store_transport.move(filename, prefix_dir + '/' + filename)
2016
except errors.NoSuchFile: # catches missing dirs strangely enough
2017
store_transport.mkdir(prefix_dir)
2018
store_transport.move(filename, prefix_dir + '/' + filename)
2019
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2022
class ConvertBzrDir6ToMeta(Converter):
2023
"""Converts format 6 bzr dirs to metadirs."""
2025
def convert(self, to_convert, pb):
2026
"""See Converter.convert()."""
2027
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2028
from bzrlib.branch import BzrBranchFormat5
2029
self.bzrdir = to_convert
2032
self.total = 20 # the steps we know about
2033
self.garbage_inventories = []
2035
self.pb.note('starting upgrade from format 6 to metadir')
2036
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2037
# its faster to move specific files around than to open and use the apis...
2038
# first off, nuke ancestry.weave, it was never used.
2040
self.step('Removing ancestry.weave')
2041
self.bzrdir.transport.delete('ancestry.weave')
2042
except errors.NoSuchFile:
2044
# find out whats there
2045
self.step('Finding branch files')
2046
last_revision = self.bzrdir.open_branch().last_revision()
2047
bzrcontents = self.bzrdir.transport.list_dir('.')
2048
for name in bzrcontents:
2049
if name.startswith('basis-inventory.'):
2050
self.garbage_inventories.append(name)
2051
# create new directories for repository, working tree and branch
2052
self.dir_mode = self.bzrdir._control_files._dir_mode
2053
self.file_mode = self.bzrdir._control_files._file_mode
2054
repository_names = [('inventory.weave', True),
2055
('revision-store', True),
2057
self.step('Upgrading repository ')
2058
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2059
self.make_lock('repository')
2060
# we hard code the formats here because we are converting into
2061
# the meta format. The meta format upgrader can take this to a
2062
# future format within each component.
2063
self.put_format('repository', RepositoryFormat7())
2064
for entry in repository_names:
2065
self.move_entry('repository', entry)
2067
self.step('Upgrading branch ')
2068
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2069
self.make_lock('branch')
2070
self.put_format('branch', BzrBranchFormat5())
2071
branch_files = [('revision-history', True),
2072
('branch-name', True),
2074
for entry in branch_files:
2075
self.move_entry('branch', entry)
2077
checkout_files = [('pending-merges', True),
2078
('inventory', True),
2079
('stat-cache', False)]
2080
# If a mandatory checkout file is not present, the branch does not have
2081
# a functional checkout. Do not create a checkout in the converted
2083
for name, mandatory in checkout_files:
2084
if mandatory and name not in bzrcontents:
2085
has_checkout = False
2089
if not has_checkout:
2090
self.pb.note('No working tree.')
2091
# If some checkout files are there, we may as well get rid of them.
2092
for name, mandatory in checkout_files:
2093
if name in bzrcontents:
2094
self.bzrdir.transport.delete(name)
2096
from bzrlib.workingtree import WorkingTreeFormat3
2097
self.step('Upgrading working tree')
2098
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2099
self.make_lock('checkout')
2101
'checkout', WorkingTreeFormat3())
2102
self.bzrdir.transport.delete_multi(
2103
self.garbage_inventories, self.pb)
2104
for entry in checkout_files:
2105
self.move_entry('checkout', entry)
2106
if last_revision is not None:
2107
self.bzrdir._control_files.put_utf8(
2108
'checkout/last-revision', last_revision)
2109
self.bzrdir._control_files.put_utf8(
2110
'branch-format', BzrDirMetaFormat1().get_format_string())
2111
return BzrDir.open(self.bzrdir.root_transport.base)
2113
def make_lock(self, name):
2114
"""Make a lock for the new control dir name."""
2115
self.step('Make %s lock' % name)
2116
ld = lockdir.LockDir(self.bzrdir.transport,
2118
file_modebits=self.file_mode,
2119
dir_modebits=self.dir_mode)
2122
def move_entry(self, new_dir, entry):
2123
"""Move then entry name into new_dir."""
2125
mandatory = entry[1]
2126
self.step('Moving %s' % name)
2128
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2129
except errors.NoSuchFile:
2133
def put_format(self, dirname, format):
2134
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2137
class ConvertMetaToMeta(Converter):
2138
"""Converts the components of metadirs."""
2140
def __init__(self, target_format):
2141
"""Create a metadir to metadir converter.
2143
:param target_format: The final metadir format that is desired.
2145
self.target_format = target_format
2147
def convert(self, to_convert, pb):
2148
"""See Converter.convert()."""
2149
self.bzrdir = to_convert
2153
self.step('checking repository format')
2155
repo = self.bzrdir.open_repository()
2156
except errors.NoRepositoryPresent:
2159
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2160
from bzrlib.repository import CopyConverter
2161
self.pb.note('starting repository conversion')
2162
converter = CopyConverter(self.target_format.repository_format)
2163
converter.convert(repo, pb)
2165
branch = self.bzrdir.open_branch()
2166
except errors.NotBranchError:
2169
# TODO: conversions of Branch and Tree should be done by
2170
# InterXFormat lookups
2171
# Avoid circular imports
2172
from bzrlib import branch as _mod_branch
2173
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2174
self.target_format.get_branch_format().__class__ is
2175
_mod_branch.BzrBranchFormat6):
2176
branch_converter = _mod_branch.Converter5to6()
2177
branch_converter.convert(branch)
2179
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2180
except (errors.NoWorkingTree, errors.NotLocalUrl):
2183
# TODO: conversions of Branch and Tree should be done by
2184
# InterXFormat lookups
2185
if (isinstance(tree, workingtree.WorkingTree3) and
2186
not isinstance(tree, workingtree_4.WorkingTree4) and
2187
isinstance(self.target_format.workingtree_format,
2188
workingtree_4.WorkingTreeFormat4)):
2189
workingtree_4.Converter3to4().convert(tree)
2193
# This is not in remote.py because it's small, and needs to be registered.
2194
# Putting it in remote.py creates a circular import problem.
2195
# we can make it a lazy object if the control formats is turned into something
2197
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2198
"""Format representing bzrdirs accessed via a smart server"""
2200
def get_format_description(self):
2201
return 'bzr remote bzrdir'
2204
def probe_transport(klass, transport):
2205
"""Return a RemoteBzrDirFormat object if it looks possible."""
2207
client = transport.get_smart_client()
2208
except (NotImplementedError, AttributeError,
2209
errors.TransportNotPossible):
2210
# no smart server, so not a branch for this format type.
2211
raise errors.NotBranchError(path=transport.base)
2213
# Send a 'hello' request in protocol version one, and decline to
2214
# open it if the server doesn't support our required version (2) so
2215
# that the VFS-based transport will do it.
2216
request = client.get_request()
2217
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
2218
server_version = smart_protocol.query_version()
2219
if server_version != 2:
2220
raise errors.NotBranchError(path=transport.base)
2223
def initialize_on_transport(self, transport):
2225
# hand off the request to the smart server
2226
shared_medium = transport.get_shared_medium()
2227
except errors.NoSmartMedium:
2228
# TODO: lookup the local format from a server hint.
2229
local_dir_format = BzrDirMetaFormat1()
2230
return local_dir_format.initialize_on_transport(transport)
2231
client = _SmartClient(shared_medium)
2232
path = client.remote_path_from_transport(transport)
2233
response = _SmartClient(shared_medium).call('BzrDirFormat.initialize',
2235
assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
2236
return remote.RemoteBzrDir(transport)
2238
def _open(self, transport):
2239
return remote.RemoteBzrDir(transport)
2241
def __eq__(self, other):
2242
if not isinstance(other, RemoteBzrDirFormat):
2244
return self.get_format_description() == other.get_format_description()
2247
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2250
class BzrDirFormatInfo(object):
2252
def __init__(self, native, deprecated, hidden):
2253
self.deprecated = deprecated
2254
self.native = native
2255
self.hidden = hidden
2258
class BzrDirFormatRegistry(registry.Registry):
2259
"""Registry of user-selectable BzrDir subformats.
2261
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2262
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2265
def register_metadir(self, key,
2266
repository_format, help, native=True, deprecated=False,
2270
"""Register a metadir subformat.
2272
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2273
by the Repository format.
2275
:param repository_format: The fully-qualified repository format class
2277
:param branch_format: Fully-qualified branch format class name as
2279
:param tree_format: Fully-qualified tree format class name as
2282
# This should be expanded to support setting WorkingTree and Branch
2283
# formats, once BzrDirMetaFormat1 supports that.
2284
def _load(full_name):
2285
mod_name, factory_name = full_name.rsplit('.', 1)
2287
mod = __import__(mod_name, globals(), locals(),
2289
except ImportError, e:
2290
raise ImportError('failed to load %s: %s' % (full_name, e))
2292
factory = getattr(mod, factory_name)
2293
except AttributeError:
2294
raise AttributeError('no factory %s in module %r'
2299
bd = BzrDirMetaFormat1()
2300
if branch_format is not None:
2301
bd.set_branch_format(_load(branch_format))
2302
if tree_format is not None:
2303
bd.workingtree_format = _load(tree_format)
2304
if repository_format is not None:
2305
bd.repository_format = _load(repository_format)
2307
self.register(key, helper, help, native, deprecated, hidden)
2309
def register(self, key, factory, help, native=True, deprecated=False,
2311
"""Register a BzrDirFormat factory.
2313
The factory must be a callable that takes one parameter: the key.
2314
It must produce an instance of the BzrDirFormat when called.
2316
This function mainly exists to prevent the info object from being
2319
registry.Registry.register(self, key, factory, help,
2320
BzrDirFormatInfo(native, deprecated, hidden))
2322
def register_lazy(self, key, module_name, member_name, help, native=True,
2323
deprecated=False, hidden=False):
2324
registry.Registry.register_lazy(self, key, module_name, member_name,
2325
help, BzrDirFormatInfo(native, deprecated, hidden))
2327
def set_default(self, key):
2328
"""Set the 'default' key to be a clone of the supplied key.
2330
This method must be called once and only once.
2332
registry.Registry.register(self, 'default', self.get(key),
2333
self.get_help(key), info=self.get_info(key))
2335
def set_default_repository(self, key):
2336
"""Set the FormatRegistry default and Repository default.
2338
This is a transitional method while Repository.set_default_format
2341
if 'default' in self:
2342
self.remove('default')
2343
self.set_default(key)
2344
format = self.get('default')()
2345
assert isinstance(format, BzrDirMetaFormat1)
2347
def make_bzrdir(self, key):
2348
return self.get(key)()
2350
def help_topic(self, topic):
2351
output = textwrap.dedent("""\
2352
These formats can be used for creating branches, working trees, and
2356
default_help = self.get_help('default')
2358
for key in self.keys():
2359
if key == 'default':
2361
help = self.get_help(key)
2362
if help == default_help:
2363
default_realkey = key
2365
help_pairs.append((key, help))
2367
def wrapped(key, help, info):
2369
help = '(native) ' + help
2370
return ':%s:\n%s\n\n' % (key,
2371
textwrap.fill(help, initial_indent=' ',
2372
subsequent_indent=' '))
2373
output += wrapped(default_realkey, '(default) %s' % default_help,
2374
self.get_info('default'))
2375
deprecated_pairs = []
2376
for key, help in help_pairs:
2377
info = self.get_info(key)
2380
elif info.deprecated:
2381
deprecated_pairs.append((key, help))
2383
output += wrapped(key, help, info)
2384
if len(deprecated_pairs) > 0:
2385
output += "Deprecated formats are shown below.\n\n"
2386
for key, help in deprecated_pairs:
2387
info = self.get_info(key)
2388
output += wrapped(key, help, info)
2393
format_registry = BzrDirFormatRegistry()
2394
format_registry.register('weave', BzrDirFormat6,
2395
'Pre-0.8 format. Slower than knit and does not'
2396
' support checkouts or shared repositories.',
2398
format_registry.register_metadir('knit',
2399
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2400
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2401
branch_format='bzrlib.branch.BzrBranchFormat5',
2402
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2403
format_registry.register_metadir('metaweave',
2404
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2405
'Transitional format in 0.8. Slower than knit.',
2406
branch_format='bzrlib.branch.BzrBranchFormat5',
2407
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2409
format_registry.register_metadir('dirstate',
2410
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2411
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2412
'above when accessed over the network.',
2413
branch_format='bzrlib.branch.BzrBranchFormat5',
2414
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2415
# directly from workingtree_4 triggers a circular import.
2416
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2418
format_registry.register_metadir('dirstate-tags',
2419
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2420
help='New in 0.15: Fast local operations and improved scaling for '
2421
'network operations. Additionally adds support for tags.'
2422
' Incompatible with bzr < 0.15.',
2423
branch_format='bzrlib.branch.BzrBranchFormat6',
2424
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2426
format_registry.register_metadir('dirstate-with-subtree',
2427
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2428
help='New in 0.15: Fast local operations and improved scaling for '
2429
'network operations. Additionally adds support for versioning nested '
2430
'bzr branches. Incompatible with bzr < 0.15.',
2431
branch_format='bzrlib.branch.BzrBranchFormat6',
2432
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2435
format_registry.set_default('dirstate')
added
removed
bzrlib/bzrdir.py
