develooper Front page | perl.perl5.porters | Postings from April 2003

[PATCH 5.8.0 UTIL] h2xs generates false comments about ABSTRACT

Thread Next
From:
Steve Hay
Date:
April 30, 2003 01:51
Subject:
[PATCH 5.8.0 UTIL] h2xs generates false comments about ABSTRACT
Message ID:
3EAF8ECE.8060403@uk.radan.com
The attached patch stops h2xs from generating an ABSTRACT section in the 
stub POD.

The section generated currently reads:

    This should be the abstract for $module.
    The abstract is used when making PPD (Perl Package Description) files.
    If you don't want an ABSTRACT you should also edit Makefile.PL to
    remove the ABSTRACT_FROM option.

This isn't true.  When making PPD files, the abstract is extracted from 
the file specified by ABSTRACT_FROM by matching the pattern 
/^($package\s-\s)(.*)/, usually in the first line of the NAME section, 
as is (correctly) explained in the ExtUtils::MakeMaker manpage.

An alternative solution would be to change the description of the 
ABSTRACT section that h2xs generates, but just having a section called 
ABSTRACT is confusing when MakeMaker has a different notion of what the 
ABSTRACT is.  In fact, ExtUtils::MakeMaker documents another option - 
ABSTRACT - which can be used to specify the abstract directly, rather 
than retrieve it from a file, and re-iterates its notion that the 
abstract is a one-line description of the module.

I therefore believe it is better not to have an ABSTRACT section in the POD.

Cheers,

Steve


Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About