Part of bzrlib.bzrdir View In Hierarchy
Known subclasses: bzrlib.bzrdir.BzrDirMetaFormat1, bzrlib.plugins.weave_fmt.bzrdir.BzrDirFormat4, bzrlib.plugins.weave_fmt.bzrdir.BzrDirFormatAllInOne, bzrlib.tests.test_bzrdir.DeprecatedBzrDirFormat, bzrlib.tests.test_bzrdir.SampleBzrDirFormat
Formats are placed in a dict by their format string for reference during bzrdir opening. These should be subclasses of BzrDirFormat for consistency.
Once a format is deprecated, just deprecate the initialize and open methods on the format class. Do not deprecate the object, as the object will be created every system load.
| Class Method | get_format_string | Return the ASCII format string that identifies this format. |
| 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. |
| Method | _open | Template method helper for opening BzrDirectories. |
| Method | _supply_sub_formats_to | Give other_format the same values for sub formats as this has. |
Inherited from ControlDirFormat:
| Method | get_format_description | Return the short description for this format. |
| Method | get_converter | Return the converter to use to convert controldirs needing converts. |
| 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. |
| Method | network_name | A simple byte string uniquely identifying this format for RPC calls. |
| Class Method | get_default_format | Return the current default format. |
| Class Method | _set_default_format | Set default format (for testing behavior of defaults only) |
The directory to initialize will be created.
| Parameters | force_new_repo | Do not use a shared repository for the target, even if one is available. |
| create_prefix | Create any missing directories leading up to to_transport. | |
| use_existing_dir | Use an existing directory if one exists. | |
| stacked_on | A url to stack any created branch on, None to follow any target stacking policy. | |
| stack_on_pwd | If stack_on is relative, the location it is relative to. | |
| repo_format_name | If non-None, a repository will be made-or-found. Should none be found, or if force_new_repo is True the repo_format_name is used to select the format of repository to create. | |
| make_working_trees | Control the setting of make_working_trees for a new shared repository when one is made. None to use whatever default the format has. | |
| shared_repo | Control whether made repositories are shared or not. | |
| vfs_only | If True do not attempt to use a smart server | |
| Returns | repo, bzrdir, require_stacking, repository_policy. repo is None if none was created or found, bzrdir is always valid. require_stacking is the result of examining the stacked_on parameter and any stacking policy found for the target. | |
| Parameters | transport | The transport to create the .bzr directory in. |
| Returns | A | |
_found is a private parameter, do not use it.
This performs the actual open and any additional logic or parameter passing.
This method is expected to be used when parameterising a RemoteBzrDirFormat instance with the parameters from a BzrDirMetaFormat1 instance.
| Parameters | other_format | other_format is a format which should be compatible with whatever sub formats are supported by self. |
| Returns | None. | |