Bug 908113 - CPAN::Debug(3pm) is missing NAME section
Summary: CPAN::Debug(3pm) is missing NAME section
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: perl
Version: 18
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Petr Pisar
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-02-05 22:18 UTC by Paul DeStefano
Modified: 2013-04-03 04:55 UTC (History)
14 users (show)

Fixed In Version: perl-5.16.2-259.fc19
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-04-03 04:55:25 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)
Fedora 18's CPAN::Debug.3pm.gz (1.74 KB, application/force-download)
2013-02-18 14:19 UTC, Ralf Corsepius
no flags Details


Links
System ID Private Priority Status Summary Last Updated
CPAN 73396 0 None None None Never

Description Paul DeStefano 2013-02-05 22:18:03 UTC
Description of problem:
mandb --test gives the following error, among others:

mandb: warning: /usr/share/man/man3/CPAN::Debug.3pm.gz: whatis parse for CPAN::Debug(3pm) failed

Version-Release number of selected component (if applicable):
Name        : perl-CPAN
Epoch       : 0
Version     : 1.9800
Release     : 237.fc18


How reproducible:


Steps to Reproduce:
1. mandb --test
2.
3.
  
Actual results:
mandb: warning: /usr/share/man/man3/CPAN::Debug.3pm.gz: whatis parse for CPAN::Debug(3pm) failed

Expected results:
No errors.

Additional info:

Comment 1 Iain Arnell 2013-02-17 18:49:45 UTC
Filed against wrong component - should be perl.

Comment 2 Petr Pisar 2013-02-18 11:04:39 UTC
Cannot reproduce with man-db-2.6.3-2.fc18.x86_64. "whatis -w '*' >/dev/null" does not complain.

Moreover I don't understand what's wrong on CPAN::Debug(3pm). It just does not contain NAME heading, which is maybe unfortunate, but I can do anything with it. 

You can try to make man-db more robust.

Comment 3 Colin Watson 2013-02-18 11:25:23 UTC
I don't see why whatis should complain.  It only looks at what's in the database, and since this parse failed it won't be in the database.  Thus, not a valid test.  lexgrog is the proper tool to use to test this.

Please attach /usr/share/man/man3/CPAN::Debug.3pm.gz to this bug.  If it doesn't contain a NAME section as Petr says, though, then this is *not* a man-db bug - the manual page must be fixed instead to be in the proper form.  The requirements are not particularly onerous.

Comment 4 Ralf Corsepius 2013-02-18 13:40:59 UTC
(In reply to comment #2)
> Cannot reproduce with man-db-2.6.3-2.fc18.x86_64.
I can.

# mandb --test
...
mandb: warning: /usr/share/man/man3/CPAN::Debug.3pm.gz: whatis parse for CPAN::Debug(3pm) failed
...

> Moreover I don't understand what's wrong on CPAN::Debug(3pm). It just does
> not contain NAME heading, which is maybe unfortunate, but I can do anything
> with it. 
Here, "man CPAN::Debug"
only displays a LICENSE.
I am having doubts this is the "intended behavior"

<snip>
CPAN::Debug(3pm)                                                 Perl Programmers Reference Guide                                                 CPAN::Debug(3pm)

LICENSE
       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.16.2                                                                2012-10-26                                                            CPAN::Debug(3pm)
</snip>


(In reply to comment #3)
> Please attach /usr/share/man/man3/CPAN::Debug.3pm.gz to this bug.
You can extract it from Fedora's perl-CPAN-1.9800-238.fc18.noarch rpm.

Comment 5 Colin Watson 2013-02-18 14:06:02 UTC
I asked for an attachment since I don't use Fedora (I'm an upstream author helping out here) and it's a pain to dig out Fedora packages and extract things from them.

But anyway, now that I've done that, this is clearly a bug in the perl-CPAN package; mandb is entirely justified in issuing a warning about this broken page.  Somebody with appropriate privileges please reassign.

Comment 6 Ralf Corsepius 2013-02-18 14:19:46 UTC
Created attachment 698907 [details]
Fedora 18's CPAN::Debug.3pm.gz

Comment 7 Ralf Corsepius 2013-02-18 14:22:32 UTC
(In reply to comment #5)
> I asked for an attachment since I don't use Fedora
I didn't know - Sorry.

> But anyway, now that I've done that, this is clearly a bug in the perl-CPAN
> package;
Are you sure? CPAN::Debug.3pm is pod2man generated, so at least I would not want to exclude it's a more general bug in pod2man rsp. its infrastructure.

Comment 8 Petr Pisar 2013-02-18 14:34:00 UTC
pod2man just converts POD to ROFF. There is no NAME heading in the POD, thus no NAME in ROFF, thus no text for man-db.

I don't think there is a Manual Page Specification which demands specific headings. I'll ask perl-CPAN upstream to add enhance the POD.

Comment 9 Petr Pisar 2013-02-18 14:40:38 UTC
This issue has been already reported to upstream <https://rt.cpan.org/Public/Bug/Display.html?id=73396> and fix is upstream VCS.

Comment 10 Colin Watson 2013-02-18 14:46:26 UTC
lexgrog(1) documents the requirements, which AFAIK are generally applicable across man implementations.

Comment 11 Fedora Update System 2013-02-18 17:17:35 UTC
perl-5.16.2-239.fc18 has been submitted as an update for Fedora 18.
https://admin.fedoraproject.org/updates/perl-5.16.2-239.fc18

Comment 12 Fedora Update System 2013-02-19 08:26:56 UTC
perl-5.14.3-222.fc17 has been submitted as an update for Fedora 17.
https://admin.fedoraproject.org/updates/perl-5.14.3-222.fc17

Comment 13 Vasilis Keramidas 2013-03-01 23:22:30 UTC
 perl-5.16.2-239.fc18 fixes this bug
I left positive feedback at https://admin.fedoraproject.org/updates/F18/FEDORA-2013-2685

Comment 14 Fedora Update System 2013-03-02 20:11:46 UTC
perl-5.16.2-239.fc18 has been pushed to the Fedora 18 stable repository.  If problems still persist, please make note of it in this bug report.

Comment 15 Fedora Update System 2013-03-05 13:31:19 UTC
perl-5.14.3-223.fc17 has been submitted as an update for Fedora 17.
https://admin.fedoraproject.org/updates/perl-5.14.3-223.fc17

Comment 16 Fedora Update System 2013-03-11 12:36:59 UTC
perl-5.14.4-224.fc17 has been submitted as an update for Fedora 17.
https://admin.fedoraproject.org/updates/perl-5.14.4-224.fc17

Comment 17 Fedora Update System 2013-03-12 08:28:50 UTC
Package perl-5.14.4-224.fc17:
* should fix your issue,
* was pushed to the Fedora 17 testing repository,
* should be available at your local mirror within two days.
Update it with:
# su -c 'yum update --enablerepo=updates-testing perl-5.14.4-224.fc17'
as soon as you are able to.
Please go to the following url:
https://admin.fedoraproject.org/updates/FEDORA-2013-3673/perl-5.14.4-224.fc17
then log in and leave karma (feedback).

Comment 18 Fedora Update System 2013-04-03 04:55:27 UTC
perl-5.14.4-224.fc17 has been pushed to the Fedora 17 stable repository.  If problems still persist, please make note of it in this bug report.


Note You need to log in before you can comment on or make changes to this bug.