The following commit has been merged in the master branch:
commit 3b5f6e9075eeab206f73e3e197a54c530af66b08
Author: Jari Aalto <[email protected]>
Date: Thu Mar 11 09:52:13 2010 +0200
Explain more about TH NAME problems
Signed-off-by: Jari Aalto <[email protected]>
diff --git a/checks/manpages.desc b/checks/manpages.desc
index 2a3de77..28bacfb 100644
--- a/checks/manpages.desc
+++ b/checks/manpages.desc
@@ -103,9 +103,11 @@ Tag: manpage-has-bad-whatis-entry
Severity: normal
Certainty: certain
Info: Each manual page should start with a "NAME" section, which lists the
- name and a brief description of the page separated by "\-". These sections
- are parsed by "mandb" and stored in a database for the use of "apropos" and
- "whatis", so they must be in a certain format. This manual page apparently
+ name and a brief description of the page separated by "\-". A common mistake
+ is that in sections TH or NAME the entry is expressed with a space in form
+ "PROGRAM NAME", not "PROGRAM_NAME" or "PROGRAM-NAME". The TH and NAME sections
+ are parsed by mandb(8) and stored in a database for the use of apropos(1) and
+ whatis(1), so they must be in a certain format. This manual page apparently
uses the wrong format and cannot be parsed by "mandb".
Ref: lexgrog(1), groff_man(7), groff_mdoc(7)
--
Debian package checker
--
To UNSUBSCRIBE, email to [email protected]
with a subject of "unsubscribe". Trouble? Contact [email protected]
Archive: http://lists.debian.org/[email protected]
