Documentation maintenance¶
When changing ossec-hids, update ossec-docs in the same release cycle when:
Config parsers (
src/config/*.c) gain or change XML elements → update the matchingdocs/syntax/ossec_config.*.trstfile.``internal_options.conf`` keys change → update
docs/syntax/internal_options.*.trst.Breaking changes → update Upgrading to OSSEC 4.x and
changelog.rst.New CLI tools in
src/util/→ add a page underdocs/programs/.
Build locally:
pip install -r requirements.txt
make html
HTML output is written to _build/html/.
Config audit checklist¶
Compare parser XML tag names in src/config/ against docs/syntax/*.trst:
Compare etc/internal_options.conf keys against docs/syntax/internal_options.*.trst.