Re: problems in one or more man pages you maintain

Eric S. Raymond wrote:
> > This one was fixed in a recent version of Perl.  For the others, see
> > the patch below.  They make your system happy, but I don't know if
> > they're a correct implementation.
> 
> I'll mark the perlce fix pending, then.

Looks like perlnetware.pod would need the same fix than perlce.pod.
Casey, I'm not sure which fix you're referring to.

> > diff -ru perl-current-orig/ext/DynaLoader/DynaLoader_pm.PL perl-current/ext/DynaLoader/DynaLoader_pm.PL
> > --- perl-current-orig/ext/DynaLoader/DynaLoader_pm.PL   Sun Nov  2 14:41:32 2003
> > +++ perl-current/ext/DynaLoader/DynaLoader_pm.PL        Tue Dec  9 16:32:10 2003
> > @@ -508,8 +508,7 @@
> >  
> >  =head1 NAME
> >  
> > -DynaLoader - Dynamically load C libraries into Perl code
> > -
> > +DynaLoader - Dynamically load C libraries into Perl code;
> >  dl_error(), dl_findfile(), dl_expandspec(), dl_load_file(), dl_unload_file(), dl_find_symbol(), dl_find_symbol_anywhere(), dl_undef_symbols(), dl_install_xsub(), dl_load_flags(), bootstrap() - routines used by DynaLoader modules
> >  
> >  =head1 SYNOPSIS
> 
> You sure you din't get this patch reversed?  The removed line is good
> (though technically that - should be \-; doclifter can cope with -
> but some man -k implementations might not).  The replacement isn't good.

I'd prefer to drop completely the function list from the NAME section.
For indexing freaks, there's always perltoc.pod.

> > --- perl-current-orig/lib/Getopt/Std.pm Tue Sep 16 16:06:11 2003
> > +++ perl-current/lib/Getopt/Std.pm      Tue Dec  9 16:32:52 2003
> > @@ -4,9 +4,7 @@
> >  
> >  =head1 NAME
> >  
> > -getopt - Process single-character switches with switch clustering
> > -
> > -getopts - Process single-character switches with switch clustering
> > +getopt, getopts - Process single-character switches with switch clustering

Looks like splain(1) and diagnostics(3pm) have a similar problem.
Strange, your report lists splain.1 but not diagnostics.3pm ?

A good thing would be to improve podchecker to warn about substandard
NAME sections.

> Good, though the - ought to be \-

I think pod2man takes care of this escape.