116
119
thing_to_unlock.break_lock()
121
def can_convert_format(self):
122
"""Return true if this bzrdir is one whose format we can convert from."""
118
125
def check_conversion_target(self, target_format):
119
"""Check that a bzrdir as a whole can be converted to a new format."""
120
# The only current restriction is that the repository content can be
121
# fetched compatibly with the target.
122
126
target_repo_format = target_format.repository_format
124
self.open_repository()._format.check_conversion_target(
126
except errors.NoRepositoryPresent:
127
# No repo, no problem.
127
source_repo_format = self._format.repository_format
128
source_repo_format.check_conversion_target(target_repo_format)
131
def _check_supported(format, allow_unsupported,
132
recommend_upgrade=True,
134
"""Give an error or warning on old formats.
136
:param format: may be any kind of format - workingtree, branch,
139
:param allow_unsupported: If true, allow opening
140
formats that are strongly deprecated, and which may
141
have limited functionality.
143
:param recommend_upgrade: If true (default), warn
144
the user through the ui object that they may wish
145
to upgrade the object.
147
# TODO: perhaps move this into a base Format class; it's not BzrDir
148
# specific. mbp 20070323
149
if not allow_unsupported and not format.is_supported():
150
# see open_downlevel to open legacy branches.
151
raise errors.UnsupportedFormatError(format=format)
152
if recommend_upgrade \
153
and getattr(format, 'upgrade_recommended', False):
154
ui.ui_factory.recommend_upgrade(
155
format.get_format_description(),
158
def clone(self, url, revision_id=None, force_new_repo=False):
159
"""Clone this bzrdir and its contents to url verbatim.
161
If url's last component 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
return self.clone_on_transport(get_transport(url),
169
revision_id=revision_id,
170
force_new_repo=force_new_repo)
130
172
def clone_on_transport(self, transport, revision_id=None,
131
force_new_repo=False, preserve_stacking=False, stacked_on=None,
132
create_prefix=False, use_existing_dir=True, no_tree=False):
173
force_new_repo=False):
133
174
"""Clone this bzrdir and its contents to transport verbatim.
135
:param transport: The transport for the location to produce the clone
136
at. If the target directory does not exist, it will be created.
137
:param revision_id: The tip revision-id to use for any branch or
138
working tree. If not None, then the clone operation may tune
176
If the target directory does not exist, it will be created.
178
if revision_id is not None, then the clone operation may tune
139
179
itself to download less data.
140
:param force_new_repo: Do not use a shared repository for the target,
180
:param force_new_repo: Do not use a shared repository for the target
141
181
even if one is available.
142
:param preserve_stacking: When cloning a stacked branch, stack the
143
new branch on top of the other branch's stacked-on branch.
144
:param create_prefix: Create any missing directories leading up to
146
:param use_existing_dir: Use an existing directory if one exists.
147
:param no_tree: If set to true prevents creation of a working tree.
149
# Overview: put together a broad description of what we want to end up
150
# with; then make as few api calls as possible to do it.
152
# We may want to create a repo/branch/tree, if we do so what format
153
# would we want for each:
154
require_stacking = (stacked_on is not None)
155
format = self.cloning_metadir(require_stacking)
157
# Figure out what objects we want:
183
transport.ensure_base()
184
result = self.cloning_metadir().initialize_on_transport(transport)
185
repository_policy = None
159
187
local_repo = self.find_repository()
160
188
except errors.NoRepositoryPresent:
161
189
local_repo = None
163
local_branch = self.open_branch()
164
except errors.NotBranchError:
167
# enable fallbacks when branch is not a branch reference
168
if local_branch.repository.has_same_location(local_repo):
169
local_repo = local_branch.repository
170
if preserve_stacking:
172
stacked_on = local_branch.get_stacked_on_url()
173
except (errors.UnstackableBranchFormat,
174
errors.UnstackableRepositoryFormat,
177
# Bug: We create a metadir without knowing if it can support stacking,
178
# we should look up the policy needs first, or just use it as a hint,
181
make_working_trees = local_repo.make_working_trees() and not no_tree
182
want_shared = local_repo.is_shared()
183
repo_format_name = format.repository_format.network_name()
185
make_working_trees = False
187
repo_format_name = None
189
result_repo, result, require_stacking, repository_policy = \
190
format.initialize_on_transport_ex(transport,
191
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
192
force_new_repo=force_new_repo, stacked_on=stacked_on,
193
stack_on_pwd=self.root_transport.base,
194
repo_format_name=repo_format_name,
195
make_working_trees=make_working_trees, shared_repo=want_shared)
198
# If the result repository is in the same place as the
199
# resulting bzr dir, it will have no content, further if the
200
# result is not stacked then we know all content should be
201
# copied, and finally if we are copying up to a specific
202
# revision_id then we can use the pending-ancestry-result which
203
# does not require traversing all of history to describe it.
204
if (result_repo.user_url == result.user_url
205
and not require_stacking and
206
revision_id is not None):
207
fetch_spec = vf_search.PendingAncestryResult(
208
[revision_id], local_repo)
209
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
211
result_repo.fetch(local_repo, revision_id=revision_id)
215
if result_repo is not None:
216
raise AssertionError('result_repo not None(%r)' % result_repo)
191
# may need to copy content in
192
repository_policy = result.determine_repository_policy(
194
make_working_trees = local_repo.make_working_trees()
195
result_repo = repository_policy.acquire_repository(
196
make_working_trees, local_repo.is_shared())
197
result_repo.fetch(local_repo, revision_id=revision_id)
217
198
# 1 if there is a branch present
218
199
# make sure its content is available in the target repository
220
if local_branch is not None:
221
result_branch = local_branch.clone(result, revision_id=revision_id,
222
repository_policy=repository_policy)
224
# Cheaper to check if the target is not local, than to try making
226
result.root_transport.local_abspath('.')
227
if result_repo is None or result_repo.make_working_trees():
228
self.open_workingtree().clone(result, revision_id=revision_id)
229
except (errors.NoWorkingTree, errors.NotLocalUrl):
202
local_branch = self.open_branch()
203
except errors.NotBranchError:
206
result_branch = local_branch.clone(result, revision_id=revision_id)
207
if repository_policy is not None:
208
repository_policy.configure_branch(result_branch)
210
result_repo = result.find_repository()
211
except errors.NoRepositoryPresent:
213
if result_repo is None or result_repo.make_working_trees():
215
self.open_workingtree().clone(result)
216
except (errors.NoWorkingTree, errors.NotLocalUrl):
233
220
# TODO: This should be given a Transport, and should chdir up; otherwise
234
221
# this will open a new connection.
235
222
def _make_tail(self, url):
236
t = _mod_transport.get_transport(url)
239
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
240
stack_on_pwd=None, require_stacking=False):
223
t = get_transport(url)
227
def create(cls, base, format=None, possible_transports=None):
228
"""Create a new BzrDir at the url 'base'.
230
:param format: If supplied, the format of branch to create. If not
231
supplied, the default is used.
232
:param possible_transports: If supplied, a list of transports that
233
can be reused to share a remote connection.
235
if cls is not BzrDir:
236
raise AssertionError("BzrDir.create always creates the default"
237
" format, not one of %r" % cls)
238
t = get_transport(base, possible_transports)
241
format = BzrDirFormat.get_default_format()
242
return format.initialize_on_transport(t)
245
def find_bzrdirs(transport, evaluate=None, list_current=None):
246
"""Find bzrdirs recursively from current location.
248
This is intended primarily as a building block for more sophisticated
249
functionality, like finding trees under a directory, or finding
250
branches that use a given repository.
251
:param evaluate: An optional callable that yields recurse, value,
252
where recurse controls whether this bzrdir is recursed into
253
and value is the value to yield. By default, all bzrdirs
254
are recursed into, and the return value is the bzrdir.
255
:param list_current: if supplied, use this function to list the current
256
directory, instead of Transport.list_dir
257
:return: a generator of found bzrdirs, or whatever evaluate returns.
259
if list_current is None:
260
def list_current(transport):
261
return transport.list_dir('')
263
def evaluate(bzrdir):
266
pending = [transport]
267
while len(pending) > 0:
268
current_transport = pending.pop()
271
bzrdir = BzrDir.open_from_transport(current_transport)
272
except errors.NotBranchError:
275
recurse, value = evaluate(bzrdir)
278
subdirs = list_current(current_transport)
279
except errors.NoSuchFile:
282
for subdir in sorted(subdirs, reverse=True):
283
pending.append(current_transport.clone(subdir))
286
def find_branches(transport):
287
"""Find all branches under a transport.
289
This will find all branches below the transport, including branches
290
inside other branches. Where possible, it will use
291
Repository.find_branches.
293
To list all the branches that use a particular Repository, see
294
Repository.find_branches
296
def evaluate(bzrdir):
298
repository = bzrdir.open_repository()
299
except errors.NoRepositoryPresent:
302
return False, (None, repository)
304
branch = bzrdir.open_branch()
305
except errors.NotBranchError:
306
return True, (None, None)
308
return True, (branch, None)
310
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
312
branches.extend(repo.find_branches())
313
if branch is not None:
314
branches.append(branch)
317
def destroy_repository(self):
318
"""Destroy the repository in this BzrDir"""
319
raise NotImplementedError(self.destroy_repository)
321
def create_branch(self):
322
"""Create a branch in this BzrDir.
324
The bzrdir's format will control what branch format is created.
325
For more control see BranchFormatXX.create(a_bzrdir).
327
raise NotImplementedError(self.create_branch)
329
def destroy_branch(self):
330
"""Destroy the branch in this BzrDir"""
331
raise NotImplementedError(self.destroy_branch)
334
def create_branch_and_repo(base, force_new_repo=False, format=None):
335
"""Create a new BzrDir, Branch and Repository at the url 'base'.
337
This will use the current default BzrDirFormat unless one is
338
specified, and use whatever
339
repository format that that uses via bzrdir.create_branch and
340
create_repository. If a shared repository is available that is used
343
The created Branch object is returned.
345
:param base: The URL to create the branch at.
346
:param force_new_repo: If True a new repository is always created.
347
:param format: If supplied, the format of branch to create. If not
348
supplied, the default is used.
350
bzrdir = BzrDir.create(base, format)
351
bzrdir._find_or_create_repository(force_new_repo)
352
return bzrdir.create_branch()
354
def determine_repository_policy(self, force_new_repo=False):
241
355
"""Return an object representing a policy to use.
243
This controls whether a new repository is created, and the format of
244
that repository, or some existing shared repository used instead.
246
If stack_on is supplied, will not seek a containing shared repo.
248
:param force_new_repo: If True, require a new repository to be created.
249
:param stack_on: If supplied, the location to stack on. If not
250
supplied, a default_stack_on location may be used.
251
:param stack_on_pwd: If stack_on is relative, the location it is
357
This controls whether a new repository is created, or a shared
358
repository used instead.
254
360
def repository_policy(found_bzrdir):
257
config = found_bzrdir.get_config()
259
stack_on = config.get_default_stack_on()
260
if stack_on is not None:
261
stack_on_pwd = found_bzrdir.user_url
263
362
# does it have a repository ?
265
364
repository = found_bzrdir.open_repository()
266
365
except errors.NoRepositoryPresent:
267
366
repository = None
269
if (found_bzrdir.user_url != self.user_url
270
and not repository.is_shared()):
271
# Don't look higher, can't use a higher shared repo.
368
if ((found_bzrdir.root_transport.base !=
369
self.root_transport.base) and not repository.is_shared()):
272
370
repository = None
277
374
return None, False
279
return UseExistingRepository(repository, stack_on,
280
stack_on_pwd, require_stacking=require_stacking), True
376
return UseExistingRepository(repository), True
282
return CreateRepository(self, stack_on, stack_on_pwd,
283
require_stacking=require_stacking), True
378
return CreateRepository(self), True
285
380
if not force_new_repo:
287
policy = self._find_containing(repository_policy)
288
if policy is not None:
292
return UseExistingRepository(self.open_repository(),
293
stack_on, stack_on_pwd,
294
require_stacking=require_stacking)
295
except errors.NoRepositoryPresent:
297
return CreateRepository(self, stack_on, stack_on_pwd,
298
require_stacking=require_stacking)
381
policy = self._find_containing(repository_policy)
382
if policy is not None:
384
return CreateRepository(self)
300
386
def _find_or_create_repository(self, force_new_repo):
301
387
"""Create a new repository if needed, returning the repository."""
302
388
policy = self.determine_repository_policy(force_new_repo)
303
return policy.acquire_repository()[0]
305
def _find_source_repo(self, add_cleanup, source_branch):
306
"""Find the source branch and repo for a sprout operation.
389
return policy.acquire_repository()
392
def create_branch_convenience(base, force_new_repo=False,
393
force_new_tree=None, format=None,
394
possible_transports=None):
395
"""Create a new BzrDir, Branch and Repository at the url 'base'.
397
This is a convenience function - it will use an existing repository
398
if possible, can be told explicitly whether to create a working tree or
401
This will use the current default BzrDirFormat unless one is
402
specified, and use whatever
403
repository format that that uses via bzrdir.create_branch and
404
create_repository. If a shared repository is available that is used
405
preferentially. Whatever repository is used, its tree creation policy
408
The created Branch object is returned.
409
If a working tree cannot be made due to base not being a file:// url,
410
no error is raised unless force_new_tree is True, in which case no
411
data is created on disk and NotLocalUrl is raised.
413
:param base: The URL to create the branch at.
414
:param force_new_repo: If True a new repository is always created.
415
:param force_new_tree: If True or False force creation of a tree or
416
prevent such creation respectively.
417
:param format: Override for the bzrdir format to create.
418
:param possible_transports: An optional reusable transports list.
421
# check for non local urls
422
t = get_transport(base, possible_transports)
423
if not isinstance(t, LocalTransport):
424
raise errors.NotLocalUrl(base)
425
bzrdir = BzrDir.create(base, format, possible_transports)
426
repo = bzrdir._find_or_create_repository(force_new_repo)
427
result = bzrdir.create_branch()
428
if force_new_tree or (repo.make_working_trees() and
429
force_new_tree is None):
431
bzrdir.create_workingtree()
432
except errors.NotLocalUrl:
437
def create_standalone_workingtree(base, format=None):
438
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
440
'base' must be a local path or a file:// url.
442
This will use the current default BzrDirFormat unless one is
443
specified, and use whatever
444
repository format that that uses for bzrdirformat.create_workingtree,
445
create_branch and create_repository.
447
:param format: Override for the bzrdir format to create.
448
:return: The WorkingTree object.
450
t = get_transport(base)
451
if not isinstance(t, LocalTransport):
452
raise errors.NotLocalUrl(base)
453
bzrdir = BzrDir.create_branch_and_repo(base,
455
format=format).bzrdir
456
return bzrdir.create_workingtree()
458
def create_workingtree(self, revision_id=None, from_branch=None,
459
accelerator_tree=None, hardlink=False):
460
"""Create a working tree at this BzrDir.
308
This is helper intended for use by _sprout.
310
:returns: (source_branch, source_repository). Either or both may be
311
None. If not None, they will be read-locked (and their unlock(s)
312
scheduled via the add_cleanup param).
314
if source_branch is not None:
315
add_cleanup(source_branch.lock_read().unlock)
316
return source_branch, source_branch.repository
318
source_branch = self.open_branch()
319
source_repository = source_branch.repository
320
except errors.NotBranchError:
323
source_repository = self.open_repository()
324
except errors.NoRepositoryPresent:
325
source_repository = None
327
add_cleanup(source_repository.lock_read().unlock)
329
add_cleanup(source_branch.lock_read().unlock)
330
return source_branch, source_repository
332
def sprout(self, url, revision_id=None, force_new_repo=False,
333
recurse='down', possible_transports=None,
334
accelerator_tree=None, hardlink=False, stacked=False,
335
source_branch=None, create_tree_if_local=True):
336
"""Create a copy of this controldir prepared for use as a new line of
339
If url's last component does not exist, it will be created.
341
Attributes related to the identity of the source branch like
342
branch nickname will be cleaned, a working tree is created
343
whether one existed before or not; and a local branch is always
346
if revision_id is not None, then the clone operation may tune
347
itself to download less data.
462
:param revision_id: create it as of this revision id.
463
:param from_branch: override bzrdir branch (for lightweight checkouts)
349
464
:param accelerator_tree: A tree which can be used for retrieving file
350
465
contents more quickly than the revision tree, i.e. a workingtree.
351
466
The revision tree will be used for cases where accelerator_tree's
352
467
content is different.
353
:param hardlink: If true, hard-link files from accelerator_tree,
355
:param stacked: If true, create a stacked branch referring to the
356
location of this control directory.
357
:param create_tree_if_local: If true, a working-tree will be created
358
when working locally.
359
:return: The created control directory
361
operation = cleanup.OperationWithCleanups(self._sprout)
362
return operation.run(url, revision_id=revision_id,
363
force_new_repo=force_new_repo, recurse=recurse,
364
possible_transports=possible_transports,
365
accelerator_tree=accelerator_tree, hardlink=hardlink,
366
stacked=stacked, source_branch=source_branch,
367
create_tree_if_local=create_tree_if_local)
369
def _sprout(self, op, url, revision_id=None, force_new_repo=False,
370
recurse='down', possible_transports=None,
371
accelerator_tree=None, hardlink=False, stacked=False,
372
source_branch=None, create_tree_if_local=True):
373
add_cleanup = op.add_cleanup
374
fetch_spec_factory = fetch.FetchSpecFactory()
375
if revision_id is not None:
376
fetch_spec_factory.add_revision_ids([revision_id])
377
fetch_spec_factory.source_branch_stop_revision_id = revision_id
378
if possible_transports is None:
379
possible_transports = []
381
possible_transports = list(possible_transports) + [
383
target_transport = _mod_transport.get_transport(url,
385
target_transport.ensure_base()
386
cloning_format = self.cloning_metadir(stacked)
387
# Create/update the result branch
389
result = controldir.ControlDir.open_from_transport(target_transport)
390
except errors.NotBranchError:
391
result = cloning_format.initialize_on_transport(target_transport)
392
source_branch, source_repository = self._find_source_repo(
393
add_cleanup, source_branch)
394
fetch_spec_factory.source_branch = source_branch
395
# if a stacked branch wasn't requested, we don't create one
396
# even if the origin was stacked
397
if stacked and source_branch is not None:
398
stacked_branch_url = self.root_transport.base
400
stacked_branch_url = None
401
repository_policy = result.determine_repository_policy(
402
force_new_repo, stacked_branch_url, require_stacking=stacked)
403
result_repo, is_new_repo = repository_policy.acquire_repository(
404
possible_transports=possible_transports)
405
add_cleanup(result_repo.lock_write().unlock)
406
fetch_spec_factory.source_repo = source_repository
407
fetch_spec_factory.target_repo = result_repo
408
if stacked or (len(result_repo._fallback_repositories) != 0):
409
target_repo_kind = fetch.TargetRepoKinds.STACKED
411
target_repo_kind = fetch.TargetRepoKinds.EMPTY
413
target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
414
fetch_spec_factory.target_repo_kind = target_repo_kind
415
if source_repository is not None:
416
fetch_spec = fetch_spec_factory.make_fetch_spec()
417
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
419
if source_branch is None:
420
# this is for sprouting a controldir without a branch; is that
422
# Not especially, but it's part of the contract.
423
result_branch = result.create_branch()
425
result_branch = source_branch.sprout(result,
426
revision_id=revision_id, repository_policy=repository_policy,
427
repository=result_repo)
428
mutter("created new branch %r" % (result_branch,))
430
# Create/update the result working tree
431
if (create_tree_if_local and not result.has_workingtree() and
432
isinstance(target_transport, local.LocalTransport) and
433
(result_repo is None or result_repo.make_working_trees())):
434
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
435
hardlink=hardlink, from_branch=result_branch)
438
if wt.path2id('') is None:
440
wt.set_root_id(self.open_workingtree.get_root_id())
441
except errors.NoWorkingTree:
447
if recurse == 'down':
450
basis = wt.basis_tree()
451
elif result_branch is not None:
452
basis = result_branch.basis_tree()
453
elif source_branch is not None:
454
basis = source_branch.basis_tree()
455
if basis is not None:
456
add_cleanup(basis.lock_read().unlock)
457
subtrees = basis.iter_references()
460
for path, file_id in subtrees:
461
target = urlutils.join(url, urlutils.escape(path))
462
sublocation = source_branch.reference_parent(file_id, path)
463
sublocation.bzrdir.sprout(target,
464
basis.get_reference_revision(file_id, path),
465
force_new_repo=force_new_repo, recurse=recurse,
469
def _available_backup_name(self, base):
470
"""Find a non-existing backup file name based on base.
472
See bzrlib.osutils.available_backup_name about race conditions.
474
return osutils.available_backup_name(base, self.root_transport.has)
476
def backup_bzrdir(self):
477
"""Backup this bzr control directory.
479
:return: Tuple with old path name and new path name
482
pb = ui.ui_factory.nested_progress_bar()
484
old_path = self.root_transport.abspath('.bzr')
485
backup_dir = self._available_backup_name('backup.bzr')
486
new_path = self.root_transport.abspath(backup_dir)
487
ui.ui_factory.note(gettext('making backup of {0}\n to {1}').format(
488
urlutils.unescape_for_display(old_path, 'utf-8'),
489
urlutils.unescape_for_display(new_path, 'utf-8')))
490
self.root_transport.copy_tree('.bzr', backup_dir)
491
return (old_path, new_path)
469
raise NotImplementedError(self.create_workingtree)
495
471
def retire_bzrdir(self, limit=10000):
496
472
"""Permanently disable the bzrdir.
633
659
:param _transport: the transport this dir is based at.
635
661
self._format = _format
636
# these are also under the more standard names of
637
# control_transport and user_transport
638
662
self.transport = _transport.clone('.bzr')
639
663
self.root_transport = _transport
640
664
self._mode_check_done = False
643
def user_transport(self):
644
return self.root_transport
647
def control_transport(self):
648
return self.transport
650
666
def is_control_filename(self, filename):
651
667
"""True if filename is the name of a path which is reserved for bzrdir's.
653
669
:param filename: A filename within the root transport of this bzrdir.
655
671
This is true IF and ONLY IF the filename is part of the namespace reserved
656
672
for bzr control dirs. Currently this is the '.bzr' directory in the root
657
of the root_transport.
673
of the root_transport. it is expected that plugins will need to extend
674
this in the future - for instance to make bzr talk with svn working
659
# this might be better on the BzrDirFormat class because it refers to
660
# all the possible bzrdir disk formats.
661
# This method is tested via the workingtree is_control_filename tests-
677
# this might be better on the BzrDirFormat class because it refers to
678
# all the possible bzrdir disk formats.
679
# This method is tested via the workingtree is_control_filename tests-
662
680
# it was extracted from WorkingTree.is_control_filename. If the method's
663
681
# contract is extended beyond the current trivial implementation, please
664
682
# add new tests for it to the appropriate place.
665
683
return filename == '.bzr' or filename.startswith('.bzr/')
685
def needs_format_conversion(self, format=None):
686
"""Return true if this bzrdir needs convert_format run on it.
688
For instance, if the repository format is out of date but the
689
branch and working tree are not, this should return True.
691
:param format: Optional parameter indicating a specific desired
692
format we plan to arrive at.
694
raise NotImplementedError(self.needs_format_conversion)
697
def open_unsupported(base):
698
"""Open a branch which is not supported."""
699
return BzrDir.open(base, _unsupported=True)
702
def open(base, _unsupported=False, possible_transports=None):
703
"""Open an existing bzrdir, rooted at 'base' (url).
705
:param _unsupported: a private parameter to the BzrDir class.
707
t = get_transport(base, possible_transports=possible_transports)
708
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
711
def open_from_transport(transport, _unsupported=False,
712
_server_formats=True):
713
"""Open a bzrdir within a particular directory.
715
:param transport: Transport containing the bzrdir.
716
:param _unsupported: private.
718
base = transport.base
720
def find_format(transport):
721
return transport, BzrDirFormat.find_format(
722
transport, _server_formats=_server_formats)
724
def redirected(transport, e, redirection_notice):
725
qualified_source = e.get_source_url()
726
relpath = transport.relpath(qualified_source)
727
if not e.target.endswith(relpath):
728
# Not redirected to a branch-format, not a branch
729
raise errors.NotBranchError(path=e.target)
730
target = e.target[:-len(relpath)]
731
note('%s is%s redirected to %s',
732
transport.base, e.permanently, target)
733
# Let's try with a new transport
734
# FIXME: If 'transport' has a qualifier, this should
735
# be applied again to the new transport *iff* the
736
# schemes used are the same. Uncomment this code
737
# once the function (and tests) exist.
739
#target = urlutils.copy_url_qualifiers(original, target)
740
return get_transport(target)
743
transport, format = do_catching_redirections(find_format,
746
except errors.TooManyRedirections:
747
raise errors.NotBranchError(base)
749
BzrDir._check_supported(format, _unsupported)
750
return format.open(transport, _found=True)
752
def open_branch(self, unsupported=False):
753
"""Open the branch object at this BzrDir if one is present.
755
If unsupported is True, then no longer supported branch formats can
758
TODO: static convenience version of this?
760
raise NotImplementedError(self.open_branch)
763
def open_containing(url, possible_transports=None):
764
"""Open an existing branch which contains url.
766
:param url: url to search from.
767
See open_containing_from_transport for more detail.
769
transport = get_transport(url, possible_transports)
770
return BzrDir.open_containing_from_transport(transport)
773
def open_containing_from_transport(a_transport):
774
"""Open an existing branch which contains a_transport.base.
776
This probes for a branch at a_transport, and searches upwards from there.
778
Basically we keep looking up until we find the control directory or
779
run into the root. If there isn't one, raises NotBranchError.
780
If there is one and it is either an unrecognised format or an unsupported
781
format, UnknownFormatError or UnsupportedFormatError are raised.
782
If there is one, it is returned, along with the unused portion of url.
784
:return: The BzrDir that contains the path, and a Unicode path
785
for the rest of the URL.
787
# this gets the normalised url back. I.e. '.' -> the full path.
788
url = a_transport.base
791
result = BzrDir.open_from_transport(a_transport)
792
return result, urlutils.unescape(a_transport.relpath(url))
793
except errors.NotBranchError, e:
796
new_t = a_transport.clone('..')
797
except errors.InvalidURLJoin:
798
# reached the root, whatever that may be
799
raise errors.NotBranchError(path=url)
800
if new_t.base == a_transport.base:
801
# reached the root, whatever that may be
802
raise errors.NotBranchError(path=url)
805
def _get_tree_branch(self):
806
"""Return the branch and tree, if any, for this bzrdir.
808
Return None for tree if not present or inaccessible.
809
Raise NotBranchError if no branch is present.
810
:return: (tree, branch)
813
tree = self.open_workingtree()
814
except (errors.NoWorkingTree, errors.NotLocalUrl):
816
branch = self.open_branch()
822
def open_tree_or_branch(klass, location):
823
"""Return the branch and working tree at a location.
825
If there is no tree at the location, tree will be None.
826
If there is no branch at the location, an exception will be
828
:return: (tree, branch)
830
bzrdir = klass.open(location)
831
return bzrdir._get_tree_branch()
834
def open_containing_tree_or_branch(klass, location):
835
"""Return the branch and working tree contained by a location.
837
Returns (tree, branch, relpath).
838
If there is no tree at containing the location, tree will be None.
839
If there is no branch containing the location, an exception will be
841
relpath is the portion of the path that is contained by the branch.
843
bzrdir, relpath = klass.open_containing(location)
844
tree, branch = bzrdir._get_tree_branch()
845
return tree, branch, relpath
847
def open_repository(self, _unsupported=False):
848
"""Open the repository object at this BzrDir if one is present.
850
This will not follow the Branch object pointer - it's strictly a direct
851
open facility. Most client code should use open_branch().repository to
854
:param _unsupported: a private parameter, not part of the api.
855
TODO: static convenience version of this?
857
raise NotImplementedError(self.open_repository)
859
def open_workingtree(self, _unsupported=False,
860
recommend_upgrade=True, from_branch=None):
861
"""Open the workingtree object at this BzrDir if one is present.
863
:param recommend_upgrade: Optional keyword parameter, when True (the
864
default), emit through the ui module a recommendation that the user
865
upgrade the working tree when the workingtree being opened is old
866
(but still fully supported).
867
:param from_branch: override bzrdir branch (for lightweight checkouts)
869
raise NotImplementedError(self.open_workingtree)
871
def has_branch(self):
872
"""Tell if this bzrdir contains a branch.
874
Note: if you're going to open the branch, you should just go ahead
875
and try, and not ask permission first. (This method just opens the
876
branch and discards it, and that's somewhat expensive.)
881
except errors.NotBranchError:
884
def has_workingtree(self):
885
"""Tell if this bzrdir contains a working tree.
887
This will still raise an exception if the bzrdir has a workingtree that
888
is remote & inaccessible.
890
Note: if you're going to open the working tree, you should just go ahead
891
and try, and not ask permission first. (This method just opens the
892
workingtree and discards it, and that's somewhat expensive.)
895
self.open_workingtree(recommend_upgrade=False)
897
except errors.NoWorkingTree:
667
900
def _cloning_metadir(self):
668
"""Produce a metadir suitable for cloning with.
670
:returns: (destination_bzrdir_format, source_repository)
901
"""Produce a metadir suitable for cloning with."""
672
902
result_format = self._format.__class__()
675
branch = self.open_branch(ignore_fallbacks=True)
905
branch = self.open_branch()
676
906
source_repository = branch.repository
677
result_format._branch_format = branch._format
678
907
except errors.NotBranchError:
679
908
source_branch = None
680
909
source_repository = self.open_repository()
700
927
result_format.workingtree_format = tree._format.__class__()
701
928
return result_format, source_repository
703
def cloning_metadir(self, require_stacking=False):
930
def cloning_metadir(self):
704
931
"""Produce a metadir suitable for cloning or sprouting with.
706
933
These operations may produce workingtrees (yes, even though they're
707
934
"cloning" something that doesn't have a tree), so a viable workingtree
708
935
format must be selected.
710
:require_stacking: If True, non-stackable formats will be upgraded
711
to similar stackable formats.
712
:returns: a ControlDirFormat with all component formats either set
713
appropriately or set to None if that component should not be
716
937
format, repository = self._cloning_metadir()
717
938
if format._workingtree_format is None:
719
939
if repository is None:
720
# No repository either
722
# We have a repository, so set a working tree? (Why? This seems to
723
# contradict the stated return value in the docstring).
724
941
tree_format = repository._format._matchingbzrdir.workingtree_format
725
942
format.workingtree_format = tree_format.__class__()
727
format.require_stacking()
730
def get_branch_transport(self, branch_format, name=None):
731
"""Get the transport for use by branch format in this BzrDir.
733
Note that bzr dirs that do not support format strings will raise
734
IncompatibleFormat if the branch format they are given has
735
a format string, and vice versa.
737
If branch_format is None, the transport is returned with no
738
checking. If it is not None, then the returned transport is
739
guaranteed to point to an existing directory ready for use.
945
def checkout_metadir(self):
946
return self.cloning_metadir()
948
def sprout(self, url, revision_id=None, force_new_repo=False,
949
recurse='down', possible_transports=None,
950
accelerator_tree=None, hardlink=False, stacked=False):
951
"""Create a copy of this bzrdir prepared for use as a new line of
954
If url's last component does not exist, it will be created.
956
Attributes related to the identity of the source branch like
957
branch nickname will be cleaned, a working tree is created
958
whether one existed before or not; and a local branch is always
961
if revision_id is not None, then the clone operation may tune
962
itself to download less data.
963
:param accelerator_tree: A tree which can be used for retrieving file
964
contents more quickly than the revision tree, i.e. a workingtree.
965
The revision tree will be used for cases where accelerator_tree's
966
content is different.
967
:param hardlink: If true, hard-link files from accelerator_tree,
969
:param stacked: If true, create a stacked branch referring to the
970
location of this control directory.
741
raise NotImplementedError(self.get_branch_transport)
972
target_transport = get_transport(url, possible_transports)
973
target_transport.ensure_base()
974
cloning_format = self.cloning_metadir()
975
result = cloning_format.initialize_on_transport(target_transport)
977
source_branch = self.open_branch()
978
source_repository = source_branch.repository
980
stacked_branch_url = self.root_transport.base
983
stacked_branch_url = source_branch.get_stacked_on()
984
except (errors.NotStacked, errors.UnstackableBranchFormat,
985
errors.UnstackableRepositoryFormat):
986
stacked_branch_url = None
987
except errors.NotBranchError:
990
source_repository = self.open_repository()
991
except errors.NoRepositoryPresent:
992
source_repository = None
993
stacked_branch_url = None
998
result_repo = result.find_repository()
999
except errors.NoRepositoryPresent:
1002
# Create/update the result repository as required
1003
if source_repository is None:
1004
if result_repo is None:
1005
# no repo available, make a new one
1006
result.create_repository()
1007
elif stacked_branch_url is not None:
1008
if result_repo is None:
1009
result_repo = source_repository._format.initialize(result)
1010
stacked_dir = BzrDir.open(stacked_branch_url)
1012
stacked_repo = stacked_dir.open_branch().repository
1013
except errors.NotBranchError:
1014
stacked_repo = stacked_dir.open_repository()
1015
result_repo.add_fallback_repository(stacked_repo)
1016
result_repo.fetch(source_repository, revision_id=revision_id)
1017
elif result_repo is None:
1018
# have source, and want to make a new target repo
1019
result_repo = source_repository.sprout(result,
1020
revision_id=revision_id)
1022
# Fetch needed content into target.
1023
# Would rather do it this way ...
1024
# source_repository.copy_content_into(result_repo,
1025
# revision_id=revision_id)
1026
# so we can override the copy method
1027
result_repo.fetch(source_repository, revision_id=revision_id)
1029
# Create/update the result branch
1030
if source_branch is not None:
1031
result_branch = source_branch.sprout(result,
1032
revision_id=revision_id)
1034
result_branch = result.create_branch()
1035
if stacked_branch_url is not None:
1036
result_branch.set_stacked_on(stacked_branch_url)
1038
# Create/update the result working tree
1039
if isinstance(target_transport, LocalTransport) and (
1040
result_repo is None or result_repo.make_working_trees()):
1041
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1045
if wt.path2id('') is None:
1047
wt.set_root_id(self.open_workingtree.get_root_id())
1048
except errors.NoWorkingTree:
1054
if recurse == 'down':
1056
basis = wt.basis_tree()
1058
subtrees = basis.iter_references()
1059
elif source_branch is not None:
1060
basis = source_branch.basis_tree()
1062
subtrees = basis.iter_references()
1067
for path, file_id in subtrees:
1068
target = urlutils.join(url, urlutils.escape(path))
1069
sublocation = source_branch.reference_parent(file_id, path)
1070
sublocation.bzrdir.sprout(target,
1071
basis.get_reference_revision(file_id, path),
1072
force_new_repo=force_new_repo, recurse=recurse,
1075
if basis is not None:
1080
class BzrDirPreSplitOut(BzrDir):
1081
"""A common class for the all-in-one formats."""
1083
def __init__(self, _transport, _format):
1084
"""See BzrDir.__init__."""
1085
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1086
self._control_files = lockable_files.LockableFiles(
1087
self.get_branch_transport(None),
1088
self._format._lock_file_name,
1089
self._format._lock_class)
1091
def break_lock(self):
1092
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1093
raise NotImplementedError(self.break_lock)
1095
def cloning_metadir(self):
1096
"""Produce a metadir suitable for cloning with."""
1097
return self._format.__class__()
1099
def clone(self, url, revision_id=None, force_new_repo=False):
1100
"""See BzrDir.clone()."""
1101
from bzrlib.workingtree import WorkingTreeFormat2
1102
self._make_tail(url)
1103
result = self._format._initialize_for_clone(url)
1104
self.open_repository().clone(result, revision_id=revision_id)
1105
from_branch = self.open_branch()
1106
from_branch.clone(result, revision_id=revision_id)
1108
self.open_workingtree().clone(result)
1109
except errors.NotLocalUrl:
1110
# make a new one, this format always has to have one.
1112
WorkingTreeFormat2().initialize(result)
1113
except errors.NotLocalUrl:
1114
# but we cannot do it for remote trees.
1115
to_branch = result.open_branch()
1116
WorkingTreeFormat2()._stub_initialize_remote(to_branch)
1119
def create_branch(self):
1120
"""See BzrDir.create_branch."""
1121
return self.open_branch()
1123
def destroy_branch(self):
1124
"""See BzrDir.destroy_branch."""
1125
raise errors.UnsupportedOperation(self.destroy_branch, self)
1127
def create_repository(self, shared=False):
1128
"""See BzrDir.create_repository."""
1130
raise errors.IncompatibleFormat('shared repository', self._format)
1131
return self.open_repository()
1133
def destroy_repository(self):
1134
"""See BzrDir.destroy_repository."""
1135
raise errors.UnsupportedOperation(self.destroy_repository, self)
1137
def create_workingtree(self, revision_id=None, from_branch=None,
1138
accelerator_tree=None, hardlink=False):
1139
"""See BzrDir.create_workingtree."""
1140
# this looks buggy but is not -really-
1141
# because this format creates the workingtree when the bzrdir is
1143
# clone and sprout will have set the revision_id
1144
# and that will have set it for us, its only
1145
# specific uses of create_workingtree in isolation
1146
# that can do wonky stuff here, and that only
1147
# happens for creating checkouts, which cannot be
1148
# done on this format anyway. So - acceptable wart.
1149
result = self.open_workingtree(recommend_upgrade=False)
1150
if revision_id is not None:
1151
if revision_id == _mod_revision.NULL_REVISION:
1152
result.set_parent_ids([])
1154
result.set_parent_ids([revision_id])
1157
def destroy_workingtree(self):
1158
"""See BzrDir.destroy_workingtree."""
1159
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1161
def destroy_workingtree_metadata(self):
1162
"""See BzrDir.destroy_workingtree_metadata."""
1163
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1166
def get_branch_transport(self, branch_format):
1167
"""See BzrDir.get_branch_transport()."""
1168
if branch_format is None:
1169
return self.transport
1171
branch_format.get_format_string()
1172
except NotImplementedError:
1173
return self.transport
1174
raise errors.IncompatibleFormat(branch_format, self._format)
743
1176
def get_repository_transport(self, repository_format):
744
"""Get the transport for use by repository format in this BzrDir.
746
Note that bzr dirs that do not support format strings will raise
747
IncompatibleFormat if the repository format they are given has
748
a format string, and vice versa.
750
If repository_format is None, the transport is returned with no
751
checking. If it is not None, then the returned transport is
752
guaranteed to point to an existing directory ready for use.
754
raise NotImplementedError(self.get_repository_transport)
756
def get_workingtree_transport(self, tree_format):
757
"""Get the transport for use by workingtree format in this BzrDir.
759
Note that bzr dirs that do not support format strings will raise
760
IncompatibleFormat if the workingtree format they are given has a
761
format string, and vice versa.
763
If workingtree_format is None, the transport is returned with no
764
checking. If it is not None, then the returned transport is
765
guaranteed to point to an existing directory ready for use.
767
raise NotImplementedError(self.get_workingtree_transport)
770
def create(cls, base, format=None, possible_transports=None):
771
"""Create a new BzrDir at the url 'base'.
773
:param format: If supplied, the format of branch to create. If not
774
supplied, the default is used.
775
:param possible_transports: If supplied, a list of transports that
776
can be reused to share a remote connection.
778
if cls is not BzrDir:
779
raise AssertionError("BzrDir.create always creates the "
780
"default format, not one of %r" % cls)
781
return controldir.ControlDir.create(base, format=format,
782
possible_transports=possible_transports)
785
return "<%s at %r>" % (self.__class__.__name__, self.user_url)
787
def update_feature_flags(self, updated_flags):
788
"""Update the features required by this bzrdir.
790
:param updated_flags: Dictionary mapping feature names to necessities
791
A necessity can be None to indicate the feature should be removed
793
self.control_files.lock_write()
795
self._format._update_feature_flags(updated_flags)
796
self.transport.put_bytes('branch-format', self._format.as_string())
798
self.control_files.unlock()
1177
"""See BzrDir.get_repository_transport()."""
1178
if repository_format is None:
1179
return self.transport
1181
repository_format.get_format_string()
1182
except NotImplementedError:
1183
return self.transport
1184
raise errors.IncompatibleFormat(repository_format, self._format)
1186
def get_workingtree_transport(self, workingtree_format):
1187
"""See BzrDir.get_workingtree_transport()."""
1188
if workingtree_format is None:
1189
return self.transport
1191
workingtree_format.get_format_string()
1192
except NotImplementedError:
1193
return self.transport
1194
raise errors.IncompatibleFormat(workingtree_format, self._format)
1196
def needs_format_conversion(self, format=None):
1197
"""See BzrDir.needs_format_conversion()."""
1198
# if the format is not the same as the system default,
1199
# an upgrade is needed.
1201
format = BzrDirFormat.get_default_format()
1202
return not isinstance(self._format, format.__class__)
1204
def open_branch(self, unsupported=False):
1205
"""See BzrDir.open_branch."""
1206
from bzrlib.branch import BzrBranchFormat4
1207
format = BzrBranchFormat4()
1208
self._check_supported(format, unsupported)
1209
return format.open(self, _found=True)
1211
def sprout(self, url, revision_id=None, force_new_repo=False,
1212
possible_transports=None, accelerator_tree=None,
1213
hardlink=False, stacked=False):
1214
"""See BzrDir.sprout()."""
1216
raise errors.UnstackableBranchFormat(
1217
self._format, self.root_transport.base)
1218
from bzrlib.workingtree import WorkingTreeFormat2
1219
self._make_tail(url)
1220
result = self._format._initialize_for_clone(url)
1222
self.open_repository().clone(result, revision_id=revision_id)
1223
except errors.NoRepositoryPresent:
1226
self.open_branch().sprout(result, revision_id=revision_id)
1227
except errors.NotBranchError:
1229
# we always want a working tree
1230
WorkingTreeFormat2().initialize(result,
1231
accelerator_tree=accelerator_tree,
1236
class BzrDir4(BzrDirPreSplitOut):
1237
"""A .bzr version 4 control object.
1239
This is a deprecated format and may be removed after sept 2006.
1242
def create_repository(self, shared=False):
1243
"""See BzrDir.create_repository."""
1244
return self._format.repository_format.initialize(self, shared)
1246
def needs_format_conversion(self, format=None):
1247
"""Format 4 dirs are always in need of conversion."""
1250
def open_repository(self):
1251
"""See BzrDir.open_repository."""
1252
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1253
return RepositoryFormat4().open(self, _found=True)
1256
class BzrDir5(BzrDirPreSplitOut):
1257
"""A .bzr version 5 control object.
1259
This is a deprecated format and may be removed after sept 2006.
1262
def open_repository(self):
1263
"""See BzrDir.open_repository."""
1264
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1265
return RepositoryFormat5().open(self, _found=True)
1267
def open_workingtree(self, _unsupported=False,
1268
recommend_upgrade=True):
1269
"""See BzrDir.create_workingtree."""
1270
from bzrlib.workingtree import WorkingTreeFormat2
1271
wt_format = WorkingTreeFormat2()
1272
# we don't warn here about upgrades; that ought to be handled for the
1274
return wt_format.open(self, _found=True)
1277
class BzrDir6(BzrDirPreSplitOut):
1278
"""A .bzr version 6 control object.
1280
This is a deprecated format and may be removed after sept 2006.
1283
def open_repository(self):
1284
"""See BzrDir.open_repository."""
1285
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1286
return RepositoryFormat6().open(self, _found=True)
1288
def open_workingtree(self, _unsupported=False,
1289
recommend_upgrade=True):
1290
"""See BzrDir.create_workingtree."""
1291
# we don't warn here about upgrades; that ought to be handled for the
1293
from bzrlib.workingtree import WorkingTreeFormat2
1294
return WorkingTreeFormat2().open(self, _found=True)
801
1297
class BzrDirMeta1(BzrDir):
802
1298
"""A .bzr meta version 1 control object.
804
This is the first control object where the
1300
This is the first control object where the
805
1301
individual aspects are really split out: there are separate repository,
806
1302
workingtree and branch subdirectories and any subset of the three can be
807
1303
present within a BzrDir.
810
def _get_branch_path(self, name):
811
"""Obtain the branch path to use.
813
This uses the API specified branch name first, and then falls back to
814
the branch name specified in the URL. If neither of those is specified,
815
it uses the default branch.
817
:param name: Optional branch name to use
818
:return: Relative path to branch
822
return urlutils.join('branches', name.encode("utf-8"))
824
def _read_branch_list(self):
825
"""Read the branch list.
827
:return: List of utf-8 encoded branch names.
830
f = self.control_transport.get('branch-list')
831
except errors.NoSuchFile:
837
ret.append(name.rstrip("\n"))
842
def _write_branch_list(self, branches):
843
"""Write out the branch list.
845
:param branches: List of utf-8 branch names to write
847
self.transport.put_bytes('branch-list',
848
"".join([name+"\n" for name in branches]))
850
def __init__(self, _transport, _format):
851
super(BzrDirMeta1, self).__init__(_transport, _format)
852
self.control_files = lockable_files.LockableFiles(
853
self.control_transport, self._format._lock_file_name,
854
self._format._lock_class)
856
1306
def can_convert_format(self):
857
1307
"""See BzrDir.can_convert_format()."""
860
def create_branch(self, name=None, repository=None,
861
append_revisions_only=None):
862
"""See ControlDir.create_branch."""
864
name = self._get_selected_branch()
865
return self._format.get_branch_format().initialize(self, name=name,
866
repository=repository,
867
append_revisions_only=append_revisions_only)
1310
def create_branch(self):
1311
"""See BzrDir.create_branch."""
1312
return self._format.get_branch_format().initialize(self)
869
def destroy_branch(self, name=None):
870
"""See ControlDir.destroy_branch."""
872
name = self._get_selected_branch()
873
path = self._get_branch_path(name)
875
self.control_files.lock_write()
877
branches = self._read_branch_list()
879
branches.remove(name.encode("utf-8"))
881
raise errors.NotBranchError(name)
882
self._write_branch_list(branches)
884
self.control_files.unlock()
886
self.transport.delete_tree(path)
887
except errors.NoSuchFile:
888
raise errors.NotBranchError(path=urlutils.join(self.transport.base,
1314
def destroy_branch(self):
1315
"""See BzrDir.create_branch."""
1316
self.transport.delete_tree('branch')
891
1318
def create_repository(self, shared=False):
892
1319
"""See BzrDir.create_repository."""
1070
def open_branch(self, name=None, unsupported=False,
1071
ignore_fallbacks=False, possible_transports=None):
1072
"""See ControlDir.open_branch."""
1074
name = self._get_selected_branch()
1075
format = self.find_branch_format(name=name)
1076
format.check_support_status(unsupported)
1077
return format.open(self, name=name,
1078
_found=True, ignore_fallbacks=ignore_fallbacks,
1079
possible_transports=possible_transports)
1438
def open_branch(self, unsupported=False):
1439
"""See BzrDir.open_branch."""
1440
format = self.find_branch_format()
1441
self._check_supported(format, unsupported)
1442
return format.open(self, _found=True)
1081
1444
def open_repository(self, unsupported=False):
1082
1445
"""See BzrDir.open_repository."""
1083
from bzrlib.repository import RepositoryFormatMetaDir
1084
format = RepositoryFormatMetaDir.find_format(self)
1085
format.check_support_status(unsupported)
1446
from bzrlib.repository import RepositoryFormat
1447
format = RepositoryFormat.find_format(self)
1448
self._check_supported(format, unsupported)
1086
1449
return format.open(self, _found=True)
1088
1451
def open_workingtree(self, unsupported=False,
1089
1452
recommend_upgrade=True):
1090
1453
"""See BzrDir.open_workingtree."""
1091
from bzrlib.workingtree import WorkingTreeFormatMetaDir
1092
format = WorkingTreeFormatMetaDir.find_format(self)
1093
format.check_support_status(unsupported, recommend_upgrade,
1454
from bzrlib.workingtree import WorkingTreeFormat
1455
format = WorkingTreeFormat.find_format(self)
1456
self._check_supported(format, unsupported,
1094
1458
basedir=self.root_transport.base)
1095
1459
return format.open(self, _found=True)
1097
def _get_config(self):
1098
return config.TransportConfig(self.transport, 'control.conf')
1101
class BzrFormat(object):
1102
"""Base class for all formats of things living in metadirs.
1104
This class manages the format string that is stored in the 'format'
1105
or 'branch-format' file.
1107
All classes for (branch-, repository-, workingtree-) formats that
1108
live in meta directories and have their own 'format' file
1109
(i.e. different from .bzr/branch-format) derive from this class,
1110
as well as the relevant base class for their kind
1111
(BranchFormat, WorkingTreeFormat, RepositoryFormat).
1113
Each format is identified by a "format" or "branch-format" file with a
1114
single line containing the base format name and then an optional list of
1117
Feature flags are supported as of bzr 2.5. Setting feature flags on formats
1118
will render them inaccessible to older versions of bzr.
1120
:ivar features: Dictionary mapping feature names to their necessity
1123
_present_features = set()
1129
def register_feature(cls, name):
1130
"""Register a feature as being present.
1132
:param name: Name of the feature
1135
raise ValueError("spaces are not allowed in feature names")
1136
if name in cls._present_features:
1137
raise errors.FeatureAlreadyRegistered(name)
1138
cls._present_features.add(name)
1141
def unregister_feature(cls, name):
1142
"""Unregister a feature."""
1143
cls._present_features.remove(name)
1145
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1147
for name, necessity in self.features.iteritems():
1148
if name in self._present_features:
1150
if necessity == "optional":
1151
mutter("ignoring optional missing feature %s", name)
1153
elif necessity == "required":
1154
raise errors.MissingFeature(name)
1156
mutter("treating unknown necessity as require for %s",
1158
raise errors.MissingFeature(name)
1161
def get_format_string(cls):
1162
"""Return the ASCII format string that identifies this format."""
1163
raise NotImplementedError(cls.get_format_string)
1166
def from_string(cls, text):
1167
format_string = cls.get_format_string()
1168
if not text.startswith(format_string):
1169
raise AssertionError("Invalid format header %r for %r" % (text, cls))
1170
lines = text[len(format_string):].splitlines()
1172
for lineno, line in enumerate(lines):
1174
(necessity, feature) = line.split(" ", 1)
1176
raise errors.ParseFormatError(format=cls, lineno=lineno+2,
1177
line=line, text=text)
1178
ret.features[feature] = necessity
1181
def as_string(self):
1182
"""Return the string representation of this format.
1184
lines = [self.get_format_string()]
1185
lines.extend([("%s %s\n" % (item[1], item[0])) for item in
1186
self.features.iteritems()])
1187
return "".join(lines)
1190
def _find_format(klass, registry, kind, format_string):
1192
first_line = format_string[:format_string.index("\n")+1]
1194
first_line = format_string
1196
cls = registry.get(first_line)
1198
raise errors.UnknownFormatError(format=first_line, kind=kind)
1199
return cls.from_string(format_string)
1201
def network_name(self):
1202
"""A simple byte string uniquely identifying this format for RPC calls.
1204
Metadir branch formats use their format string.
1206
return self.as_string()
1208
def __eq__(self, other):
1209
return (self.__class__ is other.__class__ and
1210
self.features == other.features)
1212
def _update_feature_flags(self, updated_flags):
1213
"""Update the feature flags in this format.
1215
:param updated_flags: Updated feature flags
1217
for name, necessity in updated_flags.iteritems():
1218
if necessity is None:
1220
del self.features[name]
1224
self.features[name] = necessity
1227
class BzrProber(controldir.Prober):
1228
"""Prober for formats that use a .bzr/ control directory."""
1230
formats = registry.FormatRegistry(controldir.network_format_registry)
1231
"""The known .bzr formats."""
1234
def probe_transport(klass, transport):
1235
"""Return the .bzrdir style format present in a directory."""
1237
format_string = transport.get_bytes(".bzr/branch-format")
1238
except errors.NoSuchFile:
1239
raise errors.NotBranchError(path=transport.base)
1241
first_line = format_string[:format_string.index("\n")+1]
1243
first_line = format_string
1245
cls = klass.formats.get(first_line)
1247
raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
1248
return cls.from_string(format_string)
1251
def known_formats(cls):
1253
for name, format in cls.formats.iteritems():
1254
if callable(format):
1260
controldir.ControlDirFormat.register_prober(BzrProber)
1263
class RemoteBzrProber(controldir.Prober):
1264
"""Prober for remote servers that provide a Bazaar smart server."""
1267
def probe_transport(klass, transport):
1268
"""Return a RemoteBzrDirFormat object if it looks possible."""
1270
medium = transport.get_smart_medium()
1271
except (NotImplementedError, AttributeError,
1272
errors.TransportNotPossible, errors.NoSmartMedium,
1273
errors.SmartProtocolError):
1274
# no smart server, so not a branch for this format type.
1275
raise errors.NotBranchError(path=transport.base)
1277
# Decline to open it if the server doesn't support our required
1278
# version (3) so that the VFS-based transport will do it.
1279
if medium.should_probe():
1281
server_version = medium.protocol_version()
1282
except errors.SmartProtocolError:
1283
# Apparently there's no usable smart server there, even though
1284
# the medium supports the smart protocol.
1285
raise errors.NotBranchError(path=transport.base)
1286
if server_version != '2':
1287
raise errors.NotBranchError(path=transport.base)
1288
from bzrlib.remote import RemoteBzrDirFormat
1289
return RemoteBzrDirFormat()
1292
def known_formats(cls):
1293
from bzrlib.remote import RemoteBzrDirFormat
1294
return set([RemoteBzrDirFormat()])
1297
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1298
"""ControlDirFormat base class for .bzr/ directories.
1300
Formats are placed in a dict by their format string for reference
1462
class BzrDirFormat(object):
1463
"""An encapsulation of the initialization and open routines for a format.
1465
Formats provide three things:
1466
* An initialization routine,
1470
Formats are placed in a dict by their format string for reference
1301
1471
during bzrdir opening. These should be subclasses of BzrDirFormat
1302
1472
for consistency.
1304
1474
Once a format is deprecated, just deprecate the initialize and open
1305
methods on the format class. Do not deprecate the object, as the
1475
methods on the format class. Do not deprecate the object, as the
1306
1476
object will be created every system load.
1479
_default_format = None
1480
"""The default format used for new .bzr dirs."""
1483
"""The known formats."""
1485
_control_formats = []
1486
"""The registered control formats - .bzr, ....
1488
This is a list of BzrDirFormat objects.
1491
_control_server_formats = []
1492
"""The registered control server formats, e.g. RemoteBzrDirs.
1494
This is a list of BzrDirFormat objects.
1309
1497
_lock_file_name = 'branch-lock'
1311
1499
# _lock_class must be set in subclasses to the lock type, typ.
1312
1500
# TransportLock or LockDir
1503
def find_format(klass, transport, _server_formats=True):
1504
"""Return the format present at transport."""
1506
formats = klass._control_server_formats + klass._control_formats
1508
formats = klass._control_formats
1509
for format in formats:
1511
return format.probe_transport(transport)
1512
except errors.NotBranchError:
1513
# this format does not find a control dir here.
1515
raise errors.NotBranchError(path=transport.base)
1518
def probe_transport(klass, transport):
1519
"""Return the .bzrdir style format present in a directory."""
1521
format_string = transport.get(".bzr/branch-format").read()
1522
except errors.NoSuchFile:
1523
raise errors.NotBranchError(path=transport.base)
1526
return klass._formats[format_string]
1528
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1531
def get_default_format(klass):
1532
"""Return the current default format."""
1533
return klass._default_format
1535
def get_format_string(self):
1536
"""Return the ASCII format string that identifies this format."""
1537
raise NotImplementedError(self.get_format_string)
1539
def get_format_description(self):
1540
"""Return the short description for this format."""
1541
raise NotImplementedError(self.get_format_description)
1543
def get_converter(self, format=None):
1544
"""Return the converter to use to convert bzrdirs needing converts.
1546
This returns a bzrlib.bzrdir.Converter object.
1548
This should return the best upgrader to step this format towards the
1549
current default format. In the case of plugins we can/should provide
1550
some means for them to extend the range of returnable converters.
1552
:param format: Optional format to override the default format of the
1555
raise NotImplementedError(self.get_converter)
1557
def initialize(self, url, possible_transports=None):
1558
"""Create a bzr control dir at this url and return an opened copy.
1560
Subclasses should typically override initialize_on_transport
1561
instead of this method.
1563
return self.initialize_on_transport(get_transport(url,
1564
possible_transports))
1314
1566
def initialize_on_transport(self, transport):
1315
1567
"""Initialize a new bzrdir in the base directory of a Transport."""
1317
# can we hand off the request to the smart server rather than using
1319
client_medium = transport.get_smart_medium()
1320
except errors.NoSmartMedium:
1321
return self._initialize_on_transport_vfs(transport)
1323
# Current RPC's only know how to create bzr metadir1 instances, so
1324
# we still delegate to vfs methods if the requested format is not a
1326
if type(self) != BzrDirMetaFormat1:
1327
return self._initialize_on_transport_vfs(transport)
1328
from bzrlib.remote import RemoteBzrDirFormat
1329
remote_format = RemoteBzrDirFormat()
1330
self._supply_sub_formats_to(remote_format)
1331
return remote_format.initialize_on_transport(transport)
1333
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1334
create_prefix=False, force_new_repo=False, stacked_on=None,
1335
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1336
shared_repo=False, vfs_only=False):
1337
"""Create this format on transport.
1339
The directory to initialize will be created.
1341
:param force_new_repo: Do not use a shared repository for the target,
1342
even if one is available.
1343
:param create_prefix: Create any missing directories leading up to
1345
:param use_existing_dir: Use an existing directory if one exists.
1346
:param stacked_on: A url to stack any created branch on, None to follow
1347
any target stacking policy.
1348
:param stack_on_pwd: If stack_on is relative, the location it is
1350
:param repo_format_name: If non-None, a repository will be
1351
made-or-found. Should none be found, or if force_new_repo is True
1352
the repo_format_name is used to select the format of repository to
1354
:param make_working_trees: Control the setting of make_working_trees
1355
for a new shared repository when one is made. None to use whatever
1356
default the format has.
1357
:param shared_repo: Control whether made repositories are shared or
1359
:param vfs_only: If True do not attempt to use a smart server
1360
:return: repo, controldir, require_stacking, repository_policy. repo is
1361
None if none was created or found, bzrdir is always valid.
1362
require_stacking is the result of examining the stacked_on
1363
parameter and any stacking policy found for the target.
1366
# Try to hand off to a smart server
1368
client_medium = transport.get_smart_medium()
1369
except errors.NoSmartMedium:
1372
from bzrlib.remote import RemoteBzrDirFormat
1373
# TODO: lookup the local format from a server hint.
1374
remote_dir_format = RemoteBzrDirFormat()
1375
remote_dir_format._network_name = self.network_name()
1376
self._supply_sub_formats_to(remote_dir_format)
1377
return remote_dir_format.initialize_on_transport_ex(transport,
1378
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1379
force_new_repo=force_new_repo, stacked_on=stacked_on,
1380
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1381
make_working_trees=make_working_trees, shared_repo=shared_repo)
1382
# XXX: Refactor the create_prefix/no_create_prefix code into a
1383
# common helper function
1384
# The destination may not exist - if so make it according to policy.
1385
def make_directory(transport):
1386
transport.mkdir('.')
1388
def redirected(transport, e, redirection_notice):
1389
note(redirection_notice)
1390
return transport._redirected_to(e.source, e.target)
1392
transport = do_catching_redirections(make_directory, transport,
1394
except errors.FileExists:
1395
if not use_existing_dir:
1397
except errors.NoSuchFile:
1398
if not create_prefix:
1400
transport.create_prefix()
1402
require_stacking = (stacked_on is not None)
1403
# Now the target directory exists, but doesn't have a .bzr
1404
# directory. So we need to create it, along with any work to create
1405
# all of the dependent branches, etc.
1407
result = self.initialize_on_transport(transport)
1408
if repo_format_name:
1410
# use a custom format
1411
result._format.repository_format = \
1412
repository.network_format_registry.get(repo_format_name)
1413
except AttributeError:
1414
# The format didn't permit it to be set.
1416
# A repository is desired, either in-place or shared.
1417
repository_policy = result.determine_repository_policy(
1418
force_new_repo, stacked_on, stack_on_pwd,
1419
require_stacking=require_stacking)
1420
result_repo, is_new_repo = repository_policy.acquire_repository(
1421
make_working_trees, shared_repo)
1422
if not require_stacking and repository_policy._require_stacking:
1423
require_stacking = True
1424
result._format.require_stacking()
1425
result_repo.lock_write()
1428
repository_policy = None
1429
return result_repo, result, require_stacking, repository_policy
1431
def _initialize_on_transport_vfs(self, transport):
1432
"""Initialize a new bzrdir using VFS calls.
1434
:param transport: The transport to create the .bzr directory in.
1437
# Since we are creating a .bzr directory, inherit the
1568
# Since we don't have a .bzr directory, inherit the
1438
1569
# mode from the root directory
1439
1570
temp_control = lockable_files.LockableFiles(transport,
1440
1571
'', lockable_files.TransportLock)
1442
temp_control._transport.mkdir('.bzr',
1443
# FIXME: RBC 20060121 don't peek under
1445
mode=temp_control._dir_mode)
1446
except errors.FileExists:
1447
raise errors.AlreadyControlDirError(transport.base)
1448
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1572
temp_control._transport.mkdir('.bzr',
1573
# FIXME: RBC 20060121 don't peek under
1575
mode=temp_control._dir_mode)
1576
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1449
1577
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1450
1578
file_mode = temp_control._file_mode
1451
1579
del temp_control
1494
1651
raise NotImplementedError(self._open)
1496
def _supply_sub_formats_to(self, other_format):
1497
"""Give other_format the same values for sub formats as this has.
1499
This method is expected to be used when parameterising a
1500
RemoteBzrDirFormat instance with the parameters from a
1501
BzrDirMetaFormat1 instance.
1503
:param other_format: other_format is a format which should be
1504
compatible with whatever sub formats are supported by self.
1507
other_format.features = dict(self.features)
1509
def supports_transport(self, transport):
1510
# bzr formats can be opened over all known transports
1513
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1515
controldir.ControlDirFormat.check_support_status(self,
1516
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1518
BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1519
recommend_upgrade=recommend_upgrade, basedir=basedir)
1654
def register_format(klass, format):
1655
klass._formats[format.get_format_string()] = format
1658
def register_control_format(klass, format):
1659
"""Register a format that does not use '.bzr' for its control dir.
1661
TODO: This should be pulled up into a 'ControlDirFormat' base class
1662
which BzrDirFormat can inherit from, and renamed to register_format
1663
there. It has been done without that for now for simplicity of
1666
klass._control_formats.append(format)
1669
def register_control_server_format(klass, format):
1670
"""Register a control format for client-server environments.
1672
These formats will be tried before ones registered with
1673
register_control_format. This gives implementations that decide to the
1674
chance to grab it before anything looks at the contents of the format
1677
klass._control_server_formats.append(format)
1680
def _set_default_format(klass, format):
1681
"""Set default format (for testing behavior of defaults only)"""
1682
klass._default_format = format
1686
return self.get_format_string().rstrip()
1689
def unregister_format(klass, format):
1690
del klass._formats[format.get_format_string()]
1693
def unregister_control_format(klass, format):
1694
klass._control_formats.remove(format)
1697
class BzrDirFormat4(BzrDirFormat):
1698
"""Bzr dir format 4.
1700
This format is a combined format for working tree, branch and repository.
1702
- Format 1 working trees [always]
1703
- Format 4 branches [always]
1704
- Format 4 repositories [always]
1706
This format is deprecated: it indexes texts using a text it which is
1707
removed in format 5; write support for this format has been removed.
1710
_lock_class = lockable_files.TransportLock
1712
def get_format_string(self):
1713
"""See BzrDirFormat.get_format_string()."""
1714
return "Bazaar-NG branch, format 0.0.4\n"
1716
def get_format_description(self):
1717
"""See BzrDirFormat.get_format_description()."""
1718
return "All-in-one format 4"
1720
def get_converter(self, format=None):
1721
"""See BzrDirFormat.get_converter()."""
1722
# there is one and only one upgrade path here.
1723
return ConvertBzrDir4To5()
1725
def initialize_on_transport(self, transport):
1726
"""Format 4 branches cannot be created."""
1727
raise errors.UninitializableFormat(self)
1729
def is_supported(self):
1730
"""Format 4 is not supported.
1732
It is not supported because the model changed from 4 to 5 and the
1733
conversion logic is expensive - so doing it on the fly was not
1738
def _open(self, transport):
1739
"""See BzrDirFormat._open."""
1740
return BzrDir4(transport, self)
1742
def __return_repository_format(self):
1743
"""Circular import protection."""
1744
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1745
return RepositoryFormat4()
1746
repository_format = property(__return_repository_format)
1749
class BzrDirFormat5(BzrDirFormat):
1750
"""Bzr control format 5.
1752
This format is a combined format for working tree, branch and repository.
1754
- Format 2 working trees [always]
1755
- Format 4 branches [always]
1756
- Format 5 repositories [always]
1757
Unhashed stores in the repository.
1760
_lock_class = lockable_files.TransportLock
1762
def get_format_string(self):
1763
"""See BzrDirFormat.get_format_string()."""
1764
return "Bazaar-NG branch, format 5\n"
1766
def get_format_description(self):
1767
"""See BzrDirFormat.get_format_description()."""
1768
return "All-in-one format 5"
1770
def get_converter(self, format=None):
1771
"""See BzrDirFormat.get_converter()."""
1772
# there is one and only one upgrade path here.
1773
return ConvertBzrDir5To6()
1775
def _initialize_for_clone(self, url):
1776
return self.initialize_on_transport(get_transport(url), _cloning=True)
1778
def initialize_on_transport(self, transport, _cloning=False):
1779
"""Format 5 dirs always have working tree, branch and repository.
1781
Except when they are being cloned.
1783
from bzrlib.branch import BzrBranchFormat4
1784
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1785
from bzrlib.workingtree import WorkingTreeFormat2
1786
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1787
RepositoryFormat5().initialize(result, _internal=True)
1789
branch = BzrBranchFormat4().initialize(result)
1791
WorkingTreeFormat2().initialize(result)
1792
except errors.NotLocalUrl:
1793
# Even though we can't access the working tree, we need to
1794
# create its control files.
1795
WorkingTreeFormat2()._stub_initialize_remote(branch)
1798
def _open(self, transport):
1799
"""See BzrDirFormat._open."""
1800
return BzrDir5(transport, self)
1802
def __return_repository_format(self):
1803
"""Circular import protection."""
1804
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1805
return RepositoryFormat5()
1806
repository_format = property(__return_repository_format)
1809
class BzrDirFormat6(BzrDirFormat):
1810
"""Bzr control format 6.
1812
This format is a combined format for working tree, branch and repository.
1814
- Format 2 working trees [always]
1815
- Format 4 branches [always]
1816
- Format 6 repositories [always]
1819
_lock_class = lockable_files.TransportLock
1821
def get_format_string(self):
1822
"""See BzrDirFormat.get_format_string()."""
1823
return "Bazaar-NG branch, format 6\n"
1825
def get_format_description(self):
1826
"""See BzrDirFormat.get_format_description()."""
1827
return "All-in-one format 6"
1829
def get_converter(self, format=None):
1830
"""See BzrDirFormat.get_converter()."""
1831
# there is one and only one upgrade path here.
1832
return ConvertBzrDir6ToMeta()
1834
def _initialize_for_clone(self, url):
1835
return self.initialize_on_transport(get_transport(url), _cloning=True)
1837
def initialize_on_transport(self, transport, _cloning=False):
1838
"""Format 6 dirs always have working tree, branch and repository.
1840
Except when they are being cloned.
1842
from bzrlib.branch import BzrBranchFormat4
1843
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1844
from bzrlib.workingtree import WorkingTreeFormat2
1845
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1846
RepositoryFormat6().initialize(result, _internal=True)
1848
branch = BzrBranchFormat4().initialize(result)
1850
WorkingTreeFormat2().initialize(result)
1851
except errors.NotLocalUrl:
1852
# Even though we can't access the working tree, we need to
1853
# create its control files.
1854
WorkingTreeFormat2()._stub_initialize_remote(branch)
1857
def _open(self, transport):
1858
"""See BzrDirFormat._open."""
1859
return BzrDir6(transport, self)
1861
def __return_repository_format(self):
1862
"""Circular import protection."""
1863
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1864
return RepositoryFormat6()
1865
repository_format = property(__return_repository_format)
1522
1868
class BzrDirMetaFormat1(BzrDirFormat):
1561
1897
def get_branch_format(self):
1562
1898
if self._branch_format is None:
1563
from bzrlib.branch import format_registry as branch_format_registry
1564
self._branch_format = branch_format_registry.get_default()
1899
from bzrlib.branch import BranchFormat
1900
self._branch_format = BranchFormat.get_default_format()
1565
1901
return self._branch_format
1567
1903
def set_branch_format(self, format):
1568
1904
self._branch_format = format
1570
def require_stacking(self, stack_on=None, possible_transports=None,
1572
"""We have a request to stack, try to ensure the formats support it.
1574
:param stack_on: If supplied, it is the URL to a branch that we want to
1575
stack on. Check to see if that format supports stacking before
1578
# Stacking is desired. requested by the target, but does the place it
1579
# points at support stacking? If it doesn't then we should
1580
# not implicitly upgrade. We check this here.
1581
new_repo_format = None
1582
new_branch_format = None
1584
# a bit of state for get_target_branch so that we don't try to open it
1585
# 2 times, for both repo *and* branch
1586
target = [None, False, None] # target_branch, checked, upgrade anyway
1587
def get_target_branch():
1589
# We've checked, don't check again
1591
if stack_on is None:
1592
# No target format, that means we want to force upgrading
1593
target[:] = [None, True, True]
1596
target_dir = BzrDir.open(stack_on,
1597
possible_transports=possible_transports)
1598
except errors.NotBranchError:
1599
# Nothing there, don't change formats
1600
target[:] = [None, True, False]
1602
except errors.JailBreak:
1603
# JailBreak, JFDI and upgrade anyway
1604
target[:] = [None, True, True]
1607
target_branch = target_dir.open_branch()
1608
except errors.NotBranchError:
1609
# No branch, don't upgrade formats
1610
target[:] = [None, True, False]
1612
target[:] = [target_branch, True, False]
1615
if (not _skip_repo and
1616
not self.repository_format.supports_external_lookups):
1617
# We need to upgrade the Repository.
1618
target_branch, _, do_upgrade = get_target_branch()
1619
if target_branch is None:
1620
# We don't have a target branch, should we upgrade anyway?
1622
# stack_on is inaccessible, JFDI.
1623
# TODO: bad monkey, hard-coded formats...
1624
if self.repository_format.rich_root_data:
1625
new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
1627
new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
1629
# If the target already supports stacking, then we know the
1630
# project is already able to use stacking, so auto-upgrade
1632
new_repo_format = target_branch.repository._format
1633
if not new_repo_format.supports_external_lookups:
1634
# target doesn't, source doesn't, so don't auto upgrade
1636
new_repo_format = None
1637
if new_repo_format is not None:
1638
self.repository_format = new_repo_format
1639
note(gettext('Source repository format does not support stacking,'
1640
' using format:\n %s'),
1641
new_repo_format.get_format_description())
1643
if not self.get_branch_format().supports_stacking():
1644
# We just checked the repo, now lets check if we need to
1645
# upgrade the branch format
1646
target_branch, _, do_upgrade = get_target_branch()
1647
if target_branch is None:
1649
# TODO: bad monkey, hard-coded formats...
1650
from bzrlib.branch import BzrBranchFormat7
1651
new_branch_format = BzrBranchFormat7()
1653
new_branch_format = target_branch._format
1654
if not new_branch_format.supports_stacking():
1655
new_branch_format = None
1656
if new_branch_format is not None:
1657
# Does support stacking, use its format.
1658
self.set_branch_format(new_branch_format)
1659
note(gettext('Source branch format does not support stacking,'
1660
' using format:\n %s'),
1661
new_branch_format.get_format_description())
1663
1906
def get_converter(self, format=None):
1664
1907
"""See BzrDirFormat.get_converter()."""
1665
1908
if format is None:
1666
1909
format = BzrDirFormat.get_default_format()
1667
if (type(self) is BzrDirMetaFormat1 and
1668
type(format) is BzrDirMetaFormat1Colo):
1669
return ConvertMetaToColo(format)
1670
if (type(self) is BzrDirMetaFormat1Colo and
1671
type(format) is BzrDirMetaFormat1):
1672
return ConvertMetaToColo(format)
1673
1910
if not isinstance(self, format.__class__):
1674
1911
# converting away from metadir is not implemented
1675
1912
raise NotImplementedError(self.get_converter)
1676
1913
return ConvertMetaToMeta(format)
1679
def get_format_string(cls):
1915
def get_format_string(self):
1680
1916
"""See BzrDirFormat.get_format_string()."""
1681
1917
return "Bazaar-NG meta directory, format 1\n"
1687
1923
def _open(self, transport):
1688
1924
"""See BzrDirFormat._open."""
1689
# Create a new format instance because otherwise initialisation of new
1690
# metadirs share the global default format object leading to alias
1692
format = BzrDirMetaFormat1()
1693
self._supply_sub_formats_to(format)
1694
return BzrDirMeta1(transport, format)
1925
return BzrDirMeta1(transport, self)
1696
1927
def __return_repository_format(self):
1697
1928
"""Circular import protection."""
1698
if self._repository_format:
1929
if getattr(self, '_repository_format', None):
1699
1930
return self._repository_format
1700
from bzrlib.repository import format_registry
1701
return format_registry.get_default()
1931
from bzrlib.repository import RepositoryFormat
1932
return RepositoryFormat.get_default_format()
1703
def _set_repository_format(self, value):
1934
def __set_repository_format(self, value):
1704
1935
"""Allow changing the repository format for metadir formats."""
1705
1936
self._repository_format = value
1707
repository_format = property(__return_repository_format,
1708
_set_repository_format)
1710
def _supply_sub_formats_to(self, other_format):
1711
"""Give other_format the same values for sub formats as this has.
1713
This method is expected to be used when parameterising a
1714
RemoteBzrDirFormat instance with the parameters from a
1715
BzrDirMetaFormat1 instance.
1717
:param other_format: other_format is a format which should be
1718
compatible with whatever sub formats are supported by self.
1721
super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
1722
if getattr(self, '_repository_format', None) is not None:
1723
other_format.repository_format = self.repository_format
1724
if self._branch_format is not None:
1725
other_format._branch_format = self._branch_format
1726
if self._workingtree_format is not None:
1727
other_format.workingtree_format = self.workingtree_format
1938
repository_format = property(__return_repository_format, __set_repository_format)
1729
1940
def __get_workingtree_format(self):
1730
1941
if self._workingtree_format is None:
1731
from bzrlib.workingtree import (
1732
format_registry as wt_format_registry,
1734
self._workingtree_format = wt_format_registry.get_default()
1942
from bzrlib.workingtree import WorkingTreeFormat
1943
self._workingtree_format = WorkingTreeFormat.get_default_format()
1735
1944
return self._workingtree_format
1737
1946
def __set_workingtree_format(self, wt_format):
1738
1947
self._workingtree_format = wt_format
1741
return "<%r>" % (self.__class__.__name__,)
1743
1949
workingtree_format = property(__get_workingtree_format,
1744
1950
__set_workingtree_format)
1953
# Register bzr control format
1954
BzrDirFormat.register_control_format(BzrDirFormat)
1747
1956
# Register bzr formats
1748
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
1750
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1753
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
1754
"""BzrDirMeta1 format with support for colocated branches."""
1756
colocated_branches = True
1759
def get_format_string(cls):
1760
"""See BzrDirFormat.get_format_string()."""
1761
return "Bazaar meta directory, format 1 (with colocated branches)\n"
1763
def get_format_description(self):
1764
"""See BzrDirFormat.get_format_description()."""
1765
return "Meta directory format 1 with support for colocated branches"
1767
def _open(self, transport):
1768
"""See BzrDirFormat._open."""
1769
# Create a new format instance because otherwise initialisation of new
1770
# metadirs share the global default format object leading to alias
1772
format = BzrDirMetaFormat1Colo()
1773
self._supply_sub_formats_to(format)
1774
return BzrDirMeta1(transport, format)
1777
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
1778
BzrDirMetaFormat1Colo)
1781
class ConvertMetaToMeta(controldir.Converter):
1957
BzrDirFormat.register_format(BzrDirFormat4())
1958
BzrDirFormat.register_format(BzrDirFormat5())
1959
BzrDirFormat.register_format(BzrDirFormat6())
1960
__default_format = BzrDirMetaFormat1()
1961
BzrDirFormat.register_format(__default_format)
1962
BzrDirFormat._default_format = __default_format
1965
class Converter(object):
1966
"""Converts a disk format object from one format to another."""
1968
def convert(self, to_convert, pb):
1969
"""Perform the conversion of to_convert, giving feedback via pb.
1971
:param to_convert: The disk object to convert.
1972
:param pb: a progress bar to use for progress information.
1975
def step(self, message):
1976
"""Update the pb by a step."""
1978
self.pb.update(message, self.count, self.total)
1981
class ConvertBzrDir4To5(Converter):
1982
"""Converts format 4 bzr dirs to format 5."""
1985
super(ConvertBzrDir4To5, self).__init__()
1986
self.converted_revs = set()
1987
self.absent_revisions = set()
1991
def convert(self, to_convert, pb):
1992
"""See Converter.convert()."""
1993
self.bzrdir = to_convert
1995
self.pb.note('starting upgrade from format 4 to 5')
1996
if isinstance(self.bzrdir.transport, LocalTransport):
1997
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1998
self._convert_to_weaves()
1999
return BzrDir.open(self.bzrdir.root_transport.base)
2001
def _convert_to_weaves(self):
2002
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2005
stat = self.bzrdir.transport.stat('weaves')
2006
if not S_ISDIR(stat.st_mode):
2007
self.bzrdir.transport.delete('weaves')
2008
self.bzrdir.transport.mkdir('weaves')
2009
except errors.NoSuchFile:
2010
self.bzrdir.transport.mkdir('weaves')
2011
# deliberately not a WeaveFile as we want to build it up slowly.
2012
self.inv_weave = Weave('inventory')
2013
# holds in-memory weaves for all files
2014
self.text_weaves = {}
2015
self.bzrdir.transport.delete('branch-format')
2016
self.branch = self.bzrdir.open_branch()
2017
self._convert_working_inv()
2018
rev_history = self.branch.revision_history()
2019
# to_read is a stack holding the revisions we still need to process;
2020
# appending to it adds new highest-priority revisions
2021
self.known_revisions = set(rev_history)
2022
self.to_read = rev_history[-1:]
2024
rev_id = self.to_read.pop()
2025
if (rev_id not in self.revisions
2026
and rev_id not in self.absent_revisions):
2027
self._load_one_rev(rev_id)
2029
to_import = self._make_order()
2030
for i, rev_id in enumerate(to_import):
2031
self.pb.update('converting revision', i, len(to_import))
2032
self._convert_one_rev(rev_id)
2034
self._write_all_weaves()
2035
self._write_all_revs()
2036
self.pb.note('upgraded to weaves:')
2037
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2038
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2039
self.pb.note(' %6d texts', self.text_count)
2040
self._cleanup_spare_files_after_format4()
2041
self.branch._transport.put_bytes(
2043
BzrDirFormat5().get_format_string(),
2044
mode=self.bzrdir._get_file_mode())
2046
def _cleanup_spare_files_after_format4(self):
2047
# FIXME working tree upgrade foo.
2048
for n in 'merged-patches', 'pending-merged-patches':
2050
## assert os.path.getsize(p) == 0
2051
self.bzrdir.transport.delete(n)
2052
except errors.NoSuchFile:
2054
self.bzrdir.transport.delete_tree('inventory-store')
2055
self.bzrdir.transport.delete_tree('text-store')
2057
def _convert_working_inv(self):
2058
inv = xml4.serializer_v4.read_inventory(
2059
self.branch._transport.get('inventory'))
2060
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2061
self.branch._transport.put_bytes('inventory', new_inv_xml,
2062
mode=self.bzrdir._get_file_mode())
2064
def _write_all_weaves(self):
2065
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2066
weave_transport = self.bzrdir.transport.clone('weaves')
2067
weaves = WeaveStore(weave_transport, prefixed=False)
2068
transaction = WriteTransaction()
2072
for file_id, file_weave in self.text_weaves.items():
2073
self.pb.update('writing weave', i, len(self.text_weaves))
2074
weaves._put_weave(file_id, file_weave, transaction)
2076
self.pb.update('inventory', 0, 1)
2077
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2078
self.pb.update('inventory', 1, 1)
2082
def _write_all_revs(self):
2083
"""Write all revisions out in new form."""
2084
self.bzrdir.transport.delete_tree('revision-store')
2085
self.bzrdir.transport.mkdir('revision-store')
2086
revision_transport = self.bzrdir.transport.clone('revision-store')
2088
from bzrlib.xml5 import serializer_v5
2089
from bzrlib.repofmt.weaverepo import RevisionTextStore
2090
revision_store = RevisionTextStore(revision_transport,
2091
serializer_v5, False, versionedfile.PrefixMapper(),
2092
lambda:True, lambda:True)
2094
for i, rev_id in enumerate(self.converted_revs):
2095
self.pb.update('write revision', i, len(self.converted_revs))
2096
text = serializer_v5.write_revision_to_string(
2097
self.revisions[rev_id])
2099
revision_store.add_lines(key, None, osutils.split_lines(text))
2103
def _load_one_rev(self, rev_id):
2104
"""Load a revision object into memory.
2106
Any parents not either loaded or abandoned get queued to be
2108
self.pb.update('loading revision',
2109
len(self.revisions),
2110
len(self.known_revisions))
2111
if not self.branch.repository.has_revision(rev_id):
2113
self.pb.note('revision {%s} not present in branch; '
2114
'will be converted as a ghost',
2116
self.absent_revisions.add(rev_id)
2118
rev = self.branch.repository.get_revision(rev_id)
2119
for parent_id in rev.parent_ids:
2120
self.known_revisions.add(parent_id)
2121
self.to_read.append(parent_id)
2122
self.revisions[rev_id] = rev
2124
def _load_old_inventory(self, rev_id):
2125
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2126
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2127
inv.revision_id = rev_id
2128
rev = self.revisions[rev_id]
2131
def _load_updated_inventory(self, rev_id):
2132
inv_xml = self.inv_weave.get_text(rev_id)
2133
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2136
def _convert_one_rev(self, rev_id):
2137
"""Convert revision and all referenced objects to new format."""
2138
rev = self.revisions[rev_id]
2139
inv = self._load_old_inventory(rev_id)
2140
present_parents = [p for p in rev.parent_ids
2141
if p not in self.absent_revisions]
2142
self._convert_revision_contents(rev, inv, present_parents)
2143
self._store_new_inv(rev, inv, present_parents)
2144
self.converted_revs.add(rev_id)
2146
def _store_new_inv(self, rev, inv, present_parents):
2147
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2148
new_inv_sha1 = sha_string(new_inv_xml)
2149
self.inv_weave.add_lines(rev.revision_id,
2151
new_inv_xml.splitlines(True))
2152
rev.inventory_sha1 = new_inv_sha1
2154
def _convert_revision_contents(self, rev, inv, present_parents):
2155
"""Convert all the files within a revision.
2157
Also upgrade the inventory to refer to the text revision ids."""
2158
rev_id = rev.revision_id
2159
mutter('converting texts of revision {%s}',
2161
parent_invs = map(self._load_updated_inventory, present_parents)
2162
entries = inv.iter_entries()
2164
for path, ie in entries:
2165
self._convert_file_version(rev, ie, parent_invs)
2167
def _convert_file_version(self, rev, ie, parent_invs):
2168
"""Convert one version of one file.
2170
The file needs to be added into the weave if it is a merge
2171
of >=2 parents or if it's changed from its parent.
2173
file_id = ie.file_id
2174
rev_id = rev.revision_id
2175
w = self.text_weaves.get(file_id)
2178
self.text_weaves[file_id] = w
2179
text_changed = False
2180
parent_candiate_entries = ie.parent_candidates(parent_invs)
2181
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2182
# XXX: Note that this is unordered - and this is tolerable because
2183
# the previous code was also unordered.
2184
previous_entries = dict((head, parent_candiate_entries[head]) for head
2186
self.snapshot_ie(previous_entries, ie, w, rev_id)
2189
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2190
def get_parents(self, revision_ids):
2191
for revision_id in revision_ids:
2192
yield self.revisions[revision_id].parent_ids
2194
def get_parent_map(self, revision_ids):
2195
"""See graph._StackedParentsProvider.get_parent_map"""
2196
return dict((revision_id, self.revisions[revision_id])
2197
for revision_id in revision_ids
2198
if revision_id in self.revisions)
2200
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2201
# TODO: convert this logic, which is ~= snapshot to
2202
# a call to:. This needs the path figured out. rather than a work_tree
2203
# a v4 revision_tree can be given, or something that looks enough like
2204
# one to give the file content to the entry if it needs it.
2205
# and we need something that looks like a weave store for snapshot to
2207
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2208
if len(previous_revisions) == 1:
2209
previous_ie = previous_revisions.values()[0]
2210
if ie._unchanged(previous_ie):
2211
ie.revision = previous_ie.revision
2214
text = self.branch.repository._text_store.get(ie.text_id)
2215
file_lines = text.readlines()
2216
w.add_lines(rev_id, previous_revisions, file_lines)
2217
self.text_count += 1
2219
w.add_lines(rev_id, previous_revisions, [])
2220
ie.revision = rev_id
2222
def _make_order(self):
2223
"""Return a suitable order for importing revisions.
2225
The order must be such that an revision is imported after all
2226
its (present) parents.
2228
todo = set(self.revisions.keys())
2229
done = self.absent_revisions.copy()
2232
# scan through looking for a revision whose parents
2234
for rev_id in sorted(list(todo)):
2235
rev = self.revisions[rev_id]
2236
parent_ids = set(rev.parent_ids)
2237
if parent_ids.issubset(done):
2238
# can take this one now
2239
order.append(rev_id)
2245
class ConvertBzrDir5To6(Converter):
2246
"""Converts format 5 bzr dirs to format 6."""
2248
def convert(self, to_convert, pb):
2249
"""See Converter.convert()."""
2250
self.bzrdir = to_convert
2252
self.pb.note('starting upgrade from format 5 to 6')
2253
self._convert_to_prefixed()
2254
return BzrDir.open(self.bzrdir.root_transport.base)
2256
def _convert_to_prefixed(self):
2257
from bzrlib.store import TransportStore
2258
self.bzrdir.transport.delete('branch-format')
2259
for store_name in ["weaves", "revision-store"]:
2260
self.pb.note("adding prefixes to %s" % store_name)
2261
store_transport = self.bzrdir.transport.clone(store_name)
2262
store = TransportStore(store_transport, prefixed=True)
2263
for urlfilename in store_transport.list_dir('.'):
2264
filename = urlutils.unescape(urlfilename)
2265
if (filename.endswith(".weave") or
2266
filename.endswith(".gz") or
2267
filename.endswith(".sig")):
2268
file_id, suffix = os.path.splitext(filename)
2272
new_name = store._mapper.map((file_id,)) + suffix
2273
# FIXME keep track of the dirs made RBC 20060121
2275
store_transport.move(filename, new_name)
2276
except errors.NoSuchFile: # catches missing dirs strangely enough
2277
store_transport.mkdir(osutils.dirname(new_name))
2278
store_transport.move(filename, new_name)
2279
self.bzrdir.transport.put_bytes(
2281
BzrDirFormat6().get_format_string(),
2282
mode=self.bzrdir._get_file_mode())
2285
class ConvertBzrDir6ToMeta(Converter):
2286
"""Converts format 6 bzr dirs to metadirs."""
2288
def convert(self, to_convert, pb):
2289
"""See Converter.convert()."""
2290
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2291
from bzrlib.branch import BzrBranchFormat5
2292
self.bzrdir = to_convert
2295
self.total = 20 # the steps we know about
2296
self.garbage_inventories = []
2297
self.dir_mode = self.bzrdir._get_dir_mode()
2298
self.file_mode = self.bzrdir._get_file_mode()
2300
self.pb.note('starting upgrade from format 6 to metadir')
2301
self.bzrdir.transport.put_bytes(
2303
"Converting to format 6",
2304
mode=self.file_mode)
2305
# its faster to move specific files around than to open and use the apis...
2306
# first off, nuke ancestry.weave, it was never used.
2308
self.step('Removing ancestry.weave')
2309
self.bzrdir.transport.delete('ancestry.weave')
2310
except errors.NoSuchFile:
2312
# find out whats there
2313
self.step('Finding branch files')
2314
last_revision = self.bzrdir.open_branch().last_revision()
2315
bzrcontents = self.bzrdir.transport.list_dir('.')
2316
for name in bzrcontents:
2317
if name.startswith('basis-inventory.'):
2318
self.garbage_inventories.append(name)
2319
# create new directories for repository, working tree and branch
2320
repository_names = [('inventory.weave', True),
2321
('revision-store', True),
2323
self.step('Upgrading repository ')
2324
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2325
self.make_lock('repository')
2326
# we hard code the formats here because we are converting into
2327
# the meta format. The meta format upgrader can take this to a
2328
# future format within each component.
2329
self.put_format('repository', RepositoryFormat7())
2330
for entry in repository_names:
2331
self.move_entry('repository', entry)
2333
self.step('Upgrading branch ')
2334
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2335
self.make_lock('branch')
2336
self.put_format('branch', BzrBranchFormat5())
2337
branch_files = [('revision-history', True),
2338
('branch-name', True),
2340
for entry in branch_files:
2341
self.move_entry('branch', entry)
2343
checkout_files = [('pending-merges', True),
2344
('inventory', True),
2345
('stat-cache', False)]
2346
# If a mandatory checkout file is not present, the branch does not have
2347
# a functional checkout. Do not create a checkout in the converted
2349
for name, mandatory in checkout_files:
2350
if mandatory and name not in bzrcontents:
2351
has_checkout = False
2355
if not has_checkout:
2356
self.pb.note('No working tree.')
2357
# If some checkout files are there, we may as well get rid of them.
2358
for name, mandatory in checkout_files:
2359
if name in bzrcontents:
2360
self.bzrdir.transport.delete(name)
2362
from bzrlib.workingtree import WorkingTreeFormat3
2363
self.step('Upgrading working tree')
2364
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2365
self.make_lock('checkout')
2367
'checkout', WorkingTreeFormat3())
2368
self.bzrdir.transport.delete_multi(
2369
self.garbage_inventories, self.pb)
2370
for entry in checkout_files:
2371
self.move_entry('checkout', entry)
2372
if last_revision is not None:
2373
self.bzrdir.transport.put_bytes(
2374
'checkout/last-revision', last_revision)
2375
self.bzrdir.transport.put_bytes(
2377
BzrDirMetaFormat1().get_format_string(),
2378
mode=self.file_mode)
2379
return BzrDir.open(self.bzrdir.root_transport.base)
2381
def make_lock(self, name):
2382
"""Make a lock for the new control dir name."""
2383
self.step('Make %s lock' % name)
2384
ld = lockdir.LockDir(self.bzrdir.transport,
2386
file_modebits=self.file_mode,
2387
dir_modebits=self.dir_mode)
2390
def move_entry(self, new_dir, entry):
2391
"""Move then entry name into new_dir."""
2393
mandatory = entry[1]
2394
self.step('Moving %s' % name)
2396
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2397
except errors.NoSuchFile:
2401
def put_format(self, dirname, format):
2402
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2403
format.get_format_string(),
2407
class ConvertMetaToMeta(Converter):
1782
2408
"""Converts the components of metadirs."""
1784
2410
def __init__(self, target_format):
1838
2463
# TODO: conversions of Branch and Tree should be done by
1839
2464
# InterXFormat lookups
1840
if (isinstance(tree, workingtree_3.WorkingTree3) and
1841
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2465
if (isinstance(tree, workingtree.WorkingTree3) and
2466
not isinstance(tree, workingtree_4.WorkingTree4) and
1842
2467
isinstance(self.target_format.workingtree_format,
1843
workingtree_4.DirStateWorkingTreeFormat)):
2468
workingtree_4.WorkingTreeFormat4)):
1844
2469
workingtree_4.Converter3to4().convert(tree)
1845
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
1846
not isinstance(tree, workingtree_4.WorkingTree5) and
1847
isinstance(self.target_format.workingtree_format,
1848
workingtree_4.WorkingTreeFormat5)):
1849
workingtree_4.Converter4to5().convert(tree)
1850
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
1851
not isinstance(tree, workingtree_4.WorkingTree6) and
1852
isinstance(self.target_format.workingtree_format,
1853
workingtree_4.WorkingTreeFormat6)):
1854
workingtree_4.Converter4or5to6().convert(tree)
1856
2470
return to_convert
1859
class ConvertMetaToColo(controldir.Converter):
1860
"""Add colocated branch support."""
1862
def __init__(self, target_format):
1863
"""Create a converter.that upgrades a metadir to the colo format.
1865
:param target_format: The final metadir format that is desired.
1867
self.target_format = target_format
1869
def convert(self, to_convert, pb):
1870
"""See Converter.convert()."""
1871
to_convert.transport.put_bytes('branch-format',
1872
self.target_format.as_string())
1873
return BzrDir.open_from_transport(to_convert.root_transport)
1876
class ConvertMetaToColo(controldir.Converter):
1877
"""Convert a 'development-colo' bzrdir to a '2a' bzrdir."""
1879
def __init__(self, target_format):
1880
"""Create a converter that converts a 'development-colo' metadir
1883
:param target_format: The final metadir format that is desired.
1885
self.target_format = target_format
1887
def convert(self, to_convert, pb):
1888
"""See Converter.convert()."""
1889
to_convert.transport.put_bytes('branch-format',
1890
self.target_format.as_string())
1891
return BzrDir.open_from_transport(to_convert.root_transport)
1894
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
2473
# This is not in remote.py because it's small, and needs to be registered.
2474
# Putting it in remote.py creates a circular import problem.
2475
# we can make it a lazy object if the control formats is turned into something
2477
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2478
"""Format representing bzrdirs accessed via a smart server"""
2480
def get_format_description(self):
2481
return 'bzr remote bzrdir'
2484
def probe_transport(klass, transport):
2485
"""Return a RemoteBzrDirFormat object if it looks possible."""
2487
medium = transport.get_smart_medium()
2488
except (NotImplementedError, AttributeError,
2489
errors.TransportNotPossible, errors.NoSmartMedium,
2490
errors.SmartProtocolError):
2491
# no smart server, so not a branch for this format type.
2492
raise errors.NotBranchError(path=transport.base)
2494
# Decline to open it if the server doesn't support our required
2495
# version (3) so that the VFS-based transport will do it.
2496
if medium.should_probe():
2498
server_version = medium.protocol_version()
2499
except errors.SmartProtocolError:
2500
# Apparently there's no usable smart server there, even though
2501
# the medium supports the smart protocol.
2502
raise errors.NotBranchError(path=transport.base)
2503
if server_version != '2':
2504
raise errors.NotBranchError(path=transport.base)
2507
def initialize_on_transport(self, transport):
2509
# hand off the request to the smart server
2510
client_medium = transport.get_smart_medium()
2511
except errors.NoSmartMedium:
2512
# TODO: lookup the local format from a server hint.
2513
local_dir_format = BzrDirMetaFormat1()
2514
return local_dir_format.initialize_on_transport(transport)
2515
client = _SmartClient(client_medium)
2516
path = client.remote_path_from_transport(transport)
2517
response = client.call('BzrDirFormat.initialize', path)
2518
if response[0] != 'ok':
2519
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2520
return remote.RemoteBzrDir(transport)
2522
def _open(self, transport):
2523
return remote.RemoteBzrDir(transport)
2525
def __eq__(self, other):
2526
if not isinstance(other, RemoteBzrDirFormat):
2528
return self.get_format_description() == other.get_format_description()
2531
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2534
class BzrDirFormatInfo(object):
2536
def __init__(self, native, deprecated, hidden, experimental):
2537
self.deprecated = deprecated
2538
self.native = native
2539
self.hidden = hidden
2540
self.experimental = experimental
2543
class BzrDirFormatRegistry(registry.Registry):
2544
"""Registry of user-selectable BzrDir subformats.
2546
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2547
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2551
"""Create a BzrDirFormatRegistry."""
2552
self._aliases = set()
2553
super(BzrDirFormatRegistry, self).__init__()
2556
"""Return a set of the format names which are aliases."""
2557
return frozenset(self._aliases)
2559
def register_metadir(self, key,
2560
repository_format, help, native=True, deprecated=False,
2566
"""Register a metadir subformat.
2568
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2569
by the Repository format.
2571
:param repository_format: The fully-qualified repository format class
2573
:param branch_format: Fully-qualified branch format class name as
2575
:param tree_format: Fully-qualified tree format class name as
2578
# This should be expanded to support setting WorkingTree and Branch
2579
# formats, once BzrDirMetaFormat1 supports that.
2580
def _load(full_name):
2581
mod_name, factory_name = full_name.rsplit('.', 1)
2583
mod = __import__(mod_name, globals(), locals(),
2585
except ImportError, e:
2586
raise ImportError('failed to load %s: %s' % (full_name, e))
2588
factory = getattr(mod, factory_name)
2589
except AttributeError:
2590
raise AttributeError('no factory %s in module %r'
2595
bd = BzrDirMetaFormat1()
2596
if branch_format is not None:
2597
bd.set_branch_format(_load(branch_format))
2598
if tree_format is not None:
2599
bd.workingtree_format = _load(tree_format)
2600
if repository_format is not None:
2601
bd.repository_format = _load(repository_format)
2603
self.register(key, helper, help, native, deprecated, hidden,
2604
experimental, alias)
2606
def register(self, key, factory, help, native=True, deprecated=False,
2607
hidden=False, experimental=False, alias=False):
2608
"""Register a BzrDirFormat factory.
2610
The factory must be a callable that takes one parameter: the key.
2611
It must produce an instance of the BzrDirFormat when called.
2613
This function mainly exists to prevent the info object from being
2616
registry.Registry.register(self, key, factory, help,
2617
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2619
self._aliases.add(key)
2621
def register_lazy(self, key, module_name, member_name, help, native=True,
2622
deprecated=False, hidden=False, experimental=False, alias=False):
2623
registry.Registry.register_lazy(self, key, module_name, member_name,
2624
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2626
self._aliases.add(key)
2628
def set_default(self, key):
2629
"""Set the 'default' key to be a clone of the supplied key.
2631
This method must be called once and only once.
2633
registry.Registry.register(self, 'default', self.get(key),
2634
self.get_help(key), info=self.get_info(key))
2635
self._aliases.add('default')
2637
def set_default_repository(self, key):
2638
"""Set the FormatRegistry default and Repository default.
2640
This is a transitional method while Repository.set_default_format
2643
if 'default' in self:
2644
self.remove('default')
2645
self.set_default(key)
2646
format = self.get('default')()
2648
def make_bzrdir(self, key):
2649
return self.get(key)()
2651
def help_topic(self, topic):
2652
output = textwrap.dedent("""\
2653
These formats can be used for creating branches, working trees, and
2657
default_realkey = None
2658
default_help = self.get_help('default')
2660
for key in self.keys():
2661
if key == 'default':
2663
help = self.get_help(key)
2664
if help == default_help:
2665
default_realkey = key
2667
help_pairs.append((key, help))
2669
def wrapped(key, help, info):
2671
help = '(native) ' + help
2672
return ':%s:\n%s\n\n' % (key,
2673
textwrap.fill(help, initial_indent=' ',
2674
subsequent_indent=' '))
2675
if default_realkey is not None:
2676
output += wrapped(default_realkey, '(default) %s' % default_help,
2677
self.get_info('default'))
2678
deprecated_pairs = []
2679
experimental_pairs = []
2680
for key, help in help_pairs:
2681
info = self.get_info(key)
2684
elif info.deprecated:
2685
deprecated_pairs.append((key, help))
2686
elif info.experimental:
2687
experimental_pairs.append((key, help))
2689
output += wrapped(key, help, info)
2690
if len(experimental_pairs) > 0:
2691
output += "Experimental formats are shown below.\n\n"
2692
for key, help in experimental_pairs:
2693
info = self.get_info(key)
2694
output += wrapped(key, help, info)
2695
if len(deprecated_pairs) > 0:
2696
output += "Deprecated formats are shown below.\n\n"
2697
for key, help in deprecated_pairs:
2698
info = self.get_info(key)
2699
output += wrapped(key, help, info)
1897
2704
class RepositoryAcquisitionPolicy(object):
1901
2708
for a branch that is being created. The most basic policy decision is
1902
2709
whether to create a new repository or use an existing one.
1904
def __init__(self, stack_on, stack_on_pwd, require_stacking):
1907
:param stack_on: A location to stack on
1908
:param stack_on_pwd: If stack_on is relative, the location it is
1910
:param require_stacking: If True, it is a failure to not stack.
1912
self._stack_on = stack_on
1913
self._stack_on_pwd = stack_on_pwd
1914
self._require_stacking = require_stacking
1916
2712
def configure_branch(self, branch):
1917
2713
"""Apply any configuration data from this policy to the branch.
1919
Default implementation sets repository stacking.
2715
Default implementation does nothing.
1921
if self._stack_on is None:
1923
if self._stack_on_pwd is None:
1924
stack_on = self._stack_on
1927
stack_on = urlutils.rebase_url(self._stack_on,
1930
except errors.InvalidRebaseURLs:
1931
stack_on = self._get_full_stack_on()
1933
branch.set_stacked_on_url(stack_on)
1934
except (errors.UnstackableBranchFormat,
1935
errors.UnstackableRepositoryFormat):
1936
if self._require_stacking:
1939
def requires_stacking(self):
1940
"""Return True if this policy requires stacking."""
1941
return self._stack_on is not None and self._require_stacking
1943
def _get_full_stack_on(self):
1944
"""Get a fully-qualified URL for the stack_on location."""
1945
if self._stack_on is None:
1947
if self._stack_on_pwd is None:
1948
return self._stack_on
1950
return urlutils.join(self._stack_on_pwd, self._stack_on)
1952
def _add_fallback(self, repository, possible_transports=None):
1953
"""Add a fallback to the supplied repository, if stacking is set."""
1954
stack_on = self._get_full_stack_on()
1955
if stack_on is None:
1958
stacked_dir = BzrDir.open(stack_on,
1959
possible_transports=possible_transports)
1960
except errors.JailBreak:
1961
# We keep the stacking details, but we are in the server code so
1962
# actually stacking is not needed.
1965
stacked_repo = stacked_dir.open_branch().repository
1966
except errors.NotBranchError:
1967
stacked_repo = stacked_dir.open_repository()
1969
repository.add_fallback_repository(stacked_repo)
1970
except errors.UnstackableRepositoryFormat:
1971
if self._require_stacking:
1974
self._require_stacking = True
1976
def acquire_repository(self, make_working_trees=None, shared=False,
1977
possible_transports=None):
2719
def acquire_repository(self, make_working_trees=None, shared=False):
1978
2720
"""Acquire a repository for this bzrdir.
1980
2722
Implementations may create a new repository or use a pre-exising
1983
2724
:param make_working_trees: If creating a repository, set
1984
2725
make_working_trees to this value (if non-None)
1985
2726
:param shared: If creating a repository, make it shared if True
1986
:return: A repository, is_new_flag (True if the repository was
2727
:return: A repository
1989
raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
2729
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
1992
2732
class CreateRepository(RepositoryAcquisitionPolicy):
1993
2733
"""A policy of creating a new repository"""
1995
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
1996
require_stacking=False):
1999
:param bzrdir: The bzrdir to create the repository on.
2000
:param stack_on: A location to stack on
2001
:param stack_on_pwd: If stack_on is relative, the location it is
2004
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2735
def __init__(self, bzrdir):
2736
RepositoryAcquisitionPolicy.__init__(self)
2006
2737
self._bzrdir = bzrdir
2008
def acquire_repository(self, make_working_trees=None, shared=False,
2009
possible_transports=None):
2739
def acquire_repository(self, make_working_trees=None, shared=False):
2010
2740
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2012
2742
Creates the desired repository in the bzrdir we already have.
2014
if possible_transports is None:
2015
possible_transports = []
2017
possible_transports = list(possible_transports)
2018
possible_transports.append(self._bzrdir.root_transport)
2019
stack_on = self._get_full_stack_on()
2021
format = self._bzrdir._format
2022
format.require_stacking(stack_on=stack_on,
2023
possible_transports=possible_transports)
2024
if not self._require_stacking:
2025
# We have picked up automatic stacking somewhere.
2026
note(gettext('Using default stacking branch {0} at {1}').format(
2027
self._stack_on, self._stack_on_pwd))
2028
2744
repository = self._bzrdir.create_repository(shared=shared)
2029
self._add_fallback(repository,
2030
possible_transports=possible_transports)
2031
2745
if make_working_trees is not None:
2032
2746
repository.set_make_working_trees(make_working_trees)
2033
return repository, True
2036
2750
class UseExistingRepository(RepositoryAcquisitionPolicy):
2037
2751
"""A policy of reusing an existing repository"""
2039
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
2040
require_stacking=False):
2043
:param repository: The repository to use.
2044
:param stack_on: A location to stack on
2045
:param stack_on_pwd: If stack_on is relative, the location it is
2048
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2753
def __init__(self, repository):
2754
RepositoryAcquisitionPolicy.__init__(self)
2050
2755
self._repository = repository
2052
def acquire_repository(self, make_working_trees=None, shared=False,
2053
possible_transports=None):
2757
def acquire_repository(self, make_working_trees=None, shared=False):
2054
2758
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2056
Returns an existing repository to use.
2760
Returns an existing repository to use
2058
if possible_transports is None:
2059
possible_transports = []
2061
possible_transports = list(possible_transports)
2062
possible_transports.append(self._repository.bzrdir.transport)
2063
self._add_fallback(self._repository,
2064
possible_transports=possible_transports)
2065
return self._repository, False
2068
def register_metadir(registry, key,
2069
repository_format, help, native=True, deprecated=False,
2074
alias=False, bzrdir_format=None):
2075
"""Register a metadir subformat.
2077
These all use a meta bzrdir, but can be parameterized by the
2078
Repository/Branch/WorkingTreeformats.
2080
:param repository_format: The fully-qualified repository format class
2082
:param branch_format: Fully-qualified branch format class name as
2084
:param tree_format: Fully-qualified tree format class name as
2087
if bzrdir_format is None:
2088
bzrdir_format = BzrDirMetaFormat1
2089
# This should be expanded to support setting WorkingTree and Branch
2090
# formats, once the API supports that.
2091
def _load(full_name):
2092
mod_name, factory_name = full_name.rsplit('.', 1)
2094
factory = pyutils.get_named_object(mod_name, factory_name)
2095
except ImportError, e:
2096
raise ImportError('failed to load %s: %s' % (full_name, e))
2097
except AttributeError:
2098
raise AttributeError('no factory %s in module %r'
2099
% (full_name, sys.modules[mod_name]))
2103
bd = bzrdir_format()
2104
if branch_format is not None:
2105
bd.set_branch_format(_load(branch_format))
2106
if tree_format is not None:
2107
bd.workingtree_format = _load(tree_format)
2108
if repository_format is not None:
2109
bd.repository_format = _load(repository_format)
2111
registry.register(key, helper, help, native, deprecated, hidden,
2112
experimental, alias)
2114
register_metadir(controldir.format_registry, 'knit',
2762
return self._repository
2765
format_registry = BzrDirFormatRegistry()
2766
format_registry.register('weave', BzrDirFormat6,
2767
'Pre-0.8 format. Slower than knit and does not'
2768
' support checkouts or shared repositories.',
2770
format_registry.register_metadir('knit',
2115
2771
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2116
2772
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2117
branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2118
tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
2121
register_metadir(controldir.format_registry, 'dirstate',
2122
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2123
help='Format using dirstate for working trees. '
2124
'Compatible with bzr 0.8 and '
2125
'above when accessed over the network. Introduced in bzr 0.15.',
2126
branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2127
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2130
register_metadir(controldir.format_registry, 'dirstate-tags',
2131
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2132
help='Variant of dirstate with support for tags. '
2133
'Introduced in bzr 0.15.',
2773
branch_format='bzrlib.branch.BzrBranchFormat5',
2774
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2775
format_registry.register_metadir('metaweave',
2776
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2777
'Transitional format in 0.8. Slower than knit.',
2778
branch_format='bzrlib.branch.BzrBranchFormat5',
2779
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2781
format_registry.register_metadir('dirstate',
2782
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2783
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2784
'above when accessed over the network.',
2785
branch_format='bzrlib.branch.BzrBranchFormat5',
2786
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2787
# directly from workingtree_4 triggers a circular import.
2788
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2790
format_registry.register_metadir('dirstate-tags',
2791
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2792
help='New in 0.15: Fast local operations and improved scaling for '
2793
'network operations. Additionally adds support for tags.'
2794
' Incompatible with bzr < 0.15.',
2134
2795
branch_format='bzrlib.branch.BzrBranchFormat6',
2135
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2138
register_metadir(controldir.format_registry, 'rich-root',
2796
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2798
format_registry.register_metadir('rich-root',
2139
2799
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2140
help='Variant of dirstate with better handling of tree roots. '
2141
'Introduced in bzr 1.0',
2800
help='New in 1.0. Better handling of tree roots. Incompatible with'
2142
2802
branch_format='bzrlib.branch.BzrBranchFormat6',
2143
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2146
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2803
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2805
format_registry.register_metadir('dirstate-with-subtree',
2147
2806
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2148
help='Variant of dirstate with support for nested trees. '
2149
'Introduced in 0.15.',
2150
branch_format='bzrlib.branch.BzrBranchFormat6',
2151
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2155
register_metadir(controldir.format_registry, 'pack-0.92',
2156
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
2157
help='Pack-based format used in 1.x series. Introduced in 0.92. '
2158
'Interoperates with bzr repositories before 0.92 but cannot be '
2159
'read by bzr < 0.92. '
2161
branch_format='bzrlib.branch.BzrBranchFormat6',
2162
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2165
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2166
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
2167
help='Pack-based format used in 1.x series, with subtree support. '
2168
'Introduced in 0.92. Interoperates with '
2169
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2171
branch_format='bzrlib.branch.BzrBranchFormat6',
2172
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2177
register_metadir(controldir.format_registry, 'rich-root-pack',
2178
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
2179
help='A variant of pack-0.92 that supports rich-root data '
2180
'(needed for bzr-svn and bzr-git). Introduced in 1.0.',
2181
branch_format='bzrlib.branch.BzrBranchFormat6',
2182
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2186
register_metadir(controldir.format_registry, '1.6',
2187
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
2188
help='A format that allows a branch to indicate that there is another '
2189
'(stacked) repository that should be used to access data that is '
2190
'not present locally.',
2191
branch_format='bzrlib.branch.BzrBranchFormat7',
2192
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2196
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2197
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
2198
help='A variant of 1.6 that supports rich-root data '
2199
'(needed for bzr-svn and bzr-git).',
2200
branch_format='bzrlib.branch.BzrBranchFormat7',
2201
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2205
register_metadir(controldir.format_registry, '1.9',
2206
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2207
help='A repository format using B+tree indexes. These indexes '
2208
'are smaller in size, have smarter caching and provide faster '
2209
'performance for most operations.',
2210
branch_format='bzrlib.branch.BzrBranchFormat7',
2211
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2215
register_metadir(controldir.format_registry, '1.9-rich-root',
2216
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2217
help='A variant of 1.9 that supports rich-root data '
2218
'(needed for bzr-svn and bzr-git).',
2219
branch_format='bzrlib.branch.BzrBranchFormat7',
2220
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2224
register_metadir(controldir.format_registry, '1.14',
2225
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2226
help='A working-tree format that supports content filtering.',
2227
branch_format='bzrlib.branch.BzrBranchFormat7',
2228
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2232
register_metadir(controldir.format_registry, '1.14-rich-root',
2233
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2234
help='A variant of 1.14 that supports rich-root data '
2235
'(needed for bzr-svn and bzr-git).',
2236
branch_format='bzrlib.branch.BzrBranchFormat7',
2237
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2241
# The following un-numbered 'development' formats should always just be aliases.
2242
register_metadir(controldir.format_registry, 'development-subtree',
2243
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
2807
help='New in 0.15: Fast local operations and improved scaling for '
2808
'network operations. Additionally adds support for versioning nested '
2809
'bzr branches. Incompatible with bzr < 0.15.',
2810
branch_format='bzrlib.branch.BzrBranchFormat6',
2811
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2815
format_registry.register_metadir('pack-0.92',
2816
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2817
help='New in 0.92: Pack-based format with data compatible with '
2818
'dirstate-tags format repositories. Interoperates with '
2819
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2820
'Previously called knitpack-experimental. '
2821
'For more information, see '
2822
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2823
branch_format='bzrlib.branch.BzrBranchFormat6',
2824
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2826
format_registry.register_metadir('pack-0.92-subtree',
2827
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2828
help='New in 0.92: Pack-based format with data compatible with '
2829
'dirstate-with-subtree format repositories. Interoperates with '
2830
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2831
'Previously called knitpack-experimental. '
2832
'For more information, see '
2833
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2834
branch_format='bzrlib.branch.BzrBranchFormat6',
2835
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2839
format_registry.register_metadir('rich-root-pack',
2840
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2841
help='New in 1.0: Pack-based format with data compatible with '
2842
'rich-root format repositories. Incompatible with'
2844
branch_format='bzrlib.branch.BzrBranchFormat6',
2845
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2847
# The following two formats should always just be aliases.
2848
format_registry.register_metadir('development',
2849
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
2850
help='Current development format. Can convert data to and from pack-0.92 '
2851
'(and anything compatible with pack-0.92) format repositories. '
2852
'Repositories and branches in this format can only be read by bzr.dev. '
2854
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2856
branch_format='bzrlib.branch.BzrBranchFormat7',
2857
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2861
format_registry.register_metadir('development-subtree',
2862
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
2244
2863
help='Current development format, subtree variant. Can convert data to and '
2245
2864
'from pack-0.92-subtree (and anything compatible with '
2246
2865
'pack-0.92-subtree) format repositories. Repositories and branches in '
2247
2866
'this format can only be read by bzr.dev. Please read '
2248
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2250
branch_format='bzrlib.branch.BzrBranchFormat7',
2251
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2254
alias=False, # Restore to being an alias when an actual development subtree format is added
2255
# This current non-alias status is simply because we did not introduce a
2256
# chk based subtree format.
2258
register_metadir(controldir.format_registry, 'development5-subtree',
2259
'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
2260
help='Development format, subtree variant. Can convert data to and '
2261
'from pack-0.92-subtree (and anything compatible with '
2262
'pack-0.92-subtree) format repositories. Repositories and branches in '
2263
'this format can only be read by bzr.dev. Please read '
2264
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2266
branch_format='bzrlib.branch.BzrBranchFormat7',
2267
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2273
register_metadir(controldir.format_registry, 'development-colo',
2274
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2275
help='The 2a format with experimental support for colocated branches.\n',
2276
branch_format='bzrlib.branch.BzrBranchFormat7',
2277
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2279
bzrdir_format=BzrDirMetaFormat1Colo,
2283
# And the development formats above will have aliased one of the following:
2285
# Finally, the current format.
2286
register_metadir(controldir.format_registry, '2a',
2287
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2288
help='Format for the bzr 2.0 series.\n'
2289
'Uses group-compress storage.\n'
2290
'Provides rich roots which are a one-way transition.\n',
2291
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
2292
# 'rich roots. Supported by bzr 1.16 and later.',
2293
branch_format='bzrlib.branch.BzrBranchFormat7',
2294
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2298
# The following format should be an alias for the rich root equivalent
2299
# of the default format
2300
register_metadir(controldir.format_registry, 'default-rich-root',
2301
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2302
branch_format='bzrlib.branch.BzrBranchFormat7',
2303
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2867
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2869
branch_format='bzrlib.branch.BzrBranchFormat7',
2870
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2874
# And the development formats which the will have aliased one of follow:
2875
format_registry.register_metadir('development0',
2876
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2877
help='Trivial rename of pack-0.92 to provide a development format. '
2879
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2881
branch_format='bzrlib.branch.BzrBranchFormat6',
2882
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2886
format_registry.register_metadir('development0-subtree',
2887
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2888
help='Trivial rename of pack-0.92-subtree to provide a development format. '
2890
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2892
branch_format='bzrlib.branch.BzrBranchFormat6',
2893
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2897
format_registry.register_metadir('development1',
2898
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
2899
help='A branch and pack based repository that supports stacking. '
2901
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2903
branch_format='bzrlib.branch.BzrBranchFormat7',
2904
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2908
format_registry.register_metadir('development1-subtree',
2909
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
2910
help='A branch and pack based repository that supports stacking. '
2912
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2914
branch_format='bzrlib.branch.BzrBranchFormat7',
2915
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2308
2919
# The current format that is made on 'bzr init'.
2309
format_name = config.GlobalStack().get('default_format')
2310
controldir.format_registry.set_default(format_name)
2312
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2313
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
2314
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
2315
format_registry = controldir.format_registry
2920
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
