Generate CLI manual sections from source option declarations - #3057
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CLI option lists were maintained separately from their parsers, leaving missing flags and obsolete descriptions in the manuals. Generate SYNOPSIS and OPTIONS for all six CLI tools from their getopt declarations and source documentation comments, and derive cipher lists from the C tables. The overview manual links to each command's generated reference.
CMake regenerates man/HTML inputs in the build directory without running target binaries. CI checks committed pages for drift, tests the generator, and renders both formats. The documentation build also supports Homebrew XML catalogs on Apple Silicon while honoring explicit catalog configuration.
Validation: workflow/Python lint and generated-file checks passed; 10 generator regression tests, 35 CTest tests, 131 setup assertions, and three 10 MB stress tests passed. All seven man pages and seven HTML pages built locally. Rendered manuals contain every declared flag; incremental regeneration and unchanged rebuild behavior were verified.