manuals: Misc syntax fixes #1472
Conversation
These were reported by `mandoc -T lint ...` as errors. Signed-off-by: Graham Percival <[email protected]> Sponsored by: Tarsnap Backup Inc. Pull Request: freebsd#1472
|
These were reported by Once this is merged, there will be only 3 detected errors [1] left in the non-contrib / non-insane man pages [2]. [1] I'm defining "detected errors" as "detected on 14.1". 1 of those errors is [2] full list of excluded man pages is https://github.com/Tarsnap/freebsd-doc-scripts/blob/main/generate-man-problem-lists.sh#L20. I'm not ruling out re-examining the problematic man pages at some point, but it's not a priority. |
| @@ -393,10 +393,10 @@ Boot to FW : false | |||
| BootCurrent: 0001 | |||
| Timeout : 2 seconds | |||
| BootOrder : 0000, 0001, 0003, 0004, 0005, 0006, 0001, 0008, 000A, 000B, 000C, 000E, 0007 | |||
| ... | |||
| \&... | |||
| +Boot0001* FreeBSD ZPOOL HD(1,GPT,b5d0f86b-265d-1e1b-18aa-0ed55e1e73bd,0x28,0x96000)/File(\EFI\FREEBSD\LOADER.EFI) | |||
There was a problem hiding this comment.
man interprets \E, \F, and \L as special commands. I have a fix waiting for another PR; I don't think it belongs in this one since the commit says that they were reported by mandoc.
If you'd rather that I include the fixes now, I could make the message "Most of these were reported by mandoc...".
| @@ -295,7 +295,7 @@ proto-unr | |||
| (protocol unreachable) | |||
| the IP protocol specified in the packet is not available to receive | |||
| packets. | |||
| .DE | |||
| .RE | |||
There was a problem hiding this comment.
There's no .DE in man(7).
Given the context, I think this should be .RE to close the .RS on line 257.
sbin/ipf/ipf/ipf.8
Outdated
| @@ -158,7 +158,7 @@ Zero global statistics held in the kernel for filtering only (this doesn't | |||
| affect fragment or state statistics). | |||
| .DT | |||
| .SH ENVIRONMENT | |||
| .NM utilizes the following environment variable. | |||
| ipf utilizes the following environment variable. | |||
There was a problem hiding this comment.
There's no .NM in man(7). The author was clearly thinking of mandoc mdoc(7); for plain old man(7), we have to write out the name.
EDIT: replaced an incorrect "mandoc" with "mdoc".
There was a problem hiding this comment.
Sorry for the noise from deleted comment earlier, I was confused because mandoc(1) is the compiler which speaks both man(7) and mdoc(7) roff(7) dialects (plus some others like tbl(7), roff(7) is an amazing language).
There was a problem hiding this comment.
I haven't seen your "earlier deleted comment", but this comment made me realize that I'd written "mandoc" instead of "mdoc(7)".
I've edited my earlier comment; hopefully it makes more sense now.
|
BTW @concussious : could I convince you to fix two In both cases, somebody thought that they could use formatting commands for the argument to I could just slap a |
|
I'll take a look when I get home. Thanks for inviting me! |
sbin/ipf/ipf/ipf.8
Outdated
| @@ -158,7 +158,7 @@ Zero global statistics held in the kernel for filtering only (this doesn't | |||
| affect fragment or state statistics). | |||
| .DT | |||
| .SH ENVIRONMENT | |||
| .NM utilizes the following environment variable. | |||
| ipf utilizes the following environment variable. | |||
There was a problem hiding this comment.
| ipf utilizes the following environment variable. | |
| .B ipf | |
| utilizes the following environment variable. |
These were reported by `mandoc -T lint ...` as errors. Signed-off-by: Graham Percival <[email protected]> Reviewed by: Alexander Ziaee <[email protected]> Sponsored by: Tarsnap Backup Inc. Pull Request: freebsd#1472
No description provided.