Skip to content

Improve the manpages & lint them in github#11339

Open
sylvestre wants to merge 4 commits intouutils:mainfrom
sylvestre:manpages
Open

Improve the manpages & lint them in github#11339
sylvestre wants to merge 4 commits intouutils:mainfrom
sylvestre:manpages

Conversation

@sylvestre
Copy link
Contributor

No description provided.

- Fix TH header: uppercase command names and remove invalid date format
- Remove trailing whitespace from all manpage lines
- Fix redundant .br paragraph macros that cause mandoc warnings
- Post-process manpage output to ensure compliance with mandoc standards
@github-actions
Copy link

GNU testsuite comparison:

Skipping an intermittent issue tests/pr/bounded-memory (passes in this run but fails in the 'main' branch)
Skipping an intermittent issue tests/tail/symlink (passes in this run but fails in the 'main' branch)
Note: The gnu test tests/rm/many-dir-entries-vs-OOM is now being skipped but was previously passing.

@github-actions
Copy link

GNU testsuite comparison:

Skip an intermittent issue tests/cut/bounded-memory (fails in this run but passes in the 'main' branch)
Skip an intermittent issue tests/date/date-locale-hour (fails in this run but passes in the 'main' branch)
Skipping an intermittent issue tests/pr/bounded-memory (passes in this run but fails in the 'main' branch)
Skipping an intermittent issue tests/tail/symlink (passes in this run but fails in the 'main' branch)
Skipping an intermittent issue tests/tty/tty-eof (passes in this run but fails in the 'main' branch)
Note: The gnu test tests/printf/printf-surprise is now being skipped but was previously passing.
Congrats! The gnu test tests/tail/tail-n0f is now passing!

@sylvestre sylvestre force-pushed the manpages branch 2 times, most recently from 22b8e12 to c8db906 Compare March 15, 2026 19:56
@github-actions
Copy link

GNU testsuite comparison:

Skipping an intermittent issue tests/tail/symlink (passes in this run but fails in the 'main' branch)
Note: The gnu test tests/cp/link-heap is now being skipped but was previously passing.
Note: The gnu test tests/seq/seq-epipe is now being skipped but was previously passing.
Congrats! The gnu test tests/tail/tail-n0f is now passing!

@github-actions
Copy link

GNU testsuite comparison:

Skipping an intermittent issue tests/tail/symlink (passes in this run but fails in the 'main' branch)
Note: The gnu test tests/expand/bounded-memory is now being skipped but was previously passing.
Note: The gnu test tests/printf/printf-surprise is now being skipped but was previously passing.
Congrats! The gnu test tests/tail/tail-n0f is now passing!

@github-actions
Copy link

GNU testsuite comparison:

Skip an intermittent issue tests/date/date-locale-hour (fails in this run but passes in the 'main' branch)
Skip an intermittent issue tests/date/resolution (fails in this run but passes in the 'main' branch)
Skipping an intermittent issue tests/tail/symlink (passes in this run but fails in the 'main' branch)
Congrats! The gnu test tests/tail/tail-n0f is now passing!

Add a new workflow that builds and validates all manpages using mandoc -T lint.
The workflow runs on PRs and pushes that modify manpage-related files and
validates both English and French manpages in parallel.
@sylvestre sylvestre force-pushed the manpages branch 2 times, most recently from 6fca3ad to 6691464 Compare March 15, 2026 22:17
@github-actions
Copy link

GNU testsuite comparison:

GNU test failed: tests/timeout/timeout-group. tests/timeout/timeout-group is passing on 'main'. Maybe you have to rebase?
Skipping an intermittent issue tests/pr/bounded-memory (passes in this run but fails in the 'main' branch)
Skipping an intermittent issue tests/tail/symlink (passes in this run but fails in the 'main' branch)
Skipping an intermittent issue tests/tty/tty-eof (passes in this run but fails in the 'main' branch)
Note: The gnu test tests/basenc/bounded-memory is now being skipped but was previously passing.
Note: The gnu test tests/csplit/csplit-heap is now being skipped but was previously passing.
Congrats! The gnu test tests/tail/tail-n0f is now passing!

- Move manpage post-processing logic into post_process_manpage() function
- Add comprehensive unit tests for all post-processing functionality
- Improve .br macro handling to correctly fix mandoc warnings
- Tests cover TH header fixes, whitespace removal, and .br pattern fixes
- Enhanced post-processing to remove .br macros that appear before empty lines
- This fixes 'WARNING: skipping paragraph macro: br before sp' from mandoc
- Also handles the common pattern of .br-empty-.br by removing both .br macros
- Added comprehensive test cases for the new patterns
- All mandoc 'br before sp' warnings are now resolved
@sylvestre sylvestre marked this pull request as ready for review March 15, 2026 22:32
@github-actions
Copy link

GNU testsuite comparison:

Skip an intermittent issue tests/date/date-locale-hour (fails in this run but passes in the 'main' branch)
Skip an intermittent issue tests/date/resolution (fails in this run but passes in the 'main' branch)
Congrats! The gnu test tests/tail/retry is no longer failing!
Note: The gnu test tests/tail/tail-n0f is now being skipped but was previously passing.
Congrats! The gnu test tests/cut/bounded-memory is now passing!
Congrats! The gnu test tests/expand/bounded-memory is now passing!

@cakebaker
Copy link
Contributor

I don't know if you have seen it: the newly added tests fail in the CI :|

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