Skip Menu |

This queue is for tickets about the podlators CPAN distribution.

Report information
The Basics
Id: 43700
Status: rejected
Priority: 0/
Queue: podlators

People
Owner: Nobody in particular
Requestors: dexter [...] debian.org
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: (no value)
Fixed in: (no value)



Subject: pod2man ignores L<>
pod2man ignores L<Some::Module> tag and doesn't convert it to anything useful. Many of manpages parsers (kio_man, pinfo) handle links if some keyword is suffixed with number in parentheses. I suggest to convert L<Some::Module> into Some::Module(3): Source: =head1 SEE ALSO L<Pod::Man> Manpage: SEE ALSO Pod::Man(3) Proof: KDE with man: pseudoprotocol (kio_man) and pinfo (An alternative info-file viewer) handle it as a link to another manpage.
Subject: Re: [rt.cpan.org #43700] pod2man ignores L<>
Date: Fri, 27 Feb 2009 11:50:00 -0800
To: bug-podlators [...] rt.cpan.org
From: Russ Allbery <rra [...] stanford.edu>
"Piotr Roszatycki via RT" <bug-podlators@rt.cpan.org> writes: Show quoted text
> pod2man ignores L<Some::Module> tag and doesn't convert it to anything > useful. > > Many of manpages parsers (kio_man, pinfo) handle links if some keyword > is suffixed with number in parentheses. > > I suggest to convert L<Some::Module> into Some::Module(3):
Hm, yes, that seems fair. It might be a bit tricky to do that given how Pod::Simple works, but I'll take a look. -- Russ Allbery (rra@stanford.edu) <http://www.eyrie.org/~eagle/>
On Fri Feb 27 14:50:31 2009, rra@stanford.edu wrote: Show quoted text
> "Piotr Roszatycki via RT" <bug-podlators@rt.cpan.org> writes: >
> > pod2man ignores L<Some::Module> tag and doesn't convert it to anything > > useful. > > > > Many of manpages parsers (kio_man, pinfo) handle links if some keyword > > is suffixed with number in parentheses. > > > > I suggest to convert L<Some::Module> into Some::Module(3):
> > Hm, yes, that seems fair. It might be a bit tricky to do that given how > Pod::Simple works, but I'll take a look.
I asked perl5-porters and pod-people about this, but various other problems came up with the idea. The general difficulty is that there's no way to know what section to add to the link. Some Perl man pages are in section 3, some are in section 1, and this syntax may be used for both. The general consensus was that this isn't worth trying to do; it's too easy to get it wrong and not manage the correct link.