Click here to get back home

Have I an error in my POD?
 Home | NewsGroups | Search | About
Login Password
Register Now!
 comp.lang.perl.modules    Post an article   get this group's latest topics as an RSS feed add this group's latest topics to your My MSN content add this group's latest topics to your My Yahoo content
Subject Author Date
Have I an error in my POD? Ian Stuart 12-21-2005
Get Chitika Premium
Posted by Ian Stuart on December 21, 2005, 6:35 pm
Please log in for more thread options

I have a package in CPAN (MathML::Entities::Approximate) and when it is
installed manually, it's fine.

However when it's installed via the CPAN module (perl -MCPAN -e
shell...) there is an error about the ABSTRACT (I can't paste the exact
message in, as I've installed the package on both my systems now <sad/>)

I *thought* that the abstract was deduced from the NAME line: the
element after the hyphen.... however this appears not to be the case.

I have compared my POD to other packages, and it seams to be complete.

SO:
1) What is the abstract?
2) How do I define it on my package?

Many thanks...
--
Ian


Posted by Ron Savage on December 22, 2005, 9:53 am
Please log in for more thread options

On Thu, 22 Dec 2005 05:35:24 +1100, Ian Stuart wrote:

Hi Ian

> However when it's installed via the CPAN module (perl -MCPAN -e
> shell...) there is an error about the ABSTRACT (I can't paste the
> exact message in, as I've installed the package on both my systems
> now <sad/>)

You could uninstall it, and reinstall it, though.

> I *thought* that the abstract was deduced from the NAME line: the
> element after the hyphen.... however this appears not to be the
> case.

Right. So can you post the NAME part of your POD.

> I have compared my POD to other packages, and it seams to be
> complete.

Perhaps it needs to be /(.+)\s-\s(.+)/?

Note the 2 spaces.




Posted by Ian Stuart on December 22, 2005, 9:33 am
Please log in for more thread options


Ron Savage wrote:
> You could uninstall it, and reinstall it, though.
Ah - I had a quick look at the help stuff, and didn't spot that.. I'll
have a play (however I don't want to upload a new version to cpan is
this is the only fix - not really a bug-fix <grin />)

>>I *thought* that the abstract was deduced from the NAME line: the
>>element after the hyphen.... however this appears not to be the
>>case.
> Right. So can you post the NAME part of your POD.
OK - straight from the .pm file:
--- start extract ---
=pod

=head1 NAME

MathML::Entities::Approximate - Returns approximated ASCII characters
for XHTML+MathML Named Entities

=head1 SYNOPSIS
---- end extract ----
> Perhaps it needs to be /(.+)\s-\s(.+)/?
>
> Note the 2 spaces.
Nope - they are there...
Hmmm... From Rob's (sisyphus) comment, looking at ExtUtils::MakeMaker:
"matching /^($package\s-\s)(.*)/ " - could the problem be the *leading*
space in the text of the NAME section?

---
Ian, Perl Laghu


Posted by Sisyphus on December 22, 2005, 5:11 pm
Please log in for more thread options



.
..
>
> SO:
> 1) What is the abstract?

From 'perldoc ExtUtils::MakeMaker':

ABSTRACT
One line description of the module. Will be included in PPD file.

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.

> 2) How do I define it on my package?
>

I think the need to define it should go away if you remove the
'ABSTRACT_FROM' line in your Makefile.PL. Not sure if that's the recommended
approach, but it's the one I would take. (I don't think that either ABSTRACT
or ABSTRACT_FROM are mandatory for a CPAN.pm install ... though, as I don't
use CPAN.pm, there's a chance that I'm mistaken about that. Looks to me that
they have relevance only with ppm (binary) package builds - since the "PPD"
file is part of a ppm package.)

Or ... if you replace 'ABSTRACT_FROM' in the Makefile.PL with 'ABSTRACT'
you can define the abstract then and there:

(ABSTRACT => 'Whatever you want it to be',

You should then be able to leave everything else as it is.

Cheers,
Rob




Similar ThreadsPosted
Error: RCPT TO: error (550 relay not permitted) February 11, 2006, 1:39 pm
GD.c: 533: error: syntax error before "void" March 24, 2006, 10:15 am
Error while using LWP December 1, 2005, 8:06 am
Deparse error July 7, 2004, 2:52 am
Out of Memory error September 12, 2004, 11:51 pm
expat error May 26, 2005, 9:01 pm
Error Installing XML::DOM October 15, 2004, 9:16 am
error with CPAN.pm October 19, 2004, 7:13 am
Error reporting in CGI May 19, 2005, 9:41 pm
DBI version error October 26, 2004, 11:49 am

Our other projects:

Art Dolls, Fairies and Mermaids - Sunnyfaces.net

Roy's Linux, Programming and Search Engines messages

1-Script XML SitemapXML Sitemap