b.c.ControlComponentFormat(object) : class documentation

Part of bzrlib.controldir View In Hierarchy

Known subclasses: bzrlib.branch.BranchFormat, bzrlib.tests.test_controldir.OldControlComponentFormat, bzrlib.tests.test_controldir.SampleComponentFormat, bzrlib.tests.test_controldir.SampleExtraComponentFormat, bzrlib.tests.test_controldir.UnsupportedControlComponentFormat

A component that can live inside of a .bzr meta directory.
Method get_format_string Return the format of this format, if usable in meta directories.
Method get_format_description Return the short description for this format.
Method is_supported Is this format supported?
Method check_support_status Give an error or warning on old formats.
def get_format_string(self):
Return the format of this format, if usable in meta directories.
def get_format_description(self):
Return the short description for this format.
def is_supported(self):
Is this format supported?

Supported formats must be initializable and openable. Unsupported formats may not support initialization or committing or some other features depending on the reason for not being supported.

def check_support_status(self, allow_unsupported, recommend_upgrade=True, basedir=None):
Give an error or warning on old formats.
Parametersallow_unsupportedIf true, allow opening formats that are strongly deprecated, and which may have limited functionality.
recommend_upgradeIf true (default), warn the user through the ui object that they may wish to upgrade the object.
API Documentation for Bazaar, generated by pydoctor at 2019-03-19 00:18:00.