bzrlib.tests.test_branch.SampleExtraBranchFormat : API documentation

Method	get_format_string	Return the ASCII format string that identifies this format.
Method	network_name	A simple byte string uniquely identifying this format for RPC calls.
Method	initialize	Create a branch of this format in controldir.
Method	open	Return the branch object for controldir.

Inherited from BranchFormat:

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	get_reference	Get the target reference of the branch in controldir.
Class Method	set_reference	Set the target reference of the branch in controldir.
Method	get_format_description	Return the short format description for this format.
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.
Method	supports_leaving_lock	True if this format supports leaving locks in place.
Class Method	unregister_format	Undocumented
Method	__str__	Undocumented
Method	supports_tags	True if this format supports tags stored in the branch
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 BranchFormat):

Method

check_support_status

Give an error or warning on old formats.

def network_name(self):

overrides bzrlib.branch.BranchFormat.network_name

A simple byte string uniquely identifying this format for RPC calls.

MetaDir branch formats use their disk format string to identify the repository over the wire. All in one formats such as bzr < 0.8, and foreign formats like svn/git and hg should use some marker which is unique and immutable.

def open(self, transport, name=None, _found=False, ignore_fallbacks=False):

overrides bzrlib.branch.BranchFormat.open

Return the branch object for controldir.

Parameters	controldir	A ControlDir that contains a branch.
	name	Name of colocated branch to open
	_found	a private parameter, do not use it. It is used to indicate if format probing has already be done.
	ignore_fallbacks	when set, no fallback branches will be opened (if there are any). Default is to open fallbacks.

b.t.t.SampleExtraBranchFormat(_mod_branch.BranchFormat) : class documentation