1
# Copyright (C) 2006-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
19
At format 7 this was split out into Branch, Repository and Checkout control
22
Note: This module has a lot of ``open`` functions/methods that return
23
references to in-memory objects. As a rule, there are no matching ``close``
24
methods. To free any associated resources, simply stop referencing the
30
from bzrlib.lazy_import import lazy_import
31
lazy_import(globals(), """
32
from stat import S_ISDIR
48
revision as _mod_revision,
49
transport as _mod_transport,
57
from bzrlib.repofmt import pack_repo
58
from bzrlib.transport import (
59
do_catching_redirections,
64
from bzrlib.trace import (
73
from bzrlib.symbol_versioning import (
79
class BzrDir(controldir.ControlDir):
80
"""A .bzr control diretory.
82
BzrDir instances let you create or open any of the things that can be
83
found within .bzr - checkouts, branches and repositories.
86
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
88
a transport connected to the directory this bzr was opened from
89
(i.e. the parent directory holding the .bzr directory).
91
Everything in the bzrdir should have the same file permissions.
93
:cvar hooks: An instance of BzrDirHooks.
97
"""Invoke break_lock on the first object in the bzrdir.
99
If there is a tree, the tree is opened and break_lock() called.
100
Otherwise, branch is tried, and finally repository.
102
# XXX: This seems more like a UI function than something that really
103
# belongs in this class.
105
thing_to_unlock = self.open_workingtree()
106
except (errors.NotLocalUrl, errors.NoWorkingTree):
108
thing_to_unlock = self.open_branch()
109
except errors.NotBranchError:
111
thing_to_unlock = self.open_repository()
112
except errors.NoRepositoryPresent:
114
thing_to_unlock.break_lock()
116
def check_conversion_target(self, target_format):
117
"""Check that a bzrdir as a whole can be converted to a new format."""
118
# The only current restriction is that the repository content can be
119
# fetched compatibly with the target.
120
target_repo_format = target_format.repository_format
122
self.open_repository()._format.check_conversion_target(
124
except errors.NoRepositoryPresent:
125
# No repo, no problem.
128
def clone_on_transport(self, transport, revision_id=None,
129
force_new_repo=False, preserve_stacking=False, stacked_on=None,
130
create_prefix=False, use_existing_dir=True, no_tree=False):
131
"""Clone this bzrdir and its contents to transport verbatim.
133
:param transport: The transport for the location to produce the clone
134
at. If the target directory does not exist, it will be created.
135
:param revision_id: The tip revision-id to use for any branch or
136
working tree. If not None, then the clone operation may tune
137
itself to download less data.
138
:param force_new_repo: Do not use a shared repository for the target,
139
even if one is available.
140
:param preserve_stacking: When cloning a stacked branch, stack the
141
new branch on top of the other branch's stacked-on branch.
142
:param create_prefix: Create any missing directories leading up to
144
:param use_existing_dir: Use an existing directory if one exists.
145
:param no_tree: If set to true prevents creation of a working tree.
147
# Overview: put together a broad description of what we want to end up
148
# with; then make as few api calls as possible to do it.
150
# We may want to create a repo/branch/tree, if we do so what format
151
# would we want for each:
152
require_stacking = (stacked_on is not None)
153
format = self.cloning_metadir(require_stacking)
155
# Figure out what objects we want:
157
local_repo = self.find_repository()
158
except errors.NoRepositoryPresent:
161
local_branch = self.open_branch()
162
except errors.NotBranchError:
165
# enable fallbacks when branch is not a branch reference
166
if local_branch.repository.has_same_location(local_repo):
167
local_repo = local_branch.repository
168
if preserve_stacking:
170
stacked_on = local_branch.get_stacked_on_url()
171
except (errors.UnstackableBranchFormat,
172
errors.UnstackableRepositoryFormat,
175
# Bug: We create a metadir without knowing if it can support stacking,
176
# we should look up the policy needs first, or just use it as a hint,
179
make_working_trees = local_repo.make_working_trees() and not no_tree
180
want_shared = local_repo.is_shared()
181
repo_format_name = format.repository_format.network_name()
183
make_working_trees = False
185
repo_format_name = None
187
result_repo, result, require_stacking, repository_policy = \
188
format.initialize_on_transport_ex(transport,
189
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
190
force_new_repo=force_new_repo, stacked_on=stacked_on,
191
stack_on_pwd=self.root_transport.base,
192
repo_format_name=repo_format_name,
193
make_working_trees=make_working_trees, shared_repo=want_shared)
196
# If the result repository is in the same place as the
197
# resulting bzr dir, it will have no content, further if the
198
# result is not stacked then we know all content should be
199
# copied, and finally if we are copying up to a specific
200
# revision_id then we can use the pending-ancestry-result which
201
# does not require traversing all of history to describe it.
202
if (result_repo.user_url == result.user_url
203
and not require_stacking and
204
revision_id is not None):
205
fetch_spec = graph.PendingAncestryResult(
206
[revision_id], local_repo)
207
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
209
result_repo.fetch(local_repo, revision_id=revision_id)
213
if result_repo is not None:
214
raise AssertionError('result_repo not None(%r)' % result_repo)
215
# 1 if there is a branch present
216
# make sure its content is available in the target repository
218
if local_branch is not None:
219
result_branch = local_branch.clone(result, revision_id=revision_id,
220
repository_policy=repository_policy)
222
# Cheaper to check if the target is not local, than to try making
224
result.root_transport.local_abspath('.')
225
if result_repo is None or result_repo.make_working_trees():
226
self.open_workingtree().clone(result)
227
except (errors.NoWorkingTree, errors.NotLocalUrl):
231
# TODO: This should be given a Transport, and should chdir up; otherwise
232
# this will open a new connection.
233
def _make_tail(self, url):
234
t = _mod_transport.get_transport(url)
238
def find_bzrdirs(transport, evaluate=None, list_current=None):
239
"""Find bzrdirs recursively from current location.
241
This is intended primarily as a building block for more sophisticated
242
functionality, like finding trees under a directory, or finding
243
branches that use a given repository.
244
:param evaluate: An optional callable that yields recurse, value,
245
where recurse controls whether this bzrdir is recursed into
246
and value is the value to yield. By default, all bzrdirs
247
are recursed into, and the return value is the bzrdir.
248
:param list_current: if supplied, use this function to list the current
249
directory, instead of Transport.list_dir
250
:return: a generator of found bzrdirs, or whatever evaluate returns.
252
if list_current is None:
253
def list_current(transport):
254
return transport.list_dir('')
256
def evaluate(bzrdir):
259
pending = [transport]
260
while len(pending) > 0:
261
current_transport = pending.pop()
264
bzrdir = BzrDir.open_from_transport(current_transport)
265
except (errors.NotBranchError, errors.PermissionDenied):
268
recurse, value = evaluate(bzrdir)
271
subdirs = list_current(current_transport)
272
except (errors.NoSuchFile, errors.PermissionDenied):
275
for subdir in sorted(subdirs, reverse=True):
276
pending.append(current_transport.clone(subdir))
279
def find_branches(transport):
280
"""Find all branches under a transport.
282
This will find all branches below the transport, including branches
283
inside other branches. Where possible, it will use
284
Repository.find_branches.
286
To list all the branches that use a particular Repository, see
287
Repository.find_branches
289
def evaluate(bzrdir):
291
repository = bzrdir.open_repository()
292
except errors.NoRepositoryPresent:
295
return False, ([], repository)
296
return True, (bzrdir.list_branches(), None)
298
for branches, repo in BzrDir.find_bzrdirs(transport,
301
ret.extend(repo.find_branches())
302
if branches is not None:
307
def create_branch_and_repo(base, force_new_repo=False, format=None):
308
"""Create a new BzrDir, Branch and Repository at the url 'base'.
310
This will use the current default BzrDirFormat unless one is
311
specified, and use whatever
312
repository format that that uses via bzrdir.create_branch and
313
create_repository. If a shared repository is available that is used
316
The created Branch object is returned.
318
:param base: The URL to create the branch at.
319
:param force_new_repo: If True a new repository is always created.
320
:param format: If supplied, the format of branch to create. If not
321
supplied, the default is used.
323
bzrdir = BzrDir.create(base, format)
324
bzrdir._find_or_create_repository(force_new_repo)
325
return bzrdir.create_branch()
327
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
328
stack_on_pwd=None, require_stacking=False):
329
"""Return an object representing a policy to use.
331
This controls whether a new repository is created, and the format of
332
that repository, or some existing shared repository used instead.
334
If stack_on is supplied, will not seek a containing shared repo.
336
:param force_new_repo: If True, require a new repository to be created.
337
:param stack_on: If supplied, the location to stack on. If not
338
supplied, a default_stack_on location may be used.
339
:param stack_on_pwd: If stack_on is relative, the location it is
342
def repository_policy(found_bzrdir):
345
config = found_bzrdir.get_config()
347
stack_on = config.get_default_stack_on()
348
if stack_on is not None:
349
stack_on_pwd = found_bzrdir.user_url
351
# does it have a repository ?
353
repository = found_bzrdir.open_repository()
354
except errors.NoRepositoryPresent:
357
if (found_bzrdir.user_url != self.user_url
358
and not repository.is_shared()):
359
# Don't look higher, can't use a higher shared repo.
367
return UseExistingRepository(repository, stack_on,
368
stack_on_pwd, require_stacking=require_stacking), True
370
return CreateRepository(self, stack_on, stack_on_pwd,
371
require_stacking=require_stacking), True
373
if not force_new_repo:
375
policy = self._find_containing(repository_policy)
376
if policy is not None:
380
return UseExistingRepository(self.open_repository(),
381
stack_on, stack_on_pwd,
382
require_stacking=require_stacking)
383
except errors.NoRepositoryPresent:
385
return CreateRepository(self, stack_on, stack_on_pwd,
386
require_stacking=require_stacking)
388
def _find_or_create_repository(self, force_new_repo):
389
"""Create a new repository if needed, returning the repository."""
390
policy = self.determine_repository_policy(force_new_repo)
391
return policy.acquire_repository()[0]
393
def _find_source_repo(self, add_cleanup, source_branch):
394
"""Find the source branch and repo for a sprout operation.
396
This is helper intended for use by _sprout.
398
:returns: (source_branch, source_repository). Either or both may be
399
None. If not None, they will be read-locked (and their unlock(s)
400
scheduled via the add_cleanup param).
402
if source_branch is not None:
403
add_cleanup(source_branch.lock_read().unlock)
404
return source_branch, source_branch.repository
406
source_branch = self.open_branch()
407
source_repository = source_branch.repository
408
except errors.NotBranchError:
411
source_repository = self.open_repository()
412
except errors.NoRepositoryPresent:
413
source_repository = None
415
add_cleanup(source_repository.lock_read().unlock)
417
add_cleanup(source_branch.lock_read().unlock)
418
return source_branch, source_repository
420
def sprout(self, url, revision_id=None, force_new_repo=False,
421
recurse='down', possible_transports=None,
422
accelerator_tree=None, hardlink=False, stacked=False,
423
source_branch=None, create_tree_if_local=True):
424
"""Create a copy of this controldir prepared for use as a new line of
427
If url's last component does not exist, it will be created.
429
Attributes related to the identity of the source branch like
430
branch nickname will be cleaned, a working tree is created
431
whether one existed before or not; and a local branch is always
434
if revision_id is not None, then the clone operation may tune
435
itself to download less data.
436
:param accelerator_tree: A tree which can be used for retrieving file
437
contents more quickly than the revision tree, i.e. a workingtree.
438
The revision tree will be used for cases where accelerator_tree's
439
content is different.
440
:param hardlink: If true, hard-link files from accelerator_tree,
442
:param stacked: If true, create a stacked branch referring to the
443
location of this control directory.
444
:param create_tree_if_local: If true, a working-tree will be created
445
when working locally.
447
operation = cleanup.OperationWithCleanups(self._sprout)
448
return operation.run(url, revision_id=revision_id,
449
force_new_repo=force_new_repo, recurse=recurse,
450
possible_transports=possible_transports,
451
accelerator_tree=accelerator_tree, hardlink=hardlink,
452
stacked=stacked, source_branch=source_branch,
453
create_tree_if_local=create_tree_if_local)
455
def _sprout(self, op, url, revision_id=None, force_new_repo=False,
456
recurse='down', possible_transports=None,
457
accelerator_tree=None, hardlink=False, stacked=False,
458
source_branch=None, create_tree_if_local=True):
459
add_cleanup = op.add_cleanup
460
fetch_spec_factory = fetch.FetchSpecFactory()
461
if revision_id is not None:
462
fetch_spec_factory.add_revision_ids([revision_id])
463
fetch_spec_factory.source_branch_stop_revision_id = revision_id
464
target_transport = _mod_transport.get_transport(url,
466
target_transport.ensure_base()
467
cloning_format = self.cloning_metadir(stacked)
468
# Create/update the result branch
469
result = cloning_format.initialize_on_transport(target_transport)
470
source_branch, source_repository = self._find_source_repo(
471
add_cleanup, source_branch)
472
fetch_spec_factory.source_branch = source_branch
473
# if a stacked branch wasn't requested, we don't create one
474
# even if the origin was stacked
475
if stacked and source_branch is not None:
476
stacked_branch_url = self.root_transport.base
478
stacked_branch_url = None
479
repository_policy = result.determine_repository_policy(
480
force_new_repo, stacked_branch_url, require_stacking=stacked)
481
result_repo, is_new_repo = repository_policy.acquire_repository()
482
add_cleanup(result_repo.lock_write().unlock)
483
fetch_spec_factory.source_repo = source_repository
484
fetch_spec_factory.target_repo = result_repo
485
if stacked or (len(result_repo._fallback_repositories) != 0):
486
target_repo_kind = fetch.TargetRepoKinds.STACKED
488
target_repo_kind = fetch.TargetRepoKinds.EMPTY
490
target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
491
fetch_spec_factory.target_repo_kind = target_repo_kind
492
if source_repository is not None:
493
fetch_spec = fetch_spec_factory.make_fetch_spec()
494
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
496
if source_branch is None:
497
# this is for sprouting a controldir without a branch; is that
499
# Not especially, but it's part of the contract.
500
result_branch = result.create_branch()
502
result_branch = source_branch.sprout(result,
503
revision_id=revision_id, repository_policy=repository_policy,
504
repository=result_repo)
505
mutter("created new branch %r" % (result_branch,))
507
# Create/update the result working tree
508
if (create_tree_if_local and
509
isinstance(target_transport, local.LocalTransport) and
510
(result_repo is None or result_repo.make_working_trees())):
511
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
512
hardlink=hardlink, from_branch=result_branch)
515
if wt.path2id('') is None:
517
wt.set_root_id(self.open_workingtree.get_root_id())
518
except errors.NoWorkingTree:
524
if recurse == 'down':
527
basis = wt.basis_tree()
528
elif result_branch is not None:
529
basis = result_branch.basis_tree()
530
elif source_branch is not None:
531
basis = source_branch.basis_tree()
532
if basis is not None:
533
add_cleanup(basis.lock_read().unlock)
534
subtrees = basis.iter_references()
537
for path, file_id in subtrees:
538
target = urlutils.join(url, urlutils.escape(path))
539
sublocation = source_branch.reference_parent(file_id, path)
540
sublocation.bzrdir.sprout(target,
541
basis.get_reference_revision(file_id, path),
542
force_new_repo=force_new_repo, recurse=recurse,
549
def create_branch_convenience(base, force_new_repo=False,
550
force_new_tree=None, format=None,
551
possible_transports=None):
552
"""Create a new BzrDir, Branch and Repository at the url 'base'.
554
This is a convenience function - it will use an existing repository
555
if possible, can be told explicitly whether to create a working tree or
558
This will use the current default BzrDirFormat unless one is
559
specified, and use whatever
560
repository format that that uses via bzrdir.create_branch and
561
create_repository. If a shared repository is available that is used
562
preferentially. Whatever repository is used, its tree creation policy
565
The created Branch object is returned.
566
If a working tree cannot be made due to base not being a file:// url,
567
no error is raised unless force_new_tree is True, in which case no
568
data is created on disk and NotLocalUrl is raised.
570
:param base: The URL to create the branch at.
571
:param force_new_repo: If True a new repository is always created.
572
:param force_new_tree: If True or False force creation of a tree or
573
prevent such creation respectively.
574
:param format: Override for the bzrdir format to create.
575
:param possible_transports: An optional reusable transports list.
578
# check for non local urls
579
t = _mod_transport.get_transport(base, possible_transports)
580
if not isinstance(t, local.LocalTransport):
581
raise errors.NotLocalUrl(base)
582
bzrdir = BzrDir.create(base, format, possible_transports)
583
repo = bzrdir._find_or_create_repository(force_new_repo)
584
result = bzrdir.create_branch()
585
if force_new_tree or (repo.make_working_trees() and
586
force_new_tree is None):
588
bzrdir.create_workingtree()
589
except errors.NotLocalUrl:
594
def create_standalone_workingtree(base, format=None):
595
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
597
'base' must be a local path or a file:// url.
599
This will use the current default BzrDirFormat unless one is
600
specified, and use whatever
601
repository format that that uses for bzrdirformat.create_workingtree,
602
create_branch and create_repository.
604
:param format: Override for the bzrdir format to create.
605
:return: The WorkingTree object.
607
t = _mod_transport.get_transport(base)
608
if not isinstance(t, local.LocalTransport):
609
raise errors.NotLocalUrl(base)
610
bzrdir = BzrDir.create_branch_and_repo(base,
612
format=format).bzrdir
613
return bzrdir.create_workingtree()
615
@deprecated_method(deprecated_in((2, 3, 0)))
616
def generate_backup_name(self, base):
617
return self._available_backup_name(base)
619
def _available_backup_name(self, base):
620
"""Find a non-existing backup file name based on base.
622
See bzrlib.osutils.available_backup_name about race conditions.
624
return osutils.available_backup_name(base, self.root_transport.has)
626
def backup_bzrdir(self):
627
"""Backup this bzr control directory.
629
:return: Tuple with old path name and new path name
632
pb = ui.ui_factory.nested_progress_bar()
634
old_path = self.root_transport.abspath('.bzr')
635
backup_dir = self._available_backup_name('backup.bzr')
636
new_path = self.root_transport.abspath(backup_dir)
637
ui.ui_factory.note('making backup of %s\n to %s'
638
% (old_path, new_path,))
639
self.root_transport.copy_tree('.bzr', backup_dir)
640
return (old_path, new_path)
644
def retire_bzrdir(self, limit=10000):
645
"""Permanently disable the bzrdir.
647
This is done by renaming it to give the user some ability to recover
648
if there was a problem.
650
This will have horrible consequences if anyone has anything locked or
652
:param limit: number of times to retry
657
to_path = '.bzr.retired.%d' % i
658
self.root_transport.rename('.bzr', to_path)
659
note("renamed %s to %s"
660
% (self.root_transport.abspath('.bzr'), to_path))
662
except (errors.TransportError, IOError, errors.PathError):
669
def _find_containing(self, evaluate):
670
"""Find something in a containing control directory.
672
This method will scan containing control dirs, until it finds what
673
it is looking for, decides that it will never find it, or runs out
674
of containing control directories to check.
676
It is used to implement find_repository and
677
determine_repository_policy.
679
:param evaluate: A function returning (value, stop). If stop is True,
680
the value will be returned.
684
result, stop = evaluate(found_bzrdir)
687
next_transport = found_bzrdir.root_transport.clone('..')
688
if (found_bzrdir.user_url == next_transport.base):
689
# top of the file system
691
# find the next containing bzrdir
693
found_bzrdir = BzrDir.open_containing_from_transport(
695
except errors.NotBranchError:
698
def find_repository(self):
699
"""Find the repository that should be used.
701
This does not require a branch as we use it to find the repo for
702
new branches as well as to hook existing branches up to their
705
def usable_repository(found_bzrdir):
706
# does it have a repository ?
708
repository = found_bzrdir.open_repository()
709
except errors.NoRepositoryPresent:
711
if found_bzrdir.user_url == self.user_url:
712
return repository, True
713
elif repository.is_shared():
714
return repository, True
718
found_repo = self._find_containing(usable_repository)
719
if found_repo is None:
720
raise errors.NoRepositoryPresent(self)
723
def _find_creation_modes(self):
724
"""Determine the appropriate modes for files and directories.
726
They're always set to be consistent with the base directory,
727
assuming that this transport allows setting modes.
729
# TODO: Do we need or want an option (maybe a config setting) to turn
730
# this off or override it for particular locations? -- mbp 20080512
731
if self._mode_check_done:
733
self._mode_check_done = True
735
st = self.transport.stat('.')
736
except errors.TransportNotPossible:
737
self._dir_mode = None
738
self._file_mode = None
740
# Check the directory mode, but also make sure the created
741
# directories and files are read-write for this user. This is
742
# mostly a workaround for filesystems which lie about being able to
743
# write to a directory (cygwin & win32)
744
if (st.st_mode & 07777 == 00000):
745
# FTP allows stat but does not return dir/file modes
746
self._dir_mode = None
747
self._file_mode = None
749
self._dir_mode = (st.st_mode & 07777) | 00700
750
# Remove the sticky and execute bits for files
751
self._file_mode = self._dir_mode & ~07111
753
def _get_file_mode(self):
754
"""Return Unix mode for newly created files, or None.
756
if not self._mode_check_done:
757
self._find_creation_modes()
758
return self._file_mode
760
def _get_dir_mode(self):
761
"""Return Unix mode for newly created directories, or None.
763
if not self._mode_check_done:
764
self._find_creation_modes()
765
return self._dir_mode
767
def get_config(self):
768
"""Get configuration for this BzrDir."""
769
return config.BzrDirConfig(self)
771
def _get_config(self):
772
"""By default, no configuration is available."""
775
def __init__(self, _transport, _format):
776
"""Initialize a Bzr control dir object.
778
Only really common logic should reside here, concrete classes should be
779
made with varying behaviours.
781
:param _format: the format that is creating this BzrDir instance.
782
:param _transport: the transport this dir is based at.
784
self._format = _format
785
# these are also under the more standard names of
786
# control_transport and user_transport
787
self.transport = _transport.clone('.bzr')
788
self.root_transport = _transport
789
self._mode_check_done = False
792
def user_transport(self):
793
return self.root_transport
796
def control_transport(self):
797
return self.transport
799
def is_control_filename(self, filename):
800
"""True if filename is the name of a path which is reserved for bzrdir's.
802
:param filename: A filename within the root transport of this bzrdir.
804
This is true IF and ONLY IF the filename is part of the namespace reserved
805
for bzr control dirs. Currently this is the '.bzr' directory in the root
806
of the root_transport.
808
# this might be better on the BzrDirFormat class because it refers to
809
# all the possible bzrdir disk formats.
810
# This method is tested via the workingtree is_control_filename tests-
811
# it was extracted from WorkingTree.is_control_filename. If the method's
812
# contract is extended beyond the current trivial implementation, please
813
# add new tests for it to the appropriate place.
814
return filename == '.bzr' or filename.startswith('.bzr/')
817
def open_unsupported(base):
818
"""Open a branch which is not supported."""
819
return BzrDir.open(base, _unsupported=True)
822
def open(base, _unsupported=False, possible_transports=None):
823
"""Open an existing bzrdir, rooted at 'base' (url).
825
:param _unsupported: a private parameter to the BzrDir class.
827
t = _mod_transport.get_transport(base, possible_transports)
828
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
831
def open_from_transport(transport, _unsupported=False,
832
_server_formats=True):
833
"""Open a bzrdir within a particular directory.
835
:param transport: Transport containing the bzrdir.
836
:param _unsupported: private.
838
for hook in BzrDir.hooks['pre_open']:
840
# Keep initial base since 'transport' may be modified while following
842
base = transport.base
843
def find_format(transport):
844
return transport, controldir.ControlDirFormat.find_format(
845
transport, _server_formats=_server_formats)
847
def redirected(transport, e, redirection_notice):
848
redirected_transport = transport._redirected_to(e.source, e.target)
849
if redirected_transport is None:
850
raise errors.NotBranchError(base)
851
note('%s is%s redirected to %s',
852
transport.base, e.permanently, redirected_transport.base)
853
return redirected_transport
856
transport, format = do_catching_redirections(find_format,
859
except errors.TooManyRedirections:
860
raise errors.NotBranchError(base)
862
format.check_support_status(_unsupported)
863
return format.open(transport, _found=True)
866
def open_containing(url, possible_transports=None):
867
"""Open an existing branch which contains url.
869
:param url: url to search from.
870
See open_containing_from_transport for more detail.
872
transport = _mod_transport.get_transport(url, possible_transports)
873
return BzrDir.open_containing_from_transport(transport)
876
def open_containing_from_transport(a_transport):
877
"""Open an existing branch which contains a_transport.base.
879
This probes for a branch at a_transport, and searches upwards from there.
881
Basically we keep looking up until we find the control directory or
882
run into the root. If there isn't one, raises NotBranchError.
883
If there is one and it is either an unrecognised format or an unsupported
884
format, UnknownFormatError or UnsupportedFormatError are raised.
885
If there is one, it is returned, along with the unused portion of url.
887
:return: The BzrDir that contains the path, and a Unicode path
888
for the rest of the URL.
890
# this gets the normalised url back. I.e. '.' -> the full path.
891
url = a_transport.base
894
result = BzrDir.open_from_transport(a_transport)
895
return result, urlutils.unescape(a_transport.relpath(url))
896
except errors.NotBranchError, e:
899
new_t = a_transport.clone('..')
900
except errors.InvalidURLJoin:
901
# reached the root, whatever that may be
902
raise errors.NotBranchError(path=url)
903
if new_t.base == a_transport.base:
904
# reached the root, whatever that may be
905
raise errors.NotBranchError(path=url)
909
def open_tree_or_branch(klass, location):
910
"""Return the branch and working tree at a location.
912
If there is no tree at the location, tree will be None.
913
If there is no branch at the location, an exception will be
915
:return: (tree, branch)
917
bzrdir = klass.open(location)
918
return bzrdir._get_tree_branch()
921
def open_containing_tree_or_branch(klass, location):
922
"""Return the branch and working tree contained by a location.
924
Returns (tree, branch, relpath).
925
If there is no tree at containing the location, tree will be None.
926
If there is no branch containing the location, an exception will be
928
relpath is the portion of the path that is contained by the branch.
930
bzrdir, relpath = klass.open_containing(location)
931
tree, branch = bzrdir._get_tree_branch()
932
return tree, branch, relpath
935
def open_containing_tree_branch_or_repository(klass, location):
936
"""Return the working tree, branch and repo contained by a location.
938
Returns (tree, branch, repository, relpath).
939
If there is no tree containing the location, tree will be None.
940
If there is no branch containing the location, branch will be None.
941
If there is no repository containing the location, repository will be
943
relpath is the portion of the path that is contained by the innermost
946
If no tree, branch or repository is found, a NotBranchError is raised.
948
bzrdir, relpath = klass.open_containing(location)
950
tree, branch = bzrdir._get_tree_branch()
951
except errors.NotBranchError:
953
repo = bzrdir.find_repository()
954
return None, None, repo, relpath
955
except (errors.NoRepositoryPresent):
956
raise errors.NotBranchError(location)
957
return tree, branch, branch.repository, relpath
959
def _cloning_metadir(self):
960
"""Produce a metadir suitable for cloning with.
962
:returns: (destination_bzrdir_format, source_repository)
964
result_format = self._format.__class__()
967
branch = self.open_branch(ignore_fallbacks=True)
968
source_repository = branch.repository
969
result_format._branch_format = branch._format
970
except errors.NotBranchError:
972
source_repository = self.open_repository()
973
except errors.NoRepositoryPresent:
974
source_repository = None
976
# XXX TODO: This isinstance is here because we have not implemented
977
# the fix recommended in bug # 103195 - to delegate this choice the
979
repo_format = source_repository._format
980
if isinstance(repo_format, remote.RemoteRepositoryFormat):
981
source_repository._ensure_real()
982
repo_format = source_repository._real_repository._format
983
result_format.repository_format = repo_format
985
# TODO: Couldn't we just probe for the format in these cases,
986
# rather than opening the whole tree? It would be a little
987
# faster. mbp 20070401
988
tree = self.open_workingtree(recommend_upgrade=False)
989
except (errors.NoWorkingTree, errors.NotLocalUrl):
990
result_format.workingtree_format = None
992
result_format.workingtree_format = tree._format.__class__()
993
return result_format, source_repository
995
def cloning_metadir(self, require_stacking=False):
996
"""Produce a metadir suitable for cloning or sprouting with.
998
These operations may produce workingtrees (yes, even though they're
999
"cloning" something that doesn't have a tree), so a viable workingtree
1000
format must be selected.
1002
:require_stacking: If True, non-stackable formats will be upgraded
1003
to similar stackable formats.
1004
:returns: a BzrDirFormat with all component formats either set
1005
appropriately or set to None if that component should not be
1008
format, repository = self._cloning_metadir()
1009
if format._workingtree_format is None:
1011
if repository is None:
1012
# No repository either
1014
# We have a repository, so set a working tree? (Why? This seems to
1015
# contradict the stated return value in the docstring).
1016
tree_format = repository._format._matchingbzrdir.workingtree_format
1017
format.workingtree_format = tree_format.__class__()
1018
if require_stacking:
1019
format.require_stacking()
1023
def create(cls, base, format=None, possible_transports=None):
1024
"""Create a new BzrDir at the url 'base'.
1026
:param format: If supplied, the format of branch to create. If not
1027
supplied, the default is used.
1028
:param possible_transports: If supplied, a list of transports that
1029
can be reused to share a remote connection.
1031
if cls is not BzrDir:
1032
raise AssertionError("BzrDir.create always creates the"
1033
"default format, not one of %r" % cls)
1034
t = _mod_transport.get_transport(base, possible_transports)
1037
format = controldir.ControlDirFormat.get_default_format()
1038
return format.initialize_on_transport(t)
1040
def get_branch_transport(self, branch_format, name=None):
1041
"""Get the transport for use by branch format in this BzrDir.
1043
Note that bzr dirs that do not support format strings will raise
1044
IncompatibleFormat if the branch format they are given has
1045
a format string, and vice versa.
1047
If branch_format is None, the transport is returned with no
1048
checking. If it is not None, then the returned transport is
1049
guaranteed to point to an existing directory ready for use.
1051
raise NotImplementedError(self.get_branch_transport)
1053
def get_repository_transport(self, repository_format):
1054
"""Get the transport for use by repository format in this BzrDir.
1056
Note that bzr dirs that do not support format strings will raise
1057
IncompatibleFormat if the repository format they are given has
1058
a format string, and vice versa.
1060
If repository_format is None, the transport is returned with no
1061
checking. If it is not None, then the returned transport is
1062
guaranteed to point to an existing directory ready for use.
1064
raise NotImplementedError(self.get_repository_transport)
1066
def get_workingtree_transport(self, tree_format):
1067
"""Get the transport for use by workingtree format in this BzrDir.
1069
Note that bzr dirs that do not support format strings will raise
1070
IncompatibleFormat if the workingtree format they are given has a
1071
format string, and vice versa.
1073
If workingtree_format is None, the transport is returned with no
1074
checking. If it is not None, then the returned transport is
1075
guaranteed to point to an existing directory ready for use.
1077
raise NotImplementedError(self.get_workingtree_transport)
1080
class BzrDirHooks(hooks.Hooks):
1081
"""Hooks for BzrDir operations."""
1084
"""Create the default hooks."""
1085
hooks.Hooks.__init__(self, "bzrlib.bzrdir", "BzrDir.hooks")
1086
self.add_hook('pre_open',
1087
"Invoked before attempting to open a BzrDir with the transport "
1088
"that the open will use.", (1, 14))
1089
self.add_hook('post_repo_init',
1090
"Invoked after a repository has been initialized. "
1091
"post_repo_init is called with a "
1092
"bzrlib.bzrdir.RepoInitHookParams.",
1095
# install the default hooks
1096
BzrDir.hooks = BzrDirHooks()
1099
class RepoInitHookParams(object):
1100
"""Object holding parameters passed to *_repo_init hooks.
1102
There are 4 fields that hooks may wish to access:
1104
:ivar repository: Repository created
1105
:ivar format: Repository format
1106
:ivar bzrdir: The bzrdir for the repository
1107
:ivar shared: The repository is shared
1110
def __init__(self, repository, format, a_bzrdir, shared):
1111
"""Create a group of RepoInitHook parameters.
1113
:param repository: Repository created
1114
:param format: Repository format
1115
:param bzrdir: The bzrdir for the repository
1116
:param shared: The repository is shared
1118
self.repository = repository
1119
self.format = format
1120
self.bzrdir = a_bzrdir
1121
self.shared = shared
1123
def __eq__(self, other):
1124
return self.__dict__ == other.__dict__
1128
return "<%s for %s>" % (self.__class__.__name__,
1131
return "<%s for %s>" % (self.__class__.__name__,
1135
class BzrDirMeta1(BzrDir):
1136
"""A .bzr meta version 1 control object.
1138
This is the first control object where the
1139
individual aspects are really split out: there are separate repository,
1140
workingtree and branch subdirectories and any subset of the three can be
1141
present within a BzrDir.
1144
def can_convert_format(self):
1145
"""See BzrDir.can_convert_format()."""
1148
def create_branch(self, name=None, repository=None):
1149
"""See BzrDir.create_branch."""
1150
return self._format.get_branch_format().initialize(self, name=name,
1151
repository=repository)
1153
def destroy_branch(self, name=None):
1154
"""See BzrDir.create_branch."""
1155
if name is not None:
1156
raise errors.NoColocatedBranchSupport(self)
1157
self.transport.delete_tree('branch')
1159
def create_repository(self, shared=False):
1160
"""See BzrDir.create_repository."""
1161
return self._format.repository_format.initialize(self, shared)
1163
def destroy_repository(self):
1164
"""See BzrDir.destroy_repository."""
1165
self.transport.delete_tree('repository')
1167
def create_workingtree(self, revision_id=None, from_branch=None,
1168
accelerator_tree=None, hardlink=False):
1169
"""See BzrDir.create_workingtree."""
1170
return self._format.workingtree_format.initialize(
1171
self, revision_id, from_branch=from_branch,
1172
accelerator_tree=accelerator_tree, hardlink=hardlink)
1174
def destroy_workingtree(self):
1175
"""See BzrDir.destroy_workingtree."""
1176
wt = self.open_workingtree(recommend_upgrade=False)
1177
repository = wt.branch.repository
1178
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1179
# We ignore the conflicts returned by wt.revert since we're about to
1180
# delete the wt metadata anyway, all that should be left here are
1181
# detritus. But see bug #634470 about subtree .bzr dirs.
1182
conflicts = wt.revert(old_tree=empty)
1183
self.destroy_workingtree_metadata()
1185
def destroy_workingtree_metadata(self):
1186
self.transport.delete_tree('checkout')
1188
def find_branch_format(self, name=None):
1189
"""Find the branch 'format' for this bzrdir.
1191
This might be a synthetic object for e.g. RemoteBranch and SVN.
1193
from bzrlib.branch import BranchFormat
1194
return BranchFormat.find_format(self, name=name)
1196
def _get_mkdir_mode(self):
1197
"""Figure out the mode to use when creating a bzrdir subdir."""
1198
temp_control = lockable_files.LockableFiles(self.transport, '',
1199
lockable_files.TransportLock)
1200
return temp_control._dir_mode
1202
def get_branch_reference(self, name=None):
1203
"""See BzrDir.get_branch_reference()."""
1204
from bzrlib.branch import BranchFormat
1205
format = BranchFormat.find_format(self, name=name)
1206
return format.get_reference(self, name=name)
1208
def get_branch_transport(self, branch_format, name=None):
1209
"""See BzrDir.get_branch_transport()."""
1210
if name is not None:
1211
raise errors.NoColocatedBranchSupport(self)
1212
# XXX: this shouldn't implicitly create the directory if it's just
1213
# promising to get a transport -- mbp 20090727
1214
if branch_format is None:
1215
return self.transport.clone('branch')
1217
branch_format.get_format_string()
1218
except NotImplementedError:
1219
raise errors.IncompatibleFormat(branch_format, self._format)
1221
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1222
except errors.FileExists:
1224
return self.transport.clone('branch')
1226
def get_repository_transport(self, repository_format):
1227
"""See BzrDir.get_repository_transport()."""
1228
if repository_format is None:
1229
return self.transport.clone('repository')
1231
repository_format.get_format_string()
1232
except NotImplementedError:
1233
raise errors.IncompatibleFormat(repository_format, self._format)
1235
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1236
except errors.FileExists:
1238
return self.transport.clone('repository')
1240
def get_workingtree_transport(self, workingtree_format):
1241
"""See BzrDir.get_workingtree_transport()."""
1242
if workingtree_format is None:
1243
return self.transport.clone('checkout')
1245
workingtree_format.get_format_string()
1246
except NotImplementedError:
1247
raise errors.IncompatibleFormat(workingtree_format, self._format)
1249
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1250
except errors.FileExists:
1252
return self.transport.clone('checkout')
1254
def has_workingtree(self):
1255
"""Tell if this bzrdir contains a working tree.
1257
This will still raise an exception if the bzrdir has a workingtree that
1258
is remote & inaccessible.
1260
Note: if you're going to open the working tree, you should just go
1261
ahead and try, and not ask permission first.
1263
from bzrlib.workingtree import WorkingTreeFormat
1265
WorkingTreeFormat.find_format(self)
1266
except errors.NoWorkingTree:
1270
def needs_format_conversion(self, format):
1271
"""See BzrDir.needs_format_conversion()."""
1272
if not isinstance(self._format, format.__class__):
1273
# it is not a meta dir format, conversion is needed.
1275
# we might want to push this down to the repository?
1277
if not isinstance(self.open_repository()._format,
1278
format.repository_format.__class__):
1279
# the repository needs an upgrade.
1281
except errors.NoRepositoryPresent:
1283
for branch in self.list_branches():
1284
if not isinstance(branch._format,
1285
format.get_branch_format().__class__):
1286
# the branch needs an upgrade.
1289
my_wt = self.open_workingtree(recommend_upgrade=False)
1290
if not isinstance(my_wt._format,
1291
format.workingtree_format.__class__):
1292
# the workingtree needs an upgrade.
1294
except (errors.NoWorkingTree, errors.NotLocalUrl):
1298
def open_branch(self, name=None, unsupported=False,
1299
ignore_fallbacks=False):
1300
"""See BzrDir.open_branch."""
1301
format = self.find_branch_format(name=name)
1302
format.check_support_status(unsupported)
1303
return format.open(self, name=name,
1304
_found=True, ignore_fallbacks=ignore_fallbacks)
1306
def open_repository(self, unsupported=False):
1307
"""See BzrDir.open_repository."""
1308
from bzrlib.repository import RepositoryFormat
1309
format = RepositoryFormat.find_format(self)
1310
format.check_support_status(unsupported)
1311
return format.open(self, _found=True)
1313
def open_workingtree(self, unsupported=False,
1314
recommend_upgrade=True):
1315
"""See BzrDir.open_workingtree."""
1316
from bzrlib.workingtree import WorkingTreeFormat
1317
format = WorkingTreeFormat.find_format(self)
1318
format.check_support_status(unsupported, recommend_upgrade,
1319
basedir=self.root_transport.base)
1320
return format.open(self, _found=True)
1322
def _get_config(self):
1323
return config.TransportConfig(self.transport, 'control.conf')
1326
class BzrProber(controldir.Prober):
1327
"""Prober for formats that use a .bzr/ control directory."""
1329
formats = registry.FormatRegistry(controldir.network_format_registry)
1330
"""The known .bzr formats."""
1333
@deprecated_method(deprecated_in((2, 4, 0)))
1334
def register_bzrdir_format(klass, format):
1335
klass.formats.register(format.get_format_string(), format)
1338
@deprecated_method(deprecated_in((2, 4, 0)))
1339
def unregister_bzrdir_format(klass, format):
1340
klass.formats.remove(format.get_format_string())
1343
def probe_transport(klass, transport):
1344
"""Return the .bzrdir style format present in a directory."""
1346
format_string = transport.get_bytes(".bzr/branch-format")
1347
except errors.NoSuchFile:
1348
raise errors.NotBranchError(path=transport.base)
1350
return klass.formats.get(format_string)
1352
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1355
def known_formats(cls):
1357
for name, format in cls.formats.iteritems():
1358
if callable(format):
1364
controldir.ControlDirFormat.register_prober(BzrProber)
1367
class RemoteBzrProber(controldir.Prober):
1368
"""Prober for remote servers that provide a Bazaar smart server."""
1371
def probe_transport(klass, transport):
1372
"""Return a RemoteBzrDirFormat object if it looks possible."""
1374
medium = transport.get_smart_medium()
1375
except (NotImplementedError, AttributeError,
1376
errors.TransportNotPossible, errors.NoSmartMedium,
1377
errors.SmartProtocolError):
1378
# no smart server, so not a branch for this format type.
1379
raise errors.NotBranchError(path=transport.base)
1381
# Decline to open it if the server doesn't support our required
1382
# version (3) so that the VFS-based transport will do it.
1383
if medium.should_probe():
1385
server_version = medium.protocol_version()
1386
except errors.SmartProtocolError:
1387
# Apparently there's no usable smart server there, even though
1388
# the medium supports the smart protocol.
1389
raise errors.NotBranchError(path=transport.base)
1390
if server_version != '2':
1391
raise errors.NotBranchError(path=transport.base)
1392
from bzrlib.remote import RemoteBzrDirFormat
1393
return RemoteBzrDirFormat()
1396
def known_formats(cls):
1397
from bzrlib.remote import RemoteBzrDirFormat
1398
return set([RemoteBzrDirFormat()])
1401
class BzrDirFormat(controldir.ControlDirFormat):
1402
"""ControlDirFormat base class for .bzr/ directories.
1404
Formats are placed in a dict by their format string for reference
1405
during bzrdir opening. These should be subclasses of BzrDirFormat
1408
Once a format is deprecated, just deprecate the initialize and open
1409
methods on the format class. Do not deprecate the object, as the
1410
object will be created every system load.
1413
_lock_file_name = 'branch-lock'
1415
# _lock_class must be set in subclasses to the lock type, typ.
1416
# TransportLock or LockDir
1419
def get_format_string(cls):
1420
"""Return the ASCII format string that identifies this format."""
1421
raise NotImplementedError(self.get_format_string)
1423
def initialize_on_transport(self, transport):
1424
"""Initialize a new bzrdir in the base directory of a Transport."""
1426
# can we hand off the request to the smart server rather than using
1428
client_medium = transport.get_smart_medium()
1429
except errors.NoSmartMedium:
1430
return self._initialize_on_transport_vfs(transport)
1432
# Current RPC's only know how to create bzr metadir1 instances, so
1433
# we still delegate to vfs methods if the requested format is not a
1435
if type(self) != BzrDirMetaFormat1:
1436
return self._initialize_on_transport_vfs(transport)
1437
from bzrlib.remote import RemoteBzrDirFormat
1438
remote_format = RemoteBzrDirFormat()
1439
self._supply_sub_formats_to(remote_format)
1440
return remote_format.initialize_on_transport(transport)
1442
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1443
create_prefix=False, force_new_repo=False, stacked_on=None,
1444
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1445
shared_repo=False, vfs_only=False):
1446
"""Create this format on transport.
1448
The directory to initialize will be created.
1450
:param force_new_repo: Do not use a shared repository for the target,
1451
even if one is available.
1452
:param create_prefix: Create any missing directories leading up to
1454
:param use_existing_dir: Use an existing directory if one exists.
1455
:param stacked_on: A url to stack any created branch on, None to follow
1456
any target stacking policy.
1457
:param stack_on_pwd: If stack_on is relative, the location it is
1459
:param repo_format_name: If non-None, a repository will be
1460
made-or-found. Should none be found, or if force_new_repo is True
1461
the repo_format_name is used to select the format of repository to
1463
:param make_working_trees: Control the setting of make_working_trees
1464
for a new shared repository when one is made. None to use whatever
1465
default the format has.
1466
:param shared_repo: Control whether made repositories are shared or
1468
:param vfs_only: If True do not attempt to use a smart server
1469
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1470
None if none was created or found, bzrdir is always valid.
1471
require_stacking is the result of examining the stacked_on
1472
parameter and any stacking policy found for the target.
1475
# Try to hand off to a smart server
1477
client_medium = transport.get_smart_medium()
1478
except errors.NoSmartMedium:
1481
from bzrlib.remote import RemoteBzrDirFormat
1482
# TODO: lookup the local format from a server hint.
1483
remote_dir_format = RemoteBzrDirFormat()
1484
remote_dir_format._network_name = self.network_name()
1485
self._supply_sub_formats_to(remote_dir_format)
1486
return remote_dir_format.initialize_on_transport_ex(transport,
1487
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1488
force_new_repo=force_new_repo, stacked_on=stacked_on,
1489
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1490
make_working_trees=make_working_trees, shared_repo=shared_repo)
1491
# XXX: Refactor the create_prefix/no_create_prefix code into a
1492
# common helper function
1493
# The destination may not exist - if so make it according to policy.
1494
def make_directory(transport):
1495
transport.mkdir('.')
1497
def redirected(transport, e, redirection_notice):
1498
note(redirection_notice)
1499
return transport._redirected_to(e.source, e.target)
1501
transport = do_catching_redirections(make_directory, transport,
1503
except errors.FileExists:
1504
if not use_existing_dir:
1506
except errors.NoSuchFile:
1507
if not create_prefix:
1509
transport.create_prefix()
1511
require_stacking = (stacked_on is not None)
1512
# Now the target directory exists, but doesn't have a .bzr
1513
# directory. So we need to create it, along with any work to create
1514
# all of the dependent branches, etc.
1516
result = self.initialize_on_transport(transport)
1517
if repo_format_name:
1519
# use a custom format
1520
result._format.repository_format = \
1521
repository.network_format_registry.get(repo_format_name)
1522
except AttributeError:
1523
# The format didn't permit it to be set.
1525
# A repository is desired, either in-place or shared.
1526
repository_policy = result.determine_repository_policy(
1527
force_new_repo, stacked_on, stack_on_pwd,
1528
require_stacking=require_stacking)
1529
result_repo, is_new_repo = repository_policy.acquire_repository(
1530
make_working_trees, shared_repo)
1531
if not require_stacking and repository_policy._require_stacking:
1532
require_stacking = True
1533
result._format.require_stacking()
1534
result_repo.lock_write()
1537
repository_policy = None
1538
return result_repo, result, require_stacking, repository_policy
1540
def _initialize_on_transport_vfs(self, transport):
1541
"""Initialize a new bzrdir using VFS calls.
1543
:param transport: The transport to create the .bzr directory in.
1546
# Since we are creating a .bzr directory, inherit the
1547
# mode from the root directory
1548
temp_control = lockable_files.LockableFiles(transport,
1549
'', lockable_files.TransportLock)
1550
temp_control._transport.mkdir('.bzr',
1551
# FIXME: RBC 20060121 don't peek under
1553
mode=temp_control._dir_mode)
1554
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1555
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1556
file_mode = temp_control._file_mode
1558
bzrdir_transport = transport.clone('.bzr')
1559
utf8_files = [('README',
1560
"This is a Bazaar control directory.\n"
1561
"Do not change any files in this directory.\n"
1562
"See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
1563
('branch-format', self.get_format_string()),
1565
# NB: no need to escape relative paths that are url safe.
1566
control_files = lockable_files.LockableFiles(bzrdir_transport,
1567
self._lock_file_name, self._lock_class)
1568
control_files.create_lock()
1569
control_files.lock_write()
1571
for (filename, content) in utf8_files:
1572
bzrdir_transport.put_bytes(filename, content,
1575
control_files.unlock()
1576
return self.open(transport, _found=True)
1578
def open(self, transport, _found=False):
1579
"""Return an instance of this format for the dir transport points at.
1581
_found is a private parameter, do not use it.
1584
found_format = controldir.ControlDirFormat.find_format(transport)
1585
if not isinstance(found_format, self.__class__):
1586
raise AssertionError("%s was asked to open %s, but it seems to need "
1588
% (self, transport, found_format))
1589
# Allow subclasses - use the found format.
1590
self._supply_sub_formats_to(found_format)
1591
return found_format._open(transport)
1592
return self._open(transport)
1594
def _open(self, transport):
1595
"""Template method helper for opening BzrDirectories.
1597
This performs the actual open and any additional logic or parameter
1600
raise NotImplementedError(self._open)
1602
def _supply_sub_formats_to(self, other_format):
1603
"""Give other_format the same values for sub formats as this has.
1605
This method is expected to be used when parameterising a
1606
RemoteBzrDirFormat instance with the parameters from a
1607
BzrDirMetaFormat1 instance.
1609
:param other_format: other_format is a format which should be
1610
compatible with whatever sub formats are supported by self.
1615
class BzrDirMetaFormat1(BzrDirFormat):
1616
"""Bzr meta control format 1
1618
This is the first format with split out working tree, branch and repository
1621
- Format 3 working trees [optional]
1622
- Format 5 branches [optional]
1623
- Format 7 repositories [optional]
1626
_lock_class = lockdir.LockDir
1628
fixed_components = False
1631
self._workingtree_format = None
1632
self._branch_format = None
1633
self._repository_format = None
1635
def __eq__(self, other):
1636
if other.__class__ is not self.__class__:
1638
if other.repository_format != self.repository_format:
1640
if other.workingtree_format != self.workingtree_format:
1644
def __ne__(self, other):
1645
return not self == other
1647
def get_branch_format(self):
1648
if self._branch_format is None:
1649
from bzrlib.branch import format_registry as branch_format_registry
1650
self._branch_format = branch_format_registry.get_default()
1651
return self._branch_format
1653
def set_branch_format(self, format):
1654
self._branch_format = format
1656
def require_stacking(self, stack_on=None, possible_transports=None,
1658
"""We have a request to stack, try to ensure the formats support it.
1660
:param stack_on: If supplied, it is the URL to a branch that we want to
1661
stack on. Check to see if that format supports stacking before
1664
# Stacking is desired. requested by the target, but does the place it
1665
# points at support stacking? If it doesn't then we should
1666
# not implicitly upgrade. We check this here.
1667
new_repo_format = None
1668
new_branch_format = None
1670
# a bit of state for get_target_branch so that we don't try to open it
1671
# 2 times, for both repo *and* branch
1672
target = [None, False, None] # target_branch, checked, upgrade anyway
1673
def get_target_branch():
1675
# We've checked, don't check again
1677
if stack_on is None:
1678
# No target format, that means we want to force upgrading
1679
target[:] = [None, True, True]
1682
target_dir = BzrDir.open(stack_on,
1683
possible_transports=possible_transports)
1684
except errors.NotBranchError:
1685
# Nothing there, don't change formats
1686
target[:] = [None, True, False]
1688
except errors.JailBreak:
1689
# JailBreak, JFDI and upgrade anyway
1690
target[:] = [None, True, True]
1693
target_branch = target_dir.open_branch()
1694
except errors.NotBranchError:
1695
# No branch, don't upgrade formats
1696
target[:] = [None, True, False]
1698
target[:] = [target_branch, True, False]
1701
if (not _skip_repo and
1702
not self.repository_format.supports_external_lookups):
1703
# We need to upgrade the Repository.
1704
target_branch, _, do_upgrade = get_target_branch()
1705
if target_branch is None:
1706
# We don't have a target branch, should we upgrade anyway?
1708
# stack_on is inaccessible, JFDI.
1709
# TODO: bad monkey, hard-coded formats...
1710
if self.repository_format.rich_root_data:
1711
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
1713
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
1715
# If the target already supports stacking, then we know the
1716
# project is already able to use stacking, so auto-upgrade
1718
new_repo_format = target_branch.repository._format
1719
if not new_repo_format.supports_external_lookups:
1720
# target doesn't, source doesn't, so don't auto upgrade
1722
new_repo_format = None
1723
if new_repo_format is not None:
1724
self.repository_format = new_repo_format
1725
note('Source repository format does not support stacking,'
1726
' using format:\n %s',
1727
new_repo_format.get_format_description())
1729
if not self.get_branch_format().supports_stacking():
1730
# We just checked the repo, now lets check if we need to
1731
# upgrade the branch format
1732
target_branch, _, do_upgrade = get_target_branch()
1733
if target_branch is None:
1735
# TODO: bad monkey, hard-coded formats...
1736
from bzrlib.branch import BzrBranchFormat7
1737
new_branch_format = BzrBranchFormat7()
1739
new_branch_format = target_branch._format
1740
if not new_branch_format.supports_stacking():
1741
new_branch_format = None
1742
if new_branch_format is not None:
1743
# Does support stacking, use its format.
1744
self.set_branch_format(new_branch_format)
1745
note('Source branch format does not support stacking,'
1746
' using format:\n %s',
1747
new_branch_format.get_format_description())
1749
def get_converter(self, format=None):
1750
"""See BzrDirFormat.get_converter()."""
1752
format = BzrDirFormat.get_default_format()
1753
if not isinstance(self, format.__class__):
1754
# converting away from metadir is not implemented
1755
raise NotImplementedError(self.get_converter)
1756
return ConvertMetaToMeta(format)
1759
def get_format_string(cls):
1760
"""See BzrDirFormat.get_format_string()."""
1761
return "Bazaar-NG meta directory, format 1\n"
1763
def get_format_description(self):
1764
"""See BzrDirFormat.get_format_description()."""
1765
return "Meta directory format 1"
1767
def network_name(self):
1768
return self.get_format_string()
1770
def _open(self, transport):
1771
"""See BzrDirFormat._open."""
1772
# Create a new format instance because otherwise initialisation of new
1773
# metadirs share the global default format object leading to alias
1775
format = BzrDirMetaFormat1()
1776
self._supply_sub_formats_to(format)
1777
return BzrDirMeta1(transport, format)
1779
def __return_repository_format(self):
1780
"""Circular import protection."""
1781
if self._repository_format:
1782
return self._repository_format
1783
from bzrlib.repository import format_registry
1784
return format_registry.get_default()
1786
def _set_repository_format(self, value):
1787
"""Allow changing the repository format for metadir formats."""
1788
self._repository_format = value
1790
repository_format = property(__return_repository_format,
1791
_set_repository_format)
1793
def _supply_sub_formats_to(self, other_format):
1794
"""Give other_format the same values for sub formats as this has.
1796
This method is expected to be used when parameterising a
1797
RemoteBzrDirFormat instance with the parameters from a
1798
BzrDirMetaFormat1 instance.
1800
:param other_format: other_format is a format which should be
1801
compatible with whatever sub formats are supported by self.
1804
if getattr(self, '_repository_format', None) is not None:
1805
other_format.repository_format = self.repository_format
1806
if self._branch_format is not None:
1807
other_format._branch_format = self._branch_format
1808
if self._workingtree_format is not None:
1809
other_format.workingtree_format = self.workingtree_format
1811
def __get_workingtree_format(self):
1812
if self._workingtree_format is None:
1813
from bzrlib.workingtree import (
1814
format_registry as wt_format_registry,
1816
self._workingtree_format = wt_format_registry.get_default()
1817
return self._workingtree_format
1819
def __set_workingtree_format(self, wt_format):
1820
self._workingtree_format = wt_format
1822
workingtree_format = property(__get_workingtree_format,
1823
__set_workingtree_format)
1826
# Register bzr formats
1827
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
1829
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1832
class ConvertMetaToMeta(controldir.Converter):
1833
"""Converts the components of metadirs."""
1835
def __init__(self, target_format):
1836
"""Create a metadir to metadir converter.
1838
:param target_format: The final metadir format that is desired.
1840
self.target_format = target_format
1842
def convert(self, to_convert, pb):
1843
"""See Converter.convert()."""
1844
self.bzrdir = to_convert
1845
self.pb = ui.ui_factory.nested_progress_bar()
1848
self.step('checking repository format')
1850
repo = self.bzrdir.open_repository()
1851
except errors.NoRepositoryPresent:
1854
if not isinstance(repo._format, self.target_format.repository_format.__class__):
1855
from bzrlib.repository import CopyConverter
1856
ui.ui_factory.note('starting repository conversion')
1857
converter = CopyConverter(self.target_format.repository_format)
1858
converter.convert(repo, pb)
1859
for branch in self.bzrdir.list_branches():
1860
# TODO: conversions of Branch and Tree should be done by
1861
# InterXFormat lookups/some sort of registry.
1862
# Avoid circular imports
1863
from bzrlib import branch as _mod_branch
1864
old = branch._format.__class__
1865
new = self.target_format.get_branch_format().__class__
1867
if (old == _mod_branch.BzrBranchFormat5 and
1868
new in (_mod_branch.BzrBranchFormat6,
1869
_mod_branch.BzrBranchFormat7,
1870
_mod_branch.BzrBranchFormat8)):
1871
branch_converter = _mod_branch.Converter5to6()
1872
elif (old == _mod_branch.BzrBranchFormat6 and
1873
new in (_mod_branch.BzrBranchFormat7,
1874
_mod_branch.BzrBranchFormat8)):
1875
branch_converter = _mod_branch.Converter6to7()
1876
elif (old == _mod_branch.BzrBranchFormat7 and
1877
new is _mod_branch.BzrBranchFormat8):
1878
branch_converter = _mod_branch.Converter7to8()
1880
raise errors.BadConversionTarget("No converter", new,
1882
branch_converter.convert(branch)
1883
branch = self.bzrdir.open_branch()
1884
old = branch._format.__class__
1886
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
1887
except (errors.NoWorkingTree, errors.NotLocalUrl):
1890
# TODO: conversions of Branch and Tree should be done by
1891
# InterXFormat lookups
1892
if (isinstance(tree, workingtree.WorkingTree3) and
1893
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
1894
isinstance(self.target_format.workingtree_format,
1895
workingtree_4.DirStateWorkingTreeFormat)):
1896
workingtree_4.Converter3to4().convert(tree)
1897
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
1898
not isinstance(tree, workingtree_4.WorkingTree5) and
1899
isinstance(self.target_format.workingtree_format,
1900
workingtree_4.WorkingTreeFormat5)):
1901
workingtree_4.Converter4to5().convert(tree)
1902
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
1903
not isinstance(tree, workingtree_4.WorkingTree6) and
1904
isinstance(self.target_format.workingtree_format,
1905
workingtree_4.WorkingTreeFormat6)):
1906
workingtree_4.Converter4or5to6().convert(tree)
1911
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
1914
class RepositoryAcquisitionPolicy(object):
1915
"""Abstract base class for repository acquisition policies.
1917
A repository acquisition policy decides how a BzrDir acquires a repository
1918
for a branch that is being created. The most basic policy decision is
1919
whether to create a new repository or use an existing one.
1921
def __init__(self, stack_on, stack_on_pwd, require_stacking):
1924
:param stack_on: A location to stack on
1925
:param stack_on_pwd: If stack_on is relative, the location it is
1927
:param require_stacking: If True, it is a failure to not stack.
1929
self._stack_on = stack_on
1930
self._stack_on_pwd = stack_on_pwd
1931
self._require_stacking = require_stacking
1933
def configure_branch(self, branch):
1934
"""Apply any configuration data from this policy to the branch.
1936
Default implementation sets repository stacking.
1938
if self._stack_on is None:
1940
if self._stack_on_pwd is None:
1941
stack_on = self._stack_on
1944
stack_on = urlutils.rebase_url(self._stack_on,
1947
except errors.InvalidRebaseURLs:
1948
stack_on = self._get_full_stack_on()
1950
branch.set_stacked_on_url(stack_on)
1951
except (errors.UnstackableBranchFormat,
1952
errors.UnstackableRepositoryFormat):
1953
if self._require_stacking:
1956
def requires_stacking(self):
1957
"""Return True if this policy requires stacking."""
1958
return self._stack_on is not None and self._require_stacking
1960
def _get_full_stack_on(self):
1961
"""Get a fully-qualified URL for the stack_on location."""
1962
if self._stack_on is None:
1964
if self._stack_on_pwd is None:
1965
return self._stack_on
1967
return urlutils.join(self._stack_on_pwd, self._stack_on)
1969
def _add_fallback(self, repository, possible_transports=None):
1970
"""Add a fallback to the supplied repository, if stacking is set."""
1971
stack_on = self._get_full_stack_on()
1972
if stack_on is None:
1975
stacked_dir = BzrDir.open(stack_on,
1976
possible_transports=possible_transports)
1977
except errors.JailBreak:
1978
# We keep the stacking details, but we are in the server code so
1979
# actually stacking is not needed.
1982
stacked_repo = stacked_dir.open_branch().repository
1983
except errors.NotBranchError:
1984
stacked_repo = stacked_dir.open_repository()
1986
repository.add_fallback_repository(stacked_repo)
1987
except errors.UnstackableRepositoryFormat:
1988
if self._require_stacking:
1991
self._require_stacking = True
1993
def acquire_repository(self, make_working_trees=None, shared=False):
1994
"""Acquire a repository for this bzrdir.
1996
Implementations may create a new repository or use a pre-exising
1998
:param make_working_trees: If creating a repository, set
1999
make_working_trees to this value (if non-None)
2000
:param shared: If creating a repository, make it shared if True
2001
:return: A repository, is_new_flag (True if the repository was
2004
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
2007
class CreateRepository(RepositoryAcquisitionPolicy):
2008
"""A policy of creating a new repository"""
2010
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
2011
require_stacking=False):
2014
:param bzrdir: The bzrdir to create the repository on.
2015
:param stack_on: A location to stack on
2016
:param stack_on_pwd: If stack_on is relative, the location it is
2019
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2021
self._bzrdir = bzrdir
2023
def acquire_repository(self, make_working_trees=None, shared=False):
2024
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2026
Creates the desired repository in the bzrdir we already have.
2028
stack_on = self._get_full_stack_on()
2030
format = self._bzrdir._format
2031
format.require_stacking(stack_on=stack_on,
2032
possible_transports=[self._bzrdir.root_transport])
2033
if not self._require_stacking:
2034
# We have picked up automatic stacking somewhere.
2035
note('Using default stacking branch %s at %s', self._stack_on,
2037
repository = self._bzrdir.create_repository(shared=shared)
2038
self._add_fallback(repository,
2039
possible_transports=[self._bzrdir.transport])
2040
if make_working_trees is not None:
2041
repository.set_make_working_trees(make_working_trees)
2042
return repository, True
2045
class UseExistingRepository(RepositoryAcquisitionPolicy):
2046
"""A policy of reusing an existing repository"""
2048
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
2049
require_stacking=False):
2052
:param repository: The repository to use.
2053
:param stack_on: A location to stack on
2054
:param stack_on_pwd: If stack_on is relative, the location it is
2057
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2059
self._repository = repository
2061
def acquire_repository(self, make_working_trees=None, shared=False):
2062
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2064
Returns an existing repository to use.
2066
self._add_fallback(self._repository,
2067
possible_transports=[self._repository.bzrdir.transport])
2068
return self._repository, False
2071
def register_metadir(registry, key,
2072
repository_format, help, native=True, deprecated=False,
2078
"""Register a metadir subformat.
2080
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2081
by the Repository/Branch/WorkingTreeformats.
2083
:param repository_format: The fully-qualified repository format class
2085
:param branch_format: Fully-qualified branch format class name as
2087
:param tree_format: Fully-qualified tree format class name as
2090
# This should be expanded to support setting WorkingTree and Branch
2091
# formats, once BzrDirMetaFormat1 supports that.
2092
def _load(full_name):
2093
mod_name, factory_name = full_name.rsplit('.', 1)
2095
factory = pyutils.get_named_object(mod_name, factory_name)
2096
except ImportError, e:
2097
raise ImportError('failed to load %s: %s' % (full_name, e))
2098
except AttributeError:
2099
raise AttributeError('no factory %s in module %r'
2100
% (full_name, sys.modules[mod_name]))
2104
bd = BzrDirMetaFormat1()
2105
if branch_format is not None:
2106
bd.set_branch_format(_load(branch_format))
2107
if tree_format is not None:
2108
bd.workingtree_format = _load(tree_format)
2109
if repository_format is not None:
2110
bd.repository_format = _load(repository_format)
2112
registry.register(key, helper, help, native, deprecated, hidden,
2113
experimental, alias)
2115
register_metadir(controldir.format_registry, 'knit',
2116
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2117
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2118
branch_format='bzrlib.branch.BzrBranchFormat5',
2119
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2122
register_metadir(controldir.format_registry, 'dirstate',
2123
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2124
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2125
'above when accessed over the network.',
2126
branch_format='bzrlib.branch.BzrBranchFormat5',
2127
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2128
# directly from workingtree_4 triggers a circular import.
2129
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2132
register_metadir(controldir.format_registry, 'dirstate-tags',
2133
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2134
help='New in 0.15: Fast local operations and improved scaling for '
2135
'network operations. Additionally adds support for tags.'
2136
' Incompatible with bzr < 0.15.',
2137
branch_format='bzrlib.branch.BzrBranchFormat6',
2138
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2141
register_metadir(controldir.format_registry, 'rich-root',
2142
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2143
help='New in 1.0. Better handling of tree roots. Incompatible with'
2145
branch_format='bzrlib.branch.BzrBranchFormat6',
2146
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2149
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2150
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2151
help='New in 0.15: Fast local operations and improved scaling for '
2152
'network operations. Additionally adds support for versioning nested '
2153
'bzr branches. Incompatible with bzr < 0.15.',
2154
branch_format='bzrlib.branch.BzrBranchFormat6',
2155
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2159
register_metadir(controldir.format_registry, 'pack-0.92',
2160
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2161
help='New in 0.92: Pack-based format with data compatible with '
2162
'dirstate-tags format repositories. Interoperates with '
2163
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2165
branch_format='bzrlib.branch.BzrBranchFormat6',
2166
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2168
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2169
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2170
help='New in 0.92: Pack-based format with data compatible with '
2171
'dirstate-with-subtree format repositories. Interoperates with '
2172
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2174
branch_format='bzrlib.branch.BzrBranchFormat6',
2175
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2179
register_metadir(controldir.format_registry, 'rich-root-pack',
2180
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2181
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
2182
'(needed for bzr-svn and bzr-git).',
2183
branch_format='bzrlib.branch.BzrBranchFormat6',
2184
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2187
register_metadir(controldir.format_registry, '1.6',
2188
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
2189
help='A format that allows a branch to indicate that there is another '
2190
'(stacked) repository that should be used to access data that is '
2191
'not present locally.',
2192
branch_format='bzrlib.branch.BzrBranchFormat7',
2193
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2196
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2197
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
2198
help='A variant of 1.6 that supports rich-root data '
2199
'(needed for bzr-svn and bzr-git).',
2200
branch_format='bzrlib.branch.BzrBranchFormat7',
2201
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2204
register_metadir(controldir.format_registry, '1.9',
2205
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2206
help='A repository format using B+tree indexes. These indexes '
2207
'are smaller in size, have smarter caching and provide faster '
2208
'performance for most operations.',
2209
branch_format='bzrlib.branch.BzrBranchFormat7',
2210
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2213
register_metadir(controldir.format_registry, '1.9-rich-root',
2214
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2215
help='A variant of 1.9 that supports rich-root data '
2216
'(needed for bzr-svn and bzr-git).',
2217
branch_format='bzrlib.branch.BzrBranchFormat7',
2218
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2221
register_metadir(controldir.format_registry, '1.14',
2222
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2223
help='A working-tree format that supports content filtering.',
2224
branch_format='bzrlib.branch.BzrBranchFormat7',
2225
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2227
register_metadir(controldir.format_registry, '1.14-rich-root',
2228
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2229
help='A variant of 1.14 that supports rich-root data '
2230
'(needed for bzr-svn and bzr-git).',
2231
branch_format='bzrlib.branch.BzrBranchFormat7',
2232
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2234
# The following un-numbered 'development' formats should always just be aliases.
2235
register_metadir(controldir.format_registry, 'development-subtree',
2236
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
2237
help='Current development format, subtree variant. Can convert data to and '
2238
'from pack-0.92-subtree (and anything compatible with '
2239
'pack-0.92-subtree) format repositories. Repositories and branches in '
2240
'this format can only be read by bzr.dev. Please read '
2241
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2243
branch_format='bzrlib.branch.BzrBranchFormat7',
2244
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2247
alias=False, # Restore to being an alias when an actual development subtree format is added
2248
# This current non-alias status is simply because we did not introduce a
2249
# chk based subtree format.
2251
register_metadir(controldir.format_registry, 'development5-subtree',
2252
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
2253
help='Development format, subtree variant. Can convert data to and '
2254
'from pack-0.92-subtree (and anything compatible with '
2255
'pack-0.92-subtree) format repositories. Repositories and branches in '
2256
'this format can only be read by bzr.dev. Please read '
2257
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2259
branch_format='bzrlib.branch.BzrBranchFormat7',
2260
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2266
# And the development formats above will have aliased one of the following:
2268
# Finally, the current format.
2269
register_metadir(controldir.format_registry, '2a',
2270
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2271
help='First format for bzr 2.0 series.\n'
2272
'Uses group-compress storage.\n'
2273
'Provides rich roots which are a one-way transition.\n',
2274
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
2275
# 'rich roots. Supported by bzr 1.16 and later.',
2276
branch_format='bzrlib.branch.BzrBranchFormat7',
2277
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2281
# The following format should be an alias for the rich root equivalent
2282
# of the default format
2283
register_metadir(controldir.format_registry, 'default-rich-root',
2284
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2285
branch_format='bzrlib.branch.BzrBranchFormat7',
2286
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2291
# The current format that is made on 'bzr init'.
2292
format_name = config.GlobalConfig().get_user_option('default_format')
2293
if format_name is None:
2294
controldir.format_registry.set_default('2a')
2296
controldir.format_registry.set_default(format_name)
2298
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2299
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
2300
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
2301
format_registry = controldir.format_registry
added
removed
bzrlib/bzrdir.py
