326
233
# TODO: This should be given a Transport, and should chdir up; otherwise
327
234
# this will open a new connection.
328
235
def _make_tail(self, url):
329
t = get_transport(url)
333
def create(cls, base, format=None, possible_transports=None):
334
"""Create a new BzrDir at the url 'base'.
336
:param format: If supplied, the format of branch to create. If not
337
supplied, the default is used.
338
:param possible_transports: If supplied, a list of transports that
339
can be reused to share a remote connection.
341
if cls is not BzrDir:
342
raise AssertionError("BzrDir.create always creates the default"
343
" format, not one of %r" % cls)
344
t = get_transport(base, possible_transports)
347
format = BzrDirFormat.get_default_format()
348
return format.initialize_on_transport(t)
351
def find_bzrdirs(transport, evaluate=None, list_current=None):
352
"""Find bzrdirs recursively from current location.
354
This is intended primarily as a building block for more sophisticated
355
functionality, like finding trees under a directory, or finding
356
branches that use a given repository.
357
:param evaluate: An optional callable that yields recurse, value,
358
where recurse controls whether this bzrdir is recursed into
359
and value is the value to yield. By default, all bzrdirs
360
are recursed into, and the return value is the bzrdir.
361
:param list_current: if supplied, use this function to list the current
362
directory, instead of Transport.list_dir
363
:return: a generator of found bzrdirs, or whatever evaluate returns.
365
if list_current is None:
366
def list_current(transport):
367
return transport.list_dir('')
369
def evaluate(bzrdir):
372
pending = [transport]
373
while len(pending) > 0:
374
current_transport = pending.pop()
377
bzrdir = BzrDir.open_from_transport(current_transport)
378
except errors.NotBranchError:
381
recurse, value = evaluate(bzrdir)
384
subdirs = list_current(current_transport)
385
except errors.NoSuchFile:
388
for subdir in sorted(subdirs, reverse=True):
389
pending.append(current_transport.clone(subdir))
391
def list_branches(self):
392
"""Return a sequence of all branches local to this control directory.
396
return [self.open_branch()]
397
except errors.NotBranchError:
401
def find_branches(transport):
402
"""Find all branches under a transport.
404
This will find all branches below the transport, including branches
405
inside other branches. Where possible, it will use
406
Repository.find_branches.
408
To list all the branches that use a particular Repository, see
409
Repository.find_branches
411
def evaluate(bzrdir):
413
repository = bzrdir.open_repository()
414
except errors.NoRepositoryPresent:
417
return False, ([], repository)
418
return True, (bzrdir.list_branches(), None)
420
for branches, repo in BzrDir.find_bzrdirs(transport,
423
ret.extend(repo.find_branches())
424
if branches is not None:
428
def destroy_repository(self):
429
"""Destroy the repository in this BzrDir"""
430
raise NotImplementedError(self.destroy_repository)
432
def create_branch(self, name=None):
433
"""Create a branch in this BzrDir.
435
:param name: Name of the colocated branch to create, None for
438
The bzrdir's format will control what branch format is created.
439
For more control see BranchFormatXX.create(a_bzrdir).
441
raise NotImplementedError(self.create_branch)
443
def destroy_branch(self, name=None):
444
"""Destroy a branch in this BzrDir.
446
:param name: Name of the branch to destroy, None for the default
449
raise NotImplementedError(self.destroy_branch)
452
def create_branch_and_repo(base, force_new_repo=False, format=None):
453
"""Create a new BzrDir, Branch and Repository at the url 'base'.
455
This will use the current default BzrDirFormat unless one is
456
specified, and use whatever
457
repository format that that uses via bzrdir.create_branch and
458
create_repository. If a shared repository is available that is used
461
The created Branch object is returned.
463
:param base: The URL to create the branch at.
464
:param force_new_repo: If True a new repository is always created.
465
:param format: If supplied, the format of branch to create. If not
466
supplied, the default is used.
468
bzrdir = BzrDir.create(base, format)
469
bzrdir._find_or_create_repository(force_new_repo)
470
return bzrdir.create_branch()
236
t = _mod_transport.get_transport(url)
472
239
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
473
240
stack_on_pwd=None, require_stacking=False):
535
302
policy = self.determine_repository_policy(force_new_repo)
536
303
return policy.acquire_repository()[0]
539
def create_branch_convenience(base, force_new_repo=False,
540
force_new_tree=None, format=None,
541
possible_transports=None):
542
"""Create a new BzrDir, Branch and Repository at the url 'base'.
544
This is a convenience function - it will use an existing repository
545
if possible, can be told explicitly whether to create a working tree or
548
This will use the current default BzrDirFormat unless one is
549
specified, and use whatever
550
repository format that that uses via bzrdir.create_branch and
551
create_repository. If a shared repository is available that is used
552
preferentially. Whatever repository is used, its tree creation policy
555
The created Branch object is returned.
556
If a working tree cannot be made due to base not being a file:// url,
557
no error is raised unless force_new_tree is True, in which case no
558
data is created on disk and NotLocalUrl is raised.
560
:param base: The URL to create the branch at.
561
:param force_new_repo: If True a new repository is always created.
562
:param force_new_tree: If True or False force creation of a tree or
563
prevent such creation respectively.
564
:param format: Override for the bzrdir format to create.
565
:param possible_transports: An optional reusable transports list.
305
def _find_source_repo(self, add_cleanup, source_branch):
306
"""Find the source branch and repo for a sprout operation.
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).
568
# check for non local urls
569
t = get_transport(base, possible_transports)
570
if not isinstance(t, local.LocalTransport):
571
raise errors.NotLocalUrl(base)
572
bzrdir = BzrDir.create(base, format, possible_transports)
573
repo = bzrdir._find_or_create_repository(force_new_repo)
574
result = bzrdir.create_branch()
575
if force_new_tree or (repo.make_working_trees() and
576
force_new_tree is None):
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:
578
bzrdir.create_workingtree()
579
except errors.NotLocalUrl:
584
def create_standalone_workingtree(base, format=None):
585
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
587
'base' must be a local path or a file:// url.
589
This will use the current default BzrDirFormat unless one is
590
specified, and use whatever
591
repository format that that uses for bzrdirformat.create_workingtree,
592
create_branch and create_repository.
594
:param format: Override for the bzrdir format to create.
595
:return: The WorkingTree object.
597
t = get_transport(base)
598
if not isinstance(t, local.LocalTransport):
599
raise errors.NotLocalUrl(base)
600
bzrdir = BzrDir.create_branch_and_repo(base,
602
format=format).bzrdir
603
return bzrdir.create_workingtree()
605
def create_workingtree(self, revision_id=None, from_branch=None,
606
accelerator_tree=None, hardlink=False):
607
"""Create a working tree at this BzrDir.
609
:param revision_id: create it as of this revision id.
610
:param from_branch: override bzrdir branch (for lightweight checkouts)
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.
611
349
:param accelerator_tree: A tree which can be used for retrieving file
612
350
contents more quickly than the revision tree, i.e. a workingtree.
613
351
The revision tree will be used for cases where accelerator_tree's
614
352
content is different.
616
raise NotImplementedError(self.create_workingtree)
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)
618
476
def backup_bzrdir(self):
619
477
"""Backup this bzr control directory.
621
479
:return: Tuple with old path name and new path name
623
def name_gen(base='backup.bzr'):
625
name = "%s.~%d~" % (base, counter)
626
while self.root_transport.has(name):
628
name = "%s.~%d~" % (base, counter)
631
backup_dir=name_gen()
632
482
pb = ui.ui_factory.nested_progress_bar()
634
# FIXME: bug 300001 -- the backup fails if the backup directory
635
# already exists, but it should instead either remove it or make
636
# a new backup directory.
638
484
old_path = self.root_transport.abspath('.bzr')
485
backup_dir = self._available_backup_name('backup.bzr')
639
486
new_path = self.root_transport.abspath(backup_dir)
640
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
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')))
641
490
self.root_transport.copy_tree('.bzr', backup_dir)
642
491
return (old_path, new_path)
885
664
# add new tests for it to the appropriate place.
886
665
return filename == '.bzr' or filename.startswith('.bzr/')
888
def needs_format_conversion(self, format=None):
889
"""Return true if this bzrdir needs convert_format run on it.
891
For instance, if the repository format is out of date but the
892
branch and working tree are not, this should return True.
894
:param format: Optional parameter indicating a specific desired
895
format we plan to arrive at.
897
raise NotImplementedError(self.needs_format_conversion)
900
def open_unsupported(base):
901
"""Open a branch which is not supported."""
902
return BzrDir.open(base, _unsupported=True)
905
def open(base, _unsupported=False, possible_transports=None):
906
"""Open an existing bzrdir, rooted at 'base' (url).
908
:param _unsupported: a private parameter to the BzrDir class.
910
t = get_transport(base, possible_transports=possible_transports)
911
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
914
def open_from_transport(transport, _unsupported=False,
915
_server_formats=True):
916
"""Open a bzrdir within a particular directory.
918
:param transport: Transport containing the bzrdir.
919
:param _unsupported: private.
921
for hook in BzrDir.hooks['pre_open']:
923
# Keep initial base since 'transport' may be modified while following
925
base = transport.base
926
def find_format(transport):
927
return transport, BzrDirFormat.find_format(
928
transport, _server_formats=_server_formats)
930
def redirected(transport, e, redirection_notice):
931
redirected_transport = transport._redirected_to(e.source, e.target)
932
if redirected_transport is None:
933
raise errors.NotBranchError(base)
934
note('%s is%s redirected to %s',
935
transport.base, e.permanently, redirected_transport.base)
936
return redirected_transport
939
transport, format = do_catching_redirections(find_format,
942
except errors.TooManyRedirections:
943
raise errors.NotBranchError(base)
945
BzrDir._check_supported(format, _unsupported)
946
return format.open(transport, _found=True)
948
def open_branch(self, name=None, unsupported=False,
949
ignore_fallbacks=False):
950
"""Open the branch object at this BzrDir if one is present.
952
If unsupported is True, then no longer supported branch formats can
955
TODO: static convenience version of this?
957
raise NotImplementedError(self.open_branch)
960
def open_containing(url, possible_transports=None):
961
"""Open an existing branch which contains url.
963
:param url: url to search from.
964
See open_containing_from_transport for more detail.
966
transport = get_transport(url, possible_transports)
967
return BzrDir.open_containing_from_transport(transport)
970
def open_containing_from_transport(a_transport):
971
"""Open an existing branch which contains a_transport.base.
973
This probes for a branch at a_transport, and searches upwards from there.
975
Basically we keep looking up until we find the control directory or
976
run into the root. If there isn't one, raises NotBranchError.
977
If there is one and it is either an unrecognised format or an unsupported
978
format, UnknownFormatError or UnsupportedFormatError are raised.
979
If there is one, it is returned, along with the unused portion of url.
981
:return: The BzrDir that contains the path, and a Unicode path
982
for the rest of the URL.
984
# this gets the normalised url back. I.e. '.' -> the full path.
985
url = a_transport.base
988
result = BzrDir.open_from_transport(a_transport)
989
return result, urlutils.unescape(a_transport.relpath(url))
990
except errors.NotBranchError, e:
993
new_t = a_transport.clone('..')
994
except errors.InvalidURLJoin:
995
# reached the root, whatever that may be
996
raise errors.NotBranchError(path=url)
997
if new_t.base == a_transport.base:
998
# reached the root, whatever that may be
999
raise errors.NotBranchError(path=url)
1002
def _get_tree_branch(self, name=None):
1003
"""Return the branch and tree, if any, for this bzrdir.
1005
:param name: Name of colocated branch to open.
1007
Return None for tree if not present or inaccessible.
1008
Raise NotBranchError if no branch is present.
1009
:return: (tree, branch)
1012
tree = self.open_workingtree()
1013
except (errors.NoWorkingTree, errors.NotLocalUrl):
1015
branch = self.open_branch(name=name)
1017
if name is not None:
1018
branch = self.open_branch(name=name)
1020
branch = tree.branch
1024
def open_tree_or_branch(klass, location):
1025
"""Return the branch and working tree at a location.
1027
If there is no tree at the location, tree will be None.
1028
If there is no branch at the location, an exception will be
1030
:return: (tree, branch)
1032
bzrdir = klass.open(location)
1033
return bzrdir._get_tree_branch()
1036
def open_containing_tree_or_branch(klass, location):
1037
"""Return the branch and working tree contained by a location.
1039
Returns (tree, branch, relpath).
1040
If there is no tree at containing the location, tree will be None.
1041
If there is no branch containing the location, an exception will be
1043
relpath is the portion of the path that is contained by the branch.
1045
bzrdir, relpath = klass.open_containing(location)
1046
tree, branch = bzrdir._get_tree_branch()
1047
return tree, branch, relpath
1050
def open_containing_tree_branch_or_repository(klass, location):
1051
"""Return the working tree, branch and repo contained by a location.
1053
Returns (tree, branch, repository, relpath).
1054
If there is no tree containing the location, tree will be None.
1055
If there is no branch containing the location, branch will be None.
1056
If there is no repository containing the location, repository will be
1058
relpath is the portion of the path that is contained by the innermost
1061
If no tree, branch or repository is found, a NotBranchError is raised.
1063
bzrdir, relpath = klass.open_containing(location)
1065
tree, branch = bzrdir._get_tree_branch()
1066
except errors.NotBranchError:
1068
repo = bzrdir.find_repository()
1069
return None, None, repo, relpath
1070
except (errors.NoRepositoryPresent):
1071
raise errors.NotBranchError(location)
1072
return tree, branch, branch.repository, relpath
1074
def open_repository(self, _unsupported=False):
1075
"""Open the repository object at this BzrDir if one is present.
1077
This will not follow the Branch object pointer - it's strictly a direct
1078
open facility. Most client code should use open_branch().repository to
1079
get at a repository.
1081
:param _unsupported: a private parameter, not part of the api.
1082
TODO: static convenience version of this?
1084
raise NotImplementedError(self.open_repository)
1086
def open_workingtree(self, _unsupported=False,
1087
recommend_upgrade=True, from_branch=None):
1088
"""Open the workingtree object at this BzrDir if one is present.
1090
:param recommend_upgrade: Optional keyword parameter, when True (the
1091
default), emit through the ui module a recommendation that the user
1092
upgrade the working tree when the workingtree being opened is old
1093
(but still fully supported).
1094
:param from_branch: override bzrdir branch (for lightweight checkouts)
1096
raise NotImplementedError(self.open_workingtree)
1098
def has_branch(self, name=None):
1099
"""Tell if this bzrdir contains a branch.
1101
Note: if you're going to open the branch, you should just go ahead
1102
and try, and not ask permission first. (This method just opens the
1103
branch and discards it, and that's somewhat expensive.)
1106
self.open_branch(name)
1108
except errors.NotBranchError:
1111
def has_workingtree(self):
1112
"""Tell if this bzrdir contains a working tree.
1114
This will still raise an exception if the bzrdir has a workingtree that
1115
is remote & inaccessible.
1117
Note: if you're going to open the working tree, you should just go ahead
1118
and try, and not ask permission first. (This method just opens the
1119
workingtree and discards it, and that's somewhat expensive.)
1122
self.open_workingtree(recommend_upgrade=False)
1124
except errors.NoWorkingTree:
1127
667
def _cloning_metadir(self):
1128
668
"""Produce a metadir suitable for cloning with.
1187
727
format.require_stacking()
1190
def checkout_metadir(self):
1191
return self.cloning_metadir()
1193
def sprout(self, url, revision_id=None, force_new_repo=False,
1194
recurse='down', possible_transports=None,
1195
accelerator_tree=None, hardlink=False, stacked=False,
1196
source_branch=None, create_tree_if_local=True):
1197
"""Create a copy of this bzrdir prepared for use as a new line of
1200
If url's last component does not exist, it will be created.
1202
Attributes related to the identity of the source branch like
1203
branch nickname will be cleaned, a working tree is created
1204
whether one existed before or not; and a local branch is always
1207
if revision_id is not None, then the clone operation may tune
1208
itself to download less data.
1209
:param accelerator_tree: A tree which can be used for retrieving file
1210
contents more quickly than the revision tree, i.e. a workingtree.
1211
The revision tree will be used for cases where accelerator_tree's
1212
content is different.
1213
:param hardlink: If true, hard-link files from accelerator_tree,
1215
:param stacked: If true, create a stacked branch referring to the
1216
location of this control directory.
1217
:param create_tree_if_local: If true, a working-tree will be created
1218
when working locally.
1220
target_transport = get_transport(url, possible_transports)
1221
target_transport.ensure_base()
1222
cloning_format = self.cloning_metadir(stacked)
1223
# Create/update the result branch
1224
result = cloning_format.initialize_on_transport(target_transport)
1225
# if a stacked branch wasn't requested, we don't create one
1226
# even if the origin was stacked
1227
stacked_branch_url = None
1228
if source_branch is not None:
1230
stacked_branch_url = self.root_transport.base
1231
source_repository = source_branch.repository
1234
source_branch = self.open_branch()
1235
source_repository = source_branch.repository
1237
stacked_branch_url = self.root_transport.base
1238
except errors.NotBranchError:
1239
source_branch = None
1241
source_repository = self.open_repository()
1242
except errors.NoRepositoryPresent:
1243
source_repository = None
1244
repository_policy = result.determine_repository_policy(
1245
force_new_repo, stacked_branch_url, require_stacking=stacked)
1246
result_repo, is_new_repo = repository_policy.acquire_repository()
1247
if is_new_repo and revision_id is not None and not stacked:
1248
fetch_spec = graph.PendingAncestryResult(
1249
[revision_id], source_repository)
1252
if source_repository is not None:
1253
# Fetch while stacked to prevent unstacked fetch from
1255
if fetch_spec is None:
1256
result_repo.fetch(source_repository, revision_id=revision_id)
1258
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1260
if source_branch is None:
1261
# this is for sprouting a bzrdir without a branch; is that
1263
# Not especially, but it's part of the contract.
1264
result_branch = result.create_branch()
1266
result_branch = source_branch.sprout(result,
1267
revision_id=revision_id, repository_policy=repository_policy)
1268
mutter("created new branch %r" % (result_branch,))
1270
# Create/update the result working tree
1271
if (create_tree_if_local and
1272
isinstance(target_transport, local.LocalTransport) and
1273
(result_repo is None or result_repo.make_working_trees())):
1274
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1278
if wt.path2id('') is None:
1280
wt.set_root_id(self.open_workingtree.get_root_id())
1281
except errors.NoWorkingTree:
1287
if recurse == 'down':
1289
basis = wt.basis_tree()
1291
subtrees = basis.iter_references()
1292
elif result_branch is not None:
1293
basis = result_branch.basis_tree()
1295
subtrees = basis.iter_references()
1296
elif source_branch is not None:
1297
basis = source_branch.basis_tree()
1299
subtrees = basis.iter_references()
1304
for path, file_id in subtrees:
1305
target = urlutils.join(url, urlutils.escape(path))
1306
sublocation = source_branch.reference_parent(file_id, path)
1307
sublocation.bzrdir.sprout(target,
1308
basis.get_reference_revision(file_id, path),
1309
force_new_repo=force_new_repo, recurse=recurse,
1312
if basis is not None:
1316
def push_branch(self, source, revision_id=None, overwrite=False,
1317
remember=False, create_prefix=False):
1318
"""Push the source branch into this BzrDir."""
1320
# If we can open a branch, use its direct repository, otherwise see
1321
# if there is a repository without a branch.
1323
br_to = self.open_branch()
1324
except errors.NotBranchError:
1325
# Didn't find a branch, can we find a repository?
1326
repository_to = self.find_repository()
1328
# Found a branch, so we must have found a repository
1329
repository_to = br_to.repository
1331
push_result = PushResult()
1332
push_result.source_branch = source
1334
# We have a repository but no branch, copy the revisions, and then
1336
repository_to.fetch(source.repository, revision_id=revision_id)
1337
br_to = source.clone(self, revision_id=revision_id)
1338
if source.get_push_location() is None or remember:
1339
source.set_push_location(br_to.base)
1340
push_result.stacked_on = None
1341
push_result.branch_push_result = None
1342
push_result.old_revno = None
1343
push_result.old_revid = _mod_revision.NULL_REVISION
1344
push_result.target_branch = br_to
1345
push_result.master_branch = None
1346
push_result.workingtree_updated = False
1348
# We have successfully opened the branch, remember if necessary:
1349
if source.get_push_location() is None or remember:
1350
source.set_push_location(br_to.base)
1352
tree_to = self.open_workingtree()
1353
except errors.NotLocalUrl:
1354
push_result.branch_push_result = source.push(br_to,
1355
overwrite, stop_revision=revision_id)
1356
push_result.workingtree_updated = False
1357
except errors.NoWorkingTree:
1358
push_result.branch_push_result = source.push(br_to,
1359
overwrite, stop_revision=revision_id)
1360
push_result.workingtree_updated = None # Not applicable
1362
tree_to.lock_write()
1364
push_result.branch_push_result = source.push(
1365
tree_to.branch, overwrite, stop_revision=revision_id)
1369
push_result.workingtree_updated = True
1370
push_result.old_revno = push_result.branch_push_result.old_revno
1371
push_result.old_revid = push_result.branch_push_result.old_revid
1372
push_result.target_branch = \
1373
push_result.branch_push_result.target_branch
1377
class BzrDirHooks(hooks.Hooks):
1378
"""Hooks for BzrDir operations."""
1381
"""Create the default hooks."""
1382
hooks.Hooks.__init__(self)
1383
self.create_hook(hooks.HookPoint('pre_open',
1384
"Invoked before attempting to open a BzrDir with the transport "
1385
"that the open will use.", (1, 14), None))
1386
self.create_hook(hooks.HookPoint('post_repo_init',
1387
"Invoked after a repository has been initialized. "
1388
"post_repo_init is called with a "
1389
"bzrlib.bzrdir.RepoInitHookParams.",
1392
# install the default hooks
1393
BzrDir.hooks = BzrDirHooks()
1396
class RepoInitHookParams(object):
1397
"""Object holding parameters passed to *_repo_init hooks.
1399
There are 4 fields that hooks may wish to access:
1401
:ivar repository: Repository created
1402
:ivar format: Repository format
1403
:ivar bzrdir: The bzrdir for the repository
1404
:ivar shared: The repository is shared
1407
def __init__(self, repository, format, a_bzrdir, shared):
1408
"""Create a group of RepoInitHook parameters.
1410
:param repository: Repository created
1411
:param format: Repository format
1412
:param bzrdir: The bzrdir for the repository
1413
:param shared: The repository is shared
1415
self.repository = repository
1416
self.format = format
1417
self.bzrdir = a_bzrdir
1418
self.shared = shared
1420
def __eq__(self, other):
1421
return self.__dict__ == other.__dict__
1425
return "<%s for %s>" % (self.__class__.__name__,
1428
return "<%s for %s>" % (self.__class__.__name__,
1432
class BzrDirPreSplitOut(BzrDir):
1433
"""A common class for the all-in-one formats."""
1435
def __init__(self, _transport, _format):
1436
"""See BzrDir.__init__."""
1437
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1438
self._control_files = lockable_files.LockableFiles(
1439
self.get_branch_transport(None),
1440
self._format._lock_file_name,
1441
self._format._lock_class)
1443
def break_lock(self):
1444
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1445
raise NotImplementedError(self.break_lock)
1447
def cloning_metadir(self, require_stacking=False):
1448
"""Produce a metadir suitable for cloning with."""
1449
if require_stacking:
1450
return format_registry.make_bzrdir('1.6')
1451
return self._format.__class__()
1453
def clone(self, url, revision_id=None, force_new_repo=False,
1454
preserve_stacking=False):
1455
"""See BzrDir.clone().
1457
force_new_repo has no effect, since this family of formats always
1458
require a new repository.
1459
preserve_stacking has no effect, since no source branch using this
1460
family of formats can be stacked, so there is no stacking to preserve.
1462
self._make_tail(url)
1463
result = self._format._initialize_for_clone(url)
1464
self.open_repository().clone(result, revision_id=revision_id)
1465
from_branch = self.open_branch()
1466
from_branch.clone(result, revision_id=revision_id)
1468
tree = self.open_workingtree()
1469
except errors.NotLocalUrl:
1470
# make a new one, this format always has to have one.
1471
result._init_workingtree()
1476
def create_branch(self, name=None):
1477
"""See BzrDir.create_branch."""
1478
return self._format.get_branch_format().initialize(self, name=name)
1480
def destroy_branch(self, name=None):
1481
"""See BzrDir.destroy_branch."""
1482
raise errors.UnsupportedOperation(self.destroy_branch, self)
1484
def create_repository(self, shared=False):
1485
"""See BzrDir.create_repository."""
1487
raise errors.IncompatibleFormat('shared repository', self._format)
1488
return self.open_repository()
1490
def destroy_repository(self):
1491
"""See BzrDir.destroy_repository."""
1492
raise errors.UnsupportedOperation(self.destroy_repository, self)
1494
def create_workingtree(self, revision_id=None, from_branch=None,
1495
accelerator_tree=None, hardlink=False):
1496
"""See BzrDir.create_workingtree."""
1497
# The workingtree is sometimes created when the bzrdir is created,
1498
# but not when cloning.
1500
# this looks buggy but is not -really-
1501
# because this format creates the workingtree when the bzrdir is
1503
# clone and sprout will have set the revision_id
1504
# and that will have set it for us, its only
1505
# specific uses of create_workingtree in isolation
1506
# that can do wonky stuff here, and that only
1507
# happens for creating checkouts, which cannot be
1508
# done on this format anyway. So - acceptable wart.
1510
warning("can't support hardlinked working trees in %r"
1513
result = self.open_workingtree(recommend_upgrade=False)
1514
except errors.NoSuchFile:
1515
result = self._init_workingtree()
1516
if revision_id is not None:
1517
if revision_id == _mod_revision.NULL_REVISION:
1518
result.set_parent_ids([])
1520
result.set_parent_ids([revision_id])
1523
def _init_workingtree(self):
1524
from bzrlib.workingtree import WorkingTreeFormat2
1526
return WorkingTreeFormat2().initialize(self)
1527
except errors.NotLocalUrl:
1528
# Even though we can't access the working tree, we need to
1529
# create its control files.
1530
return WorkingTreeFormat2()._stub_initialize_on_transport(
1531
self.transport, self._control_files._file_mode)
1533
def destroy_workingtree(self):
1534
"""See BzrDir.destroy_workingtree."""
1535
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1537
def destroy_workingtree_metadata(self):
1538
"""See BzrDir.destroy_workingtree_metadata."""
1539
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1542
730
def get_branch_transport(self, branch_format, name=None):
1543
"""See BzrDir.get_branch_transport()."""
1544
if name is not None:
1545
raise errors.NoColocatedBranchSupport(self)
1546
if branch_format is None:
1547
return self.transport
1549
branch_format.get_format_string()
1550
except NotImplementedError:
1551
return self.transport
1552
raise errors.IncompatibleFormat(branch_format, self._format)
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.
741
raise NotImplementedError(self.get_branch_transport)
1554
743
def get_repository_transport(self, repository_format):
1555
"""See BzrDir.get_repository_transport()."""
1556
if repository_format is None:
1557
return self.transport
1559
repository_format.get_format_string()
1560
except NotImplementedError:
1561
return self.transport
1562
raise errors.IncompatibleFormat(repository_format, self._format)
1564
def get_workingtree_transport(self, workingtree_format):
1565
"""See BzrDir.get_workingtree_transport()."""
1566
if workingtree_format is None:
1567
return self.transport
1569
workingtree_format.get_format_string()
1570
except NotImplementedError:
1571
return self.transport
1572
raise errors.IncompatibleFormat(workingtree_format, self._format)
1574
def needs_format_conversion(self, format=None):
1575
"""See BzrDir.needs_format_conversion()."""
1576
# if the format is not the same as the system default,
1577
# an upgrade is needed.
1579
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1580
% 'needs_format_conversion(format=None)')
1581
format = BzrDirFormat.get_default_format()
1582
return not isinstance(self._format, format.__class__)
1584
def open_branch(self, name=None, unsupported=False,
1585
ignore_fallbacks=False):
1586
"""See BzrDir.open_branch."""
1587
from bzrlib.branch import BzrBranchFormat4
1588
format = BzrBranchFormat4()
1589
self._check_supported(format, unsupported)
1590
return format.open(self, name, _found=True)
1592
def sprout(self, url, revision_id=None, force_new_repo=False,
1593
possible_transports=None, accelerator_tree=None,
1594
hardlink=False, stacked=False, create_tree_if_local=True,
1595
source_branch=None):
1596
"""See BzrDir.sprout()."""
1597
if source_branch is not None:
1598
my_branch = self.open_branch()
1599
if source_branch.base != my_branch.base:
1600
raise AssertionError(
1601
"source branch %r is not within %r with branch %r" %
1602
(source_branch, self, my_branch))
1604
raise errors.UnstackableBranchFormat(
1605
self._format, self.root_transport.base)
1606
if not create_tree_if_local:
1607
raise errors.MustHaveWorkingTree(
1608
self._format, self.root_transport.base)
1609
from bzrlib.workingtree import WorkingTreeFormat2
1610
self._make_tail(url)
1611
result = self._format._initialize_for_clone(url)
1613
self.open_repository().clone(result, revision_id=revision_id)
1614
except errors.NoRepositoryPresent:
1617
self.open_branch().sprout(result, revision_id=revision_id)
1618
except errors.NotBranchError:
1621
# we always want a working tree
1622
WorkingTreeFormat2().initialize(result,
1623
accelerator_tree=accelerator_tree,
1628
class BzrDir4(BzrDirPreSplitOut):
1629
"""A .bzr version 4 control object.
1631
This is a deprecated format and may be removed after sept 2006.
1634
def create_repository(self, shared=False):
1635
"""See BzrDir.create_repository."""
1636
return self._format.repository_format.initialize(self, shared)
1638
def needs_format_conversion(self, format=None):
1639
"""Format 4 dirs are always in need of conversion."""
1641
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1642
% 'needs_format_conversion(format=None)')
1645
def open_repository(self):
1646
"""See BzrDir.open_repository."""
1647
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1648
return RepositoryFormat4().open(self, _found=True)
1651
class BzrDir5(BzrDirPreSplitOut):
1652
"""A .bzr version 5 control object.
1654
This is a deprecated format and may be removed after sept 2006.
1657
def has_workingtree(self):
1658
"""See BzrDir.has_workingtree."""
1661
def open_repository(self):
1662
"""See BzrDir.open_repository."""
1663
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1664
return RepositoryFormat5().open(self, _found=True)
1666
def open_workingtree(self, _unsupported=False,
1667
recommend_upgrade=True):
1668
"""See BzrDir.create_workingtree."""
1669
from bzrlib.workingtree import WorkingTreeFormat2
1670
wt_format = WorkingTreeFormat2()
1671
# we don't warn here about upgrades; that ought to be handled for the
1673
return wt_format.open(self, _found=True)
1676
class BzrDir6(BzrDirPreSplitOut):
1677
"""A .bzr version 6 control object.
1679
This is a deprecated format and may be removed after sept 2006.
1682
def has_workingtree(self):
1683
"""See BzrDir.has_workingtree."""
1686
def open_repository(self):
1687
"""See BzrDir.open_repository."""
1688
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1689
return RepositoryFormat6().open(self, _found=True)
1691
def open_workingtree(self, _unsupported=False,
1692
recommend_upgrade=True):
1693
"""See BzrDir.create_workingtree."""
1694
# we don't warn here about upgrades; that ought to be handled for the
1696
from bzrlib.workingtree import WorkingTreeFormat2
1697
return WorkingTreeFormat2().open(self, _found=True)
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()
1700
801
class BzrDirMeta1(BzrDir):
1890
1098
return config.TransportConfig(self.transport, 'control.conf')
1893
class BzrDirFormat(object):
1894
"""An encapsulation of the initialization and open routines for a format.
1896
Formats provide three things:
1897
* An initialization routine,
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.
1901
1300
Formats are placed in a dict by their format string for reference
1902
1301
during bzrdir opening. These should be subclasses of BzrDirFormat
2271
1504
compatible with whatever sub formats are supported by self.
2276
def unregister_format(klass, format):
2277
del klass._formats[format.get_format_string()]
2280
def unregister_control_format(klass, format):
2281
klass._control_formats.remove(format)
2284
class BzrDirFormat4(BzrDirFormat):
2285
"""Bzr dir format 4.
2287
This format is a combined format for working tree, branch and repository.
2289
- Format 1 working trees [always]
2290
- Format 4 branches [always]
2291
- Format 4 repositories [always]
2293
This format is deprecated: it indexes texts using a text it which is
2294
removed in format 5; write support for this format has been removed.
2297
_lock_class = lockable_files.TransportLock
2299
def get_format_string(self):
2300
"""See BzrDirFormat.get_format_string()."""
2301
return "Bazaar-NG branch, format 0.0.4\n"
2303
def get_format_description(self):
2304
"""See BzrDirFormat.get_format_description()."""
2305
return "All-in-one format 4"
2307
def get_converter(self, format=None):
2308
"""See BzrDirFormat.get_converter()."""
2309
# there is one and only one upgrade path here.
2310
return ConvertBzrDir4To5()
2312
def initialize_on_transport(self, transport):
2313
"""Format 4 branches cannot be created."""
2314
raise errors.UninitializableFormat(self)
2316
def is_supported(self):
2317
"""Format 4 is not supported.
2319
It is not supported because the model changed from 4 to 5 and the
2320
conversion logic is expensive - so doing it on the fly was not
2325
def network_name(self):
2326
return self.get_format_string()
2328
def _open(self, transport):
2329
"""See BzrDirFormat._open."""
2330
return BzrDir4(transport, self)
2332
def __return_repository_format(self):
2333
"""Circular import protection."""
2334
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2335
return RepositoryFormat4()
2336
repository_format = property(__return_repository_format)
2339
class BzrDirFormatAllInOne(BzrDirFormat):
2340
"""Common class for formats before meta-dirs."""
2342
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2343
create_prefix=False, force_new_repo=False, stacked_on=None,
2344
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2346
"""See BzrDirFormat.initialize_on_transport_ex."""
2347
require_stacking = (stacked_on is not None)
2348
# Format 5 cannot stack, but we've been asked to - actually init
2350
if require_stacking:
2351
format = BzrDirMetaFormat1()
2352
return format.initialize_on_transport_ex(transport,
2353
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2354
force_new_repo=force_new_repo, stacked_on=stacked_on,
2355
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2356
make_working_trees=make_working_trees, shared_repo=shared_repo)
2357
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2358
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2359
force_new_repo=force_new_repo, stacked_on=stacked_on,
2360
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2361
make_working_trees=make_working_trees, shared_repo=shared_repo)
2364
class BzrDirFormat5(BzrDirFormatAllInOne):
2365
"""Bzr control format 5.
2367
This format is a combined format for working tree, branch and repository.
2369
- Format 2 working trees [always]
2370
- Format 4 branches [always]
2371
- Format 5 repositories [always]
2372
Unhashed stores in the repository.
2375
_lock_class = lockable_files.TransportLock
2377
def get_format_string(self):
2378
"""See BzrDirFormat.get_format_string()."""
2379
return "Bazaar-NG branch, format 5\n"
2381
def get_branch_format(self):
2382
from bzrlib import branch
2383
return branch.BzrBranchFormat4()
2385
def get_format_description(self):
2386
"""See BzrDirFormat.get_format_description()."""
2387
return "All-in-one format 5"
2389
def get_converter(self, format=None):
2390
"""See BzrDirFormat.get_converter()."""
2391
# there is one and only one upgrade path here.
2392
return ConvertBzrDir5To6()
2394
def _initialize_for_clone(self, url):
2395
return self.initialize_on_transport(get_transport(url), _cloning=True)
2397
def initialize_on_transport(self, transport, _cloning=False):
2398
"""Format 5 dirs always have working tree, branch and repository.
2400
Except when they are being cloned.
2402
from bzrlib.branch import BzrBranchFormat4
2403
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2404
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2405
RepositoryFormat5().initialize(result, _internal=True)
2407
branch = BzrBranchFormat4().initialize(result)
2408
result._init_workingtree()
2411
def network_name(self):
2412
return self.get_format_string()
2414
def _open(self, transport):
2415
"""See BzrDirFormat._open."""
2416
return BzrDir5(transport, self)
2418
def __return_repository_format(self):
2419
"""Circular import protection."""
2420
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2421
return RepositoryFormat5()
2422
repository_format = property(__return_repository_format)
2425
class BzrDirFormat6(BzrDirFormatAllInOne):
2426
"""Bzr control format 6.
2428
This format is a combined format for working tree, branch and repository.
2430
- Format 2 working trees [always]
2431
- Format 4 branches [always]
2432
- Format 6 repositories [always]
2435
_lock_class = lockable_files.TransportLock
2437
def get_format_string(self):
2438
"""See BzrDirFormat.get_format_string()."""
2439
return "Bazaar-NG branch, format 6\n"
2441
def get_format_description(self):
2442
"""See BzrDirFormat.get_format_description()."""
2443
return "All-in-one format 6"
2445
def get_branch_format(self):
2446
from bzrlib import branch
2447
return branch.BzrBranchFormat4()
2449
def get_converter(self, format=None):
2450
"""See BzrDirFormat.get_converter()."""
2451
# there is one and only one upgrade path here.
2452
return ConvertBzrDir6ToMeta()
2454
def _initialize_for_clone(self, url):
2455
return self.initialize_on_transport(get_transport(url), _cloning=True)
2457
def initialize_on_transport(self, transport, _cloning=False):
2458
"""Format 6 dirs always have working tree, branch and repository.
2460
Except when they are being cloned.
2462
from bzrlib.branch import BzrBranchFormat4
2463
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2464
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2465
RepositoryFormat6().initialize(result, _internal=True)
2467
branch = BzrBranchFormat4().initialize(result)
2468
result._init_workingtree()
2471
def network_name(self):
2472
return self.get_format_string()
2474
def _open(self, transport):
2475
"""See BzrDirFormat._open."""
2476
return BzrDir6(transport, self)
2478
def __return_repository_format(self):
2479
"""Circular import protection."""
2480
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2481
return RepositoryFormat6()
2482
repository_format = property(__return_repository_format)
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)
2485
1522
class BzrDirMetaFormat1(BzrDirFormat):
2677
1729
def __get_workingtree_format(self):
2678
1730
if self._workingtree_format is None:
2679
from bzrlib.workingtree import WorkingTreeFormat
2680
self._workingtree_format = WorkingTreeFormat.get_default_format()
1731
from bzrlib.workingtree import (
1732
format_registry as wt_format_registry,
1734
self._workingtree_format = wt_format_registry.get_default()
2681
1735
return self._workingtree_format
2683
1737
def __set_workingtree_format(self, wt_format):
2684
1738
self._workingtree_format = wt_format
1741
return "<%r>" % (self.__class__.__name__,)
2686
1743
workingtree_format = property(__get_workingtree_format,
2687
1744
__set_workingtree_format)
2690
network_format_registry = registry.FormatRegistry()
2691
"""Registry of formats indexed by their network name.
2693
The network name for a BzrDirFormat is an identifier that can be used when
2694
referring to formats with smart server operations. See
2695
BzrDirFormat.network_name() for more detail.
2699
# Register bzr control format
2700
BzrDirFormat.register_control_format(BzrDirFormat)
2702
1747
# Register bzr formats
2703
BzrDirFormat.register_format(BzrDirFormat4())
2704
BzrDirFormat.register_format(BzrDirFormat5())
2705
BzrDirFormat.register_format(BzrDirFormat6())
2706
__default_format = BzrDirMetaFormat1()
2707
BzrDirFormat.register_format(__default_format)
2708
BzrDirFormat._default_format = __default_format
2711
class Converter(object):
2712
"""Converts a disk format object from one format to another."""
2714
def convert(self, to_convert, pb):
2715
"""Perform the conversion of to_convert, giving feedback via pb.
2717
:param to_convert: The disk object to convert.
2718
:param pb: a progress bar to use for progress information.
2721
def step(self, message):
2722
"""Update the pb by a step."""
2724
self.pb.update(message, self.count, self.total)
2727
class ConvertBzrDir4To5(Converter):
2728
"""Converts format 4 bzr dirs to format 5."""
2731
super(ConvertBzrDir4To5, self).__init__()
2732
self.converted_revs = set()
2733
self.absent_revisions = set()
2737
def convert(self, to_convert, pb):
2738
"""See Converter.convert()."""
2739
self.bzrdir = to_convert
2741
warnings.warn("pb parameter to convert() is deprecated")
2742
self.pb = ui.ui_factory.nested_progress_bar()
2744
ui.ui_factory.note('starting upgrade from format 4 to 5')
2745
if isinstance(self.bzrdir.transport, local.LocalTransport):
2746
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2747
self._convert_to_weaves()
2748
return BzrDir.open(self.bzrdir.user_url)
2752
def _convert_to_weaves(self):
2753
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2756
stat = self.bzrdir.transport.stat('weaves')
2757
if not S_ISDIR(stat.st_mode):
2758
self.bzrdir.transport.delete('weaves')
2759
self.bzrdir.transport.mkdir('weaves')
2760
except errors.NoSuchFile:
2761
self.bzrdir.transport.mkdir('weaves')
2762
# deliberately not a WeaveFile as we want to build it up slowly.
2763
self.inv_weave = Weave('inventory')
2764
# holds in-memory weaves for all files
2765
self.text_weaves = {}
2766
self.bzrdir.transport.delete('branch-format')
2767
self.branch = self.bzrdir.open_branch()
2768
self._convert_working_inv()
2769
rev_history = self.branch.revision_history()
2770
# to_read is a stack holding the revisions we still need to process;
2771
# appending to it adds new highest-priority revisions
2772
self.known_revisions = set(rev_history)
2773
self.to_read = rev_history[-1:]
2775
rev_id = self.to_read.pop()
2776
if (rev_id not in self.revisions
2777
and rev_id not in self.absent_revisions):
2778
self._load_one_rev(rev_id)
2780
to_import = self._make_order()
2781
for i, rev_id in enumerate(to_import):
2782
self.pb.update('converting revision', i, len(to_import))
2783
self._convert_one_rev(rev_id)
2785
self._write_all_weaves()
2786
self._write_all_revs()
2787
ui.ui_factory.note('upgraded to weaves:')
2788
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2789
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2790
ui.ui_factory.note(' %6d texts' % self.text_count)
2791
self._cleanup_spare_files_after_format4()
2792
self.branch._transport.put_bytes(
2794
BzrDirFormat5().get_format_string(),
2795
mode=self.bzrdir._get_file_mode())
2797
def _cleanup_spare_files_after_format4(self):
2798
# FIXME working tree upgrade foo.
2799
for n in 'merged-patches', 'pending-merged-patches':
2801
## assert os.path.getsize(p) == 0
2802
self.bzrdir.transport.delete(n)
2803
except errors.NoSuchFile:
2805
self.bzrdir.transport.delete_tree('inventory-store')
2806
self.bzrdir.transport.delete_tree('text-store')
2808
def _convert_working_inv(self):
2809
inv = xml4.serializer_v4.read_inventory(
2810
self.branch._transport.get('inventory'))
2811
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2812
self.branch._transport.put_bytes('inventory', new_inv_xml,
2813
mode=self.bzrdir._get_file_mode())
2815
def _write_all_weaves(self):
2816
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2817
weave_transport = self.bzrdir.transport.clone('weaves')
2818
weaves = WeaveStore(weave_transport, prefixed=False)
2819
transaction = WriteTransaction()
2823
for file_id, file_weave in self.text_weaves.items():
2824
self.pb.update('writing weave', i, len(self.text_weaves))
2825
weaves._put_weave(file_id, file_weave, transaction)
2827
self.pb.update('inventory', 0, 1)
2828
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2829
self.pb.update('inventory', 1, 1)
2833
def _write_all_revs(self):
2834
"""Write all revisions out in new form."""
2835
self.bzrdir.transport.delete_tree('revision-store')
2836
self.bzrdir.transport.mkdir('revision-store')
2837
revision_transport = self.bzrdir.transport.clone('revision-store')
2839
from bzrlib.xml5 import serializer_v5
2840
from bzrlib.repofmt.weaverepo import RevisionTextStore
2841
revision_store = RevisionTextStore(revision_transport,
2842
serializer_v5, False, versionedfile.PrefixMapper(),
2843
lambda:True, lambda:True)
2845
for i, rev_id in enumerate(self.converted_revs):
2846
self.pb.update('write revision', i, len(self.converted_revs))
2847
text = serializer_v5.write_revision_to_string(
2848
self.revisions[rev_id])
2850
revision_store.add_lines(key, None, osutils.split_lines(text))
2854
def _load_one_rev(self, rev_id):
2855
"""Load a revision object into memory.
2857
Any parents not either loaded or abandoned get queued to be
2859
self.pb.update('loading revision',
2860
len(self.revisions),
2861
len(self.known_revisions))
2862
if not self.branch.repository.has_revision(rev_id):
2864
ui.ui_factory.note('revision {%s} not present in branch; '
2865
'will be converted as a ghost' %
2867
self.absent_revisions.add(rev_id)
2869
rev = self.branch.repository.get_revision(rev_id)
2870
for parent_id in rev.parent_ids:
2871
self.known_revisions.add(parent_id)
2872
self.to_read.append(parent_id)
2873
self.revisions[rev_id] = rev
2875
def _load_old_inventory(self, rev_id):
2876
f = self.branch.repository.inventory_store.get(rev_id)
2878
old_inv_xml = f.read()
2881
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2882
inv.revision_id = rev_id
2883
rev = self.revisions[rev_id]
2886
def _load_updated_inventory(self, rev_id):
2887
inv_xml = self.inv_weave.get_text(rev_id)
2888
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2891
def _convert_one_rev(self, rev_id):
2892
"""Convert revision and all referenced objects to new format."""
2893
rev = self.revisions[rev_id]
2894
inv = self._load_old_inventory(rev_id)
2895
present_parents = [p for p in rev.parent_ids
2896
if p not in self.absent_revisions]
2897
self._convert_revision_contents(rev, inv, present_parents)
2898
self._store_new_inv(rev, inv, present_parents)
2899
self.converted_revs.add(rev_id)
2901
def _store_new_inv(self, rev, inv, present_parents):
2902
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2903
new_inv_sha1 = sha_string(new_inv_xml)
2904
self.inv_weave.add_lines(rev.revision_id,
2906
new_inv_xml.splitlines(True))
2907
rev.inventory_sha1 = new_inv_sha1
2909
def _convert_revision_contents(self, rev, inv, present_parents):
2910
"""Convert all the files within a revision.
2912
Also upgrade the inventory to refer to the text revision ids."""
2913
rev_id = rev.revision_id
2914
mutter('converting texts of revision {%s}',
2916
parent_invs = map(self._load_updated_inventory, present_parents)
2917
entries = inv.iter_entries()
2919
for path, ie in entries:
2920
self._convert_file_version(rev, ie, parent_invs)
2922
def _convert_file_version(self, rev, ie, parent_invs):
2923
"""Convert one version of one file.
2925
The file needs to be added into the weave if it is a merge
2926
of >=2 parents or if it's changed from its parent.
2928
file_id = ie.file_id
2929
rev_id = rev.revision_id
2930
w = self.text_weaves.get(file_id)
2933
self.text_weaves[file_id] = w
2934
text_changed = False
2935
parent_candiate_entries = ie.parent_candidates(parent_invs)
2936
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2937
# XXX: Note that this is unordered - and this is tolerable because
2938
# the previous code was also unordered.
2939
previous_entries = dict((head, parent_candiate_entries[head]) for head
2941
self.snapshot_ie(previous_entries, ie, w, rev_id)
2944
def get_parent_map(self, revision_ids):
2945
"""See graph.StackedParentsProvider.get_parent_map"""
2946
return dict((revision_id, self.revisions[revision_id])
2947
for revision_id in revision_ids
2948
if revision_id in self.revisions)
2950
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2951
# TODO: convert this logic, which is ~= snapshot to
2952
# a call to:. This needs the path figured out. rather than a work_tree
2953
# a v4 revision_tree can be given, or something that looks enough like
2954
# one to give the file content to the entry if it needs it.
2955
# and we need something that looks like a weave store for snapshot to
2957
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2958
if len(previous_revisions) == 1:
2959
previous_ie = previous_revisions.values()[0]
2960
if ie._unchanged(previous_ie):
2961
ie.revision = previous_ie.revision
2964
f = self.branch.repository._text_store.get(ie.text_id)
2966
file_lines = f.readlines()
2969
w.add_lines(rev_id, previous_revisions, file_lines)
2970
self.text_count += 1
2972
w.add_lines(rev_id, previous_revisions, [])
2973
ie.revision = rev_id
2975
def _make_order(self):
2976
"""Return a suitable order for importing revisions.
2978
The order must be such that an revision is imported after all
2979
its (present) parents.
2981
todo = set(self.revisions.keys())
2982
done = self.absent_revisions.copy()
2985
# scan through looking for a revision whose parents
2987
for rev_id in sorted(list(todo)):
2988
rev = self.revisions[rev_id]
2989
parent_ids = set(rev.parent_ids)
2990
if parent_ids.issubset(done):
2991
# can take this one now
2992
order.append(rev_id)
2998
class ConvertBzrDir5To6(Converter):
2999
"""Converts format 5 bzr dirs to format 6."""
3001
def convert(self, to_convert, pb):
3002
"""See Converter.convert()."""
3003
self.bzrdir = to_convert
3004
pb = ui.ui_factory.nested_progress_bar()
3006
ui.ui_factory.note('starting upgrade from format 5 to 6')
3007
self._convert_to_prefixed()
3008
return BzrDir.open(self.bzrdir.user_url)
3012
def _convert_to_prefixed(self):
3013
from bzrlib.store import TransportStore
3014
self.bzrdir.transport.delete('branch-format')
3015
for store_name in ["weaves", "revision-store"]:
3016
ui.ui_factory.note("adding prefixes to %s" % store_name)
3017
store_transport = self.bzrdir.transport.clone(store_name)
3018
store = TransportStore(store_transport, prefixed=True)
3019
for urlfilename in store_transport.list_dir('.'):
3020
filename = urlutils.unescape(urlfilename)
3021
if (filename.endswith(".weave") or
3022
filename.endswith(".gz") or
3023
filename.endswith(".sig")):
3024
file_id, suffix = os.path.splitext(filename)
3028
new_name = store._mapper.map((file_id,)) + suffix
3029
# FIXME keep track of the dirs made RBC 20060121
3031
store_transport.move(filename, new_name)
3032
except errors.NoSuchFile: # catches missing dirs strangely enough
3033
store_transport.mkdir(osutils.dirname(new_name))
3034
store_transport.move(filename, new_name)
3035
self.bzrdir.transport.put_bytes(
3037
BzrDirFormat6().get_format_string(),
3038
mode=self.bzrdir._get_file_mode())
3041
class ConvertBzrDir6ToMeta(Converter):
3042
"""Converts format 6 bzr dirs to metadirs."""
3044
def convert(self, to_convert, pb):
3045
"""See Converter.convert()."""
3046
from bzrlib.repofmt.weaverepo import RepositoryFormat7
3047
from bzrlib.branch import BzrBranchFormat5
3048
self.bzrdir = to_convert
3049
self.pb = ui.ui_factory.nested_progress_bar()
3051
self.total = 20 # the steps we know about
3052
self.garbage_inventories = []
3053
self.dir_mode = self.bzrdir._get_dir_mode()
3054
self.file_mode = self.bzrdir._get_file_mode()
3056
ui.ui_factory.note('starting upgrade from format 6 to metadir')
3057
self.bzrdir.transport.put_bytes(
3059
"Converting to format 6",
3060
mode=self.file_mode)
3061
# its faster to move specific files around than to open and use the apis...
3062
# first off, nuke ancestry.weave, it was never used.
3064
self.step('Removing ancestry.weave')
3065
self.bzrdir.transport.delete('ancestry.weave')
3066
except errors.NoSuchFile:
3068
# find out whats there
3069
self.step('Finding branch files')
3070
last_revision = self.bzrdir.open_branch().last_revision()
3071
bzrcontents = self.bzrdir.transport.list_dir('.')
3072
for name in bzrcontents:
3073
if name.startswith('basis-inventory.'):
3074
self.garbage_inventories.append(name)
3075
# create new directories for repository, working tree and branch
3076
repository_names = [('inventory.weave', True),
3077
('revision-store', True),
3079
self.step('Upgrading repository ')
3080
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3081
self.make_lock('repository')
3082
# we hard code the formats here because we are converting into
3083
# the meta format. The meta format upgrader can take this to a
3084
# future format within each component.
3085
self.put_format('repository', RepositoryFormat7())
3086
for entry in repository_names:
3087
self.move_entry('repository', entry)
3089
self.step('Upgrading branch ')
3090
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
3091
self.make_lock('branch')
3092
self.put_format('branch', BzrBranchFormat5())
3093
branch_files = [('revision-history', True),
3094
('branch-name', True),
3096
for entry in branch_files:
3097
self.move_entry('branch', entry)
3099
checkout_files = [('pending-merges', True),
3100
('inventory', True),
3101
('stat-cache', False)]
3102
# If a mandatory checkout file is not present, the branch does not have
3103
# a functional checkout. Do not create a checkout in the converted
3105
for name, mandatory in checkout_files:
3106
if mandatory and name not in bzrcontents:
3107
has_checkout = False
3111
if not has_checkout:
3112
ui.ui_factory.note('No working tree.')
3113
# If some checkout files are there, we may as well get rid of them.
3114
for name, mandatory in checkout_files:
3115
if name in bzrcontents:
3116
self.bzrdir.transport.delete(name)
3118
from bzrlib.workingtree import WorkingTreeFormat3
3119
self.step('Upgrading working tree')
3120
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
3121
self.make_lock('checkout')
3123
'checkout', WorkingTreeFormat3())
3124
self.bzrdir.transport.delete_multi(
3125
self.garbage_inventories, self.pb)
3126
for entry in checkout_files:
3127
self.move_entry('checkout', entry)
3128
if last_revision is not None:
3129
self.bzrdir.transport.put_bytes(
3130
'checkout/last-revision', last_revision)
3131
self.bzrdir.transport.put_bytes(
3133
BzrDirMetaFormat1().get_format_string(),
3134
mode=self.file_mode)
3136
return BzrDir.open(self.bzrdir.user_url)
3138
def make_lock(self, name):
3139
"""Make a lock for the new control dir name."""
3140
self.step('Make %s lock' % name)
3141
ld = lockdir.LockDir(self.bzrdir.transport,
3143
file_modebits=self.file_mode,
3144
dir_modebits=self.dir_mode)
3147
def move_entry(self, new_dir, entry):
3148
"""Move then entry name into new_dir."""
3150
mandatory = entry[1]
3151
self.step('Moving %s' % name)
3153
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3154
except errors.NoSuchFile:
3158
def put_format(self, dirname, format):
3159
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3160
format.get_format_string(),
3164
class ConvertMetaToMeta(Converter):
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):
3165
1782
"""Converts the components of metadirs."""
3167
1784
def __init__(self, target_format):
3240
1856
return to_convert
3243
# This is not in remote.py because it's relatively small, and needs to be
3244
# registered. Putting it in remote.py creates a circular import problem.
3245
# we can make it a lazy object if the control formats is turned into something
3247
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3248
"""Format representing bzrdirs accessed via a smart server"""
3251
BzrDirMetaFormat1.__init__(self)
3252
# XXX: It's a bit ugly that the network name is here, because we'd
3253
# like to believe that format objects are stateless or at least
3254
# immutable, However, we do at least avoid mutating the name after
3255
# it's returned. See <https://bugs.launchpad.net/bzr/+bug/504102>
3256
self._network_name = None
3259
return "%s(_network_name=%r)" % (self.__class__.__name__,
3262
def get_format_description(self):
3263
if self._network_name:
3264
real_format = network_format_registry.get(self._network_name)
3265
return 'Remote: ' + real_format.get_format_description()
3266
return 'bzr remote bzrdir'
3268
def get_format_string(self):
3269
raise NotImplementedError(self.get_format_string)
3271
def network_name(self):
3272
if self._network_name:
3273
return self._network_name
3275
raise AssertionError("No network name set.")
3278
def probe_transport(klass, transport):
3279
"""Return a RemoteBzrDirFormat object if it looks possible."""
3281
medium = transport.get_smart_medium()
3282
except (NotImplementedError, AttributeError,
3283
errors.TransportNotPossible, errors.NoSmartMedium,
3284
errors.SmartProtocolError):
3285
# no smart server, so not a branch for this format type.
3286
raise errors.NotBranchError(path=transport.base)
3288
# Decline to open it if the server doesn't support our required
3289
# version (3) so that the VFS-based transport will do it.
3290
if medium.should_probe():
3292
server_version = medium.protocol_version()
3293
except errors.SmartProtocolError:
3294
# Apparently there's no usable smart server there, even though
3295
# the medium supports the smart protocol.
3296
raise errors.NotBranchError(path=transport.base)
3297
if server_version != '2':
3298
raise errors.NotBranchError(path=transport.base)
3301
def initialize_on_transport(self, transport):
3303
# hand off the request to the smart server
3304
client_medium = transport.get_smart_medium()
3305
except errors.NoSmartMedium:
3306
# TODO: lookup the local format from a server hint.
3307
local_dir_format = BzrDirMetaFormat1()
3308
return local_dir_format.initialize_on_transport(transport)
3309
client = _SmartClient(client_medium)
3310
path = client.remote_path_from_transport(transport)
3312
response = client.call('BzrDirFormat.initialize', path)
3313
except errors.ErrorFromSmartServer, err:
3314
remote._translate_error(err, path=path)
3315
if response[0] != 'ok':
3316
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3317
format = RemoteBzrDirFormat()
3318
self._supply_sub_formats_to(format)
3319
return remote.RemoteBzrDir(transport, format)
3321
def parse_NoneTrueFalse(self, arg):
3328
raise AssertionError("invalid arg %r" % arg)
3330
def _serialize_NoneTrueFalse(self, arg):
3337
def _serialize_NoneString(self, arg):
3340
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3341
create_prefix=False, force_new_repo=False, stacked_on=None,
3342
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3345
# hand off the request to the smart server
3346
client_medium = transport.get_smart_medium()
3347
except errors.NoSmartMedium:
3350
# Decline to open it if the server doesn't support our required
3351
# version (3) so that the VFS-based transport will do it.
3352
if client_medium.should_probe():
3354
server_version = client_medium.protocol_version()
3355
if server_version != '2':
3359
except errors.SmartProtocolError:
3360
# Apparently there's no usable smart server there, even though
3361
# the medium supports the smart protocol.
3366
client = _SmartClient(client_medium)
3367
path = client.remote_path_from_transport(transport)
3368
if client_medium._is_remote_before((1, 16)):
3371
# TODO: lookup the local format from a server hint.
3372
local_dir_format = BzrDirMetaFormat1()
3373
self._supply_sub_formats_to(local_dir_format)
3374
return local_dir_format.initialize_on_transport_ex(transport,
3375
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3376
force_new_repo=force_new_repo, stacked_on=stacked_on,
3377
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3378
make_working_trees=make_working_trees, shared_repo=shared_repo,
3380
return self._initialize_on_transport_ex_rpc(client, path, transport,
3381
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3382
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3384
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3385
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3386
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3388
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3389
args.append(self._serialize_NoneTrueFalse(create_prefix))
3390
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3391
args.append(self._serialize_NoneString(stacked_on))
3392
# stack_on_pwd is often/usually our transport
3395
stack_on_pwd = transport.relpath(stack_on_pwd)
3396
if not stack_on_pwd:
3398
except errors.PathNotChild:
3400
args.append(self._serialize_NoneString(stack_on_pwd))
3401
args.append(self._serialize_NoneString(repo_format_name))
3402
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3403
args.append(self._serialize_NoneTrueFalse(shared_repo))
3404
request_network_name = self._network_name or \
3405
BzrDirFormat.get_default_format().network_name()
3407
response = client.call('BzrDirFormat.initialize_ex_1.16',
3408
request_network_name, path, *args)
3409
except errors.UnknownSmartMethod:
3410
client._medium._remember_remote_is_before((1,16))
3411
local_dir_format = BzrDirMetaFormat1()
3412
self._supply_sub_formats_to(local_dir_format)
3413
return local_dir_format.initialize_on_transport_ex(transport,
3414
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3415
force_new_repo=force_new_repo, stacked_on=stacked_on,
3416
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3417
make_working_trees=make_working_trees, shared_repo=shared_repo,
3419
except errors.ErrorFromSmartServer, err:
3420
remote._translate_error(err, path=path)
3421
repo_path = response[0]
3422
bzrdir_name = response[6]
3423
require_stacking = response[7]
3424
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3425
format = RemoteBzrDirFormat()
3426
format._network_name = bzrdir_name
3427
self._supply_sub_formats_to(format)
3428
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3430
repo_format = remote.response_tuple_to_repo_format(response[1:])
3431
if repo_path == '.':
3434
repo_bzrdir_format = RemoteBzrDirFormat()
3435
repo_bzrdir_format._network_name = response[5]
3436
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3440
final_stack = response[8] or None
3441
final_stack_pwd = response[9] or None
3443
final_stack_pwd = urlutils.join(
3444
transport.base, final_stack_pwd)
3445
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3446
if len(response) > 10:
3447
# Updated server verb that locks remotely.
3448
repo_lock_token = response[10] or None
3449
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3451
remote_repo.dont_leave_lock_in_place()
3453
remote_repo.lock_write()
3454
policy = UseExistingRepository(remote_repo, final_stack,
3455
final_stack_pwd, require_stacking)
3456
policy.acquire_repository()
3460
bzrdir._format.set_branch_format(self.get_branch_format())
3461
if require_stacking:
3462
# The repo has already been created, but we need to make sure that
3463
# we'll make a stackable branch.
3464
bzrdir._format.require_stacking(_skip_repo=True)
3465
return remote_repo, bzrdir, require_stacking, policy
3467
def _open(self, transport):
3468
return remote.RemoteBzrDir(transport, self)
3470
def __eq__(self, other):
3471
if not isinstance(other, RemoteBzrDirFormat):
3473
return self.get_format_description() == other.get_format_description()
3475
def __return_repository_format(self):
3476
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3477
# repository format has been asked for, tell the RemoteRepositoryFormat
3478
# that it should use that for init() etc.
3479
result = remote.RemoteRepositoryFormat()
3480
custom_format = getattr(self, '_repository_format', None)
3482
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3483
return custom_format
3485
# We will use the custom format to create repositories over the
3486
# wire; expose its details like rich_root_data for code to
3488
result._custom_format = custom_format
3491
def get_branch_format(self):
3492
result = BzrDirMetaFormat1.get_branch_format(self)
3493
if not isinstance(result, remote.RemoteBranchFormat):
3494
new_result = remote.RemoteBranchFormat()
3495
new_result._custom_format = result
3497
self.set_branch_format(new_result)
3501
repository_format = property(__return_repository_format,
3502
BzrDirMetaFormat1._set_repository_format) #.im_func)
3505
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3508
class BzrDirFormatInfo(object):
3510
def __init__(self, native, deprecated, hidden, experimental):
3511
self.deprecated = deprecated
3512
self.native = native
3513
self.hidden = hidden
3514
self.experimental = experimental
3517
class BzrDirFormatRegistry(registry.Registry):
3518
"""Registry of user-selectable BzrDir subformats.
3520
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3521
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3525
"""Create a BzrDirFormatRegistry."""
3526
self._aliases = set()
3527
self._registration_order = list()
3528
super(BzrDirFormatRegistry, self).__init__()
3531
"""Return a set of the format names which are aliases."""
3532
return frozenset(self._aliases)
3534
def register_metadir(self, key,
3535
repository_format, help, native=True, deprecated=False,
3541
"""Register a metadir subformat.
3543
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3544
by the Repository/Branch/WorkingTreeformats.
3546
:param repository_format: The fully-qualified repository format class
3548
:param branch_format: Fully-qualified branch format class name as
3550
:param tree_format: Fully-qualified tree format class name as
3553
# This should be expanded to support setting WorkingTree and Branch
3554
# formats, once BzrDirMetaFormat1 supports that.
3555
def _load(full_name):
3556
mod_name, factory_name = full_name.rsplit('.', 1)
3558
mod = __import__(mod_name, globals(), locals(),
3560
except ImportError, e:
3561
raise ImportError('failed to load %s: %s' % (full_name, e))
3563
factory = getattr(mod, factory_name)
3564
except AttributeError:
3565
raise AttributeError('no factory %s in module %r'
3570
bd = BzrDirMetaFormat1()
3571
if branch_format is not None:
3572
bd.set_branch_format(_load(branch_format))
3573
if tree_format is not None:
3574
bd.workingtree_format = _load(tree_format)
3575
if repository_format is not None:
3576
bd.repository_format = _load(repository_format)
3578
self.register(key, helper, help, native, deprecated, hidden,
3579
experimental, alias)
3581
def register(self, key, factory, help, native=True, deprecated=False,
3582
hidden=False, experimental=False, alias=False):
3583
"""Register a BzrDirFormat factory.
3585
The factory must be a callable that takes one parameter: the key.
3586
It must produce an instance of the BzrDirFormat when called.
3588
This function mainly exists to prevent the info object from being
3591
registry.Registry.register(self, key, factory, help,
3592
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3594
self._aliases.add(key)
3595
self._registration_order.append(key)
3597
def register_lazy(self, key, module_name, member_name, help, native=True,
3598
deprecated=False, hidden=False, experimental=False, alias=False):
3599
registry.Registry.register_lazy(self, key, module_name, member_name,
3600
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3602
self._aliases.add(key)
3603
self._registration_order.append(key)
3605
def set_default(self, key):
3606
"""Set the 'default' key to be a clone of the supplied key.
3608
This method must be called once and only once.
3610
registry.Registry.register(self, 'default', self.get(key),
3611
self.get_help(key), info=self.get_info(key))
3612
self._aliases.add('default')
3614
def set_default_repository(self, key):
3615
"""Set the FormatRegistry default and Repository default.
3617
This is a transitional method while Repository.set_default_format
3620
if 'default' in self:
3621
self.remove('default')
3622
self.set_default(key)
3623
format = self.get('default')()
3625
def make_bzrdir(self, key):
3626
return self.get(key)()
3628
def help_topic(self, topic):
3630
default_realkey = None
3631
default_help = self.get_help('default')
3633
for key in self._registration_order:
3634
if key == 'default':
3636
help = self.get_help(key)
3637
if help == default_help:
3638
default_realkey = key
3640
help_pairs.append((key, help))
3642
def wrapped(key, help, info):
3644
help = '(native) ' + help
3645
return ':%s:\n%s\n\n' % (key,
3646
textwrap.fill(help, initial_indent=' ',
3647
subsequent_indent=' ',
3648
break_long_words=False))
3649
if default_realkey is not None:
3650
output += wrapped(default_realkey, '(default) %s' % default_help,
3651
self.get_info('default'))
3652
deprecated_pairs = []
3653
experimental_pairs = []
3654
for key, help in help_pairs:
3655
info = self.get_info(key)
3658
elif info.deprecated:
3659
deprecated_pairs.append((key, help))
3660
elif info.experimental:
3661
experimental_pairs.append((key, help))
3663
output += wrapped(key, help, info)
3664
output += "\nSee :doc:`formats-help` for more about storage formats."
3666
if len(experimental_pairs) > 0:
3667
other_output += "Experimental formats are shown below.\n\n"
3668
for key, help in experimental_pairs:
3669
info = self.get_info(key)
3670
other_output += wrapped(key, help, info)
3673
"No experimental formats are available.\n\n"
3674
if len(deprecated_pairs) > 0:
3675
other_output += "\nDeprecated formats are shown below.\n\n"
3676
for key, help in deprecated_pairs:
3677
info = self.get_info(key)
3678
other_output += wrapped(key, help, info)
3681
"\nNo deprecated formats are available.\n\n"
3683
"\nSee :doc:`formats-help` for more about storage formats."
3685
if topic == 'other-formats':
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)
3691
1897
class RepositoryAcquisitionPolicy(object):
3835
2049
require_stacking)
3836
2050
self._repository = repository
3838
def acquire_repository(self, make_working_trees=None, shared=False):
2052
def acquire_repository(self, make_working_trees=None, shared=False,
2053
possible_transports=None):
3839
2054
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3841
2056
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)
3843
2063
self._add_fallback(self._repository,
3844
possible_transports=[self._repository.bzrdir.transport])
2064
possible_transports=possible_transports)
3845
2065
return self._repository, False
3848
# Please register new formats after old formats so that formats
3849
# appear in chronological order and format descriptions can build
3851
format_registry = BzrDirFormatRegistry()
3852
# The pre-0.8 formats have their repository format network name registered in
3853
# repository.py. MetaDir formats have their repository format network name
3854
# inferred from their disk format string.
3855
format_registry.register('weave', BzrDirFormat6,
3856
'Pre-0.8 format. Slower than knit and does not'
3857
' support checkouts or shared repositories.',
3860
format_registry.register_metadir('metaweave',
3861
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3862
'Transitional format in 0.8. Slower than knit.',
3863
branch_format='bzrlib.branch.BzrBranchFormat5',
3864
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3867
format_registry.register_metadir('knit',
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',
3868
2115
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
2116
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3870
branch_format='bzrlib.branch.BzrBranchFormat5',
3871
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3874
format_registry.register_metadir('dirstate',
3875
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3876
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3877
'above when accessed over the network.',
3878
branch_format='bzrlib.branch.BzrBranchFormat5',
3879
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3880
# directly from workingtree_4 triggers a circular import.
3881
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3884
format_registry.register_metadir('dirstate-tags',
3885
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3886
help='New in 0.15: Fast local operations and improved scaling for '
3887
'network operations. Additionally adds support for tags.'
3888
' Incompatible with bzr < 0.15.',
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.',
3889
2134
branch_format='bzrlib.branch.BzrBranchFormat6',
3890
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2135
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3892
2137
deprecated=True)
3893
format_registry.register_metadir('rich-root',
2138
register_metadir(controldir.format_registry, 'rich-root',
3894
2139
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3895
help='New in 1.0. Better handling of tree roots. Incompatible with'
2140
help='Variant of dirstate with better handling of tree roots. '
2141
'Introduced in bzr 1.0',
3897
2142
branch_format='bzrlib.branch.BzrBranchFormat6',
3898
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2143
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3900
2145
deprecated=True)
3901
format_registry.register_metadir('dirstate-with-subtree',
2146
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
3902
2147
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3903
help='New in 0.15: Fast local operations and improved scaling for '
3904
'network operations. Additionally adds support for versioning nested '
3905
'bzr branches. Incompatible with bzr < 0.15.',
3906
branch_format='bzrlib.branch.BzrBranchFormat6',
3907
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3911
format_registry.register_metadir('pack-0.92',
3912
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3913
help='New in 0.92: Pack-based format with data compatible with '
3914
'dirstate-tags format repositories. Interoperates with '
3915
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3917
branch_format='bzrlib.branch.BzrBranchFormat6',
3918
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3920
format_registry.register_metadir('pack-0.92-subtree',
3921
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3922
help='New in 0.92: Pack-based format with data compatible with '
3923
'dirstate-with-subtree format repositories. Interoperates with '
3924
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3926
branch_format='bzrlib.branch.BzrBranchFormat6',
3927
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3931
format_registry.register_metadir('rich-root-pack',
3932
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3933
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3934
'(needed for bzr-svn and bzr-git).',
3935
branch_format='bzrlib.branch.BzrBranchFormat6',
3936
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3939
format_registry.register_metadir('1.6',
3940
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
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',
3941
2188
help='A format that allows a branch to indicate that there is another '
3942
2189
'(stacked) repository that should be used to access data that is '
3943
2190
'not present locally.',
3944
2191
branch_format='bzrlib.branch.BzrBranchFormat7',
3945
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2192
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3948
format_registry.register_metadir('1.6.1-rich-root',
3949
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
2196
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2197
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
3950
2198
help='A variant of 1.6 that supports rich-root data '
3951
2199
'(needed for bzr-svn and bzr-git).',
3952
2200
branch_format='bzrlib.branch.BzrBranchFormat7',
3953
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2201
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3956
format_registry.register_metadir('1.9',
3957
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2205
register_metadir(controldir.format_registry, '1.9',
2206
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
3958
2207
help='A repository format using B+tree indexes. These indexes '
3959
2208
'are smaller in size, have smarter caching and provide faster '
3960
2209
'performance for most operations.',
3961
2210
branch_format='bzrlib.branch.BzrBranchFormat7',
3962
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2211
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3965
format_registry.register_metadir('1.9-rich-root',
3966
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2215
register_metadir(controldir.format_registry, '1.9-rich-root',
2216
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
3967
2217
help='A variant of 1.9 that supports rich-root data '
3968
2218
'(needed for bzr-svn and bzr-git).',
3969
2219
branch_format='bzrlib.branch.BzrBranchFormat7',
3970
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2220
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3973
format_registry.register_metadir('1.14',
3974
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2224
register_metadir(controldir.format_registry, '1.14',
2225
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
3975
2226
help='A working-tree format that supports content filtering.',
3976
2227
branch_format='bzrlib.branch.BzrBranchFormat7',
3977
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2228
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
3979
format_registry.register_metadir('1.14-rich-root',
3980
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2232
register_metadir(controldir.format_registry, '1.14-rich-root',
2233
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
3981
2234
help='A variant of 1.14 that supports rich-root data '
3982
2235
'(needed for bzr-svn and bzr-git).',
3983
2236
branch_format='bzrlib.branch.BzrBranchFormat7',
3984
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2237
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
3986
2241
# The following un-numbered 'development' formats should always just be aliases.
3987
format_registry.register_metadir('development-rich-root',
3988
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3989
help='Current development format. Supports rich roots. Can convert data '
3990
'to and from rich-root-pack (and anything compatible with '
3991
'rich-root-pack) format repositories. Repositories and branches in '
3992
'this format can only be read by bzr.dev. Please read '
3993
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3995
branch_format='bzrlib.branch.BzrBranchFormat7',
3996
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4001
format_registry.register_metadir('development-subtree',
4002
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
2242
register_metadir(controldir.format_registry, 'development-subtree',
2243
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
4003
2244
help='Current development format, subtree variant. Can convert data to and '
4004
2245
'from pack-0.92-subtree (and anything compatible with '
4005
2246
'pack-0.92-subtree) format repositories. Repositories and branches in '
4007
2248
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4009
2250
branch_format='bzrlib.branch.BzrBranchFormat7',
4010
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2251
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
4011
2252
experimental=True,
4013
2254
alias=False, # Restore to being an alias when an actual development subtree format is added
4014
2255
# This current non-alias status is simply because we did not introduce a
4015
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,
4018
2283
# And the development formats above will have aliased one of the following:
4019
format_registry.register_metadir('development6-rich-root',
4020
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4021
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4023
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4025
branch_format='bzrlib.branch.BzrBranchFormat7',
4026
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4031
format_registry.register_metadir('development7-rich-root',
4032
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4033
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4034
'rich roots. Please read '
4035
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4037
branch_format='bzrlib.branch.BzrBranchFormat7',
4038
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4043
format_registry.register_metadir('2a',
2285
# Finally, the current format.
2286
register_metadir(controldir.format_registry, '2a',
4044
2287
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4045
help='First format for bzr 2.0 series.\n'
2288
help='Format for the bzr 2.0 series.\n'
4046
2289
'Uses group-compress storage.\n'
4047
2290
'Provides rich roots which are a one-way transition.\n',
4048
2291
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4049
2292
# 'rich roots. Supported by bzr 1.16 and later.',
4050
2293
branch_format='bzrlib.branch.BzrBranchFormat7',
4051
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2294
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
4055
2298
# The following format should be an alias for the rich root equivalent
4056
2299
# of the default format
4057
format_registry.register_metadir('default-rich-root',
2300
register_metadir(controldir.format_registry, 'default-rich-root',
4058
2301
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4059
2302
branch_format='bzrlib.branch.BzrBranchFormat7',
4060
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2303
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
4063
2306
help='Same as 2a.')
4065
2308
# The current format that is made on 'bzr init'.
4066
format_registry.set_default('2a')
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
added
removed
bzrlib/bzrdir.py
