Part of bzrlib.workingtree View In Hierarchy
Known subclasses: bzrlib.plugins.weave_fmt.workingtree.WorkingTreeFormat2, bzrlib.tests.per_bzrdir.test_bzrdir.AnonymousTestWorkingTreeFormat, bzrlib.tests.per_bzrdir.test_bzrdir.IdentifiableTestWorkingTreeFormat, bzrlib.tests.test_workingtree.SampleExtraTreeFormat, bzrlib.tests.test_workingtree.SampleTreeFormat, bzrlib.workingtree_3.WorkingTreeFormat3, bzrlib.workingtree_4.DirStateWorkingTreeFormat
Formats are placed in an dict by their format string for reference during workingtree opening. Its not required that these be instances, they can be classes themselves with class methods - it simply depends on whether state is needed for a given format or not.
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 time regardless.
Class Method | find_format_string | Return format name for the working tree object in controldir. |
Class Method | find_format | Return the format for the working tree object in controldir. |
Method | initialize | Initialize a new working tree in controldir. |
Method | __eq__ | Undocumented |
Method | __ne__ | Undocumented |
Class Method | get_default_format | Return the current default format. |
Method | get_format_string | Return the ASCII format string that identifies this format. |
Method | get_format_description | Return the short description for this format. |
Method | is_supported | Is this format supported? |
Method | supports_content_filtering | True if this format supports content filtering. |
Method | supports_views | True if this format supports stored views. |
Class Method | register_format | Undocumented |
Class Method | register_extra_format | Undocumented |
Class Method | unregister_extra_format | Undocumented |
Class Method | get_formats | Undocumented |
Class Method | set_default_format | Undocumented |
Class Method | unregister_format | Undocumented |
Method | get_controldir_for_branch | Get the control directory format for creating branches. |
Parameters | controldir | ControlDir to initialize the working tree in. |
revision_id | allows creating a working tree at a different revision than the branch is at. | |
from_branch | Branch to checkout | |
accelerator_tree | A tree which can be used for retrieving file contents more quickly than the revision tree, i.e. a workingtree. The revision tree will be used for cases where accelerator_tree's content is different. | |
hardlink | If true, hard-link files from accelerator_tree, where possible. |
Supported formats can be initialized and opened. Unsupported formats may not support initialization or committing or some other features depending on the reason for not being supported.