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 (
55
from bzrlib.smart.client import _SmartClient
56
from bzrlib.smart import protocol
57
from bzrlib.store.revision.text import TextRevisionStore
58
from bzrlib.store.text import TextStore
59
from bzrlib.store.versioned import WeaveStore
60
from bzrlib.transactions import WriteTransaction
61
from bzrlib.transport import (
62
do_catching_redirections,
65
from bzrlib.weave import Weave
68
from bzrlib.trace import (
72
from bzrlib.transport.local import LocalTransport
76
"""A .bzr control diretory.
78
BzrDir instances let you create or open any of the things that can be
79
found within .bzr - checkouts, branches and repositories.
82
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
84
a transport connected to the directory this bzr was opened from.
88
"""Invoke break_lock on the first object in the bzrdir.
90
If there is a tree, the tree is opened and break_lock() called.
91
Otherwise, branch is tried, and finally repository.
93
# XXX: This seems more like a UI function than something that really
94
# belongs in this class.
96
thing_to_unlock = self.open_workingtree()
97
except (errors.NotLocalUrl, errors.NoWorkingTree):
99
thing_to_unlock = self.open_branch()
100
except errors.NotBranchError:
102
thing_to_unlock = self.open_repository()
103
except errors.NoRepositoryPresent:
105
thing_to_unlock.break_lock()
107
def can_convert_format(self):
108
"""Return true if this bzrdir is one whose format we can convert from."""
111
def check_conversion_target(self, target_format):
112
target_repo_format = target_format.repository_format
113
source_repo_format = self._format.repository_format
114
source_repo_format.check_conversion_target(target_repo_format)
117
def _check_supported(format, allow_unsupported,
118
recommend_upgrade=True,
120
"""Give an error or warning on old formats.
122
:param format: may be any kind of format - workingtree, branch,
125
:param allow_unsupported: If true, allow opening
126
formats that are strongly deprecated, and which may
127
have limited functionality.
129
:param recommend_upgrade: If true (default), warn
130
the user through the ui object that they may wish
131
to upgrade the object.
133
# TODO: perhaps move this into a base Format class; it's not BzrDir
134
# specific. mbp 20070323
135
if not allow_unsupported and not format.is_supported():
136
# see open_downlevel to open legacy branches.
137
raise errors.UnsupportedFormatError(format=format)
138
if recommend_upgrade \
139
and getattr(format, 'upgrade_recommended', False):
140
ui.ui_factory.recommend_upgrade(
141
format.get_format_description(),
144
def clone(self, url, revision_id=None, force_new_repo=False):
145
"""Clone this bzrdir and its contents to url verbatim.
147
If urls last component does not exist, it will be created.
149
if revision_id is not None, then the clone operation may tune
150
itself to download less data.
151
:param force_new_repo: Do not use a shared repository for the target
152
even if one is available.
154
return self.clone_on_transport(get_transport(url),
155
revision_id=revision_id,
156
force_new_repo=force_new_repo)
158
def clone_on_transport(self, transport, revision_id=None,
159
force_new_repo=False):
160
"""Clone this bzrdir and its contents to transport verbatim.
162
If the target directory does not exist, it will be created.
164
if revision_id is not None, then the clone operation may tune
165
itself to download less data.
166
:param force_new_repo: Do not use a shared repository for the target
167
even if one is available.
169
transport.ensure_base()
170
result = self._format.initialize_on_transport(transport)
172
local_repo = self.find_repository()
173
except errors.NoRepositoryPresent:
176
# may need to copy content in
178
result_repo = local_repo.clone(
180
revision_id=revision_id)
181
result_repo.set_make_working_trees(local_repo.make_working_trees())
184
result_repo = result.find_repository()
185
# fetch content this dir needs.
186
result_repo.fetch(local_repo, revision_id=revision_id)
187
except errors.NoRepositoryPresent:
188
# needed to make one anyway.
189
result_repo = local_repo.clone(
191
revision_id=revision_id)
192
result_repo.set_make_working_trees(local_repo.make_working_trees())
193
# 1 if there is a branch present
194
# make sure its content is available in the target repository
197
self.open_branch().clone(result, revision_id=revision_id)
198
except errors.NotBranchError:
201
self.open_workingtree().clone(result)
202
except (errors.NoWorkingTree, errors.NotLocalUrl):
206
# TODO: This should be given a Transport, and should chdir up; otherwise
207
# this will open a new connection.
208
def _make_tail(self, url):
209
t = get_transport(url)
212
# TODO: Should take a Transport
214
def create(cls, base, format=None):
215
"""Create a new BzrDir at the url 'base'.
217
This will call the current default formats initialize with base
218
as the only parameter.
220
:param format: If supplied, the format of branch to create. If not
221
supplied, the default is used.
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)
229
format = BzrDirFormat.get_default_format()
230
return format.initialize(safe_unicode(base))
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
"""Create a new BzrDir, Branch and Repository at the url 'base'.
272
This is a convenience function - it will use an existing repository
273
if possible, can be told explicitly whether to create a working tree or
276
This will use the current default BzrDirFormat, and use whatever
277
repository format that that uses via bzrdir.create_branch and
278
create_repository. If a shared repository is available that is used
279
preferentially. Whatever repository is used, its tree creation policy
282
The created Branch object is returned.
283
If a working tree cannot be made due to base not being a file:// url,
284
no error is raised unless force_new_tree is True, in which case no
285
data is created on disk and NotLocalUrl is raised.
287
:param base: The URL to create the branch at.
288
:param force_new_repo: If True a new repository is always created.
289
:param force_new_tree: If True or False force creation of a tree or
290
prevent such creation respectively.
291
:param format: Override for the for the bzrdir format to create
294
# check for non local urls
295
t = get_transport(safe_unicode(base))
296
if not isinstance(t, LocalTransport):
297
raise errors.NotLocalUrl(base)
298
bzrdir = BzrDir.create(base, format)
299
repo = bzrdir._find_or_create_repository(force_new_repo)
300
result = bzrdir.create_branch()
301
if force_new_tree or (repo.make_working_trees() and
302
force_new_tree is None):
304
bzrdir.create_workingtree()
305
except errors.NotLocalUrl:
310
def create_repository(base, shared=False, format=None):
311
"""Create a new BzrDir and Repository at the url 'base'.
313
If no format is supplied, this will default to the current default
314
BzrDirFormat by default, and use whatever repository format that that
315
uses for bzrdirformat.create_repository.
317
:param shared: Create a shared repository rather than a standalone
319
The Repository object is returned.
321
This must be overridden as an instance method in child classes, where
322
it should take no parameters and construct whatever repository format
323
that child class desires.
325
bzrdir = BzrDir.create(base, format)
326
return bzrdir.create_repository(shared)
329
def create_standalone_workingtree(base, format=None):
330
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
332
'base' must be a local path or a file:// url.
334
This will use the current default BzrDirFormat, and use whatever
335
repository format that that uses for bzrdirformat.create_workingtree,
336
create_branch and create_repository.
338
:return: The WorkingTree object.
340
t = get_transport(safe_unicode(base))
341
if not isinstance(t, LocalTransport):
342
raise errors.NotLocalUrl(base)
343
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
345
format=format).bzrdir
346
return bzrdir.create_workingtree()
348
def create_workingtree(self, revision_id=None):
349
"""Create a working tree at this BzrDir.
351
revision_id: create it as of this revision id.
353
raise NotImplementedError(self.create_workingtree)
355
def retire_bzrdir(self):
356
"""Permanently disable the bzrdir.
358
This is done by renaming it to give the user some ability to recover
359
if there was a problem.
361
This will have horrible consequences if anyone has anything locked or
364
for i in xrange(10000):
366
to_path = '.bzr.retired.%d' % i
367
self.root_transport.rename('.bzr', to_path)
368
note("renamed %s to %s"
369
% (self.root_transport.abspath('.bzr'), to_path))
371
except (errors.TransportError, IOError, errors.PathError):
374
def destroy_workingtree(self):
375
"""Destroy the working tree at this BzrDir.
377
Formats that do not support this may raise UnsupportedOperation.
379
raise NotImplementedError(self.destroy_workingtree)
381
def destroy_workingtree_metadata(self):
382
"""Destroy the control files for the working tree at this BzrDir.
384
The contents of working tree files are not affected.
385
Formats that do not support this may raise UnsupportedOperation.
387
raise NotImplementedError(self.destroy_workingtree_metadata)
389
def find_repository(self):
390
"""Find the repository that should be used for a_bzrdir.
392
This does not require a branch as we use it to find the repo for
393
new branches as well as to hook existing branches up to their
397
return self.open_repository()
398
except errors.NoRepositoryPresent:
400
next_transport = self.root_transport.clone('..')
402
# find the next containing bzrdir
404
found_bzrdir = BzrDir.open_containing_from_transport(
406
except errors.NotBranchError:
408
raise errors.NoRepositoryPresent(self)
409
# does it have a repository ?
411
repository = found_bzrdir.open_repository()
412
except errors.NoRepositoryPresent:
413
next_transport = found_bzrdir.root_transport.clone('..')
414
if (found_bzrdir.root_transport.base == next_transport.base):
415
# top of the file system
419
if ((found_bzrdir.root_transport.base ==
420
self.root_transport.base) or repository.is_shared()):
423
raise errors.NoRepositoryPresent(self)
424
raise errors.NoRepositoryPresent(self)
426
def get_branch_reference(self):
427
"""Return the referenced URL for the branch in this bzrdir.
429
:raises NotBranchError: If there is no Branch.
430
:return: The URL the branch in this bzrdir references if it is a
431
reference branch, or None for regular branches.
435
def get_branch_transport(self, branch_format):
436
"""Get the transport for use by branch format in this BzrDir.
438
Note that bzr dirs that do not support format strings will raise
439
IncompatibleFormat if the branch format they are given has
440
a format string, and vice versa.
442
If branch_format is None, the transport is returned with no
443
checking. if it is not None, then the returned transport is
444
guaranteed to point to an existing directory ready for use.
446
raise NotImplementedError(self.get_branch_transport)
448
def get_repository_transport(self, repository_format):
449
"""Get the transport for use by repository format in this BzrDir.
451
Note that bzr dirs that do not support format strings will raise
452
IncompatibleFormat if the repository format they are given has
453
a format string, and vice versa.
455
If repository_format is None, the transport is returned with no
456
checking. if it is not None, then the returned transport is
457
guaranteed to point to an existing directory ready for use.
459
raise NotImplementedError(self.get_repository_transport)
461
def get_workingtree_transport(self, tree_format):
462
"""Get the transport for use by workingtree format in this BzrDir.
464
Note that bzr dirs that do not support format strings will raise
465
IncompatibleFormat if the workingtree format they are given has a
466
format string, and vice versa.
468
If workingtree_format is None, the transport is returned with no
469
checking. if it is not None, then the returned transport is
470
guaranteed to point to an existing directory ready for use.
472
raise NotImplementedError(self.get_workingtree_transport)
474
def __init__(self, _transport, _format):
475
"""Initialize a Bzr control dir object.
477
Only really common logic should reside here, concrete classes should be
478
made with varying behaviours.
480
:param _format: the format that is creating this BzrDir instance.
481
:param _transport: the transport this dir is based at.
483
self._format = _format
484
self.transport = _transport.clone('.bzr')
485
self.root_transport = _transport
487
def is_control_filename(self, filename):
488
"""True if filename is the name of a path which is reserved for bzrdir's.
490
:param filename: A filename within the root transport of this bzrdir.
492
This is true IF and ONLY IF the filename is part of the namespace reserved
493
for bzr control dirs. Currently this is the '.bzr' directory in the root
494
of the root_transport. it is expected that plugins will need to extend
495
this in the future - for instance to make bzr talk with svn working
498
# this might be better on the BzrDirFormat class because it refers to
499
# all the possible bzrdir disk formats.
500
# This method is tested via the workingtree is_control_filename tests-
501
# it was extracted from WorkingTree.is_control_filename. If the methods
502
# contract is extended beyond the current trivial implementation please
503
# add new tests for it to the appropriate place.
504
return filename == '.bzr' or filename.startswith('.bzr/')
506
def needs_format_conversion(self, format=None):
507
"""Return true if this bzrdir needs convert_format run on it.
509
For instance, if the repository format is out of date but the
510
branch and working tree are not, this should return True.
512
:param format: Optional parameter indicating a specific desired
513
format we plan to arrive at.
515
raise NotImplementedError(self.needs_format_conversion)
518
def open_unsupported(base):
519
"""Open a branch which is not supported."""
520
return BzrDir.open(base, _unsupported=True)
523
def open(base, _unsupported=False):
524
"""Open an existing bzrdir, rooted at 'base' (url)
526
_unsupported is a private parameter to the BzrDir class.
528
t = get_transport(base)
529
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
532
def open_from_transport(transport, _unsupported=False,
533
_server_formats=True):
534
"""Open a bzrdir within a particular directory.
536
:param transport: Transport containing the bzrdir.
537
:param _unsupported: private.
539
base = transport.base
541
def find_format(transport):
542
return transport, BzrDirFormat.find_format(
543
transport, _server_formats=_server_formats)
545
def redirected(transport, e, redirection_notice):
546
qualified_source = e.get_source_url()
547
relpath = transport.relpath(qualified_source)
548
if not e.target.endswith(relpath):
549
# Not redirected to a branch-format, not a branch
550
raise errors.NotBranchError(path=e.target)
551
target = e.target[:-len(relpath)]
552
note('%s is%s redirected to %s',
553
transport.base, e.permanently, target)
554
# Let's try with a new transport
555
qualified_target = e.get_target_url()[:-len(relpath)]
556
# FIXME: If 'transport' has a qualifier, this should
557
# be applied again to the new transport *iff* the
558
# schemes used are the same. It's a bit tricky to
559
# verify, so I'll punt for now
561
return get_transport(target)
564
transport, format = do_catching_redirections(find_format,
567
except errors.TooManyRedirections:
568
raise errors.NotBranchError(base)
570
BzrDir._check_supported(format, _unsupported)
571
return format.open(transport, _found=True)
573
def open_branch(self, unsupported=False):
574
"""Open the branch object at this BzrDir if one is present.
576
If unsupported is True, then no longer supported branch formats can
579
TODO: static convenience version of this?
581
raise NotImplementedError(self.open_branch)
584
def open_containing(url):
585
"""Open an existing branch which contains url.
587
:param url: url to search from.
588
See open_containing_from_transport for more detail.
590
return BzrDir.open_containing_from_transport(get_transport(url))
593
def open_containing_from_transport(a_transport):
594
"""Open an existing branch which contains a_transport.base
596
This probes for a branch at a_transport, and searches upwards from there.
598
Basically we keep looking up until we find the control directory or
599
run into the root. If there isn't one, raises NotBranchError.
600
If there is one and it is either an unrecognised format or an unsupported
601
format, UnknownFormatError or UnsupportedFormatError are raised.
602
If there is one, it is returned, along with the unused portion of url.
604
:return: The BzrDir that contains the path, and a Unicode path
605
for the rest of the URL.
607
# this gets the normalised url back. I.e. '.' -> the full path.
608
url = a_transport.base
611
result = BzrDir.open_from_transport(a_transport)
612
return result, urlutils.unescape(a_transport.relpath(url))
613
except errors.NotBranchError, e:
616
new_t = a_transport.clone('..')
617
except errors.InvalidURLJoin:
618
# reached the root, whatever that may be
619
raise errors.NotBranchError(path=url)
620
if new_t.base == a_transport.base:
621
# reached the root, whatever that may be
622
raise errors.NotBranchError(path=url)
626
def open_containing_tree_or_branch(klass, location):
627
"""Return the branch and working tree contained by a location.
629
Returns (tree, branch, relpath).
630
If there is no tree at containing the location, tree will be None.
631
If there is no branch containing the location, an exception will be
633
relpath is the portion of the path that is contained by the branch.
635
bzrdir, relpath = klass.open_containing(location)
637
tree = bzrdir.open_workingtree()
638
except (errors.NoWorkingTree, errors.NotLocalUrl):
640
branch = bzrdir.open_branch()
643
return tree, branch, relpath
645
def open_repository(self, _unsupported=False):
646
"""Open the repository object at this BzrDir if one is present.
648
This will not follow the Branch object pointer - its strictly a direct
649
open facility. Most client code should use open_branch().repository to
652
_unsupported is a private parameter, not part of the api.
653
TODO: static convenience version of this?
655
raise NotImplementedError(self.open_repository)
657
def open_workingtree(self, _unsupported=False,
658
recommend_upgrade=True):
659
"""Open the workingtree object at this BzrDir if one is present.
661
:param recommend_upgrade: Optional keyword parameter, when True (the
662
default), emit through the ui module a recommendation that the user
663
upgrade the working tree when the workingtree being opened is old
664
(but still fully supported).
666
raise NotImplementedError(self.open_workingtree)
668
def has_branch(self):
669
"""Tell if this bzrdir contains a branch.
671
Note: if you're going to open the branch, you should just go ahead
672
and try, and not ask permission first. (This method just opens the
673
branch and discards it, and that's somewhat expensive.)
678
except errors.NotBranchError:
681
def has_workingtree(self):
682
"""Tell if this bzrdir contains a working tree.
684
This will still raise an exception if the bzrdir has a workingtree that
685
is remote & inaccessible.
687
Note: if you're going to open the working tree, you should just go ahead
688
and try, and not ask permission first. (This method just opens the
689
workingtree and discards it, and that's somewhat expensive.)
692
self.open_workingtree(recommend_upgrade=False)
694
except errors.NoWorkingTree:
697
def _cloning_metadir(self):
698
"""Produce a metadir suitable for cloning with"""
699
result_format = self._format.__class__()
702
branch = self.open_branch()
703
source_repository = branch.repository
704
except errors.NotBranchError:
706
source_repository = self.open_repository()
707
except errors.NoRepositoryPresent:
708
source_repository = None
710
# XXX TODO: This isinstance is here because we have not implemented
711
# the fix recommended in bug # 103195 - to delegate this choice the
713
repo_format = source_repository._format
714
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
715
result_format.repository_format = repo_format
717
# TODO: Couldn't we just probe for the format in these cases,
718
# rather than opening the whole tree? It would be a little
719
# faster. mbp 20070401
720
tree = self.open_workingtree(recommend_upgrade=False)
721
except (errors.NoWorkingTree, errors.NotLocalUrl):
722
result_format.workingtree_format = None
724
result_format.workingtree_format = tree._format.__class__()
725
return result_format, source_repository
727
def cloning_metadir(self):
728
"""Produce a metadir suitable for cloning or sprouting with.
730
These operations may produce workingtrees (yes, even though they're
731
"cloning" something that doesn't have a tree, so a viable workingtree
732
format must be selected.
734
format, repository = self._cloning_metadir()
735
if format._workingtree_format is None:
736
if repository is None:
738
tree_format = repository._format._matchingbzrdir.workingtree_format
739
format.workingtree_format = tree_format.__class__()
742
def checkout_metadir(self):
743
return self.cloning_metadir()
745
def sprout(self, url, revision_id=None, force_new_repo=False,
747
"""Create a copy of this bzrdir prepared for use as a new line of
750
If urls last component does not exist, it will be created.
752
Attributes related to the identity of the source branch like
753
branch nickname will be cleaned, a working tree is created
754
whether one existed before or not; and a local branch is always
757
if revision_id is not None, then the clone operation may tune
758
itself to download less data.
760
target_transport = get_transport(url)
761
target_transport.ensure_base()
762
cloning_format = self.cloning_metadir()
763
result = cloning_format.initialize_on_transport(target_transport)
765
source_branch = self.open_branch()
766
source_repository = source_branch.repository
767
except errors.NotBranchError:
770
source_repository = self.open_repository()
771
except errors.NoRepositoryPresent:
772
source_repository = None
777
result_repo = result.find_repository()
778
except errors.NoRepositoryPresent:
780
if source_repository is None and result_repo is not None:
782
elif source_repository is None and result_repo is None:
783
# no repo available, make a new one
784
result.create_repository()
785
elif source_repository is not None and result_repo is None:
786
# have source, and want to make a new target repo
787
result_repo = source_repository.sprout(result, revision_id=revision_id)
789
# fetch needed content into target.
790
if source_repository is not None:
792
# source_repository.copy_content_into(result_repo, revision_id=revision_id)
793
# so we can override the copy method
794
result_repo.fetch(source_repository, revision_id=revision_id)
795
if source_branch is not None:
796
source_branch.sprout(result, revision_id=revision_id)
798
result.create_branch()
799
# TODO: jam 20060426 we probably need a test in here in the
800
# case that the newly sprouted branch is a remote one
801
if result_repo is None or result_repo.make_working_trees():
802
wt = result.create_workingtree()
805
if wt.path2id('') is None:
807
wt.set_root_id(self.open_workingtree.get_root_id())
808
except errors.NoWorkingTree:
814
if recurse == 'down':
816
basis = wt.basis_tree()
818
subtrees = basis.iter_references()
819
recurse_branch = wt.branch
820
elif source_branch is not None:
821
basis = source_branch.basis_tree()
823
subtrees = basis.iter_references()
824
recurse_branch = source_branch
829
for path, file_id in subtrees:
830
target = urlutils.join(url, urlutils.escape(path))
831
sublocation = source_branch.reference_parent(file_id, path)
832
sublocation.bzrdir.sprout(target,
833
basis.get_reference_revision(file_id, path),
834
force_new_repo=force_new_repo, recurse=recurse)
836
if basis is not None:
841
class BzrDirPreSplitOut(BzrDir):
842
"""A common class for the all-in-one formats."""
844
def __init__(self, _transport, _format):
845
"""See BzrDir.__init__."""
846
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
847
assert self._format._lock_class == lockable_files.TransportLock
848
assert self._format._lock_file_name == 'branch-lock'
849
self._control_files = lockable_files.LockableFiles(
850
self.get_branch_transport(None),
851
self._format._lock_file_name,
852
self._format._lock_class)
854
def break_lock(self):
855
"""Pre-splitout bzrdirs do not suffer from stale locks."""
856
raise NotImplementedError(self.break_lock)
858
def clone(self, url, revision_id=None, force_new_repo=False):
859
"""See BzrDir.clone()."""
860
from bzrlib.workingtree import WorkingTreeFormat2
862
result = self._format._initialize_for_clone(url)
863
self.open_repository().clone(result, revision_id=revision_id)
864
from_branch = self.open_branch()
865
from_branch.clone(result, revision_id=revision_id)
867
self.open_workingtree().clone(result)
868
except errors.NotLocalUrl:
869
# make a new one, this format always has to have one.
871
WorkingTreeFormat2().initialize(result)
872
except errors.NotLocalUrl:
873
# but we cannot do it for remote trees.
874
to_branch = result.open_branch()
875
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
878
def create_branch(self):
879
"""See BzrDir.create_branch."""
880
return self.open_branch()
882
def create_repository(self, shared=False):
883
"""See BzrDir.create_repository."""
885
raise errors.IncompatibleFormat('shared repository', self._format)
886
return self.open_repository()
888
def create_workingtree(self, revision_id=None):
889
"""See BzrDir.create_workingtree."""
890
# this looks buggy but is not -really-
891
# because this format creates the workingtree when the bzrdir is
893
# clone and sprout will have set the revision_id
894
# and that will have set it for us, its only
895
# specific uses of create_workingtree in isolation
896
# that can do wonky stuff here, and that only
897
# happens for creating checkouts, which cannot be
898
# done on this format anyway. So - acceptable wart.
899
result = self.open_workingtree(recommend_upgrade=False)
900
if revision_id is not None:
901
if revision_id == _mod_revision.NULL_REVISION:
902
result.set_parent_ids([])
904
result.set_parent_ids([revision_id])
907
def destroy_workingtree(self):
908
"""See BzrDir.destroy_workingtree."""
909
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
911
def destroy_workingtree_metadata(self):
912
"""See BzrDir.destroy_workingtree_metadata."""
913
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
916
def get_branch_transport(self, branch_format):
917
"""See BzrDir.get_branch_transport()."""
918
if branch_format is None:
919
return self.transport
921
branch_format.get_format_string()
922
except NotImplementedError:
923
return self.transport
924
raise errors.IncompatibleFormat(branch_format, self._format)
926
def get_repository_transport(self, repository_format):
927
"""See BzrDir.get_repository_transport()."""
928
if repository_format is None:
929
return self.transport
931
repository_format.get_format_string()
932
except NotImplementedError:
933
return self.transport
934
raise errors.IncompatibleFormat(repository_format, self._format)
936
def get_workingtree_transport(self, workingtree_format):
937
"""See BzrDir.get_workingtree_transport()."""
938
if workingtree_format is None:
939
return self.transport
941
workingtree_format.get_format_string()
942
except NotImplementedError:
943
return self.transport
944
raise errors.IncompatibleFormat(workingtree_format, self._format)
946
def needs_format_conversion(self, format=None):
947
"""See BzrDir.needs_format_conversion()."""
948
# if the format is not the same as the system default,
949
# an upgrade is needed.
951
format = BzrDirFormat.get_default_format()
952
return not isinstance(self._format, format.__class__)
954
def open_branch(self, unsupported=False):
955
"""See BzrDir.open_branch."""
956
from bzrlib.branch import BzrBranchFormat4
957
format = BzrBranchFormat4()
958
self._check_supported(format, unsupported)
959
return format.open(self, _found=True)
961
def sprout(self, url, revision_id=None, force_new_repo=False):
962
"""See BzrDir.sprout()."""
963
from bzrlib.workingtree import WorkingTreeFormat2
965
result = self._format._initialize_for_clone(url)
967
self.open_repository().clone(result, revision_id=revision_id)
968
except errors.NoRepositoryPresent:
971
self.open_branch().sprout(result, revision_id=revision_id)
972
except errors.NotBranchError:
974
# we always want a working tree
975
WorkingTreeFormat2().initialize(result)
979
class BzrDir4(BzrDirPreSplitOut):
980
"""A .bzr version 4 control object.
982
This is a deprecated format and may be removed after sept 2006.
985
def create_repository(self, shared=False):
986
"""See BzrDir.create_repository."""
987
return self._format.repository_format.initialize(self, shared)
989
def needs_format_conversion(self, format=None):
990
"""Format 4 dirs are always in need of conversion."""
993
def open_repository(self):
994
"""See BzrDir.open_repository."""
995
from bzrlib.repofmt.weaverepo import RepositoryFormat4
996
return RepositoryFormat4().open(self, _found=True)
999
class BzrDir5(BzrDirPreSplitOut):
1000
"""A .bzr version 5 control object.
1002
This is a deprecated format and may be removed after sept 2006.
1005
def open_repository(self):
1006
"""See BzrDir.open_repository."""
1007
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1008
return RepositoryFormat5().open(self, _found=True)
1010
def open_workingtree(self, _unsupported=False,
1011
recommend_upgrade=True):
1012
"""See BzrDir.create_workingtree."""
1013
from bzrlib.workingtree import WorkingTreeFormat2
1014
wt_format = WorkingTreeFormat2()
1015
# we don't warn here about upgrades; that ought to be handled for the
1017
return wt_format.open(self, _found=True)
1020
class BzrDir6(BzrDirPreSplitOut):
1021
"""A .bzr version 6 control object.
1023
This is a deprecated format and may be removed after sept 2006.
1026
def open_repository(self):
1027
"""See BzrDir.open_repository."""
1028
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1029
return RepositoryFormat6().open(self, _found=True)
1031
def open_workingtree(self, _unsupported=False,
1032
recommend_upgrade=True):
1033
"""See BzrDir.create_workingtree."""
1034
# we don't warn here about upgrades; that ought to be handled for the
1036
from bzrlib.workingtree import WorkingTreeFormat2
1037
return WorkingTreeFormat2().open(self, _found=True)
1040
class BzrDirMeta1(BzrDir):
1041
"""A .bzr meta version 1 control object.
1043
This is the first control object where the
1044
individual aspects are really split out: there are separate repository,
1045
workingtree and branch subdirectories and any subset of the three can be
1046
present within a BzrDir.
1049
def can_convert_format(self):
1050
"""See BzrDir.can_convert_format()."""
1053
def create_branch(self):
1054
"""See BzrDir.create_branch."""
1055
return self._format.get_branch_format().initialize(self)
1057
def create_repository(self, shared=False):
1058
"""See BzrDir.create_repository."""
1059
return self._format.repository_format.initialize(self, shared)
1061
def create_workingtree(self, revision_id=None):
1062
"""See BzrDir.create_workingtree."""
1063
from bzrlib.workingtree import WorkingTreeFormat
1064
return self._format.workingtree_format.initialize(self, revision_id)
1066
def destroy_workingtree(self):
1067
"""See BzrDir.destroy_workingtree."""
1068
wt = self.open_workingtree(recommend_upgrade=False)
1069
repository = wt.branch.repository
1070
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1071
wt.revert([], old_tree=empty)
1072
self.destroy_workingtree_metadata()
1074
def destroy_workingtree_metadata(self):
1075
self.transport.delete_tree('checkout')
1077
def find_branch_format(self):
1078
"""Find the branch 'format' for this bzrdir.
1080
This might be a synthetic object for e.g. RemoteBranch and SVN.
1082
from bzrlib.branch import BranchFormat
1083
return BranchFormat.find_format(self)
1085
def _get_mkdir_mode(self):
1086
"""Figure out the mode to use when creating a bzrdir subdir."""
1087
temp_control = lockable_files.LockableFiles(self.transport, '',
1088
lockable_files.TransportLock)
1089
return temp_control._dir_mode
1091
def get_branch_reference(self):
1092
"""See BzrDir.get_branch_reference()."""
1093
from bzrlib.branch import BranchFormat
1094
format = BranchFormat.find_format(self)
1095
return format.get_reference(self)
1097
def get_branch_transport(self, branch_format):
1098
"""See BzrDir.get_branch_transport()."""
1099
if branch_format is None:
1100
return self.transport.clone('branch')
1102
branch_format.get_format_string()
1103
except NotImplementedError:
1104
raise errors.IncompatibleFormat(branch_format, self._format)
1106
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1107
except errors.FileExists:
1109
return self.transport.clone('branch')
1111
def get_repository_transport(self, repository_format):
1112
"""See BzrDir.get_repository_transport()."""
1113
if repository_format is None:
1114
return self.transport.clone('repository')
1116
repository_format.get_format_string()
1117
except NotImplementedError:
1118
raise errors.IncompatibleFormat(repository_format, self._format)
1120
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1121
except errors.FileExists:
1123
return self.transport.clone('repository')
1125
def get_workingtree_transport(self, workingtree_format):
1126
"""See BzrDir.get_workingtree_transport()."""
1127
if workingtree_format is None:
1128
return self.transport.clone('checkout')
1130
workingtree_format.get_format_string()
1131
except NotImplementedError:
1132
raise errors.IncompatibleFormat(workingtree_format, self._format)
1134
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1135
except errors.FileExists:
1137
return self.transport.clone('checkout')
1139
def needs_format_conversion(self, format=None):
1140
"""See BzrDir.needs_format_conversion()."""
1142
format = BzrDirFormat.get_default_format()
1143
if not isinstance(self._format, format.__class__):
1144
# it is not a meta dir format, conversion is needed.
1146
# we might want to push this down to the repository?
1148
if not isinstance(self.open_repository()._format,
1149
format.repository_format.__class__):
1150
# the repository needs an upgrade.
1152
except errors.NoRepositoryPresent:
1155
if not isinstance(self.open_branch()._format,
1156
format.get_branch_format().__class__):
1157
# the branch needs an upgrade.
1159
except errors.NotBranchError:
1162
my_wt = self.open_workingtree(recommend_upgrade=False)
1163
if not isinstance(my_wt._format,
1164
format.workingtree_format.__class__):
1165
# the workingtree needs an upgrade.
1167
except (errors.NoWorkingTree, errors.NotLocalUrl):
1171
def open_branch(self, unsupported=False):
1172
"""See BzrDir.open_branch."""
1173
format = self.find_branch_format()
1174
self._check_supported(format, unsupported)
1175
return format.open(self, _found=True)
1177
def open_repository(self, unsupported=False):
1178
"""See BzrDir.open_repository."""
1179
from bzrlib.repository import RepositoryFormat
1180
format = RepositoryFormat.find_format(self)
1181
self._check_supported(format, unsupported)
1182
return format.open(self, _found=True)
1184
def open_workingtree(self, unsupported=False,
1185
recommend_upgrade=True):
1186
"""See BzrDir.open_workingtree."""
1187
from bzrlib.workingtree import WorkingTreeFormat
1188
format = WorkingTreeFormat.find_format(self)
1189
self._check_supported(format, unsupported,
1191
basedir=self.root_transport.base)
1192
return format.open(self, _found=True)
1195
class BzrDirFormat(object):
1196
"""An encapsulation of the initialization and open routines for a format.
1198
Formats provide three things:
1199
* An initialization routine,
1203
Formats are placed in an dict by their format string for reference
1204
during bzrdir opening. These should be subclasses of BzrDirFormat
1207
Once a format is deprecated, just deprecate the initialize and open
1208
methods on the format class. Do not deprecate the object, as the
1209
object will be created every system load.
1212
_default_format = None
1213
"""The default format used for new .bzr dirs."""
1216
"""The known formats."""
1218
_control_formats = []
1219
"""The registered control formats - .bzr, ....
1221
This is a list of BzrDirFormat objects.
1224
_control_server_formats = []
1225
"""The registered control server formats, e.g. RemoteBzrDirs.
1227
This is a list of BzrDirFormat objects.
1230
_lock_file_name = 'branch-lock'
1232
# _lock_class must be set in subclasses to the lock type, typ.
1233
# TransportLock or LockDir
1236
def find_format(klass, transport, _server_formats=True):
1237
"""Return the format present at transport."""
1239
formats = klass._control_server_formats + klass._control_formats
1241
formats = klass._control_formats
1242
for format in formats:
1244
return format.probe_transport(transport)
1245
except errors.NotBranchError:
1246
# this format does not find a control dir here.
1248
raise errors.NotBranchError(path=transport.base)
1251
def probe_transport(klass, transport):
1252
"""Return the .bzrdir style format present in a directory."""
1254
format_string = transport.get(".bzr/branch-format").read()
1255
except errors.NoSuchFile:
1256
raise errors.NotBranchError(path=transport.base)
1259
return klass._formats[format_string]
1261
raise errors.UnknownFormatError(format=format_string)
1264
def get_default_format(klass):
1265
"""Return the current default format."""
1266
return klass._default_format
1268
def get_format_string(self):
1269
"""Return the ASCII format string that identifies this format."""
1270
raise NotImplementedError(self.get_format_string)
1272
def get_format_description(self):
1273
"""Return the short description for this format."""
1274
raise NotImplementedError(self.get_format_description)
1276
def get_converter(self, format=None):
1277
"""Return the converter to use to convert bzrdirs needing converts.
1279
This returns a bzrlib.bzrdir.Converter object.
1281
This should return the best upgrader to step this format towards the
1282
current default format. In the case of plugins we can/should provide
1283
some means for them to extend the range of returnable converters.
1285
:param format: Optional format to override the default format of the
1288
raise NotImplementedError(self.get_converter)
1290
def initialize(self, url):
1291
"""Create a bzr control dir at this url and return an opened copy.
1293
Subclasses should typically override initialize_on_transport
1294
instead of this method.
1296
return self.initialize_on_transport(get_transport(url))
1298
def initialize_on_transport(self, transport):
1299
"""Initialize a new bzrdir in the base directory of a Transport."""
1300
# Since we don't have a .bzr directory, inherit the
1301
# mode from the root directory
1302
temp_control = lockable_files.LockableFiles(transport,
1303
'', lockable_files.TransportLock)
1304
temp_control._transport.mkdir('.bzr',
1305
# FIXME: RBC 20060121 don't peek under
1307
mode=temp_control._dir_mode)
1308
file_mode = temp_control._file_mode
1310
mutter('created control directory in ' + transport.base)
1311
control = transport.clone('.bzr')
1312
utf8_files = [('README',
1313
"This is a Bazaar-NG control directory.\n"
1314
"Do not change any files in this directory.\n"),
1315
('branch-format', self.get_format_string()),
1317
# NB: no need to escape relative paths that are url safe.
1318
control_files = lockable_files.LockableFiles(control,
1319
self._lock_file_name, self._lock_class)
1320
control_files.create_lock()
1321
control_files.lock_write()
1323
for file, content in utf8_files:
1324
control_files.put_utf8(file, content)
1326
control_files.unlock()
1327
return self.open(transport, _found=True)
1329
def is_supported(self):
1330
"""Is this format supported?
1332
Supported formats must be initializable and openable.
1333
Unsupported formats may not support initialization or committing or
1334
some other features depending on the reason for not being supported.
1338
def same_model(self, target_format):
1339
return (self.repository_format.rich_root_data ==
1340
target_format.rich_root_data)
1343
def known_formats(klass):
1344
"""Return all the known formats.
1346
Concrete formats should override _known_formats.
1348
# There is double indirection here to make sure that control
1349
# formats used by more than one dir format will only be probed
1350
# once. This can otherwise be quite expensive for remote connections.
1352
for format in klass._control_formats:
1353
result.update(format._known_formats())
1357
def _known_formats(klass):
1358
"""Return the known format instances for this control format."""
1359
return set(klass._formats.values())
1361
def open(self, transport, _found=False):
1362
"""Return an instance of this format for the dir transport points at.
1364
_found is a private parameter, do not use it.
1367
found_format = BzrDirFormat.find_format(transport)
1368
if not isinstance(found_format, self.__class__):
1369
raise AssertionError("%s was asked to open %s, but it seems to need "
1371
% (self, transport, found_format))
1372
return self._open(transport)
1374
def _open(self, transport):
1375
"""Template method helper for opening BzrDirectories.
1377
This performs the actual open and any additional logic or parameter
1380
raise NotImplementedError(self._open)
1383
def register_format(klass, format):
1384
klass._formats[format.get_format_string()] = format
1387
def register_control_format(klass, format):
1388
"""Register a format that does not use '.bzr' for its control dir.
1390
TODO: This should be pulled up into a 'ControlDirFormat' base class
1391
which BzrDirFormat can inherit from, and renamed to register_format
1392
there. It has been done without that for now for simplicity of
1395
klass._control_formats.append(format)
1398
def register_control_server_format(klass, format):
1399
"""Register a control format for client-server environments.
1401
These formats will be tried before ones registered with
1402
register_control_format. This gives implementations that decide to the
1403
chance to grab it before anything looks at the contents of the format
1406
klass._control_server_formats.append(format)
1409
@symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1410
def set_default_format(klass, format):
1411
klass._set_default_format(format)
1414
def _set_default_format(klass, format):
1415
"""Set default format (for testing behavior of defaults only)"""
1416
klass._default_format = format
1419
return self.get_format_string()[:-1]
1422
def unregister_format(klass, format):
1423
assert klass._formats[format.get_format_string()] is format
1424
del klass._formats[format.get_format_string()]
1427
def unregister_control_format(klass, format):
1428
klass._control_formats.remove(format)
1431
class BzrDirFormat4(BzrDirFormat):
1432
"""Bzr dir format 4.
1434
This format is a combined format for working tree, branch and repository.
1436
- Format 1 working trees [always]
1437
- Format 4 branches [always]
1438
- Format 4 repositories [always]
1440
This format is deprecated: it indexes texts using a text it which is
1441
removed in format 5; write support for this format has been removed.
1444
_lock_class = lockable_files.TransportLock
1446
def get_format_string(self):
1447
"""See BzrDirFormat.get_format_string()."""
1448
return "Bazaar-NG branch, format 0.0.4\n"
1450
def get_format_description(self):
1451
"""See BzrDirFormat.get_format_description()."""
1452
return "All-in-one format 4"
1454
def get_converter(self, format=None):
1455
"""See BzrDirFormat.get_converter()."""
1456
# there is one and only one upgrade path here.
1457
return ConvertBzrDir4To5()
1459
def initialize_on_transport(self, transport):
1460
"""Format 4 branches cannot be created."""
1461
raise errors.UninitializableFormat(self)
1463
def is_supported(self):
1464
"""Format 4 is not supported.
1466
It is not supported because the model changed from 4 to 5 and the
1467
conversion logic is expensive - so doing it on the fly was not
1472
def _open(self, transport):
1473
"""See BzrDirFormat._open."""
1474
return BzrDir4(transport, self)
1476
def __return_repository_format(self):
1477
"""Circular import protection."""
1478
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1479
return RepositoryFormat4()
1480
repository_format = property(__return_repository_format)
1483
class BzrDirFormat5(BzrDirFormat):
1484
"""Bzr control format 5.
1486
This format is a combined format for working tree, branch and repository.
1488
- Format 2 working trees [always]
1489
- Format 4 branches [always]
1490
- Format 5 repositories [always]
1491
Unhashed stores in the repository.
1494
_lock_class = lockable_files.TransportLock
1496
def get_format_string(self):
1497
"""See BzrDirFormat.get_format_string()."""
1498
return "Bazaar-NG branch, format 5\n"
1500
def get_format_description(self):
1501
"""See BzrDirFormat.get_format_description()."""
1502
return "All-in-one format 5"
1504
def get_converter(self, format=None):
1505
"""See BzrDirFormat.get_converter()."""
1506
# there is one and only one upgrade path here.
1507
return ConvertBzrDir5To6()
1509
def _initialize_for_clone(self, url):
1510
return self.initialize_on_transport(get_transport(url), _cloning=True)
1512
def initialize_on_transport(self, transport, _cloning=False):
1513
"""Format 5 dirs always have working tree, branch and repository.
1515
Except when they are being cloned.
1517
from bzrlib.branch import BzrBranchFormat4
1518
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1519
from bzrlib.workingtree import WorkingTreeFormat2
1520
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1521
RepositoryFormat5().initialize(result, _internal=True)
1523
branch = BzrBranchFormat4().initialize(result)
1525
WorkingTreeFormat2().initialize(result)
1526
except errors.NotLocalUrl:
1527
# Even though we can't access the working tree, we need to
1528
# create its control files.
1529
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1532
def _open(self, transport):
1533
"""See BzrDirFormat._open."""
1534
return BzrDir5(transport, self)
1536
def __return_repository_format(self):
1537
"""Circular import protection."""
1538
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1539
return RepositoryFormat5()
1540
repository_format = property(__return_repository_format)
1543
class BzrDirFormat6(BzrDirFormat):
1544
"""Bzr control format 6.
1546
This format is a combined format for working tree, branch and repository.
1548
- Format 2 working trees [always]
1549
- Format 4 branches [always]
1550
- Format 6 repositories [always]
1553
_lock_class = lockable_files.TransportLock
1555
def get_format_string(self):
1556
"""See BzrDirFormat.get_format_string()."""
1557
return "Bazaar-NG branch, format 6\n"
1559
def get_format_description(self):
1560
"""See BzrDirFormat.get_format_description()."""
1561
return "All-in-one format 6"
1563
def get_converter(self, format=None):
1564
"""See BzrDirFormat.get_converter()."""
1565
# there is one and only one upgrade path here.
1566
return ConvertBzrDir6ToMeta()
1568
def _initialize_for_clone(self, url):
1569
return self.initialize_on_transport(get_transport(url), _cloning=True)
1571
def initialize_on_transport(self, transport, _cloning=False):
1572
"""Format 6 dirs always have working tree, branch and repository.
1574
Except when they are being cloned.
1576
from bzrlib.branch import BzrBranchFormat4
1577
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1578
from bzrlib.workingtree import WorkingTreeFormat2
1579
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1580
RepositoryFormat6().initialize(result, _internal=True)
1582
branch = BzrBranchFormat4().initialize(result)
1584
WorkingTreeFormat2().initialize(result)
1585
except errors.NotLocalUrl:
1586
# Even though we can't access the working tree, we need to
1587
# create its control files.
1588
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1591
def _open(self, transport):
1592
"""See BzrDirFormat._open."""
1593
return BzrDir6(transport, self)
1595
def __return_repository_format(self):
1596
"""Circular import protection."""
1597
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1598
return RepositoryFormat6()
1599
repository_format = property(__return_repository_format)
1602
class BzrDirMetaFormat1(BzrDirFormat):
1603
"""Bzr meta control format 1
1605
This is the first format with split out working tree, branch and repository
1608
- Format 3 working trees [optional]
1609
- Format 5 branches [optional]
1610
- Format 7 repositories [optional]
1613
_lock_class = lockdir.LockDir
1616
self._workingtree_format = None
1617
self._branch_format = None
1619
def __eq__(self, other):
1620
if other.__class__ is not self.__class__:
1622
if other.repository_format != self.repository_format:
1624
if other.workingtree_format != self.workingtree_format:
1628
def __ne__(self, other):
1629
return not self == other
1631
def get_branch_format(self):
1632
if self._branch_format is None:
1633
from bzrlib.branch import BranchFormat
1634
self._branch_format = BranchFormat.get_default_format()
1635
return self._branch_format
1637
def set_branch_format(self, format):
1638
self._branch_format = format
1640
def get_converter(self, format=None):
1641
"""See BzrDirFormat.get_converter()."""
1643
format = BzrDirFormat.get_default_format()
1644
if not isinstance(self, format.__class__):
1645
# converting away from metadir is not implemented
1646
raise NotImplementedError(self.get_converter)
1647
return ConvertMetaToMeta(format)
1649
def get_format_string(self):
1650
"""See BzrDirFormat.get_format_string()."""
1651
return "Bazaar-NG meta directory, format 1\n"
1653
def get_format_description(self):
1654
"""See BzrDirFormat.get_format_description()."""
1655
return "Meta directory format 1"
1657
def _open(self, transport):
1658
"""See BzrDirFormat._open."""
1659
return BzrDirMeta1(transport, self)
1661
def __return_repository_format(self):
1662
"""Circular import protection."""
1663
if getattr(self, '_repository_format', None):
1664
return self._repository_format
1665
from bzrlib.repository import RepositoryFormat
1666
return RepositoryFormat.get_default_format()
1668
def __set_repository_format(self, value):
1669
"""Allow changint the repository format for metadir formats."""
1670
self._repository_format = value
1672
repository_format = property(__return_repository_format, __set_repository_format)
1674
def __get_workingtree_format(self):
1675
if self._workingtree_format is None:
1676
from bzrlib.workingtree import WorkingTreeFormat
1677
self._workingtree_format = WorkingTreeFormat.get_default_format()
1678
return self._workingtree_format
1680
def __set_workingtree_format(self, wt_format):
1681
self._workingtree_format = wt_format
1683
workingtree_format = property(__get_workingtree_format,
1684
__set_workingtree_format)
1687
# Register bzr control format
1688
BzrDirFormat.register_control_format(BzrDirFormat)
1690
# Register bzr formats
1691
BzrDirFormat.register_format(BzrDirFormat4())
1692
BzrDirFormat.register_format(BzrDirFormat5())
1693
BzrDirFormat.register_format(BzrDirFormat6())
1694
__default_format = BzrDirMetaFormat1()
1695
BzrDirFormat.register_format(__default_format)
1696
BzrDirFormat._default_format = __default_format
1699
class Converter(object):
1700
"""Converts a disk format object from one format to another."""
1702
def convert(self, to_convert, pb):
1703
"""Perform the conversion of to_convert, giving feedback via pb.
1705
:param to_convert: The disk object to convert.
1706
:param pb: a progress bar to use for progress information.
1709
def step(self, message):
1710
"""Update the pb by a step."""
1712
self.pb.update(message, self.count, self.total)
1715
class ConvertBzrDir4To5(Converter):
1716
"""Converts format 4 bzr dirs to format 5."""
1719
super(ConvertBzrDir4To5, self).__init__()
1720
self.converted_revs = set()
1721
self.absent_revisions = set()
1725
def convert(self, to_convert, pb):
1726
"""See Converter.convert()."""
1727
self.bzrdir = to_convert
1729
self.pb.note('starting upgrade from format 4 to 5')
1730
if isinstance(self.bzrdir.transport, LocalTransport):
1731
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1732
self._convert_to_weaves()
1733
return BzrDir.open(self.bzrdir.root_transport.base)
1735
def _convert_to_weaves(self):
1736
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1739
stat = self.bzrdir.transport.stat('weaves')
1740
if not S_ISDIR(stat.st_mode):
1741
self.bzrdir.transport.delete('weaves')
1742
self.bzrdir.transport.mkdir('weaves')
1743
except errors.NoSuchFile:
1744
self.bzrdir.transport.mkdir('weaves')
1745
# deliberately not a WeaveFile as we want to build it up slowly.
1746
self.inv_weave = Weave('inventory')
1747
# holds in-memory weaves for all files
1748
self.text_weaves = {}
1749
self.bzrdir.transport.delete('branch-format')
1750
self.branch = self.bzrdir.open_branch()
1751
self._convert_working_inv()
1752
rev_history = self.branch.revision_history()
1753
# to_read is a stack holding the revisions we still need to process;
1754
# appending to it adds new highest-priority revisions
1755
self.known_revisions = set(rev_history)
1756
self.to_read = rev_history[-1:]
1758
rev_id = self.to_read.pop()
1759
if (rev_id not in self.revisions
1760
and rev_id not in self.absent_revisions):
1761
self._load_one_rev(rev_id)
1763
to_import = self._make_order()
1764
for i, rev_id in enumerate(to_import):
1765
self.pb.update('converting revision', i, len(to_import))
1766
self._convert_one_rev(rev_id)
1768
self._write_all_weaves()
1769
self._write_all_revs()
1770
self.pb.note('upgraded to weaves:')
1771
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1772
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1773
self.pb.note(' %6d texts', self.text_count)
1774
self._cleanup_spare_files_after_format4()
1775
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1777
def _cleanup_spare_files_after_format4(self):
1778
# FIXME working tree upgrade foo.
1779
for n in 'merged-patches', 'pending-merged-patches':
1781
## assert os.path.getsize(p) == 0
1782
self.bzrdir.transport.delete(n)
1783
except errors.NoSuchFile:
1785
self.bzrdir.transport.delete_tree('inventory-store')
1786
self.bzrdir.transport.delete_tree('text-store')
1788
def _convert_working_inv(self):
1789
inv = xml4.serializer_v4.read_inventory(
1790
self.branch.control_files.get('inventory'))
1791
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1792
# FIXME inventory is a working tree change.
1793
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1795
def _write_all_weaves(self):
1796
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1797
weave_transport = self.bzrdir.transport.clone('weaves')
1798
weaves = WeaveStore(weave_transport, prefixed=False)
1799
transaction = WriteTransaction()
1803
for file_id, file_weave in self.text_weaves.items():
1804
self.pb.update('writing weave', i, len(self.text_weaves))
1805
weaves._put_weave(file_id, file_weave, transaction)
1807
self.pb.update('inventory', 0, 1)
1808
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1809
self.pb.update('inventory', 1, 1)
1813
def _write_all_revs(self):
1814
"""Write all revisions out in new form."""
1815
self.bzrdir.transport.delete_tree('revision-store')
1816
self.bzrdir.transport.mkdir('revision-store')
1817
revision_transport = self.bzrdir.transport.clone('revision-store')
1819
_revision_store = TextRevisionStore(TextStore(revision_transport,
1823
transaction = WriteTransaction()
1824
for i, rev_id in enumerate(self.converted_revs):
1825
self.pb.update('write revision', i, len(self.converted_revs))
1826
_revision_store.add_revision(self.revisions[rev_id], transaction)
1830
def _load_one_rev(self, rev_id):
1831
"""Load a revision object into memory.
1833
Any parents not either loaded or abandoned get queued to be
1835
self.pb.update('loading revision',
1836
len(self.revisions),
1837
len(self.known_revisions))
1838
if not self.branch.repository.has_revision(rev_id):
1840
self.pb.note('revision {%s} not present in branch; '
1841
'will be converted as a ghost',
1843
self.absent_revisions.add(rev_id)
1845
rev = self.branch.repository._revision_store.get_revision(rev_id,
1846
self.branch.repository.get_transaction())
1847
for parent_id in rev.parent_ids:
1848
self.known_revisions.add(parent_id)
1849
self.to_read.append(parent_id)
1850
self.revisions[rev_id] = rev
1852
def _load_old_inventory(self, rev_id):
1853
assert rev_id not in self.converted_revs
1854
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1855
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1856
inv.revision_id = rev_id
1857
rev = self.revisions[rev_id]
1858
if rev.inventory_sha1:
1859
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1860
'inventory sha mismatch for {%s}' % rev_id
1863
def _load_updated_inventory(self, rev_id):
1864
assert rev_id in self.converted_revs
1865
inv_xml = self.inv_weave.get_text(rev_id)
1866
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1869
def _convert_one_rev(self, rev_id):
1870
"""Convert revision and all referenced objects to new format."""
1871
rev = self.revisions[rev_id]
1872
inv = self._load_old_inventory(rev_id)
1873
present_parents = [p for p in rev.parent_ids
1874
if p not in self.absent_revisions]
1875
self._convert_revision_contents(rev, inv, present_parents)
1876
self._store_new_weave(rev, inv, present_parents)
1877
self.converted_revs.add(rev_id)
1879
def _store_new_weave(self, rev, inv, present_parents):
1880
# the XML is now updated with text versions
1882
entries = inv.iter_entries()
1884
for path, ie in entries:
1885
assert getattr(ie, 'revision', None) is not None, \
1886
'no revision on {%s} in {%s}' % \
1887
(file_id, rev.revision_id)
1888
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1889
new_inv_sha1 = sha_string(new_inv_xml)
1890
self.inv_weave.add_lines(rev.revision_id,
1892
new_inv_xml.splitlines(True))
1893
rev.inventory_sha1 = new_inv_sha1
1895
def _convert_revision_contents(self, rev, inv, present_parents):
1896
"""Convert all the files within a revision.
1898
Also upgrade the inventory to refer to the text revision ids."""
1899
rev_id = rev.revision_id
1900
mutter('converting texts of revision {%s}',
1902
parent_invs = map(self._load_updated_inventory, present_parents)
1903
entries = inv.iter_entries()
1905
for path, ie in entries:
1906
self._convert_file_version(rev, ie, parent_invs)
1908
def _convert_file_version(self, rev, ie, parent_invs):
1909
"""Convert one version of one file.
1911
The file needs to be added into the weave if it is a merge
1912
of >=2 parents or if it's changed from its parent.
1914
file_id = ie.file_id
1915
rev_id = rev.revision_id
1916
w = self.text_weaves.get(file_id)
1919
self.text_weaves[file_id] = w
1920
text_changed = False
1921
previous_entries = ie.find_previous_heads(parent_invs,
1925
for old_revision in previous_entries:
1926
# if this fails, its a ghost ?
1927
assert old_revision in self.converted_revs, \
1928
"Revision {%s} not in converted_revs" % old_revision
1929
self.snapshot_ie(previous_entries, ie, w, rev_id)
1931
assert getattr(ie, 'revision', None) is not None
1933
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1934
# TODO: convert this logic, which is ~= snapshot to
1935
# a call to:. This needs the path figured out. rather than a work_tree
1936
# a v4 revision_tree can be given, or something that looks enough like
1937
# one to give the file content to the entry if it needs it.
1938
# and we need something that looks like a weave store for snapshot to
1940
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
1941
if len(previous_revisions) == 1:
1942
previous_ie = previous_revisions.values()[0]
1943
if ie._unchanged(previous_ie):
1944
ie.revision = previous_ie.revision
1947
text = self.branch.repository.text_store.get(ie.text_id)
1948
file_lines = text.readlines()
1949
assert sha_strings(file_lines) == ie.text_sha1
1950
assert sum(map(len, file_lines)) == ie.text_size
1951
w.add_lines(rev_id, previous_revisions, file_lines)
1952
self.text_count += 1
1954
w.add_lines(rev_id, previous_revisions, [])
1955
ie.revision = rev_id
1957
def _make_order(self):
1958
"""Return a suitable order for importing revisions.
1960
The order must be such that an revision is imported after all
1961
its (present) parents.
1963
todo = set(self.revisions.keys())
1964
done = self.absent_revisions.copy()
1967
# scan through looking for a revision whose parents
1969
for rev_id in sorted(list(todo)):
1970
rev = self.revisions[rev_id]
1971
parent_ids = set(rev.parent_ids)
1972
if parent_ids.issubset(done):
1973
# can take this one now
1974
order.append(rev_id)
1980
class ConvertBzrDir5To6(Converter):
1981
"""Converts format 5 bzr dirs to format 6."""
1983
def convert(self, to_convert, pb):
1984
"""See Converter.convert()."""
1985
self.bzrdir = to_convert
1987
self.pb.note('starting upgrade from format 5 to 6')
1988
self._convert_to_prefixed()
1989
return BzrDir.open(self.bzrdir.root_transport.base)
1991
def _convert_to_prefixed(self):
1992
from bzrlib.store import TransportStore
1993
self.bzrdir.transport.delete('branch-format')
1994
for store_name in ["weaves", "revision-store"]:
1995
self.pb.note("adding prefixes to %s" % store_name)
1996
store_transport = self.bzrdir.transport.clone(store_name)
1997
store = TransportStore(store_transport, prefixed=True)
1998
for urlfilename in store_transport.list_dir('.'):
1999
filename = urlutils.unescape(urlfilename)
2000
if (filename.endswith(".weave") or
2001
filename.endswith(".gz") or
2002
filename.endswith(".sig")):
2003
file_id = os.path.splitext(filename)[0]
2006
prefix_dir = store.hash_prefix(file_id)
2007
# FIXME keep track of the dirs made RBC 20060121
2009
store_transport.move(filename, prefix_dir + '/' + filename)
2010
except errors.NoSuchFile: # catches missing dirs strangely enough
2011
store_transport.mkdir(prefix_dir)
2012
store_transport.move(filename, prefix_dir + '/' + filename)
2013
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2016
class ConvertBzrDir6ToMeta(Converter):
2017
"""Converts format 6 bzr dirs to metadirs."""
2019
def convert(self, to_convert, pb):
2020
"""See Converter.convert()."""
2021
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2022
from bzrlib.branch import BzrBranchFormat5
2023
self.bzrdir = to_convert
2026
self.total = 20 # the steps we know about
2027
self.garbage_inventories = []
2029
self.pb.note('starting upgrade from format 6 to metadir')
2030
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2031
# its faster to move specific files around than to open and use the apis...
2032
# first off, nuke ancestry.weave, it was never used.
2034
self.step('Removing ancestry.weave')
2035
self.bzrdir.transport.delete('ancestry.weave')
2036
except errors.NoSuchFile:
2038
# find out whats there
2039
self.step('Finding branch files')
2040
last_revision = self.bzrdir.open_branch().last_revision()
2041
bzrcontents = self.bzrdir.transport.list_dir('.')
2042
for name in bzrcontents:
2043
if name.startswith('basis-inventory.'):
2044
self.garbage_inventories.append(name)
2045
# create new directories for repository, working tree and branch
2046
self.dir_mode = self.bzrdir._control_files._dir_mode
2047
self.file_mode = self.bzrdir._control_files._file_mode
2048
repository_names = [('inventory.weave', True),
2049
('revision-store', True),
2051
self.step('Upgrading repository ')
2052
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2053
self.make_lock('repository')
2054
# we hard code the formats here because we are converting into
2055
# the meta format. The meta format upgrader can take this to a
2056
# future format within each component.
2057
self.put_format('repository', RepositoryFormat7())
2058
for entry in repository_names:
2059
self.move_entry('repository', entry)
2061
self.step('Upgrading branch ')
2062
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2063
self.make_lock('branch')
2064
self.put_format('branch', BzrBranchFormat5())
2065
branch_files = [('revision-history', True),
2066
('branch-name', True),
2068
for entry in branch_files:
2069
self.move_entry('branch', entry)
2071
checkout_files = [('pending-merges', True),
2072
('inventory', True),
2073
('stat-cache', False)]
2074
# If a mandatory checkout file is not present, the branch does not have
2075
# a functional checkout. Do not create a checkout in the converted
2077
for name, mandatory in checkout_files:
2078
if mandatory and name not in bzrcontents:
2079
has_checkout = False
2083
if not has_checkout:
2084
self.pb.note('No working tree.')
2085
# If some checkout files are there, we may as well get rid of them.
2086
for name, mandatory in checkout_files:
2087
if name in bzrcontents:
2088
self.bzrdir.transport.delete(name)
2090
from bzrlib.workingtree import WorkingTreeFormat3
2091
self.step('Upgrading working tree')
2092
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2093
self.make_lock('checkout')
2095
'checkout', WorkingTreeFormat3())
2096
self.bzrdir.transport.delete_multi(
2097
self.garbage_inventories, self.pb)
2098
for entry in checkout_files:
2099
self.move_entry('checkout', entry)
2100
if last_revision is not None:
2101
self.bzrdir._control_files.put_utf8(
2102
'checkout/last-revision', last_revision)
2103
self.bzrdir._control_files.put_utf8(
2104
'branch-format', BzrDirMetaFormat1().get_format_string())
2105
return BzrDir.open(self.bzrdir.root_transport.base)
2107
def make_lock(self, name):
2108
"""Make a lock for the new control dir name."""
2109
self.step('Make %s lock' % name)
2110
ld = lockdir.LockDir(self.bzrdir.transport,
2112
file_modebits=self.file_mode,
2113
dir_modebits=self.dir_mode)
2116
def move_entry(self, new_dir, entry):
2117
"""Move then entry name into new_dir."""
2119
mandatory = entry[1]
2120
self.step('Moving %s' % name)
2122
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2123
except errors.NoSuchFile:
2127
def put_format(self, dirname, format):
2128
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2131
class ConvertMetaToMeta(Converter):
2132
"""Converts the components of metadirs."""
2134
def __init__(self, target_format):
2135
"""Create a metadir to metadir converter.
2137
:param target_format: The final metadir format that is desired.
2139
self.target_format = target_format
2141
def convert(self, to_convert, pb):
2142
"""See Converter.convert()."""
2143
self.bzrdir = to_convert
2147
self.step('checking repository format')
2149
repo = self.bzrdir.open_repository()
2150
except errors.NoRepositoryPresent:
2153
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2154
from bzrlib.repository import CopyConverter
2155
self.pb.note('starting repository conversion')
2156
converter = CopyConverter(self.target_format.repository_format)
2157
converter.convert(repo, pb)
2159
branch = self.bzrdir.open_branch()
2160
except errors.NotBranchError:
2163
# TODO: conversions of Branch and Tree should be done by
2164
# InterXFormat lookups
2165
# Avoid circular imports
2166
from bzrlib import branch as _mod_branch
2167
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2168
self.target_format.get_branch_format().__class__ is
2169
_mod_branch.BzrBranchFormat6):
2170
branch_converter = _mod_branch.Converter5to6()
2171
branch_converter.convert(branch)
2173
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2174
except (errors.NoWorkingTree, errors.NotLocalUrl):
2177
# TODO: conversions of Branch and Tree should be done by
2178
# InterXFormat lookups
2179
if (isinstance(tree, workingtree.WorkingTree3) and
2180
not isinstance(tree, workingtree_4.WorkingTree4) and
2181
isinstance(self.target_format.workingtree_format,
2182
workingtree_4.WorkingTreeFormat4)):
2183
workingtree_4.Converter3to4().convert(tree)
2187
# This is not in remote.py because it's small, and needs to be registered.
2188
# Putting it in remote.py creates a circular import problem.
2189
# we can make it a lazy object if the control formats is turned into something
2191
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2192
"""Format representing bzrdirs accessed via a smart server"""
2194
def get_format_description(self):
2195
return 'bzr remote bzrdir'
2198
def probe_transport(klass, transport):
2199
"""Return a RemoteBzrDirFormat object if it looks possible."""
2201
client = transport.get_smart_client()
2202
except (NotImplementedError, AttributeError,
2203
errors.TransportNotPossible):
2204
# no smart server, so not a branch for this format type.
2205
raise errors.NotBranchError(path=transport.base)
2207
# Send a 'hello' request in protocol version one, and decline to
2208
# open it if the server doesn't support our required version (2) so
2209
# that the VFS-based transport will do it.
2210
request = client.get_request()
2211
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
2212
server_version = smart_protocol.query_version()
2213
if server_version != 2:
2214
raise errors.NotBranchError(path=transport.base)
2217
def initialize_on_transport(self, transport):
2219
# hand off the request to the smart server
2220
medium = transport.get_smart_medium()
2221
except errors.NoSmartMedium:
2222
# TODO: lookup the local format from a server hint.
2223
local_dir_format = BzrDirMetaFormat1()
2224
return local_dir_format.initialize_on_transport(transport)
2225
client = _SmartClient(medium)
2226
path = client.remote_path_from_transport(transport)
2227
response = _SmartClient(medium).call('BzrDirFormat.initialize', path)
2228
assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
2229
return remote.RemoteBzrDir(transport)
2231
def _open(self, transport):
2232
return remote.RemoteBzrDir(transport)
2234
def __eq__(self, other):
2235
if not isinstance(other, RemoteBzrDirFormat):
2237
return self.get_format_description() == other.get_format_description()
2240
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2243
class BzrDirFormatInfo(object):
2245
def __init__(self, native, deprecated, hidden):
2246
self.deprecated = deprecated
2247
self.native = native
2248
self.hidden = hidden
2251
class BzrDirFormatRegistry(registry.Registry):
2252
"""Registry of user-selectable BzrDir subformats.
2254
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2255
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2258
def register_metadir(self, key,
2259
repository_format, help, native=True, deprecated=False,
2263
"""Register a metadir subformat.
2265
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2266
by the Repository format.
2268
:param repository_format: The fully-qualified repository format class
2270
:param branch_format: Fully-qualified branch format class name as
2272
:param tree_format: Fully-qualified tree format class name as
2275
# This should be expanded to support setting WorkingTree and Branch
2276
# formats, once BzrDirMetaFormat1 supports that.
2277
def _load(full_name):
2278
mod_name, factory_name = full_name.rsplit('.', 1)
2280
mod = __import__(mod_name, globals(), locals(),
2282
except ImportError, e:
2283
raise ImportError('failed to load %s: %s' % (full_name, e))
2285
factory = getattr(mod, factory_name)
2286
except AttributeError:
2287
raise AttributeError('no factory %s in module %r'
2292
bd = BzrDirMetaFormat1()
2293
if branch_format is not None:
2294
bd.set_branch_format(_load(branch_format))
2295
if tree_format is not None:
2296
bd.workingtree_format = _load(tree_format)
2297
if repository_format is not None:
2298
bd.repository_format = _load(repository_format)
2300
self.register(key, helper, help, native, deprecated, hidden)
2302
def register(self, key, factory, help, native=True, deprecated=False,
2304
"""Register a BzrDirFormat factory.
2306
The factory must be a callable that takes one parameter: the key.
2307
It must produce an instance of the BzrDirFormat when called.
2309
This function mainly exists to prevent the info object from being
2312
registry.Registry.register(self, key, factory, help,
2313
BzrDirFormatInfo(native, deprecated, hidden))
2315
def register_lazy(self, key, module_name, member_name, help, native=True,
2316
deprecated=False, hidden=False):
2317
registry.Registry.register_lazy(self, key, module_name, member_name,
2318
help, BzrDirFormatInfo(native, deprecated, hidden))
2320
def set_default(self, key):
2321
"""Set the 'default' key to be a clone of the supplied key.
2323
This method must be called once and only once.
2325
registry.Registry.register(self, 'default', self.get(key),
2326
self.get_help(key), info=self.get_info(key))
2328
def set_default_repository(self, key):
2329
"""Set the FormatRegistry default and Repository default.
2331
This is a transitional method while Repository.set_default_format
2334
if 'default' in self:
2335
self.remove('default')
2336
self.set_default(key)
2337
format = self.get('default')()
2338
assert isinstance(format, BzrDirMetaFormat1)
2340
def make_bzrdir(self, key):
2341
return self.get(key)()
2343
def help_topic(self, topic):
2344
output = textwrap.dedent("""\
2345
Bazaar directory formats
2346
------------------------
2348
These formats can be used for creating branches, working trees, and
2352
default_help = self.get_help('default')
2354
for key in self.keys():
2355
if key == 'default':
2357
help = self.get_help(key)
2358
if help == default_help:
2359
default_realkey = key
2361
help_pairs.append((key, help))
2363
def wrapped(key, help, info):
2365
help = '(native) ' + help
2366
return ' %s:\n%s\n\n' % (key,
2367
textwrap.fill(help, initial_indent=' ',
2368
subsequent_indent=' '))
2369
output += wrapped('%s/default' % default_realkey, default_help,
2370
self.get_info('default'))
2371
deprecated_pairs = []
2372
for key, help in help_pairs:
2373
info = self.get_info(key)
2376
elif info.deprecated:
2377
deprecated_pairs.append((key, help))
2379
output += wrapped(key, help, info)
2380
if len(deprecated_pairs) > 0:
2381
output += "Deprecated formats\n------------------\n\n"
2382
for key, help in deprecated_pairs:
2383
info = self.get_info(key)
2384
output += wrapped(key, help, info)
2389
format_registry = BzrDirFormatRegistry()
2390
format_registry.register('weave', BzrDirFormat6,
2391
'Pre-0.8 format. Slower than knit and does not'
2392
' support checkouts or shared repositories.',
2394
format_registry.register_metadir('knit',
2395
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2396
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2397
branch_format='bzrlib.branch.BzrBranchFormat5',
2398
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2399
format_registry.register_metadir('metaweave',
2400
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2401
'Transitional format in 0.8. Slower than knit.',
2402
branch_format='bzrlib.branch.BzrBranchFormat5',
2403
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2405
format_registry.register_metadir('dirstate',
2406
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2407
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2408
'above when accessed over the network.',
2409
branch_format='bzrlib.branch.BzrBranchFormat5',
2410
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2411
# directly from workingtree_4 triggers a circular import.
2412
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2414
format_registry.register_metadir('dirstate-tags',
2415
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2416
help='New in 0.15: Fast local operations and improved scaling for '
2417
'network operations. Additionally adds support for tags.'
2418
' Incompatible with bzr < 0.15.',
2419
branch_format='bzrlib.branch.BzrBranchFormat6',
2420
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2422
format_registry.register_metadir('dirstate-with-subtree',
2423
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2424
help='New in 0.15: Fast local operations and improved scaling for '
2425
'network operations. Additionally adds support for versioning nested '
2426
'bzr branches. Incompatible with bzr < 0.15.',
2427
branch_format='bzrlib.branch.BzrBranchFormat6',
2428
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2431
format_registry.set_default('dirstate')
added
removed
bzrlib/bzrdir.py
