Every help text below the current directory is parsed and reported on, and no file of any kind is produced. It is the way to examine a package whose documentation is built as HTML, that route writing pages rather than reporting on what it rendered, and it is the fastest of the three: nothing is rendered and no definition is loaded, so a tree is read straight from disk.

It runs from wherever it is called and works downwards, so a package root covers the whole package and inst covers only what is below it. A src directory is passed over, a DEFUN_DLD help text living inside the compiled file rather than the source, as are tests, demos and datasets, which carry none.

Unlike the documentation builders, it checks everything it finds, a Hidden member and a private helper included. Those are the help texts no reader ever meets and nothing else looks at, so they are the ones that rot unnoticed.

options is a pkg_doc_options object, and without one the settings are read from doc-options.json in the current directory if there is one. The INDEX of the current directory is read unless the object names another, which is what the category label rule is checked against; where no INDEX can be found that rule stands down rather than guess.

status is the number of findings and is zero when nothing was found. report is a struct array of them, carrying 'rule', 'severity', 'file', 'line' and 'message'. With no output requested they are printed.

See also: package_texi2cache, package_texi2html, package_texi2qch, pkg_doc_options

Source Code: check_texi_docs