Bug #8486 for ExtUtils-MakeMaker: EU:MM handling of ABSTRACT_FROM doesn't handle pod formatting codes

Tue Nov 16 19:26:11 2004 Guest - Ticket created

Subject:

EU:MM handling of ABSTRACT_FROM doesn't handle pod formatting codes

When building File::Remove (version 0.25) from CPAN, I get the error $ perl Makefile.PL Checking if your kit is complete... Looks good WARNING: Setting ABSTRACT via file 'lib/File/Remove.pm' failed at /usr/local/lib/perl5/5.9.2/ExtUtils/MakeMaker.pm line 611 when creating the ppd section. The pod documenation for EU::MM reports ABSTRACT_FROM Name of the file that contains the package description. MakeMaker looks for a line in the POD matching /^($package\s-\s)(.*)/. This is typically the first line in the "=head1 NAME" section. $2 becomes the abstract. If the following is valid, then we should parse it correctly B<File::Remove> - Remove files and directories If not, it would be helpful if the error message directed the reader to the pod documention prescribing the limited fixed format for the abstract. (By the way, I didn't find any other abstract that had B<> or any other formatting codes in the NAME section)

Tue Nov 16 23:22:00 2004 schwern [...] pobox.com - Correspondence added

Date:	Tue, 16 Nov 2004 20:04:55 -0500
From:	Michael G Schwern <schwern [...] pobox.com>
To:	Guest via RT <bug-ExtUtils-MakeMaker [...] rt.cpan.org>
Subject:	Re: [cpan #8486] EU:MM handling of ABSTRACT_FROM doesn't handle pod formatting codes
RT-Send-Cc:

On Tue, Nov 16, 2004 at 07:26:12PM -0500, Guest via RT wrote: Show quoted text

> When building File::Remove (version 0.25) from CPAN, I get the error > > $ perl Makefile.PL > Checking if your kit is complete... > Looks good > WARNING: Setting ABSTRACT via file 'lib/File/Remove.pm' failed > at /usr/local/lib/perl5/5.9.2/ExtUtils/MakeMaker.pm line 611 > > when creating the ppd section. > > The pod documenation for EU::MM reports > ABSTRACT_FROM > Name of the file that contains the package description. > MakeMaker looks for a line in the POD matching > /^($package\s-\s)(.*)/. This is typically the first line > in the "=head1 NAME" section. $2 becomes the abstract. > > If the following is valid, then we should parse it correctly > B<File::Remove> - Remove files and directories

Its not valid. $package is "File::Remove". So you're attempting: "B<File::Remove> - Remove files and directories" =~ /^(File::Remove\s-\s)(.*)/; Which does not match. One could argue that MM should strip POD formatting before attempting to match but that's a can of worms I don't know if I want to open. Show quoted text

> If not, it would be helpful if the error message directed the reader > to the pod documention prescribing the limited fixed format for > the abstract.

Did you have trouble finding the docs on it? Show quoted text

> (By the way, I didn't find any other abstract that had B<> or any > other formatting codes in the NAME section)

For this reason. I'd recommend against it as other utilities are going to do something similar to MakeMaker to try and infer information from the POD. -- Michael G Schwern schwern@pobox.com http://www.pobox.com/~schwern/ Operation Bitter Jungle Cat

Tue Nov 23 00:06:22 2004 mschwern [...] cpan.org - Status changed from 'new' to 'resolved'