b.b.BranchReferenceFormat(BranchFormatMetadir) : class documentation

Part of bzrlib.branch View In Hierarchy

Bzr branch reference format.

Branch references are used in implementing checkouts, they act as an alias to the real branch which is at some other url.

This format has:
  • A location file
  • a format string
Method get_format_string See BranchFormat.get_format_string().
Method get_format_description See BranchFormat.get_format_description().
Method get_reference See BranchFormat.get_reference().
Method set_reference See BranchFormat.set_reference().
Method initialize Create a branch of this format in a_bzrdir.
Method open Return the branch that the branch reference in a_bzrdir points at.
Method _make_reference_clone_function Create a clone() routine for a branch dynamically.

Inherited from BranchFormatMetadir:

Method network_name A simple byte string uniquely identifying this format for RPC calls.
Method supports_tags True if this format supports tags stored in the branch
Method supports_leaving_lock True if this format supports leaving locks in place.
Method _branch_class What class to instantiate on open calls.
Method _get_initial_config Undocumented
Method _initialize_helper Initialize a branch in a bzrdir, with specified files
Method _matchingbzrdir Undocumented

Inherited from BranchFormat (via BranchFormatMetadir):

Method __eq__ Undocumented
Method __ne__ Undocumented
Class Method find_format Return the format for the branch object in controldir.
Class Method get_default_format Return the current default format.
Class Method get_formats Get all the known formats.
Method is_supported Is this format supported?
Method make_tags Create a tags object for branch.
Class Method register_format Register a metadir format.
Class Method set_default_format Undocumented
Method supports_set_append_revisions_only True if this format supports set_append_revisions_only.
Method supports_stacking True if this format records a stacked-on branch.
Class Method unregister_format Undocumented
Method __str__ Undocumented
Method tags_are_versioned Whether the tag container for this branch versions tags.
Method supports_tags_referencing_ghosts True if tags can reference ghost revisions.
Method _run_post_branch_init_hooks Undocumented

Inherited from ControlComponentFormat (via BranchFormatMetadir, BranchFormat):

Method check_support_status Give an error or warning on old formats.
def get_format_string(self):
See BranchFormat.get_format_string().
def get_format_description(self):
See BranchFormat.get_format_description().
def get_reference(self, a_bzrdir, name=None):
See BranchFormat.get_reference().
def set_reference(self, a_bzrdir, name, to_branch):
See BranchFormat.set_reference().
def initialize(self, a_bzrdir, name=None, target_branch=None, repository=None, append_revisions_only=None):
Create a branch of this format in a_bzrdir.
def _make_reference_clone_function(format, a_branch):
Create a clone() routine for a branch dynamically.
def open(self, a_bzrdir, name=None, _found=False, location=None, possible_transports=None, ignore_fallbacks=False, found_repository=None):
Return the branch that the branch reference in a_bzrdir points at.
Parametersa_bzrdirA BzrDir that contains a branch.
nameName of colocated branch to open, if any
_founda private parameter, do not use it. It is used to indicate if format probing has already be done.
ignore_fallbackswhen set, no fallback branches will be opened (if there are any). Default is to open fallbacks.
locationThe location of the referenced branch. If unspecified, this will be determined from the branch reference in a_bzrdir.
possible_transportsAn optional reusable transports list.
API Documentation for Bazaar, generated by pydoctor at 2021-01-28 00:28:51.