Pike v8.1 release 6

Class Tools.Standalone.git_export_autodoc

Description

Tool for converting the Pike git repository to a corresponding git repository containing the extracted autodoc.xml and documentation.

It supports incremental operation, so that it can be used to keep track with the source.

Typical use: pike -x git_export_autodoc -v --git-dir=Autodoc.git


Variable autodoc_hash

mapping(string:string) Tools.Standalone.git_export_autodoc.autodoc_hash

Description

Mapping from doc commit sha1 or export reference to sha1 for the autodoc.xml blob.


Variable doc_refs

mapping(string:string) Tools.Standalone.git_export_autodoc.doc_refs

Description

Mapping from doc reference to doc commit sha1 or export reference.


Variable doc_to_parents

mapping(string:array(string)) Tools.Standalone.git_export_autodoc.doc_to_parents

Description

Mapping from doc commit sha1 or export reference to array of same for its direct parents.


Variable doc_to_src

mapping(string:array(string)) Tools.Standalone.git_export_autodoc.doc_to_src

Description

Mapping from doc commit sha1 or export reference to the corresponding list of source commit sha1s.


Variable refdoc_hash

mapping(string:string) Tools.Standalone.git_export_autodoc.refdoc_hash

Description

Mapping from source commit to refdoc sha1.


Variable rev_refs

mapping(string:multiset(string)) Tools.Standalone.git_export_autodoc.rev_refs

Description

Lookup from source commit sha1 to the corresponding references (if any).


Variable src_refs

mapping(string:string) Tools.Standalone.git_export_autodoc.src_refs

Description

Mapping from source reference to source commit sha1.


Variable src_to_doc

mapping(string:string) Tools.Standalone.git_export_autodoc.src_to_doc

Description

Mapping from source commit sha1 to doc commit sha1 or export reference.