Skip to content

Generate ctl.h.3 from a curated docs/ctl.md, not the README dump (#20) - #29

Merged
rurban merged 2 commits into
masterfrom
man
Sep 22, 2026
Merged

rurban merged 2 commits into
masterfrom
man

Conversation

@rurban

@rurban rurban commented Sep 21, 2026

Copy link
Copy Markdown
Owner

docs/man/ctl.h.3 was generated from docs/index.md, a near-verbatim copy of README.md: badges/CI links, 13 ![]() image references ronn can't render ("unrecognized inline tag: ["img"]" x13), and the ~700-row method-coverage compatibility grid rendered as an unreadably wide table ("table wider than line length", "cannot adjust line"). 758 lines of mostly-noise output.

docs/ctl.md is a dedicated, terminal-appropriate NAME/SYNOPSIS/ DESCRIPTION/CONTAINERS/SEE ALSO/BUGS/AUTHOR page: no images, no grid, one line per container linking to its own man page. 107 lines, zero ronn/groff warnings.

Also stopped generating-then-discarding docs/man/index.h.3, memory.h.3 and numeric.h.3 (the man recipe already deleted them right after building them) by excluding them from $(MANPAGES) instead. index.md's own rule transitively required rebuilding README.md and every listed test binary just to produce a man page that was thrown away immediately after; make man/make install no longer do that.

Verified: ronn and groff -man both exit 0 with no warnings on the new ctl.h.3; make -n man no longer touches README.md or any test binary; make check passes.

@rurban rurban left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove: This page is the
terminal-friendly counterpart to the project README: no badges, images, or
the web compatibility grid, just the reference a man reader needs.

rurban and others added 2 commits September 22, 2026 15:15
docs/man/ctl.h.3 was generated from docs/index.md, a near-verbatim copy
of README.md: badges/CI links, 13 `![]()` image references ronn can't
render ("unrecognized inline tag: [\"img\"]" x13), and the ~700-row
method-coverage compatibility grid rendered as an unreadably wide
table ("table wider than line length", "cannot adjust line"). 758
lines of mostly-noise output.

docs/ctl.md is a dedicated, terminal-appropriate NAME/SYNOPSIS/
DESCRIPTION/CONTAINERS/SEE ALSO/BUGS/AUTHOR page: no images, no grid,
one line per container linking to its own man page. 107 lines, zero
ronn/groff warnings.

Also stopped generating-then-discarding docs/man/index.h.3,
memory.h.3 and numeric.h.3 (the `man` recipe already deleted them
right after building them) by excluding them from $(MANPAGES) instead.
index.md's own rule transitively required rebuilding README.md and
every listed test binary just to produce a man page that was thrown
away immediately after; `make man`/`make install` no longer do that.

Verified: ronn and groff -man both exit 0 with no warnings on the new
ctl.h.3; `make -n man` no longer touches README.md or any test
binary; `make check` passes.
@rurban
rurban merged commit 7758b32 into master Sep 22, 2026
31 checks passed

This branch was successfully deployed

1 active deployment
github-pages 7758b32f Deployed Sep 22, 2026 by rurban via deploy #21
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.

1 participant