326
232
# TODO: This should be given a Transport, and should chdir up; otherwise
327
233
# this will open a new connection.
328
234
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()
235
t = _mod_transport.get_transport(url)
472
238
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
473
239
stack_on_pwd=None, require_stacking=False):
535
301
policy = self.determine_repository_policy(force_new_repo)
536
302
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.
304
def _find_source_repo(self, add_cleanup, source_branch):
305
"""Find the source branch and repo for a sprout operation.
307
This is helper intended for use by _sprout.
309
:returns: (source_branch, source_repository). Either or both may be
310
None. If not None, they will be read-locked (and their unlock(s)
311
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):
313
if source_branch is not None:
314
add_cleanup(source_branch.lock_read().unlock)
315
return source_branch, source_branch.repository
317
source_branch = self.open_branch()
318
source_repository = source_branch.repository
319
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)
322
source_repository = self.open_repository()
323
except errors.NoRepositoryPresent:
324
source_repository = None
326
add_cleanup(source_repository.lock_read().unlock)
328
add_cleanup(source_branch.lock_read().unlock)
329
return source_branch, source_repository
331
def sprout(self, url, revision_id=None, force_new_repo=False,
332
recurse='down', possible_transports=None,
333
accelerator_tree=None, hardlink=False, stacked=False,
334
source_branch=None, create_tree_if_local=True):
335
"""Create a copy of this controldir prepared for use as a new line of
338
If url's last component does not exist, it will be created.
340
Attributes related to the identity of the source branch like
341
branch nickname will be cleaned, a working tree is created
342
whether one existed before or not; and a local branch is always
345
if revision_id is not None, then the clone operation may tune
346
itself to download less data.
611
348
:param accelerator_tree: A tree which can be used for retrieving file
612
349
contents more quickly than the revision tree, i.e. a workingtree.
613
350
The revision tree will be used for cases where accelerator_tree's
614
351
content is different.
616
raise NotImplementedError(self.create_workingtree)
352
:param hardlink: If true, hard-link files from accelerator_tree,
354
:param stacked: If true, create a stacked branch referring to the
355
location of this control directory.
356
:param create_tree_if_local: If true, a working-tree will be created
357
when working locally.
359
operation = cleanup.OperationWithCleanups(self._sprout)
360
return operation.run(url, revision_id=revision_id,
361
force_new_repo=force_new_repo, recurse=recurse,
362
possible_transports=possible_transports,
363
accelerator_tree=accelerator_tree, hardlink=hardlink,
364
stacked=stacked, source_branch=source_branch,
365
create_tree_if_local=create_tree_if_local)
367
def _sprout(self, op, url, revision_id=None, force_new_repo=False,
368
recurse='down', possible_transports=None,
369
accelerator_tree=None, hardlink=False, stacked=False,
370
source_branch=None, create_tree_if_local=True):
371
add_cleanup = op.add_cleanup
372
fetch_spec_factory = fetch.FetchSpecFactory()
373
if revision_id is not None:
374
fetch_spec_factory.add_revision_ids([revision_id])
375
fetch_spec_factory.source_branch_stop_revision_id = revision_id
376
if possible_transports is None:
377
possible_transports = []
379
possible_transports = list(possible_transports) + [
381
target_transport = _mod_transport.get_transport(url,
383
target_transport.ensure_base()
384
cloning_format = self.cloning_metadir(stacked)
385
# Create/update the result branch
387
result = controldir.ControlDir.open_from_transport(target_transport)
388
except errors.NotBranchError:
389
result = cloning_format.initialize_on_transport(target_transport)
390
source_branch, source_repository = self._find_source_repo(
391
add_cleanup, source_branch)
392
fetch_spec_factory.source_branch = source_branch
393
# if a stacked branch wasn't requested, we don't create one
394
# even if the origin was stacked
395
if stacked and source_branch is not None:
396
stacked_branch_url = self.root_transport.base
398
stacked_branch_url = None
399
repository_policy = result.determine_repository_policy(
400
force_new_repo, stacked_branch_url, require_stacking=stacked)
401
result_repo, is_new_repo = repository_policy.acquire_repository(
402
possible_transports=possible_transports)
403
add_cleanup(result_repo.lock_write().unlock)
404
fetch_spec_factory.source_repo = source_repository
405
fetch_spec_factory.target_repo = result_repo
406
if stacked or (len(result_repo._fallback_repositories) != 0):
407
target_repo_kind = fetch.TargetRepoKinds.STACKED
409
target_repo_kind = fetch.TargetRepoKinds.EMPTY
411
target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
412
fetch_spec_factory.target_repo_kind = target_repo_kind
413
if source_repository is not None:
414
fetch_spec = fetch_spec_factory.make_fetch_spec()
415
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
417
if source_branch is None:
418
# this is for sprouting a controldir without a branch; is that
420
# Not especially, but it's part of the contract.
421
result_branch = result.create_branch()
423
result_branch = source_branch.sprout(result,
424
revision_id=revision_id, repository_policy=repository_policy,
425
repository=result_repo)
426
mutter("created new branch %r" % (result_branch,))
428
# Create/update the result working tree
429
if (create_tree_if_local and not result.has_workingtree() and
430
isinstance(target_transport, local.LocalTransport) and
431
(result_repo is None or result_repo.make_working_trees())):
432
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
433
hardlink=hardlink, from_branch=result_branch)
436
if wt.path2id('') is None:
438
wt.set_root_id(self.open_workingtree.get_root_id())
439
except errors.NoWorkingTree:
445
if recurse == 'down':
448
basis = wt.basis_tree()
449
elif result_branch is not None:
450
basis = result_branch.basis_tree()
451
elif source_branch is not None:
452
basis = source_branch.basis_tree()
453
if basis is not None:
454
add_cleanup(basis.lock_read().unlock)
455
subtrees = basis.iter_references()
458
for path, file_id in subtrees:
459
target = urlutils.join(url, urlutils.escape(path))
460
sublocation = source_branch.reference_parent(file_id, path)
461
sublocation.bzrdir.sprout(target,
462
basis.get_reference_revision(file_id, path),
463
force_new_repo=force_new_repo, recurse=recurse,
467
@deprecated_method(deprecated_in((2, 3, 0)))
468
def generate_backup_name(self, base):
469
return self._available_backup_name(base)
471
def _available_backup_name(self, base):
472
"""Find a non-existing backup file name based on base.
474
See bzrlib.osutils.available_backup_name about race conditions.
476
return osutils.available_backup_name(base, self.root_transport.has)
618
478
def backup_bzrdir(self):
619
479
"""Backup this bzr control directory.
621
481
: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
484
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
486
old_path = self.root_transport.abspath('.bzr')
487
backup_dir = self._available_backup_name('backup.bzr')
639
488
new_path = self.root_transport.abspath(backup_dir)
640
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
489
ui.ui_factory.note(gettext('making backup of {0}\n to {1}').format(
490
urlutils.unescape_for_display(old_path, 'utf-8'),
491
urlutils.unescape_for_display(new_path, 'utf-8')))
641
492
self.root_transport.copy_tree('.bzr', backup_dir)
642
493
return (old_path, new_path)
880
666
# add new tests for it to the appropriate place.
881
667
return filename == '.bzr' or filename.startswith('.bzr/')
883
def needs_format_conversion(self, format=None):
884
"""Return true if this bzrdir needs convert_format run on it.
886
For instance, if the repository format is out of date but the
887
branch and working tree are not, this should return True.
889
:param format: Optional parameter indicating a specific desired
890
format we plan to arrive at.
892
raise NotImplementedError(self.needs_format_conversion)
895
def open_unsupported(base):
896
"""Open a branch which is not supported."""
897
return BzrDir.open(base, _unsupported=True)
900
def open(base, _unsupported=False, possible_transports=None):
901
"""Open an existing bzrdir, rooted at 'base' (url).
903
:param _unsupported: a private parameter to the BzrDir class.
905
t = get_transport(base, possible_transports=possible_transports)
906
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
909
def open_from_transport(transport, _unsupported=False,
910
_server_formats=True):
911
"""Open a bzrdir within a particular directory.
913
:param transport: Transport containing the bzrdir.
914
:param _unsupported: private.
916
for hook in BzrDir.hooks['pre_open']:
918
# Keep initial base since 'transport' may be modified while following
920
base = transport.base
921
def find_format(transport):
922
return transport, BzrDirFormat.find_format(
923
transport, _server_formats=_server_formats)
925
def redirected(transport, e, redirection_notice):
926
redirected_transport = transport._redirected_to(e.source, e.target)
927
if redirected_transport is None:
928
raise errors.NotBranchError(base)
929
note('%s is%s redirected to %s',
930
transport.base, e.permanently, redirected_transport.base)
931
return redirected_transport
934
transport, format = do_catching_redirections(find_format,
937
except errors.TooManyRedirections:
938
raise errors.NotBranchError(base)
940
BzrDir._check_supported(format, _unsupported)
941
return format.open(transport, _found=True)
943
def open_branch(self, name=None, unsupported=False,
944
ignore_fallbacks=False):
945
"""Open the branch object at this BzrDir if one is present.
947
If unsupported is True, then no longer supported branch formats can
950
TODO: static convenience version of this?
952
raise NotImplementedError(self.open_branch)
955
def open_containing(url, possible_transports=None):
956
"""Open an existing branch which contains url.
958
:param url: url to search from.
959
See open_containing_from_transport for more detail.
961
transport = get_transport(url, possible_transports)
962
return BzrDir.open_containing_from_transport(transport)
965
def open_containing_from_transport(a_transport):
966
"""Open an existing branch which contains a_transport.base.
968
This probes for a branch at a_transport, and searches upwards from there.
970
Basically we keep looking up until we find the control directory or
971
run into the root. If there isn't one, raises NotBranchError.
972
If there is one and it is either an unrecognised format or an unsupported
973
format, UnknownFormatError or UnsupportedFormatError are raised.
974
If there is one, it is returned, along with the unused portion of url.
976
:return: The BzrDir that contains the path, and a Unicode path
977
for the rest of the URL.
979
# this gets the normalised url back. I.e. '.' -> the full path.
980
url = a_transport.base
983
result = BzrDir.open_from_transport(a_transport)
984
return result, urlutils.unescape(a_transport.relpath(url))
985
except errors.NotBranchError, e:
988
new_t = a_transport.clone('..')
989
except errors.InvalidURLJoin:
990
# reached the root, whatever that may be
991
raise errors.NotBranchError(path=url)
992
if new_t.base == a_transport.base:
993
# reached the root, whatever that may be
994
raise errors.NotBranchError(path=url)
997
def _get_tree_branch(self):
998
"""Return the branch and tree, if any, for this bzrdir.
1000
Return None for tree if not present or inaccessible.
1001
Raise NotBranchError if no branch is present.
1002
:return: (tree, branch)
1005
tree = self.open_workingtree()
1006
except (errors.NoWorkingTree, errors.NotLocalUrl):
1008
branch = self.open_branch()
1010
branch = tree.branch
1014
def open_tree_or_branch(klass, location):
1015
"""Return the branch and working tree at a location.
1017
If there is no tree at the location, tree will be None.
1018
If there is no branch at the location, an exception will be
1020
:return: (tree, branch)
1022
bzrdir = klass.open(location)
1023
return bzrdir._get_tree_branch()
1026
def open_containing_tree_or_branch(klass, location):
1027
"""Return the branch and working tree contained by a location.
1029
Returns (tree, branch, relpath).
1030
If there is no tree at containing the location, tree will be None.
1031
If there is no branch containing the location, an exception will be
1033
relpath is the portion of the path that is contained by the branch.
1035
bzrdir, relpath = klass.open_containing(location)
1036
tree, branch = bzrdir._get_tree_branch()
1037
return tree, branch, relpath
1040
def open_containing_tree_branch_or_repository(klass, location):
1041
"""Return the working tree, branch and repo contained by a location.
1043
Returns (tree, branch, repository, relpath).
1044
If there is no tree containing the location, tree will be None.
1045
If there is no branch containing the location, branch will be None.
1046
If there is no repository containing the location, repository will be
1048
relpath is the portion of the path that is contained by the innermost
1051
If no tree, branch or repository is found, a NotBranchError is raised.
1053
bzrdir, relpath = klass.open_containing(location)
1055
tree, branch = bzrdir._get_tree_branch()
1056
except errors.NotBranchError:
1058
repo = bzrdir.find_repository()
1059
return None, None, repo, relpath
1060
except (errors.NoRepositoryPresent):
1061
raise errors.NotBranchError(location)
1062
return tree, branch, branch.repository, relpath
1064
def open_repository(self, _unsupported=False):
1065
"""Open the repository object at this BzrDir if one is present.
1067
This will not follow the Branch object pointer - it's strictly a direct
1068
open facility. Most client code should use open_branch().repository to
1069
get at a repository.
1071
:param _unsupported: a private parameter, not part of the api.
1072
TODO: static convenience version of this?
1074
raise NotImplementedError(self.open_repository)
1076
def open_workingtree(self, _unsupported=False,
1077
recommend_upgrade=True, from_branch=None):
1078
"""Open the workingtree object at this BzrDir if one is present.
1080
:param recommend_upgrade: Optional keyword parameter, when True (the
1081
default), emit through the ui module a recommendation that the user
1082
upgrade the working tree when the workingtree being opened is old
1083
(but still fully supported).
1084
:param from_branch: override bzrdir branch (for lightweight checkouts)
1086
raise NotImplementedError(self.open_workingtree)
1088
def has_branch(self, name=None):
1089
"""Tell if this bzrdir contains a branch.
1091
Note: if you're going to open the branch, you should just go ahead
1092
and try, and not ask permission first. (This method just opens the
1093
branch and discards it, and that's somewhat expensive.)
1096
self.open_branch(name)
1098
except errors.NotBranchError:
1101
def has_workingtree(self):
1102
"""Tell if this bzrdir contains a working tree.
1104
This will still raise an exception if the bzrdir has a workingtree that
1105
is remote & inaccessible.
1107
Note: if you're going to open the working tree, you should just go ahead
1108
and try, and not ask permission first. (This method just opens the
1109
workingtree and discards it, and that's somewhat expensive.)
1112
self.open_workingtree(recommend_upgrade=False)
1114
except errors.NoWorkingTree:
1117
669
def _cloning_metadir(self):
1118
670
"""Produce a metadir suitable for cloning with.
1177
729
format.require_stacking()
1180
def checkout_metadir(self):
1181
return self.cloning_metadir()
1183
def sprout(self, url, revision_id=None, force_new_repo=False,
1184
recurse='down', possible_transports=None,
1185
accelerator_tree=None, hardlink=False, stacked=False,
1186
source_branch=None, create_tree_if_local=True):
1187
"""Create a copy of this bzrdir prepared for use as a new line of
1190
If url's last component does not exist, it will be created.
1192
Attributes related to the identity of the source branch like
1193
branch nickname will be cleaned, a working tree is created
1194
whether one existed before or not; and a local branch is always
1197
if revision_id is not None, then the clone operation may tune
1198
itself to download less data.
1199
:param accelerator_tree: A tree which can be used for retrieving file
1200
contents more quickly than the revision tree, i.e. a workingtree.
1201
The revision tree will be used for cases where accelerator_tree's
1202
content is different.
1203
:param hardlink: If true, hard-link files from accelerator_tree,
1205
:param stacked: If true, create a stacked branch referring to the
1206
location of this control directory.
1207
:param create_tree_if_local: If true, a working-tree will be created
1208
when working locally.
1210
target_transport = get_transport(url, possible_transports)
1211
target_transport.ensure_base()
1212
cloning_format = self.cloning_metadir(stacked)
1213
# Create/update the result branch
1214
result = cloning_format.initialize_on_transport(target_transport)
1215
# if a stacked branch wasn't requested, we don't create one
1216
# even if the origin was stacked
1217
stacked_branch_url = None
1218
if source_branch is not None:
1220
stacked_branch_url = self.root_transport.base
1221
source_repository = source_branch.repository
1224
source_branch = self.open_branch()
1225
source_repository = source_branch.repository
1227
stacked_branch_url = self.root_transport.base
1228
except errors.NotBranchError:
1229
source_branch = None
1231
source_repository = self.open_repository()
1232
except errors.NoRepositoryPresent:
1233
source_repository = None
1234
repository_policy = result.determine_repository_policy(
1235
force_new_repo, stacked_branch_url, require_stacking=stacked)
1236
result_repo, is_new_repo = repository_policy.acquire_repository()
1237
if is_new_repo and revision_id is not None and not stacked:
1238
fetch_spec = graph.PendingAncestryResult(
1239
[revision_id], source_repository)
1242
if source_repository is not None:
1243
# Fetch while stacked to prevent unstacked fetch from
1245
if fetch_spec is None:
1246
result_repo.fetch(source_repository, revision_id=revision_id)
1248
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1250
if source_branch is None:
1251
# this is for sprouting a bzrdir without a branch; is that
1253
# Not especially, but it's part of the contract.
1254
result_branch = result.create_branch()
1256
result_branch = source_branch.sprout(result,
1257
revision_id=revision_id, repository_policy=repository_policy)
1258
mutter("created new branch %r" % (result_branch,))
1260
# Create/update the result working tree
1261
if (create_tree_if_local and
1262
isinstance(target_transport, local.LocalTransport) and
1263
(result_repo is None or result_repo.make_working_trees())):
1264
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1268
if wt.path2id('') is None:
1270
wt.set_root_id(self.open_workingtree.get_root_id())
1271
except errors.NoWorkingTree:
1277
if recurse == 'down':
1279
basis = wt.basis_tree()
1281
subtrees = basis.iter_references()
1282
elif result_branch is not None:
1283
basis = result_branch.basis_tree()
1285
subtrees = basis.iter_references()
1286
elif source_branch is not None:
1287
basis = source_branch.basis_tree()
1289
subtrees = basis.iter_references()
1294
for path, file_id in subtrees:
1295
target = urlutils.join(url, urlutils.escape(path))
1296
sublocation = source_branch.reference_parent(file_id, path)
1297
sublocation.bzrdir.sprout(target,
1298
basis.get_reference_revision(file_id, path),
1299
force_new_repo=force_new_repo, recurse=recurse,
1302
if basis is not None:
1306
def push_branch(self, source, revision_id=None, overwrite=False,
1307
remember=False, create_prefix=False):
1308
"""Push the source branch into this BzrDir."""
1310
# If we can open a branch, use its direct repository, otherwise see
1311
# if there is a repository without a branch.
1313
br_to = self.open_branch()
1314
except errors.NotBranchError:
1315
# Didn't find a branch, can we find a repository?
1316
repository_to = self.find_repository()
1318
# Found a branch, so we must have found a repository
1319
repository_to = br_to.repository
1321
push_result = PushResult()
1322
push_result.source_branch = source
1324
# We have a repository but no branch, copy the revisions, and then
1326
repository_to.fetch(source.repository, revision_id=revision_id)
1327
br_to = source.clone(self, revision_id=revision_id)
1328
if source.get_push_location() is None or remember:
1329
source.set_push_location(br_to.base)
1330
push_result.stacked_on = None
1331
push_result.branch_push_result = None
1332
push_result.old_revno = None
1333
push_result.old_revid = _mod_revision.NULL_REVISION
1334
push_result.target_branch = br_to
1335
push_result.master_branch = None
1336
push_result.workingtree_updated = False
1338
# We have successfully opened the branch, remember if necessary:
1339
if source.get_push_location() is None or remember:
1340
source.set_push_location(br_to.base)
1342
tree_to = self.open_workingtree()
1343
except errors.NotLocalUrl:
1344
push_result.branch_push_result = source.push(br_to,
1345
overwrite, stop_revision=revision_id)
1346
push_result.workingtree_updated = False
1347
except errors.NoWorkingTree:
1348
push_result.branch_push_result = source.push(br_to,
1349
overwrite, stop_revision=revision_id)
1350
push_result.workingtree_updated = None # Not applicable
1352
tree_to.lock_write()
1354
push_result.branch_push_result = source.push(
1355
tree_to.branch, overwrite, stop_revision=revision_id)
1359
push_result.workingtree_updated = True
1360
push_result.old_revno = push_result.branch_push_result.old_revno
1361
push_result.old_revid = push_result.branch_push_result.old_revid
1362
push_result.target_branch = \
1363
push_result.branch_push_result.target_branch
1367
class BzrDirHooks(hooks.Hooks):
1368
"""Hooks for BzrDir operations."""
1371
"""Create the default hooks."""
1372
hooks.Hooks.__init__(self)
1373
self.create_hook(hooks.HookPoint('pre_open',
1374
"Invoked before attempting to open a BzrDir with the transport "
1375
"that the open will use.", (1, 14), None))
1376
self.create_hook(hooks.HookPoint('post_repo_init',
1377
"Invoked after a repository has been initialized. "
1378
"post_repo_init is called with a "
1379
"bzrlib.bzrdir.RepoInitHookParams.",
1382
# install the default hooks
1383
BzrDir.hooks = BzrDirHooks()
1386
class RepoInitHookParams(object):
1387
"""Object holding parameters passed to *_repo_init hooks.
1389
There are 4 fields that hooks may wish to access:
1391
:ivar repository: Repository created
1392
:ivar format: Repository format
1393
:ivar bzrdir: The bzrdir for the repository
1394
:ivar shared: The repository is shared
1397
def __init__(self, repository, format, a_bzrdir, shared):
1398
"""Create a group of RepoInitHook parameters.
1400
:param repository: Repository created
1401
:param format: Repository format
1402
:param bzrdir: The bzrdir for the repository
1403
:param shared: The repository is shared
1405
self.repository = repository
1406
self.format = format
1407
self.bzrdir = a_bzrdir
1408
self.shared = shared
1410
def __eq__(self, other):
1411
return self.__dict__ == other.__dict__
1415
return "<%s for %s>" % (self.__class__.__name__,
1418
return "<%s for %s>" % (self.__class__.__name__,
1422
class BzrDirPreSplitOut(BzrDir):
1423
"""A common class for the all-in-one formats."""
1425
def __init__(self, _transport, _format):
1426
"""See BzrDir.__init__."""
1427
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1428
self._control_files = lockable_files.LockableFiles(
1429
self.get_branch_transport(None),
1430
self._format._lock_file_name,
1431
self._format._lock_class)
1433
def break_lock(self):
1434
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1435
raise NotImplementedError(self.break_lock)
1437
def cloning_metadir(self, require_stacking=False):
1438
"""Produce a metadir suitable for cloning with."""
1439
if require_stacking:
1440
return format_registry.make_bzrdir('1.6')
1441
return self._format.__class__()
1443
def clone(self, url, revision_id=None, force_new_repo=False,
1444
preserve_stacking=False):
1445
"""See BzrDir.clone().
1447
force_new_repo has no effect, since this family of formats always
1448
require a new repository.
1449
preserve_stacking has no effect, since no source branch using this
1450
family of formats can be stacked, so there is no stacking to preserve.
1452
self._make_tail(url)
1453
result = self._format._initialize_for_clone(url)
1454
self.open_repository().clone(result, revision_id=revision_id)
1455
from_branch = self.open_branch()
1456
from_branch.clone(result, revision_id=revision_id)
1458
tree = self.open_workingtree()
1459
except errors.NotLocalUrl:
1460
# make a new one, this format always has to have one.
1461
result._init_workingtree()
1466
def create_branch(self, name=None):
1467
"""See BzrDir.create_branch."""
1468
return self._format.get_branch_format().initialize(self, name=name)
1470
def destroy_branch(self, name=None):
1471
"""See BzrDir.destroy_branch."""
1472
raise errors.UnsupportedOperation(self.destroy_branch, self)
1474
def create_repository(self, shared=False):
1475
"""See BzrDir.create_repository."""
1477
raise errors.IncompatibleFormat('shared repository', self._format)
1478
return self.open_repository()
1480
def destroy_repository(self):
1481
"""See BzrDir.destroy_repository."""
1482
raise errors.UnsupportedOperation(self.destroy_repository, self)
1484
def create_workingtree(self, revision_id=None, from_branch=None,
1485
accelerator_tree=None, hardlink=False):
1486
"""See BzrDir.create_workingtree."""
1487
# The workingtree is sometimes created when the bzrdir is created,
1488
# but not when cloning.
1490
# this looks buggy but is not -really-
1491
# because this format creates the workingtree when the bzrdir is
1493
# clone and sprout will have set the revision_id
1494
# and that will have set it for us, its only
1495
# specific uses of create_workingtree in isolation
1496
# that can do wonky stuff here, and that only
1497
# happens for creating checkouts, which cannot be
1498
# done on this format anyway. So - acceptable wart.
1500
warning("can't support hardlinked working trees in %r"
1503
result = self.open_workingtree(recommend_upgrade=False)
1504
except errors.NoSuchFile:
1505
result = self._init_workingtree()
1506
if revision_id is not None:
1507
if revision_id == _mod_revision.NULL_REVISION:
1508
result.set_parent_ids([])
1510
result.set_parent_ids([revision_id])
1513
def _init_workingtree(self):
1514
from bzrlib.workingtree import WorkingTreeFormat2
1516
return WorkingTreeFormat2().initialize(self)
1517
except errors.NotLocalUrl:
1518
# Even though we can't access the working tree, we need to
1519
# create its control files.
1520
return WorkingTreeFormat2()._stub_initialize_on_transport(
1521
self.transport, self._control_files._file_mode)
1523
def destroy_workingtree(self):
1524
"""See BzrDir.destroy_workingtree."""
1525
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1527
def destroy_workingtree_metadata(self):
1528
"""See BzrDir.destroy_workingtree_metadata."""
1529
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1532
732
def get_branch_transport(self, branch_format, name=None):
1533
"""See BzrDir.get_branch_transport()."""
1534
if name is not None:
1535
raise errors.NoColocatedBranchSupport(self)
1536
if branch_format is None:
1537
return self.transport
1539
branch_format.get_format_string()
1540
except NotImplementedError:
1541
return self.transport
1542
raise errors.IncompatibleFormat(branch_format, self._format)
733
"""Get the transport for use by branch format in this BzrDir.
735
Note that bzr dirs that do not support format strings will raise
736
IncompatibleFormat if the branch format they are given has
737
a format string, and vice versa.
739
If branch_format is None, the transport is returned with no
740
checking. If it is not None, then the returned transport is
741
guaranteed to point to an existing directory ready for use.
743
raise NotImplementedError(self.get_branch_transport)
1544
745
def get_repository_transport(self, repository_format):
1545
"""See BzrDir.get_repository_transport()."""
1546
if repository_format is None:
1547
return self.transport
1549
repository_format.get_format_string()
1550
except NotImplementedError:
1551
return self.transport
1552
raise errors.IncompatibleFormat(repository_format, self._format)
1554
def get_workingtree_transport(self, workingtree_format):
1555
"""See BzrDir.get_workingtree_transport()."""
1556
if workingtree_format is None:
1557
return self.transport
1559
workingtree_format.get_format_string()
1560
except NotImplementedError:
1561
return self.transport
1562
raise errors.IncompatibleFormat(workingtree_format, self._format)
1564
def needs_format_conversion(self, format=None):
1565
"""See BzrDir.needs_format_conversion()."""
1566
# if the format is not the same as the system default,
1567
# an upgrade is needed.
1569
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1570
% 'needs_format_conversion(format=None)')
1571
format = BzrDirFormat.get_default_format()
1572
return not isinstance(self._format, format.__class__)
1574
def open_branch(self, name=None, unsupported=False,
1575
ignore_fallbacks=False):
1576
"""See BzrDir.open_branch."""
1577
from bzrlib.branch import BzrBranchFormat4
1578
format = BzrBranchFormat4()
1579
self._check_supported(format, unsupported)
1580
return format.open(self, name, _found=True)
1582
def sprout(self, url, revision_id=None, force_new_repo=False,
1583
possible_transports=None, accelerator_tree=None,
1584
hardlink=False, stacked=False, create_tree_if_local=True,
1585
source_branch=None):
1586
"""See BzrDir.sprout()."""
1587
if source_branch is not None:
1588
my_branch = self.open_branch()
1589
if source_branch.base != my_branch.base:
1590
raise AssertionError(
1591
"source branch %r is not within %r with branch %r" %
1592
(source_branch, self, my_branch))
1594
raise errors.UnstackableBranchFormat(
1595
self._format, self.root_transport.base)
1596
if not create_tree_if_local:
1597
raise errors.MustHaveWorkingTree(
1598
self._format, self.root_transport.base)
1599
from bzrlib.workingtree import WorkingTreeFormat2
1600
self._make_tail(url)
1601
result = self._format._initialize_for_clone(url)
1603
self.open_repository().clone(result, revision_id=revision_id)
1604
except errors.NoRepositoryPresent:
1607
self.open_branch().sprout(result, revision_id=revision_id)
1608
except errors.NotBranchError:
1611
# we always want a working tree
1612
WorkingTreeFormat2().initialize(result,
1613
accelerator_tree=accelerator_tree,
1618
class BzrDir4(BzrDirPreSplitOut):
1619
"""A .bzr version 4 control object.
1621
This is a deprecated format and may be removed after sept 2006.
1624
def create_repository(self, shared=False):
1625
"""See BzrDir.create_repository."""
1626
return self._format.repository_format.initialize(self, shared)
1628
def needs_format_conversion(self, format=None):
1629
"""Format 4 dirs are always in need of conversion."""
1631
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1632
% 'needs_format_conversion(format=None)')
1635
def open_repository(self):
1636
"""See BzrDir.open_repository."""
1637
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1638
return RepositoryFormat4().open(self, _found=True)
1641
class BzrDir5(BzrDirPreSplitOut):
1642
"""A .bzr version 5 control object.
1644
This is a deprecated format and may be removed after sept 2006.
1647
def has_workingtree(self):
1648
"""See BzrDir.has_workingtree."""
1651
def open_repository(self):
1652
"""See BzrDir.open_repository."""
1653
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1654
return RepositoryFormat5().open(self, _found=True)
1656
def open_workingtree(self, _unsupported=False,
1657
recommend_upgrade=True):
1658
"""See BzrDir.create_workingtree."""
1659
from bzrlib.workingtree import WorkingTreeFormat2
1660
wt_format = WorkingTreeFormat2()
1661
# we don't warn here about upgrades; that ought to be handled for the
1663
return wt_format.open(self, _found=True)
1666
class BzrDir6(BzrDirPreSplitOut):
1667
"""A .bzr version 6 control object.
1669
This is a deprecated format and may be removed after sept 2006.
1672
def has_workingtree(self):
1673
"""See BzrDir.has_workingtree."""
1676
def open_repository(self):
1677
"""See BzrDir.open_repository."""
1678
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1679
return RepositoryFormat6().open(self, _found=True)
1681
def open_workingtree(self, _unsupported=False,
1682
recommend_upgrade=True):
1683
"""See BzrDir.create_workingtree."""
1684
# we don't warn here about upgrades; that ought to be handled for the
1686
from bzrlib.workingtree import WorkingTreeFormat2
1687
return WorkingTreeFormat2().open(self, _found=True)
746
"""Get the transport for use by repository format in this BzrDir.
748
Note that bzr dirs that do not support format strings will raise
749
IncompatibleFormat if the repository format they are given has
750
a format string, and vice versa.
752
If repository_format is None, the transport is returned with no
753
checking. If it is not None, then the returned transport is
754
guaranteed to point to an existing directory ready for use.
756
raise NotImplementedError(self.get_repository_transport)
758
def get_workingtree_transport(self, tree_format):
759
"""Get the transport for use by workingtree format in this BzrDir.
761
Note that bzr dirs that do not support format strings will raise
762
IncompatibleFormat if the workingtree format they are given has a
763
format string, and vice versa.
765
If workingtree_format is None, the transport is returned with no
766
checking. If it is not None, then the returned transport is
767
guaranteed to point to an existing directory ready for use.
769
raise NotImplementedError(self.get_workingtree_transport)
772
def create(cls, base, format=None, possible_transports=None):
773
"""Create a new BzrDir at the url 'base'.
775
:param format: If supplied, the format of branch to create. If not
776
supplied, the default is used.
777
:param possible_transports: If supplied, a list of transports that
778
can be reused to share a remote connection.
780
if cls is not BzrDir:
781
raise AssertionError("BzrDir.create always creates the "
782
"default format, not one of %r" % cls)
783
return controldir.ControlDir.create(base, format=format,
784
possible_transports=possible_transports)
787
return "<%s at %r>" % (self.__class__.__name__, self.user_url)
789
def update_feature_flags(self, updated_flags):
790
"""Update the features required by this bzrdir.
792
:param updated_flags: Dictionary mapping feature names to necessities
793
A necessity can be None to indicate the feature should be removed
795
self.control_files.lock_write()
797
self._format._update_feature_flags(updated_flags)
798
self.transport.put_bytes('branch-format', self._format.as_string())
800
self.control_files.unlock()
1690
803
class BzrDirMeta1(BzrDir):
1880
1004
return config.TransportConfig(self.transport, 'control.conf')
1883
class BzrDirFormat(object):
1884
"""An encapsulation of the initialization and open routines for a format.
1886
Formats provide three things:
1887
* An initialization routine,
1007
class BzrDirMeta1Colo(BzrDirMeta1):
1008
"""BzrDirMeta1 with support for colocated branches.
1010
This format is experimental, and will eventually be merged back into
1014
def _get_branch_path(self, name):
1015
"""Obtain the branch path to use.
1017
This uses the API specified branch name first, and then falls back to
1018
the branch name specified in the URL. If neither of those is specified,
1019
it uses the default branch.
1021
:param name: Optional branch name to use
1022
:return: Relative path to branch
1026
return urlutils.join('branches', name.encode("utf-8"))
1028
def _read_branch_list(self):
1029
"""Read the branch list.
1031
:return: List of utf-8 encoded branch names.
1034
f = self.control_transport.get('branch-list')
1035
except errors.NoSuchFile:
1041
ret.append(name.rstrip("\n"))
1046
def _write_branch_list(self, branches):
1047
"""Write out the branch list.
1049
:param branches: List of utf-8 branch names to write
1051
self.transport.put_bytes('branch-list',
1052
"".join([name+"\n" for name in branches]))
1054
def destroy_branch(self, name=None):
1055
"""See BzrDir.create_branch."""
1057
name = self._get_selected_branch()
1058
path = self._get_branch_path(name)
1059
if name is not None:
1060
self.control_files.lock_write()
1062
branches = self._read_branch_list()
1064
branches.remove(name.encode("utf-8"))
1066
raise errors.NotBranchError(name)
1067
self._write_branch_list(branches)
1069
self.control_files.unlock()
1070
self.transport.delete_tree(path)
1072
def get_branches(self):
1073
"""See ControlDir.get_branches."""
1076
ret[None] = self.open_branch()
1077
except (errors.NotBranchError, errors.NoRepositoryPresent):
1080
for name in self._read_branch_list():
1081
ret[name] = self.open_branch(name.decode('utf-8'))
1085
def get_branch_transport(self, branch_format, name=None):
1086
"""See BzrDir.get_branch_transport()."""
1087
path = self._get_branch_path(name)
1088
# XXX: this shouldn't implicitly create the directory if it's just
1089
# promising to get a transport -- mbp 20090727
1090
if branch_format is None:
1091
return self.transport.clone(path)
1093
branch_format.get_format_string()
1094
except NotImplementedError:
1095
raise errors.IncompatibleFormat(branch_format, self._format)
1096
if name is not None:
1098
self.transport.mkdir('branches', mode=self._get_mkdir_mode())
1099
except errors.FileExists:
1101
branches = self._read_branch_list()
1102
utf8_name = name.encode("utf-8")
1103
if not utf8_name in branches:
1104
self.control_files.lock_write()
1106
branches = self._read_branch_list()
1107
branches.append(utf8_name)
1108
self._write_branch_list(branches)
1110
self.control_files.unlock()
1112
self.transport.mkdir(path, mode=self._get_mkdir_mode())
1113
except errors.FileExists:
1115
return self.transport.clone(path)
1118
class BzrFormat(object):
1119
"""Base class for all formats of things living in metadirs.
1121
This class manages the format string that is stored in the 'format'
1122
or 'branch-format' file.
1124
All classes for (branch-, repository-, workingtree-) formats that
1125
live in meta directories and have their own 'format' file
1126
(i.e. different from .bzr/branch-format) derive from this class,
1127
as well as the relevant base class for their kind
1128
(BranchFormat, WorkingTreeFormat, RepositoryFormat).
1130
Each format is identified by a "format" or "branch-format" file with a
1131
single line containing the base format name and then an optional list of
1134
Feature flags are supported as of bzr 2.5. Setting feature flags on formats
1135
will render them inaccessible to older versions of bzr.
1137
:ivar features: Dictionary mapping feature names to their necessity
1140
_present_features = set()
1146
def register_feature(cls, name):
1147
"""Register a feature as being present.
1149
:param name: Name of the feature
1152
raise ValueError("spaces are not allowed in feature names")
1153
if name in cls._present_features:
1154
raise errors.FeatureAlreadyRegistered(name)
1155
cls._present_features.add(name)
1158
def unregister_feature(cls, name):
1159
"""Unregister a feature."""
1160
cls._present_features.remove(name)
1162
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1164
for name, necessity in self.features.iteritems():
1165
if name in self._present_features:
1167
if necessity == "optional":
1168
mutter("ignoring optional missing feature %s", name)
1170
elif necessity == "required":
1171
raise errors.MissingFeature(name)
1173
mutter("treating unknown necessity as require for %s",
1175
raise errors.MissingFeature(name)
1178
def get_format_string(cls):
1179
"""Return the ASCII format string that identifies this format."""
1180
raise NotImplementedError(cls.get_format_string)
1183
def from_string(cls, text):
1184
format_string = cls.get_format_string()
1185
if not text.startswith(format_string):
1186
raise AssertionError("Invalid format header %r for %r" % (text, cls))
1187
lines = text[len(format_string):].splitlines()
1189
for lineno, line in enumerate(lines):
1191
(necessity, feature) = line.split(" ", 1)
1193
raise errors.ParseFormatError(format=cls, lineno=lineno+2,
1194
line=line, text=text)
1195
ret.features[feature] = necessity
1198
def as_string(self):
1199
"""Return the string representation of this format.
1201
lines = [self.get_format_string()]
1202
lines.extend([("%s %s\n" % (item[1], item[0])) for item in
1203
self.features.iteritems()])
1204
return "".join(lines)
1207
def _find_format(klass, registry, kind, format_string):
1209
first_line = format_string[:format_string.index("\n")+1]
1211
first_line = format_string
1213
cls = registry.get(first_line)
1215
raise errors.UnknownFormatError(format=first_line, kind=kind)
1216
return cls.from_string(format_string)
1218
def network_name(self):
1219
"""A simple byte string uniquely identifying this format for RPC calls.
1221
Metadir branch formats use their format string.
1223
return self.as_string()
1225
def __eq__(self, other):
1226
return (self.__class__ is other.__class__ and
1227
self.features == other.features)
1229
def _update_feature_flags(self, updated_flags):
1230
"""Update the feature flags in this format.
1232
:param updated_flags: Updated feature flags
1234
for name, necessity in updated_flags.iteritems():
1235
if necessity is None:
1237
del self.features[name]
1241
self.features[name] = necessity
1244
class BzrProber(controldir.Prober):
1245
"""Prober for formats that use a .bzr/ control directory."""
1247
formats = registry.FormatRegistry(controldir.network_format_registry)
1248
"""The known .bzr formats."""
1251
@deprecated_method(deprecated_in((2, 4, 0)))
1252
def register_bzrdir_format(klass, format):
1253
klass.formats.register(format.get_format_string(), format)
1256
@deprecated_method(deprecated_in((2, 4, 0)))
1257
def unregister_bzrdir_format(klass, format):
1258
klass.formats.remove(format.get_format_string())
1261
def probe_transport(klass, transport):
1262
"""Return the .bzrdir style format present in a directory."""
1264
format_string = transport.get_bytes(".bzr/branch-format")
1265
except errors.NoSuchFile:
1266
raise errors.NotBranchError(path=transport.base)
1268
first_line = format_string[:format_string.index("\n")+1]
1270
first_line = format_string
1272
cls = klass.formats.get(first_line)
1274
raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
1275
return cls.from_string(format_string)
1278
def known_formats(cls):
1280
for name, format in cls.formats.iteritems():
1281
if callable(format):
1287
controldir.ControlDirFormat.register_prober(BzrProber)
1290
class RemoteBzrProber(controldir.Prober):
1291
"""Prober for remote servers that provide a Bazaar smart server."""
1294
def probe_transport(klass, transport):
1295
"""Return a RemoteBzrDirFormat object if it looks possible."""
1297
medium = transport.get_smart_medium()
1298
except (NotImplementedError, AttributeError,
1299
errors.TransportNotPossible, errors.NoSmartMedium,
1300
errors.SmartProtocolError):
1301
# no smart server, so not a branch for this format type.
1302
raise errors.NotBranchError(path=transport.base)
1304
# Decline to open it if the server doesn't support our required
1305
# version (3) so that the VFS-based transport will do it.
1306
if medium.should_probe():
1308
server_version = medium.protocol_version()
1309
except errors.SmartProtocolError:
1310
# Apparently there's no usable smart server there, even though
1311
# the medium supports the smart protocol.
1312
raise errors.NotBranchError(path=transport.base)
1313
if server_version != '2':
1314
raise errors.NotBranchError(path=transport.base)
1315
from bzrlib.remote import RemoteBzrDirFormat
1316
return RemoteBzrDirFormat()
1319
def known_formats(cls):
1320
from bzrlib.remote import RemoteBzrDirFormat
1321
return set([RemoteBzrDirFormat()])
1324
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1325
"""ControlDirFormat base class for .bzr/ directories.
1891
1327
Formats are placed in a dict by their format string for reference
1892
1328
during bzrdir opening. These should be subclasses of BzrDirFormat
2261
1528
compatible with whatever sub formats are supported by self.
2266
def unregister_format(klass, format):
2267
del klass._formats[format.get_format_string()]
2270
def unregister_control_format(klass, format):
2271
klass._control_formats.remove(format)
2274
class BzrDirFormat4(BzrDirFormat):
2275
"""Bzr dir format 4.
2277
This format is a combined format for working tree, branch and repository.
2279
- Format 1 working trees [always]
2280
- Format 4 branches [always]
2281
- Format 4 repositories [always]
2283
This format is deprecated: it indexes texts using a text it which is
2284
removed in format 5; write support for this format has been removed.
2287
_lock_class = lockable_files.TransportLock
2289
def get_format_string(self):
2290
"""See BzrDirFormat.get_format_string()."""
2291
return "Bazaar-NG branch, format 0.0.4\n"
2293
def get_format_description(self):
2294
"""See BzrDirFormat.get_format_description()."""
2295
return "All-in-one format 4"
2297
def get_converter(self, format=None):
2298
"""See BzrDirFormat.get_converter()."""
2299
# there is one and only one upgrade path here.
2300
return ConvertBzrDir4To5()
2302
def initialize_on_transport(self, transport):
2303
"""Format 4 branches cannot be created."""
2304
raise errors.UninitializableFormat(self)
2306
def is_supported(self):
2307
"""Format 4 is not supported.
2309
It is not supported because the model changed from 4 to 5 and the
2310
conversion logic is expensive - so doing it on the fly was not
2315
def network_name(self):
2316
return self.get_format_string()
2318
def _open(self, transport):
2319
"""See BzrDirFormat._open."""
2320
return BzrDir4(transport, self)
2322
def __return_repository_format(self):
2323
"""Circular import protection."""
2324
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2325
return RepositoryFormat4()
2326
repository_format = property(__return_repository_format)
2329
class BzrDirFormatAllInOne(BzrDirFormat):
2330
"""Common class for formats before meta-dirs."""
2332
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2333
create_prefix=False, force_new_repo=False, stacked_on=None,
2334
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2336
"""See BzrDirFormat.initialize_on_transport_ex."""
2337
require_stacking = (stacked_on is not None)
2338
# Format 5 cannot stack, but we've been asked to - actually init
2340
if require_stacking:
2341
format = BzrDirMetaFormat1()
2342
return format.initialize_on_transport_ex(transport,
2343
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2344
force_new_repo=force_new_repo, stacked_on=stacked_on,
2345
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2346
make_working_trees=make_working_trees, shared_repo=shared_repo)
2347
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2348
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2349
force_new_repo=force_new_repo, stacked_on=stacked_on,
2350
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2351
make_working_trees=make_working_trees, shared_repo=shared_repo)
2354
class BzrDirFormat5(BzrDirFormatAllInOne):
2355
"""Bzr control format 5.
2357
This format is a combined format for working tree, branch and repository.
2359
- Format 2 working trees [always]
2360
- Format 4 branches [always]
2361
- Format 5 repositories [always]
2362
Unhashed stores in the repository.
2365
_lock_class = lockable_files.TransportLock
2367
def get_format_string(self):
2368
"""See BzrDirFormat.get_format_string()."""
2369
return "Bazaar-NG branch, format 5\n"
2371
def get_branch_format(self):
2372
from bzrlib import branch
2373
return branch.BzrBranchFormat4()
2375
def get_format_description(self):
2376
"""See BzrDirFormat.get_format_description()."""
2377
return "All-in-one format 5"
2379
def get_converter(self, format=None):
2380
"""See BzrDirFormat.get_converter()."""
2381
# there is one and only one upgrade path here.
2382
return ConvertBzrDir5To6()
2384
def _initialize_for_clone(self, url):
2385
return self.initialize_on_transport(get_transport(url), _cloning=True)
2387
def initialize_on_transport(self, transport, _cloning=False):
2388
"""Format 5 dirs always have working tree, branch and repository.
2390
Except when they are being cloned.
2392
from bzrlib.branch import BzrBranchFormat4
2393
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2394
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2395
RepositoryFormat5().initialize(result, _internal=True)
2397
branch = BzrBranchFormat4().initialize(result)
2398
result._init_workingtree()
2401
def network_name(self):
2402
return self.get_format_string()
2404
def _open(self, transport):
2405
"""See BzrDirFormat._open."""
2406
return BzrDir5(transport, self)
2408
def __return_repository_format(self):
2409
"""Circular import protection."""
2410
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2411
return RepositoryFormat5()
2412
repository_format = property(__return_repository_format)
2415
class BzrDirFormat6(BzrDirFormatAllInOne):
2416
"""Bzr control format 6.
2418
This format is a combined format for working tree, branch and repository.
2420
- Format 2 working trees [always]
2421
- Format 4 branches [always]
2422
- Format 6 repositories [always]
2425
_lock_class = lockable_files.TransportLock
2427
def get_format_string(self):
2428
"""See BzrDirFormat.get_format_string()."""
2429
return "Bazaar-NG branch, format 6\n"
2431
def get_format_description(self):
2432
"""See BzrDirFormat.get_format_description()."""
2433
return "All-in-one format 6"
2435
def get_branch_format(self):
2436
from bzrlib import branch
2437
return branch.BzrBranchFormat4()
2439
def get_converter(self, format=None):
2440
"""See BzrDirFormat.get_converter()."""
2441
# there is one and only one upgrade path here.
2442
return ConvertBzrDir6ToMeta()
2444
def _initialize_for_clone(self, url):
2445
return self.initialize_on_transport(get_transport(url), _cloning=True)
2447
def initialize_on_transport(self, transport, _cloning=False):
2448
"""Format 6 dirs always have working tree, branch and repository.
2450
Except when they are being cloned.
2452
from bzrlib.branch import BzrBranchFormat4
2453
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2454
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2455
RepositoryFormat6().initialize(result, _internal=True)
2457
branch = BzrBranchFormat4().initialize(result)
2458
result._init_workingtree()
2461
def network_name(self):
2462
return self.get_format_string()
2464
def _open(self, transport):
2465
"""See BzrDirFormat._open."""
2466
return BzrDir6(transport, self)
2468
def __return_repository_format(self):
2469
"""Circular import protection."""
2470
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2471
return RepositoryFormat6()
2472
repository_format = property(__return_repository_format)
1531
other_format.features = dict(self.features)
1533
def supports_transport(self, transport):
1534
# bzr formats can be opened over all known transports
1537
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1539
controldir.ControlDirFormat.check_support_status(self,
1540
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1542
BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1543
recommend_upgrade=recommend_upgrade, basedir=basedir)
2475
1546
class BzrDirMetaFormat1(BzrDirFormat):
2667
1753
def __get_workingtree_format(self):
2668
1754
if self._workingtree_format is None:
2669
from bzrlib.workingtree import WorkingTreeFormat
2670
self._workingtree_format = WorkingTreeFormat.get_default_format()
1755
from bzrlib.workingtree import (
1756
format_registry as wt_format_registry,
1758
self._workingtree_format = wt_format_registry.get_default()
2671
1759
return self._workingtree_format
2673
1761
def __set_workingtree_format(self, wt_format):
2674
1762
self._workingtree_format = wt_format
1765
return "<%r>" % (self.__class__.__name__,)
2676
1767
workingtree_format = property(__get_workingtree_format,
2677
1768
__set_workingtree_format)
2680
network_format_registry = registry.FormatRegistry()
2681
"""Registry of formats indexed by their network name.
2683
The network name for a BzrDirFormat is an identifier that can be used when
2684
referring to formats with smart server operations. See
2685
BzrDirFormat.network_name() for more detail.
2689
# Register bzr control format
2690
BzrDirFormat.register_control_format(BzrDirFormat)
2692
1771
# Register bzr formats
2693
BzrDirFormat.register_format(BzrDirFormat4())
2694
BzrDirFormat.register_format(BzrDirFormat5())
2695
BzrDirFormat.register_format(BzrDirFormat6())
2696
__default_format = BzrDirMetaFormat1()
2697
BzrDirFormat.register_format(__default_format)
2698
BzrDirFormat._default_format = __default_format
2701
class Converter(object):
2702
"""Converts a disk format object from one format to another."""
2704
def convert(self, to_convert, pb):
2705
"""Perform the conversion of to_convert, giving feedback via pb.
2707
:param to_convert: The disk object to convert.
2708
:param pb: a progress bar to use for progress information.
2711
def step(self, message):
2712
"""Update the pb by a step."""
2714
self.pb.update(message, self.count, self.total)
2717
class ConvertBzrDir4To5(Converter):
2718
"""Converts format 4 bzr dirs to format 5."""
2721
super(ConvertBzrDir4To5, self).__init__()
2722
self.converted_revs = set()
2723
self.absent_revisions = set()
2727
def convert(self, to_convert, pb):
2728
"""See Converter.convert()."""
2729
self.bzrdir = to_convert
2731
warnings.warn("pb parameter to convert() is deprecated")
2732
self.pb = ui.ui_factory.nested_progress_bar()
2734
ui.ui_factory.note('starting upgrade from format 4 to 5')
2735
if isinstance(self.bzrdir.transport, local.LocalTransport):
2736
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2737
self._convert_to_weaves()
2738
return BzrDir.open(self.bzrdir.user_url)
2742
def _convert_to_weaves(self):
2743
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2746
stat = self.bzrdir.transport.stat('weaves')
2747
if not S_ISDIR(stat.st_mode):
2748
self.bzrdir.transport.delete('weaves')
2749
self.bzrdir.transport.mkdir('weaves')
2750
except errors.NoSuchFile:
2751
self.bzrdir.transport.mkdir('weaves')
2752
# deliberately not a WeaveFile as we want to build it up slowly.
2753
self.inv_weave = Weave('inventory')
2754
# holds in-memory weaves for all files
2755
self.text_weaves = {}
2756
self.bzrdir.transport.delete('branch-format')
2757
self.branch = self.bzrdir.open_branch()
2758
self._convert_working_inv()
2759
rev_history = self.branch.revision_history()
2760
# to_read is a stack holding the revisions we still need to process;
2761
# appending to it adds new highest-priority revisions
2762
self.known_revisions = set(rev_history)
2763
self.to_read = rev_history[-1:]
2765
rev_id = self.to_read.pop()
2766
if (rev_id not in self.revisions
2767
and rev_id not in self.absent_revisions):
2768
self._load_one_rev(rev_id)
2770
to_import = self._make_order()
2771
for i, rev_id in enumerate(to_import):
2772
self.pb.update('converting revision', i, len(to_import))
2773
self._convert_one_rev(rev_id)
2775
self._write_all_weaves()
2776
self._write_all_revs()
2777
ui.ui_factory.note('upgraded to weaves:')
2778
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2779
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2780
ui.ui_factory.note(' %6d texts' % self.text_count)
2781
self._cleanup_spare_files_after_format4()
2782
self.branch._transport.put_bytes(
2784
BzrDirFormat5().get_format_string(),
2785
mode=self.bzrdir._get_file_mode())
2787
def _cleanup_spare_files_after_format4(self):
2788
# FIXME working tree upgrade foo.
2789
for n in 'merged-patches', 'pending-merged-patches':
2791
## assert os.path.getsize(p) == 0
2792
self.bzrdir.transport.delete(n)
2793
except errors.NoSuchFile:
2795
self.bzrdir.transport.delete_tree('inventory-store')
2796
self.bzrdir.transport.delete_tree('text-store')
2798
def _convert_working_inv(self):
2799
inv = xml4.serializer_v4.read_inventory(
2800
self.branch._transport.get('inventory'))
2801
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2802
self.branch._transport.put_bytes('inventory', new_inv_xml,
2803
mode=self.bzrdir._get_file_mode())
2805
def _write_all_weaves(self):
2806
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2807
weave_transport = self.bzrdir.transport.clone('weaves')
2808
weaves = WeaveStore(weave_transport, prefixed=False)
2809
transaction = WriteTransaction()
2813
for file_id, file_weave in self.text_weaves.items():
2814
self.pb.update('writing weave', i, len(self.text_weaves))
2815
weaves._put_weave(file_id, file_weave, transaction)
2817
self.pb.update('inventory', 0, 1)
2818
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2819
self.pb.update('inventory', 1, 1)
2823
def _write_all_revs(self):
2824
"""Write all revisions out in new form."""
2825
self.bzrdir.transport.delete_tree('revision-store')
2826
self.bzrdir.transport.mkdir('revision-store')
2827
revision_transport = self.bzrdir.transport.clone('revision-store')
2829
from bzrlib.xml5 import serializer_v5
2830
from bzrlib.repofmt.weaverepo import RevisionTextStore
2831
revision_store = RevisionTextStore(revision_transport,
2832
serializer_v5, False, versionedfile.PrefixMapper(),
2833
lambda:True, lambda:True)
2835
for i, rev_id in enumerate(self.converted_revs):
2836
self.pb.update('write revision', i, len(self.converted_revs))
2837
text = serializer_v5.write_revision_to_string(
2838
self.revisions[rev_id])
2840
revision_store.add_lines(key, None, osutils.split_lines(text))
2844
def _load_one_rev(self, rev_id):
2845
"""Load a revision object into memory.
2847
Any parents not either loaded or abandoned get queued to be
2849
self.pb.update('loading revision',
2850
len(self.revisions),
2851
len(self.known_revisions))
2852
if not self.branch.repository.has_revision(rev_id):
2854
ui.ui_factory.note('revision {%s} not present in branch; '
2855
'will be converted as a ghost' %
2857
self.absent_revisions.add(rev_id)
2859
rev = self.branch.repository.get_revision(rev_id)
2860
for parent_id in rev.parent_ids:
2861
self.known_revisions.add(parent_id)
2862
self.to_read.append(parent_id)
2863
self.revisions[rev_id] = rev
2865
def _load_old_inventory(self, rev_id):
2866
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2867
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2868
inv.revision_id = rev_id
2869
rev = self.revisions[rev_id]
2872
def _load_updated_inventory(self, rev_id):
2873
inv_xml = self.inv_weave.get_text(rev_id)
2874
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2877
def _convert_one_rev(self, rev_id):
2878
"""Convert revision and all referenced objects to new format."""
2879
rev = self.revisions[rev_id]
2880
inv = self._load_old_inventory(rev_id)
2881
present_parents = [p for p in rev.parent_ids
2882
if p not in self.absent_revisions]
2883
self._convert_revision_contents(rev, inv, present_parents)
2884
self._store_new_inv(rev, inv, present_parents)
2885
self.converted_revs.add(rev_id)
2887
def _store_new_inv(self, rev, inv, present_parents):
2888
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2889
new_inv_sha1 = sha_string(new_inv_xml)
2890
self.inv_weave.add_lines(rev.revision_id,
2892
new_inv_xml.splitlines(True))
2893
rev.inventory_sha1 = new_inv_sha1
2895
def _convert_revision_contents(self, rev, inv, present_parents):
2896
"""Convert all the files within a revision.
2898
Also upgrade the inventory to refer to the text revision ids."""
2899
rev_id = rev.revision_id
2900
mutter('converting texts of revision {%s}',
2902
parent_invs = map(self._load_updated_inventory, present_parents)
2903
entries = inv.iter_entries()
2905
for path, ie in entries:
2906
self._convert_file_version(rev, ie, parent_invs)
2908
def _convert_file_version(self, rev, ie, parent_invs):
2909
"""Convert one version of one file.
2911
The file needs to be added into the weave if it is a merge
2912
of >=2 parents or if it's changed from its parent.
2914
file_id = ie.file_id
2915
rev_id = rev.revision_id
2916
w = self.text_weaves.get(file_id)
2919
self.text_weaves[file_id] = w
2920
text_changed = False
2921
parent_candiate_entries = ie.parent_candidates(parent_invs)
2922
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2923
# XXX: Note that this is unordered - and this is tolerable because
2924
# the previous code was also unordered.
2925
previous_entries = dict((head, parent_candiate_entries[head]) for head
2927
self.snapshot_ie(previous_entries, ie, w, rev_id)
2930
def get_parent_map(self, revision_ids):
2931
"""See graph.StackedParentsProvider.get_parent_map"""
2932
return dict((revision_id, self.revisions[revision_id])
2933
for revision_id in revision_ids
2934
if revision_id in self.revisions)
2936
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2937
# TODO: convert this logic, which is ~= snapshot to
2938
# a call to:. This needs the path figured out. rather than a work_tree
2939
# a v4 revision_tree can be given, or something that looks enough like
2940
# one to give the file content to the entry if it needs it.
2941
# and we need something that looks like a weave store for snapshot to
2943
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2944
if len(previous_revisions) == 1:
2945
previous_ie = previous_revisions.values()[0]
2946
if ie._unchanged(previous_ie):
2947
ie.revision = previous_ie.revision
2950
text = self.branch.repository._text_store.get(ie.text_id)
2951
file_lines = text.readlines()
2952
w.add_lines(rev_id, previous_revisions, file_lines)
2953
self.text_count += 1
2955
w.add_lines(rev_id, previous_revisions, [])
2956
ie.revision = rev_id
2958
def _make_order(self):
2959
"""Return a suitable order for importing revisions.
2961
The order must be such that an revision is imported after all
2962
its (present) parents.
2964
todo = set(self.revisions.keys())
2965
done = self.absent_revisions.copy()
2968
# scan through looking for a revision whose parents
2970
for rev_id in sorted(list(todo)):
2971
rev = self.revisions[rev_id]
2972
parent_ids = set(rev.parent_ids)
2973
if parent_ids.issubset(done):
2974
# can take this one now
2975
order.append(rev_id)
2981
class ConvertBzrDir5To6(Converter):
2982
"""Converts format 5 bzr dirs to format 6."""
2984
def convert(self, to_convert, pb):
2985
"""See Converter.convert()."""
2986
self.bzrdir = to_convert
2987
pb = ui.ui_factory.nested_progress_bar()
2989
ui.ui_factory.note('starting upgrade from format 5 to 6')
2990
self._convert_to_prefixed()
2991
return BzrDir.open(self.bzrdir.user_url)
2995
def _convert_to_prefixed(self):
2996
from bzrlib.store import TransportStore
2997
self.bzrdir.transport.delete('branch-format')
2998
for store_name in ["weaves", "revision-store"]:
2999
ui.ui_factory.note("adding prefixes to %s" % store_name)
3000
store_transport = self.bzrdir.transport.clone(store_name)
3001
store = TransportStore(store_transport, prefixed=True)
3002
for urlfilename in store_transport.list_dir('.'):
3003
filename = urlutils.unescape(urlfilename)
3004
if (filename.endswith(".weave") or
3005
filename.endswith(".gz") or
3006
filename.endswith(".sig")):
3007
file_id, suffix = os.path.splitext(filename)
3011
new_name = store._mapper.map((file_id,)) + suffix
3012
# FIXME keep track of the dirs made RBC 20060121
3014
store_transport.move(filename, new_name)
3015
except errors.NoSuchFile: # catches missing dirs strangely enough
3016
store_transport.mkdir(osutils.dirname(new_name))
3017
store_transport.move(filename, new_name)
3018
self.bzrdir.transport.put_bytes(
3020
BzrDirFormat6().get_format_string(),
3021
mode=self.bzrdir._get_file_mode())
3024
class ConvertBzrDir6ToMeta(Converter):
3025
"""Converts format 6 bzr dirs to metadirs."""
3027
def convert(self, to_convert, pb):
3028
"""See Converter.convert()."""
3029
from bzrlib.repofmt.weaverepo import RepositoryFormat7
3030
from bzrlib.branch import BzrBranchFormat5
3031
self.bzrdir = to_convert
3032
self.pb = ui.ui_factory.nested_progress_bar()
3034
self.total = 20 # the steps we know about
3035
self.garbage_inventories = []
3036
self.dir_mode = self.bzrdir._get_dir_mode()
3037
self.file_mode = self.bzrdir._get_file_mode()
3039
ui.ui_factory.note('starting upgrade from format 6 to metadir')
3040
self.bzrdir.transport.put_bytes(
3042
"Converting to format 6",
3043
mode=self.file_mode)
3044
# its faster to move specific files around than to open and use the apis...
3045
# first off, nuke ancestry.weave, it was never used.
3047
self.step('Removing ancestry.weave')
3048
self.bzrdir.transport.delete('ancestry.weave')
3049
except errors.NoSuchFile:
3051
# find out whats there
3052
self.step('Finding branch files')
3053
last_revision = self.bzrdir.open_branch().last_revision()
3054
bzrcontents = self.bzrdir.transport.list_dir('.')
3055
for name in bzrcontents:
3056
if name.startswith('basis-inventory.'):
3057
self.garbage_inventories.append(name)
3058
# create new directories for repository, working tree and branch
3059
repository_names = [('inventory.weave', True),
3060
('revision-store', True),
3062
self.step('Upgrading repository ')
3063
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3064
self.make_lock('repository')
3065
# we hard code the formats here because we are converting into
3066
# the meta format. The meta format upgrader can take this to a
3067
# future format within each component.
3068
self.put_format('repository', RepositoryFormat7())
3069
for entry in repository_names:
3070
self.move_entry('repository', entry)
3072
self.step('Upgrading branch ')
3073
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
3074
self.make_lock('branch')
3075
self.put_format('branch', BzrBranchFormat5())
3076
branch_files = [('revision-history', True),
3077
('branch-name', True),
3079
for entry in branch_files:
3080
self.move_entry('branch', entry)
3082
checkout_files = [('pending-merges', True),
3083
('inventory', True),
3084
('stat-cache', False)]
3085
# If a mandatory checkout file is not present, the branch does not have
3086
# a functional checkout. Do not create a checkout in the converted
3088
for name, mandatory in checkout_files:
3089
if mandatory and name not in bzrcontents:
3090
has_checkout = False
3094
if not has_checkout:
3095
ui.ui_factory.note('No working tree.')
3096
# If some checkout files are there, we may as well get rid of them.
3097
for name, mandatory in checkout_files:
3098
if name in bzrcontents:
3099
self.bzrdir.transport.delete(name)
3101
from bzrlib.workingtree import WorkingTreeFormat3
3102
self.step('Upgrading working tree')
3103
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
3104
self.make_lock('checkout')
3106
'checkout', WorkingTreeFormat3())
3107
self.bzrdir.transport.delete_multi(
3108
self.garbage_inventories, self.pb)
3109
for entry in checkout_files:
3110
self.move_entry('checkout', entry)
3111
if last_revision is not None:
3112
self.bzrdir.transport.put_bytes(
3113
'checkout/last-revision', last_revision)
3114
self.bzrdir.transport.put_bytes(
3116
BzrDirMetaFormat1().get_format_string(),
3117
mode=self.file_mode)
3119
return BzrDir.open(self.bzrdir.user_url)
3121
def make_lock(self, name):
3122
"""Make a lock for the new control dir name."""
3123
self.step('Make %s lock' % name)
3124
ld = lockdir.LockDir(self.bzrdir.transport,
3126
file_modebits=self.file_mode,
3127
dir_modebits=self.dir_mode)
3130
def move_entry(self, new_dir, entry):
3131
"""Move then entry name into new_dir."""
3133
mandatory = entry[1]
3134
self.step('Moving %s' % name)
3136
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3137
except errors.NoSuchFile:
3141
def put_format(self, dirname, format):
3142
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3143
format.get_format_string(),
3147
class ConvertMetaToMeta(Converter):
1772
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
1774
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1777
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
1778
"""BzrDirMeta1 format with support for colocated branches."""
1780
colocated_branches = True
1783
def get_format_string(cls):
1784
"""See BzrDirFormat.get_format_string()."""
1785
return "Bazaar meta directory, format 1 (with colocated branches)\n"
1787
def get_format_description(self):
1788
"""See BzrDirFormat.get_format_description()."""
1789
return "Meta directory format 1 with support for colocated branches"
1791
def _open(self, transport):
1792
"""See BzrDirFormat._open."""
1793
# Create a new format instance because otherwise initialisation of new
1794
# metadirs share the global default format object leading to alias
1796
format = BzrDirMetaFormat1Colo()
1797
self._supply_sub_formats_to(format)
1798
return BzrDirMeta1Colo(transport, format)
1801
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
1802
BzrDirMetaFormat1Colo)
1805
class ConvertMetaToMeta(controldir.Converter):
3148
1806
"""Converts the components of metadirs."""
3150
1808
def __init__(self, target_format):
3223
1880
return to_convert
3226
# This is not in remote.py because it's relatively small, and needs to be
3227
# registered. Putting it in remote.py creates a circular import problem.
3228
# we can make it a lazy object if the control formats is turned into something
3230
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3231
"""Format representing bzrdirs accessed via a smart server"""
3234
BzrDirMetaFormat1.__init__(self)
3235
# XXX: It's a bit ugly that the network name is here, because we'd
3236
# like to believe that format objects are stateless or at least
3237
# immutable, However, we do at least avoid mutating the name after
3238
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3239
self._network_name = None
3242
return "%s(_network_name=%r)" % (self.__class__.__name__,
3245
def get_format_description(self):
3246
if self._network_name:
3247
real_format = network_format_registry.get(self._network_name)
3248
return 'Remote: ' + real_format.get_format_description()
3249
return 'bzr remote bzrdir'
3251
def get_format_string(self):
3252
raise NotImplementedError(self.get_format_string)
3254
def network_name(self):
3255
if self._network_name:
3256
return self._network_name
3258
raise AssertionError("No network name set.")
3261
def probe_transport(klass, transport):
3262
"""Return a RemoteBzrDirFormat object if it looks possible."""
3264
medium = transport.get_smart_medium()
3265
except (NotImplementedError, AttributeError,
3266
errors.TransportNotPossible, errors.NoSmartMedium,
3267
errors.SmartProtocolError):
3268
# no smart server, so not a branch for this format type.
3269
raise errors.NotBranchError(path=transport.base)
3271
# Decline to open it if the server doesn't support our required
3272
# version (3) so that the VFS-based transport will do it.
3273
if medium.should_probe():
3275
server_version = medium.protocol_version()
3276
except errors.SmartProtocolError:
3277
# Apparently there's no usable smart server there, even though
3278
# the medium supports the smart protocol.
3279
raise errors.NotBranchError(path=transport.base)
3280
if server_version != '2':
3281
raise errors.NotBranchError(path=transport.base)
3284
def initialize_on_transport(self, transport):
3286
# hand off the request to the smart server
3287
client_medium = transport.get_smart_medium()
3288
except errors.NoSmartMedium:
3289
# TODO: lookup the local format from a server hint.
3290
local_dir_format = BzrDirMetaFormat1()
3291
return local_dir_format.initialize_on_transport(transport)
3292
client = _SmartClient(client_medium)
3293
path = client.remote_path_from_transport(transport)
3295
response = client.call('BzrDirFormat.initialize', path)
3296
except errors.ErrorFromSmartServer, err:
3297
remote._translate_error(err, path=path)
3298
if response[0] != 'ok':
3299
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3300
format = RemoteBzrDirFormat()
3301
self._supply_sub_formats_to(format)
3302
return remote.RemoteBzrDir(transport, format)
3304
def parse_NoneTrueFalse(self, arg):
3311
raise AssertionError("invalid arg %r" % arg)
3313
def _serialize_NoneTrueFalse(self, arg):
3320
def _serialize_NoneString(self, arg):
3323
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3324
create_prefix=False, force_new_repo=False, stacked_on=None,
3325
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3328
# hand off the request to the smart server
3329
client_medium = transport.get_smart_medium()
3330
except errors.NoSmartMedium:
3333
# Decline to open it if the server doesn't support our required
3334
# version (3) so that the VFS-based transport will do it.
3335
if client_medium.should_probe():
3337
server_version = client_medium.protocol_version()
3338
if server_version != '2':
3342
except errors.SmartProtocolError:
3343
# Apparently there's no usable smart server there, even though
3344
# the medium supports the smart protocol.
3349
client = _SmartClient(client_medium)
3350
path = client.remote_path_from_transport(transport)
3351
if client_medium._is_remote_before((1, 16)):
3354
# TODO: lookup the local format from a server hint.
3355
local_dir_format = BzrDirMetaFormat1()
3356
self._supply_sub_formats_to(local_dir_format)
3357
return local_dir_format.initialize_on_transport_ex(transport,
3358
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3359
force_new_repo=force_new_repo, stacked_on=stacked_on,
3360
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3361
make_working_trees=make_working_trees, shared_repo=shared_repo,
3363
return self._initialize_on_transport_ex_rpc(client, path, transport,
3364
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3365
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3367
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3368
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3369
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3371
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3372
args.append(self._serialize_NoneTrueFalse(create_prefix))
3373
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3374
args.append(self._serialize_NoneString(stacked_on))
3375
# stack_on_pwd is often/usually our transport
3378
stack_on_pwd = transport.relpath(stack_on_pwd)
3379
if not stack_on_pwd:
3381
except errors.PathNotChild:
3383
args.append(self._serialize_NoneString(stack_on_pwd))
3384
args.append(self._serialize_NoneString(repo_format_name))
3385
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3386
args.append(self._serialize_NoneTrueFalse(shared_repo))
3387
request_network_name = self._network_name or \
3388
BzrDirFormat.get_default_format().network_name()
3390
response = client.call('BzrDirFormat.initialize_ex_1.16',
3391
request_network_name, path, *args)
3392
except errors.UnknownSmartMethod:
3393
client._medium._remember_remote_is_before((1,16))
3394
local_dir_format = BzrDirMetaFormat1()
3395
self._supply_sub_formats_to(local_dir_format)
3396
return local_dir_format.initialize_on_transport_ex(transport,
3397
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3398
force_new_repo=force_new_repo, stacked_on=stacked_on,
3399
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3400
make_working_trees=make_working_trees, shared_repo=shared_repo,
3402
except errors.ErrorFromSmartServer, err:
3403
remote._translate_error(err, path=path)
3404
repo_path = response[0]
3405
bzrdir_name = response[6]
3406
require_stacking = response[7]
3407
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3408
format = RemoteBzrDirFormat()
3409
format._network_name = bzrdir_name
3410
self._supply_sub_formats_to(format)
3411
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3413
repo_format = remote.response_tuple_to_repo_format(response[1:])
3414
if repo_path == '.':
3417
repo_bzrdir_format = RemoteBzrDirFormat()
3418
repo_bzrdir_format._network_name = response[5]
3419
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3423
final_stack = response[8] or None
3424
final_stack_pwd = response[9] or None
3426
final_stack_pwd = urlutils.join(
3427
transport.base, final_stack_pwd)
3428
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3429
if len(response) > 10:
3430
# Updated server verb that locks remotely.
3431
repo_lock_token = response[10] or None
3432
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3434
remote_repo.dont_leave_lock_in_place()
3436
remote_repo.lock_write()
3437
policy = UseExistingRepository(remote_repo, final_stack,
3438
final_stack_pwd, require_stacking)
3439
policy.acquire_repository()
3443
bzrdir._format.set_branch_format(self.get_branch_format())
3444
if require_stacking:
3445
# The repo has already been created, but we need to make sure that
3446
# we'll make a stackable branch.
3447
bzrdir._format.require_stacking(_skip_repo=True)
3448
return remote_repo, bzrdir, require_stacking, policy
3450
def _open(self, transport):
3451
return remote.RemoteBzrDir(transport, self)
3453
def __eq__(self, other):
3454
if not isinstance(other, RemoteBzrDirFormat):
3456
return self.get_format_description() == other.get_format_description()
3458
def __return_repository_format(self):
3459
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3460
# repository format has been asked for, tell the RemoteRepositoryFormat
3461
# that it should use that for init() etc.
3462
result = remote.RemoteRepositoryFormat()
3463
custom_format = getattr(self, '_repository_format', None)
3465
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3466
return custom_format
3468
# We will use the custom format to create repositories over the
3469
# wire; expose its details like rich_root_data for code to
3471
result._custom_format = custom_format
3474
def get_branch_format(self):
3475
result = BzrDirMetaFormat1.get_branch_format(self)
3476
if not isinstance(result, remote.RemoteBranchFormat):
3477
new_result = remote.RemoteBranchFormat()
3478
new_result._custom_format = result
3480
self.set_branch_format(new_result)
3484
repository_format = property(__return_repository_format,
3485
BzrDirMetaFormat1._set_repository_format) #.im_func)
3488
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3491
class BzrDirFormatInfo(object):
3493
def __init__(self, native, deprecated, hidden, experimental):
3494
self.deprecated = deprecated
3495
self.native = native
3496
self.hidden = hidden
3497
self.experimental = experimental
3500
class BzrDirFormatRegistry(registry.Registry):
3501
"""Registry of user-selectable BzrDir subformats.
3503
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3504
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3508
"""Create a BzrDirFormatRegistry."""
3509
self._aliases = set()
3510
self._registration_order = list()
3511
super(BzrDirFormatRegistry, self).__init__()
3514
"""Return a set of the format names which are aliases."""
3515
return frozenset(self._aliases)
3517
def register_metadir(self, key,
3518
repository_format, help, native=True, deprecated=False,
3524
"""Register a metadir subformat.
3526
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3527
by the Repository/Branch/WorkingTreeformats.
3529
:param repository_format: The fully-qualified repository format class
3531
:param branch_format: Fully-qualified branch format class name as
3533
:param tree_format: Fully-qualified tree format class name as
3536
# This should be expanded to support setting WorkingTree and Branch
3537
# formats, once BzrDirMetaFormat1 supports that.
3538
def _load(full_name):
3539
mod_name, factory_name = full_name.rsplit('.', 1)
3541
mod = __import__(mod_name, globals(), locals(),
3543
except ImportError, e:
3544
raise ImportError('failed to load %s: %s' % (full_name, e))
3546
factory = getattr(mod, factory_name)
3547
except AttributeError:
3548
raise AttributeError('no factory %s in module %r'
3553
bd = BzrDirMetaFormat1()
3554
if branch_format is not None:
3555
bd.set_branch_format(_load(branch_format))
3556
if tree_format is not None:
3557
bd.workingtree_format = _load(tree_format)
3558
if repository_format is not None:
3559
bd.repository_format = _load(repository_format)
3561
self.register(key, helper, help, native, deprecated, hidden,
3562
experimental, alias)
3564
def register(self, key, factory, help, native=True, deprecated=False,
3565
hidden=False, experimental=False, alias=False):
3566
"""Register a BzrDirFormat factory.
3568
The factory must be a callable that takes one parameter: the key.
3569
It must produce an instance of the BzrDirFormat when called.
3571
This function mainly exists to prevent the info object from being
3574
registry.Registry.register(self, key, factory, help,
3575
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3577
self._aliases.add(key)
3578
self._registration_order.append(key)
3580
def register_lazy(self, key, module_name, member_name, help, native=True,
3581
deprecated=False, hidden=False, experimental=False, alias=False):
3582
registry.Registry.register_lazy(self, key, module_name, member_name,
3583
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3585
self._aliases.add(key)
3586
self._registration_order.append(key)
3588
def set_default(self, key):
3589
"""Set the 'default' key to be a clone of the supplied key.
3591
This method must be called once and only once.
3593
registry.Registry.register(self, 'default', self.get(key),
3594
self.get_help(key), info=self.get_info(key))
3595
self._aliases.add('default')
3597
def set_default_repository(self, key):
3598
"""Set the FormatRegistry default and Repository default.
3600
This is a transitional method while Repository.set_default_format
3603
if 'default' in self:
3604
self.remove('default')
3605
self.set_default(key)
3606
format = self.get('default')()
3608
def make_bzrdir(self, key):
3609
return self.get(key)()
3611
def help_topic(self, topic):
3613
default_realkey = None
3614
default_help = self.get_help('default')
3616
for key in self._registration_order:
3617
if key == 'default':
3619
help = self.get_help(key)
3620
if help == default_help:
3621
default_realkey = key
3623
help_pairs.append((key, help))
3625
def wrapped(key, help, info):
3627
help = '(native) ' + help
3628
return ':%s:\n%s\n\n' % (key,
3629
textwrap.fill(help, initial_indent=' ',
3630
subsequent_indent=' ',
3631
break_long_words=False))
3632
if default_realkey is not None:
3633
output += wrapped(default_realkey, '(default) %s' % default_help,
3634
self.get_info('default'))
3635
deprecated_pairs = []
3636
experimental_pairs = []
3637
for key, help in help_pairs:
3638
info = self.get_info(key)
3641
elif info.deprecated:
3642
deprecated_pairs.append((key, help))
3643
elif info.experimental:
3644
experimental_pairs.append((key, help))
3646
output += wrapped(key, help, info)
3647
output += "\nSee :doc:`formats-help` for more about storage formats."
3649
if len(experimental_pairs) > 0:
3650
other_output += "Experimental formats are shown below.\n\n"
3651
for key, help in experimental_pairs:
3652
info = self.get_info(key)
3653
other_output += wrapped(key, help, info)
3656
"No experimental formats are available.\n\n"
3657
if len(deprecated_pairs) > 0:
3658
other_output += "\nDeprecated formats are shown below.\n\n"
3659
for key, help in deprecated_pairs:
3660
info = self.get_info(key)
3661
other_output += wrapped(key, help, info)
3664
"\nNo deprecated formats are available.\n\n"
3666
"\nSee :doc:`formats-help` for more about storage formats."
3668
if topic == 'other-formats':
1883
class ConvertMetaToColo(controldir.Converter):
1884
"""Add colocated branch support."""
1886
def __init__(self, target_format):
1887
"""Create a converter.that upgrades a metadir to the colo format.
1889
:param target_format: The final metadir format that is desired.
1891
self.target_format = target_format
1893
def convert(self, to_convert, pb):
1894
"""See Converter.convert()."""
1895
to_convert.transport.put_bytes('branch-format',
1896
self.target_format.as_string())
1897
return BzrDir.open_from_transport(to_convert.root_transport)
1900
class ConvertMetaRemoveColo(controldir.Converter):
1901
"""Remove colocated branch support from a bzrdir."""
1903
def __init__(self, target_format):
1904
"""Create a converter.that downgrades a colocated branch metadir
1905
to a regular metadir.
1907
:param target_format: The final metadir format that is desired.
1909
self.target_format = target_format
1911
def convert(self, to_convert, pb):
1912
"""See Converter.convert()."""
1913
to_convert.control_files.lock_write()
1915
branches = to_convert.list_branches()
1916
if len(branches) > 1:
1917
raise errors.BzrError("remove all but a single "
1918
"colocated branch when downgrading")
1920
to_convert.control_files.unlock()
1921
to_convert.transport.put_bytes('branch-format',
1922
self.target_format.as_string())
1923
return BzrDir.open_from_transport(to_convert.root_transport)
1926
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
3674
1929
class RepositoryAcquisitionPolicy(object):
3818
2081
require_stacking)
3819
2082
self._repository = repository
3821
def acquire_repository(self, make_working_trees=None, shared=False):
2084
def acquire_repository(self, make_working_trees=None, shared=False,
2085
possible_transports=None):
3822
2086
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3824
2088
Returns an existing repository to use.
2090
if possible_transports is None:
2091
possible_transports = []
2093
possible_transports = list(possible_transports)
2094
possible_transports.append(self._repository.bzrdir.transport)
3826
2095
self._add_fallback(self._repository,
3827
possible_transports=[self._repository.bzrdir.transport])
2096
possible_transports=possible_transports)
3828
2097
return self._repository, False
3831
# Please register new formats after old formats so that formats
3832
# appear in chronological order and format descriptions can build
3834
format_registry = BzrDirFormatRegistry()
3835
# The pre-0.8 formats have their repository format network name registered in
3836
# repository.py. MetaDir formats have their repository format network name
3837
# inferred from their disk format string.
3838
format_registry.register('weave', BzrDirFormat6,
3839
'Pre-0.8 format. Slower than knit and does not'
3840
' support checkouts or shared repositories.',
3843
format_registry.register_metadir('metaweave',
3844
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
'Transitional format in 0.8. Slower than knit.',
3846
branch_format='bzrlib.branch.BzrBranchFormat5',
3847
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3850
format_registry.register_metadir('knit',
2100
def register_metadir(registry, key,
2101
repository_format, help, native=True, deprecated=False,
2106
alias=False, bzrdir_format=None):
2107
"""Register a metadir subformat.
2109
These all use a meta bzrdir, but can be parameterized by the
2110
Repository/Branch/WorkingTreeformats.
2112
:param repository_format: The fully-qualified repository format class
2114
:param branch_format: Fully-qualified branch format class name as
2116
:param tree_format: Fully-qualified tree format class name as
2119
if bzrdir_format is None:
2120
bzrdir_format = BzrDirMetaFormat1
2121
# This should be expanded to support setting WorkingTree and Branch
2122
# formats, once the API supports that.
2123
def _load(full_name):
2124
mod_name, factory_name = full_name.rsplit('.', 1)
2126
factory = pyutils.get_named_object(mod_name, factory_name)
2127
except ImportError, e:
2128
raise ImportError('failed to load %s: %s' % (full_name, e))
2129
except AttributeError:
2130
raise AttributeError('no factory %s in module %r'
2131
% (full_name, sys.modules[mod_name]))
2135
bd = bzrdir_format()
2136
if branch_format is not None:
2137
bd.set_branch_format(_load(branch_format))
2138
if tree_format is not None:
2139
bd.workingtree_format = _load(tree_format)
2140
if repository_format is not None:
2141
bd.repository_format = _load(repository_format)
2143
registry.register(key, helper, help, native, deprecated, hidden,
2144
experimental, alias)
2146
register_metadir(controldir.format_registry, 'knit',
3851
2147
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3852
2148
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3853
2149
branch_format='bzrlib.branch.BzrBranchFormat5',
3854
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2150
tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
3856
2152
deprecated=True)
3857
format_registry.register_metadir('dirstate',
2153
register_metadir(controldir.format_registry, 'dirstate',
3858
2154
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3859
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3860
'above when accessed over the network.',
2155
help='Format using dirstate for working trees. '
2156
'Compatible with bzr 0.8 and '
2157
'above when accessed over the network. Introduced in bzr 0.15.',
3861
2158
branch_format='bzrlib.branch.BzrBranchFormat5',
3862
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3863
# directly from workingtree_4 triggers a circular import.
3864
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2159
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3866
2161
deprecated=True)
3867
format_registry.register_metadir('dirstate-tags',
2162
register_metadir(controldir.format_registry, 'dirstate-tags',
3868
2163
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
help='New in 0.15: Fast local operations and improved scaling for '
3870
'network operations. Additionally adds support for tags.'
3871
' Incompatible with bzr < 0.15.',
2164
help='Variant of dirstate with support for tags. '
2165
'Introduced in bzr 0.15.',
3872
2166
branch_format='bzrlib.branch.BzrBranchFormat6',
3873
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2167
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3875
2169
deprecated=True)
3876
format_registry.register_metadir('rich-root',
2170
register_metadir(controldir.format_registry, 'rich-root',
3877
2171
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3878
help='New in 1.0. Better handling of tree roots. Incompatible with'
2172
help='Variant of dirstate with better handling of tree roots. '
2173
'Introduced in bzr 1.0',
3880
2174
branch_format='bzrlib.branch.BzrBranchFormat6',
3881
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2175
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3883
2177
deprecated=True)
3884
format_registry.register_metadir('dirstate-with-subtree',
2178
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
3885
2179
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3886
help='New in 0.15: Fast local operations and improved scaling for '
3887
'network operations. Additionally adds support for versioning nested '
3888
'bzr branches. Incompatible with bzr < 0.15.',
3889
branch_format='bzrlib.branch.BzrBranchFormat6',
3890
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3894
format_registry.register_metadir('pack-0.92',
3895
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3896
help='New in 0.92: Pack-based format with data compatible with '
3897
'dirstate-tags format repositories. Interoperates with '
3898
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3900
branch_format='bzrlib.branch.BzrBranchFormat6',
3901
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3903
format_registry.register_metadir('pack-0.92-subtree',
3904
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3905
help='New in 0.92: Pack-based format with data compatible with '
3906
'dirstate-with-subtree format repositories. Interoperates with '
3907
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3909
branch_format='bzrlib.branch.BzrBranchFormat6',
3910
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3914
format_registry.register_metadir('rich-root-pack',
3915
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3916
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3917
'(needed for bzr-svn and bzr-git).',
3918
branch_format='bzrlib.branch.BzrBranchFormat6',
3919
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3922
format_registry.register_metadir('1.6',
3923
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
2180
help='Variant of dirstate with support for nested trees. '
2181
'Introduced in 0.15.',
2182
branch_format='bzrlib.branch.BzrBranchFormat6',
2183
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2187
register_metadir(controldir.format_registry, 'pack-0.92',
2188
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
2189
help='Pack-based format used in 1.x series. Introduced in 0.92. '
2190
'Interoperates with bzr repositories before 0.92 but cannot be '
2191
'read by bzr < 0.92. '
2193
branch_format='bzrlib.branch.BzrBranchFormat6',
2194
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2197
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2198
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
2199
help='Pack-based format used in 1.x series, with subtree support. '
2200
'Introduced in 0.92. Interoperates with '
2201
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2203
branch_format='bzrlib.branch.BzrBranchFormat6',
2204
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2209
register_metadir(controldir.format_registry, 'rich-root-pack',
2210
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
2211
help='A variant of pack-0.92 that supports rich-root data '
2212
'(needed for bzr-svn and bzr-git). Introduced in 1.0.',
2213
branch_format='bzrlib.branch.BzrBranchFormat6',
2214
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2218
register_metadir(controldir.format_registry, '1.6',
2219
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
3924
2220
help='A format that allows a branch to indicate that there is another '
3925
2221
'(stacked) repository that should be used to access data that is '
3926
2222
'not present locally.',
3927
2223
branch_format='bzrlib.branch.BzrBranchFormat7',
3928
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2224
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3931
format_registry.register_metadir('1.6.1-rich-root',
3932
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
2228
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2229
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
3933
2230
help='A variant of 1.6 that supports rich-root data '
3934
2231
'(needed for bzr-svn and bzr-git).',
3935
2232
branch_format='bzrlib.branch.BzrBranchFormat7',
3936
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2233
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3939
format_registry.register_metadir('1.9',
3940
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2237
register_metadir(controldir.format_registry, '1.9',
2238
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
3941
2239
help='A repository format using B+tree indexes. These indexes '
3942
2240
'are smaller in size, have smarter caching and provide faster '
3943
2241
'performance for most operations.',
3944
2242
branch_format='bzrlib.branch.BzrBranchFormat7',
3945
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2243
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3948
format_registry.register_metadir('1.9-rich-root',
3949
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2247
register_metadir(controldir.format_registry, '1.9-rich-root',
2248
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
3950
2249
help='A variant of 1.9 that supports rich-root data '
3951
2250
'(needed for bzr-svn and bzr-git).',
3952
2251
branch_format='bzrlib.branch.BzrBranchFormat7',
3953
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2252
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3956
format_registry.register_metadir('1.14',
3957
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2256
register_metadir(controldir.format_registry, '1.14',
2257
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
3958
2258
help='A working-tree format that supports content filtering.',
3959
2259
branch_format='bzrlib.branch.BzrBranchFormat7',
3960
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2260
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
3962
format_registry.register_metadir('1.14-rich-root',
3963
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2264
register_metadir(controldir.format_registry, '1.14-rich-root',
2265
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
3964
2266
help='A variant of 1.14 that supports rich-root data '
3965
2267
'(needed for bzr-svn and bzr-git).',
3966
2268
branch_format='bzrlib.branch.BzrBranchFormat7',
3967
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2269
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
3969
2273
# The following un-numbered 'development' formats should always just be aliases.
3970
format_registry.register_metadir('development-rich-root',
3971
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3972
help='Current development format. Supports rich roots. Can convert data '
3973
'to and from rich-root-pack (and anything compatible with '
3974
'rich-root-pack) format repositories. Repositories and branches in '
3975
'this format can only be read by bzr.dev. Please read '
3976
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3978
branch_format='bzrlib.branch.BzrBranchFormat7',
3979
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3984
format_registry.register_metadir('development-subtree',
3985
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
2274
register_metadir(controldir.format_registry, 'development-subtree',
2275
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
3986
2276
help='Current development format, subtree variant. Can convert data to and '
3987
2277
'from pack-0.92-subtree (and anything compatible with '
3988
2278
'pack-0.92-subtree) format repositories. Repositories and branches in '
3990
2280
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3992
2282
branch_format='bzrlib.branch.BzrBranchFormat7',
3993
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2283
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
3994
2284
experimental=True,
3996
2286
alias=False, # Restore to being an alias when an actual development subtree format is added
3997
2287
# This current non-alias status is simply because we did not introduce a
3998
2288
# chk based subtree format.
2290
register_metadir(controldir.format_registry, 'development5-subtree',
2291
'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
2292
help='Development format, subtree variant. Can convert data to and '
2293
'from pack-0.92-subtree (and anything compatible with '
2294
'pack-0.92-subtree) format repositories. Repositories and branches in '
2295
'this format can only be read by bzr.dev. Please read '
2296
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2298
branch_format='bzrlib.branch.BzrBranchFormat7',
2299
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2305
register_metadir(controldir.format_registry, 'development-colo',
2306
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2307
help='The 2a format with experimental support for colocated branches.\n',
2308
branch_format='bzrlib.branch.BzrBranchFormat7',
2309
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2311
bzrdir_format=BzrDirMetaFormat1Colo,
4001
2315
# And the development formats above will have aliased one of the following:
4002
format_registry.register_metadir('development6-rich-root',
4003
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4004
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4006
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4008
branch_format='bzrlib.branch.BzrBranchFormat7',
4009
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4014
format_registry.register_metadir('development7-rich-root',
4015
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4016
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4017
'rich roots. Please read '
4018
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4020
branch_format='bzrlib.branch.BzrBranchFormat7',
4021
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4026
format_registry.register_metadir('2a',
2317
# Finally, the current format.
2318
register_metadir(controldir.format_registry, '2a',
4027
2319
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4028
help='First format for bzr 2.0 series.\n'
2320
help='Format for the bzr 2.0 series.\n'
4029
2321
'Uses group-compress storage.\n'
4030
2322
'Provides rich roots which are a one-way transition.\n',
4031
2323
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4032
2324
# 'rich roots. Supported by bzr 1.16 and later.',
4033
2325
branch_format='bzrlib.branch.BzrBranchFormat7',
4034
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2326
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
4038
2330
# The following format should be an alias for the rich root equivalent
4039
2331
# of the default format
4040
format_registry.register_metadir('default-rich-root',
2332
register_metadir(controldir.format_registry, 'default-rich-root',
4041
2333
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4042
2334
branch_format='bzrlib.branch.BzrBranchFormat7',
4043
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2335
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
4046
2338
help='Same as 2a.')
4048
2340
# The current format that is made on 'bzr init'.
4049
format_registry.set_default('2a')
2341
format_name = config.GlobalStack().get('default_format')
2342
controldir.format_registry.set_default(format_name)
2344
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2345
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
2346
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
2347
format_registry = controldir.format_registry
added
removed
bzrlib/bzrdir.py
