whatis information in manpages

[please CC me on replies, I'm not subscribed]

Hi,

during packaging the new 2.02 version of Class::Methodmaker for Debian,
one of our checking tools said:

W: libclass-methodmaker-perl: manpage-has-bad-whatis-entry usr/share/man/man3/Class::MethodMaker::hash.3pm.gz
N:
N:   Each manual page should start with a `NAME' section, which lists the
N:   name and a brief description of the page seperated by '\-'. These
N:   sections are parsed by `mandb' and stored in a database for the use of
N:   `apropos' and `whatis', so they must be in a certain format. This
N:   manual page apparently uses the wrong format and cannot be parsed by
N:   `mandb'.
N:   
N:   For information on how `NAME' sections should be written see
N:   lexgrog(1). See also groff_man(7) and groff_mdoc(7) for general
N:   information on writing manual pages.
N:
W: libclass-methodmaker-perl: manpage-has-bad-whatis-entry usr/share/man/man3/Class::MethodMaker::array.3pm.gz
W: libclass-methodmaker-perl: manpage-has-bad-whatis-entry usr/share/man/man3/Class::MethodMaker::scalar.3pm.gz


This is one possible fix for the issue:

--- libclass-methodmaker-perl-2.02.orig/components/array.m
+++ libclass-methodmaker-perl-2.02/components/array.m
@@ -8,6 +8,10 @@
 
 # -------------------------------------
 
+=head1 NAME
+
+Class::MethodMaker::array - Create methods for handling a array value.
+
 =head1 array
 
 Create methods for handling an array value.
--- libclass-methodmaker-perl-2.02.orig/components/hash.m
+++ libclass-methodmaker-perl-2.02/components/hash.m
@@ -8,6 +8,10 @@
 
 # -------------------------------------
 
+=head1 NAME
+
+Class::MethodMaker::hash - Create methods for handling a hash value.
+
 =head2 hash
 
 Create methods for handling a hash value.
--- libclass-methodmaker-perl-2.02.orig/components/scalar.m
+++ libclass-methodmaker-perl-2.02/components/scalar.m
@@ -8,6 +8,10 @@
 
 # -------------------------------------
 
+=head1 NAME
+
+Class::MethodMaker::scalar - Create methods for handling a scalar value.
+
 =head2 scalar
 
 Create methods for handling a scalar value.



-- 
Peter


-------------------------------------------------------
This SF.net email is sponsored by: IT Product Guide on ITManagersJournal
Use IT products in your business? Tell us what you think of them. Give us
Your Opinions, Get Free ThinkGeek Gift Certificates! Click to find out more
http://productguide.itmanagersjournal.com/guidepromo.tmpl