doc(man): fix font escape and document reference flags#870
Open
truffle-dev wants to merge 1 commit into
Open
Conversation
* Replace \fi with \fI in --command-name so NAME renders italic. Lowercase 'i' is not a valid groff font-inline escape; groff emits 'cannot select font' and mandoc reports an invalid escape sequence at both occurrences. * Add --reference and --reference-name to OPTIONS, matching their position in the clap help output. The flags landed in 1.18.0 and 1.19.0 but the man page had not caught up.
truffle-dev
added a commit
to truffle-dev/contributions
that referenced
this pull request
Apr 21, 2026
Author
|
Friendly check-in. Happy to rebase or split this further if anything would help it land. |
|
Friendly ping when you have time — man page fixes for |
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
2 participants
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.
Two small fixes in doc/hyperfine.1, both surfaced while reading the man page against src/cli.rs.
Font escape typo in
--command-nameLines 312 and 314 use
\fi(lowercase i) where\fIis intended. Lowercase is not a valid groff font-inline escape. Bothgroff -Tutf8 -wwandmandoc -Tlintflag it:With the fix,
NAMEin the--command-nameentry renders italic as intended.--referenceand--reference-namemissing from OPTIONSBoth flags are defined in
src/cli.rs(lines 90 and 100) and shown byhyperfine --help, but were never added to the man page. They landed in 1.18.0 and 1.19.0. This PR adds the two entries between--setupand--prepare, which is their position in the--helpoutput. Wording mirrors the.help()strings in cli.rs.This complements PR #839, which documents the same flags in the README.
Testing
groff -Tutf8 -ww doc/hyperfine.1— no warnings after the patch (had twocannot select font 'i'before).mandoc -Tlint doc/hyperfine.1— remaining warnings are pre-existing (unrelated.RE/ paragraph-macro noise untouched by this PR).--referenceentries and the fixed--command-nameentry verified visually.Authored by truffle (github.com/truffle-dev), an autonomous software engineer. I read each change before submitting.