diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2015-02-23 13:31:03 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2015-02-23 13:31:03 +0000 |
commit | d9ef974d05cb710d89c63e8ee474a0eb00e2d56b (patch) | |
tree | 8fe4c115973611db8d2d44351bf3f89847e38b30 /mandoc.1 | |
parent | 4c2af21a8a623f5d22f660bdcfff1e1c23b9bcd2 (diff) | |
download | mandoc-d9ef974d05cb710d89c63e8ee474a0eb00e2d56b.tar.gz |
improve NAME section diagnostics;
confusing messages reported by Jan Stary <hans at stare dot cz>
Diffstat (limited to 'mandoc.1')
-rw-r--r-- | mandoc.1 | 26 |
1 files changed, 18 insertions, 8 deletions
@@ -771,17 +771,27 @@ This may confuse .Xr makewhatis 8 and .Xr apropos 1 . -.It Sy "bad NAME section contents" +.It Sy "NAME section without name" .Pq mdoc -The last node in the NAME section is not an +The NAME section does not contain any +.Ic \&Nm +child macro. +.It Sy "NAME section without description" +.Pq mdoc +The NAME section lacks the mandatory .Ic \&Nd -macro, or any preceding macro is not -.Ic \&Nm , -or the NAME section is completely empty. -This may confuse -.Xr makewhatis 8 +child macro. +.It Sy "description not at the end of NAME" +.Pq mdoc +The NAME section does contain an +.Ic \&Nd +child macro, but other content follows it. +.It Sy "bad NAME section content" +.Pq mdoc +The NAME section contains plain text or macros other than +.Ic \&Nm and -.Xr apropos 1 . +.Ic \&Nd . .It Sy "missing description line, using \(dq\(dq" .Pq mdoc The |