Skip to content

Add man page validation to CI - #580

Merged
bastelfreak merged 1 commit into
OpenVoxProject:mainfrom
silug:manpage-ci-check
Aug 1, 2026
Merged

Add man page validation to CI#580
bastelfreak merged 1 commit into
OpenVoxProject:mainfrom
silug:manpage-ci-check

Conversation

@silug

@silug silug commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

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:

  • 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.

Checklist

I have:

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>
@silug silug mentioned this pull request Aug 1, 2026
8 tasks
@bastelfreak
bastelfreak merged commit 0794e79 into OpenVoxProject:main Aug 1, 2026
15 checks passed
@silug
silug deleted the manpage-ci-check branch August 2, 2026 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants