[SCM] Debian package checker branch, master, updated. 2.3.3-76-ga3e4f5c
The following commit has been merged in the master branch:
commit a3e4f5cafab7040e15f3ae4dcb6ff05f13d4dbc9
Author: Russ Allbery <rra@debian.org>
Date: Sun Mar 21 21:03:25 2010 -0700
Clarify the long description for manpage-has-bad-whatis-entry
* checks/manpages.desc:
+ [RA] Clarify the long description for manpage-has-bad-whatis-entry.
Thanks, Jari Aalto. (Closes: #573837)
diff --git a/checks/manpages.desc b/checks/manpages.desc
index 28bacfb..bc49b70 100644
--- a/checks/manpages.desc
+++ b/checks/manpages.desc
@@ -103,12 +103,16 @@ 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 "\-". 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".
+ name and a brief description of the page separated by "\-". The "NAME"
+ section is parsed by lexgrog and used to generate a database that's
+ queried by commands like apropos and whatis. This tag indicates that
+ lexgrog was unable to parse the NAME section of this manual page.
+ .
+ For manual pages that document multiple programs, functions, files, or
+ other things, the part before "\-" should list each separated by a comma
+ and a space. Each thing listed must not contain spaces; a man page for a
+ two-part command like "fs listacl" must use something like "fs_listacl"
+ in the "NAME" section so that it can be parsed by lexgrog.
Ref: lexgrog(1), groff_man(7), groff_mdoc(7)
Tag: manpage-has-useless-whatis-entry
diff --git a/debian/changelog b/debian/changelog
index 3ad5d49..24a602a 100755
--- a/debian/changelog
+++ b/debian/changelog
@@ -72,6 +72,9 @@ lintian (2.3.4) UNRELEASED; urgency=low
umountnfs or umountfs to satisfy a $local_fs requirement in LSB
headers, avoiding false positives in unusual situations such as
rsyslog. Thanks, Michael Biebl. (Closes: #571280)
+ * checks/manpages.desc:
+ + [RA] Clarify the long description for manpage-has-bad-whatis-entry.
+ Thanks, Jari Aalto. (Closes: #573837)
* checks/rules:
+ [RA] Allow ant1.7 to satisfy a build requirement for ant. Thanks,
Rene Engelhard. (Closes: #572430)
--
Debian package checker
Reply to: