Details
- Reviewers
brueffer - Group Reviewers
Doc Committers - Commits
- rS273235: Fix UEFI manpage whitespace and minor issues
rS273218: Add basic UEFI boot procedure manpage
Diff Detail
- Lint
Lint Skipped - Unit
Tests Skipped
Event Timeline
| share/man/man8/uefi.8 | ||
|---|---|---|
| 45 | double "in" | |
| 49 | Further down only the "file system" spelling is used, so it should be consistent here. | |
| 62 | firmare -> firmware | |
| 83 | laods -> loads | |
| 102 | This should be something like the following: [...] | |
| 131 | The first sort key in SEE ALSO is section, then manpage name (and no period at the end): .Sh SEE ALSO | |
textproc/igor checks for whitespace and spelling problems, among others. It is a good idea to run it on man pages and even plain text files before commit:
igor -R Makefile | less -RS
igor -R uefi.8 | less -RS
For man pages, it is also useful to run
mandoc -Tlint uefi.8
| head/share/man/man8/Makefile | ||
|---|---|---|
| 31 ↗ | (On Diff #2016) | There is a bunch of trailing whitespace on this line. |
| head/share/man/man8/uefi.8 | ||
| 34 ↗ | (On Diff #2016) | Trailing whitespace. |
| 46 ↗ | (On Diff #2016) | spelling: "parition" |
| 103 ↗ | (On Diff #2016) | Trailing whitespace. |
Move CAVEATS to end as suggested by mandoc -T lint
| share/man/man8/uefi.8 | ||
|---|---|---|
| 134 | It seems mandoc -Tlint treats CAVEATS as BUGS | |
| head/share/man/man8/uefi.8 | ||
|---|---|---|
| 33 ↗ | (On Diff #2016) | Yes. A typical man page has a minimum set of eight sections in order. Man pages that do not apply to ordinary commands leave out the synopsis. |
| 113 ↗ | (On Diff #2016) | Kind of depends on how you look at it. "Bug" says "it is present but does not work correctly" while caveats could be warnings about differences from expectations or unimplemented things. |
| head/share/man/man8/uefi.8 | ||
|---|---|---|
| 113 ↗ | (On Diff #2016) | Ok - these are legitimately CAVEATS I think. I was mainly confused by mandoc -Tlint's complaint about ordering, as mdoc(7) does not describe CAVEATS, but mandoc -Tlint seems to treat it as BUGS. |