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
Details
Details
- Reviewers
carlavilla gjb - Group Reviewers
manpages - Commits
- rG88be8b8e5479: Fix igor and mandoc -T lint low-hanging fruit in hier(7)
man and inspect output
Diff Detail
Diff Detail
- Repository
- rG FreeBSD src repository
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 48462 Build 45348: arc lint + arc unit
Event Timeline
| 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 | 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 | 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 |
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 | 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.) | |
| share/man/man7/hier.7 | ||
|---|---|---|
| 388 |
Description is okay, but why not annotate .Xr pc 5 explicitly? | |
| share/man/man7/hier.7 | ||
|---|---|---|
| 388 | 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 | 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 | |
| share/man/man7/hier.7 | ||
|---|---|---|
| 388 | WFM. | |