b.b.BzrDirMetaFormat1(BzrDirFormat) : class documentation

Part of bzrlib.bzrdir View In Hierarchy

Known subclasses: bzrlib.bzrdir.BzrDirMetaFormat1Colo, bzrlib.remote.RemoteBzrDirFormat, bzrlib.tests.blackbox.test_upgrade.OldBzrDirFormat, bzrlib.tests.test_bzrdir._TestBzrDirFormat, bzrlib.tests.test_bzrdir.BzrDirFormatTest1, bzrlib.tests.test_bzrdir.BzrDirFormatTest2, bzrlib.tests.test_foreign.DummyForeignVcsDirFormat

Bzr meta control format 1

This is the first format with split out working tree, branch and repository disk storage.

It has:

Method __init__ Undocumented
Method __eq__ Undocumented
Method __ne__ Undocumented
Method get_branch_format Undocumented
Method set_branch_format Undocumented
Method require_stacking We have a request to stack, try to ensure the formats support it.
Method get_converter See BzrDirFormat.get_converter().
Class Method get_format_string See BzrDirFormat.get_format_string().
Method get_format_description See BzrDirFormat.get_format_description().
Method network_name A simple byte string uniquely identifying this format for RPC calls.
Method _open See BzrDirFormat._open.
Method __return_repository_format Circular import protection.
Method _set_repository_format Allow changing the repository format for metadir formats.
Method _supply_sub_formats_to Give other_format the same values for sub formats as this has.
Method __get_workingtree_format Undocumented
Method __set_workingtree_format Undocumented

Inherited from BzrDirFormat:

Method initialize_on_transport Initialize a new bzrdir in the base directory of a Transport.
Method initialize_on_transport_ex Create this format on transport.
Method open Return an instance of this format for the dir transport points at.
Method supports_transport Check if this format can be opened over a particular transport.
Method _initialize_on_transport_vfs Initialize a new bzrdir using VFS calls.

Inherited from ControlDirFormat (via BzrDirFormat):

Method is_supported Is this format supported?
Method is_initializable Whether new control directories of this format can be initialized.
Method check_support_status Give an error or warning on old formats.
Method same_model Undocumented
Class Method register_format Register a format that does not use '.bzr' for its control dir.
Class Method register_prober Register a prober that can look for a control dir.
Class Method unregister_prober Unregister a prober.
Class Method register_server_prober Register a control format prober for client-server environments.
Method __str__ Undocumented
Class Method known_formats Return all the known formats.
Class Method find_format Return the format present at transport.
Method initialize Create a control dir at this url and return an opened copy.
Class Method get_default_format Return the current default format.
Class Method _set_default_format Set default format (for testing behavior of defaults only)
def __init__(self):
def __eq__(self, other):
def __ne__(self, other):
def get_branch_format(self):
def set_branch_format(self, format):
def require_stacking(self, stack_on=None, possible_transports=None, _skip_repo=False):
We have a request to stack, try to ensure the formats support it.
Parametersstack_onIf supplied, it is the URL to a branch that we want to stack on. Check to see if that format supports stacking before forcing an upgrade.
def get_converter(self, format=None):
See BzrDirFormat.get_converter().
def get_format_string(cls):
See BzrDirFormat.get_format_string().
def get_format_description(self):
See BzrDirFormat.get_format_description().
def network_name(self):
A simple byte string uniquely identifying this format for RPC calls.

Bzr control formats use this disk format string to identify the format over the wire. Its possible that other control formats have more complex detection requirements, so we permit them to use any unique and immutable string they desire.

def _open(self, transport):
See BzrDirFormat._open.
def __return_repository_format(self):
Circular import protection.
def _set_repository_format(self, value):
Allow changing the repository format for metadir formats.
def _supply_sub_formats_to(self, other_format):
Give other_format the same values for sub formats as this has.

This method is expected to be used when parameterising a RemoteBzrDirFormat instance with the parameters from a BzrDirMetaFormat1 instance.

Parametersother_formatother_format is a format which should be compatible with whatever sub formats are supported by self.
def __get_workingtree_format(self):
def __set_workingtree_format(self, wt_format):
API Documentation for Bazaar, generated by pydoctor at 2019-10-20 00:34:54.