Add man page validation to CI - #580
Merged
Merged
Conversation
Port the validate_manpage check from openfact's CI: render every man page with groff warnings enabled and fail on any diagnostic output. This catches broken roff from a bad man page regeneration (e.g. undefined macros). Two deviations from the openfact version, both required for openvox: - Only stderr is inspected, since some pages legitimately contain the word "warning" in their text (e.g. the disable_warnings setting in puppet.conf(5)), which would false-trip the grep-based check. - MANWIDTH=1000 instead of 80, since some pages contain unbreakable tokens wider than 80 columns (long URLs, the ciphers default value) that produce unfixable "cannot break line" warnings. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Steven Pritchard <steven.pritchard@gmail.com>
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
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.
Short description
As suggested in #579 (comment), port the validate_manpage check from openfact's CI: render every man page with groff warnings enabled and fail on any diagnostic output. This catches broken roff from a bad man page regeneration (e.g. undefined macros).
Two deviations from the openfact version, both required for openvox:
Checklist
I have:
Signed-off-byannotation to each of my commitsGenerated-byorAssisted-byannotations to each of my commits created with the help of an AI agent