b.w.DirStateWorkingTreeFormat(WorkingTreeFormat) : class documentation

Part of bzrlib.workingtree_4 View In Hierarchy

Known subclasses: bzrlib.workingtree_4.WorkingTreeFormat4, bzrlib.workingtree_4.WorkingTreeFormat5, bzrlib.workingtree_4.WorkingTreeFormat6

No class docstring
Method initialize See WorkingTreeFormat.initialize().
Method open Return the WorkingTree object for a_bzrdir
Method _open_control_files Undocumented
Method _init_custom_control_files Subclasses with custom control files should override this method.
Method _open Open the tree itself.
Method __get_matchingbzrdir Undocumented
Method _get_matchingbzrdir Overrideable method to get a bzrdir for testing.

Inherited from WorkingTreeFormat:

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 __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.
def _open_control_files(self, a_bzrdir):
Undocumented
def initialize(self, a_bzrdir, revision_id=None, from_branch=None, accelerator_tree=None, hardlink=False):
overrides bzrlib.workingtree.WorkingTreeFormat.initialize
See WorkingTreeFormat.initialize().

These trees get an initial random root id, if their repository supports rich root data, TREE_ROOT otherwise.

Parametersrevision_idallows creating a working tree at a different revision than the branch is at.
accelerator_treeA 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.
hardlinkIf true, hard-link files from accelerator_tree, where possible.
def _init_custom_control_files(self, wt):
overridden in bzrlib.workingtree_4.WorkingTreeFormat6
Subclasses with custom control files should override this method.

The working tree and control files are locked for writing when this method is called.

Parameterswtthe WorkingTree object
def open(self, a_bzrdir, _found=False):

Return the WorkingTree object for a_bzrdir

_found is a private parameter, do not use it. It is used to indicate
if format probing has already been done.
def _open(self, a_bzrdir, control_files):
Open the tree itself.
Parametersa_bzrdirthe dir for the tree.
control_filesthe control files for the tree.
def __get_matchingbzrdir(self):
Undocumented
def _get_matchingbzrdir(self):
Overrideable method to get a bzrdir for testing.
API Documentation for Bazaar, generated by pydoctor at 2022-06-16 00:25:16.