Page MenuHomeFreeBSD

Fix igor and mandoc -T lint low-hanging fruit in hier(7)
ClosedPublic

Authored by pauamma_gundo.com on Nov 23 2022, 1:56 AM.
Tags
None
Referenced Files
Unknown Object (File)
Jan 7 2024, 6:30 AM
Unknown Object (File)
Jan 7 2024, 6:30 AM
Unknown Object (File)
Dec 20 2023, 5:31 AM
Unknown Object (File)
Nov 28 2023, 12:05 PM
Unknown Object (File)
Nov 26 2023, 11:13 PM
Unknown Object (File)
Nov 25 2023, 4:40 AM
Unknown Object (File)
Nov 24 2023, 2:30 PM
Unknown Object (File)
Nov 22 2023, 9:53 PM
Subscribers

Details

Summary

I left some mandoc complaints unaddressed because either:

  • they were spurious complaints about missing \&-prefixed command names
  • whether and how to fix them wasn't clear to me
Test Plan

man and inspect output

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 48469
Build 45355: arc lint + arc unit

Event Timeline

pauamma_gundo.com edited the test plan for this revision. (Show Details)
danfe added inline comments.
share/man/man7/hier.7
382

GCC configuration data, perhaps: before it was correct as it was referring to the command and rendered as gcc(1), but now it means the product itself, which name is an abbreviation and thus should be capitalized.

388–389

I would have also expanded what those pc files are, currently it's unclear unless the reader already knows what they are.

share/man/man7/hier.7
388–389

Come to think of it, I'm not sure what they are for. Compiler and linker options for contributed base software?

share/man/man7/hier.7
388–389

I'm not sure what they are for.

man pc(5) -- actually, changing it to .Xr pc 5 would probably be sufficient and avoid the need for elaborate explanation.

share/man/man7/hier.7
388–389

Not in base. But perhaps "compiler flags, linker flags, and other information relevant to library use"? (Summarized from first paragraph of https://www.freebsd.org/cgi/man.cgi?query=pc&apropos=0&sektion=0&manpath=FreeBSD+13.1-RELEASE+and+Ports&arch=default&format=html description, as I think it would apply to use in base.)

pauamma_gundo.com edited the test plan for this revision. (Show Details)

Elaborate on pc files

This revision is now accepted and ready to land.Nov 23 2022, 4:58 PM
pauamma_gundo.com added inline comments.
share/man/man7/hier.7
382

I forgot that one. Unless there's another round of reviewing, I'll fix it before pushing.

388–389

How does it look now?

share/man/man7/hier.7
388–389

How does it look now?

Description is okay, but why not annotate .Xr pc 5 explicitly?

share/man/man7/hier.7
388–389

Because, as I mentioned earlier, that manual page isn't in base. I'm trying to bring mandoc -T lint complaints down here, not give it more things to complain about.

share/man/man7/hier.7
388–389

I doubt this will appease mandoc -T lint, but you could always add a reference that the manual is part of a third-party package, such as in security(7):

security.7:.Xr xterm 1 Pq Pa ports/x11/xterm

gjb's suggestion and a change I forgot earlier.

This revision now requires review to proceed.Nov 23 2022, 7:43 PM
pauamma_gundo.com added inline comments.
share/man/man7/hier.7
388–389

WFM.

This revision is now accepted and ready to land.Nov 23 2022, 7:53 PM