Skip Menu |

Preferred bug tracker

Please visit the preferred bug tracker to report your issue.

This queue is for tickets about the Capture-Tiny CPAN distribution.

Report information
The Basics
Id: 46648
Status: resolved
Priority: 0/
Queue: Capture-Tiny
People
Owner: Nobody in particular
Requestors: ynnor [...] mm.st
Cc:
AdminCc:
Bug Information
Severity: Important
Broken in: (no value)
Fixed in: (no value)

History Show all quoted text
  Wed Jun 03 10:11:55 2009 ynnor [...] mm.st - Ticket created
Subject: Error in POD format?
After installing the module on Windows, I see on the command prompt: =============================================== Show quoted text
> perl -we "use Capture::Tiny;"
Show quoted text
> perldoc -l Capture::Tiny
No documentation found for "Capture::Tiny". =============================================== We can see from this, that the module can be found, but the perldocs can't be displayed. I'm not a specialist in Perldoc syntax, but mustn't be the first POD markup be =head1? In this module, the first POD directive is =begin Ronald
  Wed Jun 03 12:20:25 2009 dagolden [...] cpan.org - Correspondence added
Which version of perldoc do you have? (Output of "perldoc -V") Capture::Tiny "compiles" its POD from the .pm file into a separate .pod file and it seems like your perldoc isn't locating that file. For me, on Windows with Strawberry Perl, I get this: C:\david>perldoc -V Perldoc v3.14_02, under perl v5.010000 for MSWin32 C:\david>perldoc -l Capture::Tiny C:\strawberry\perl\site\lib\Capture\Tiny.pod Regards, David
  Wed Jun 03 12:20:25 2009 The RT System itself - Status changed from 'new' to 'open'
  Fri Jun 05 03:32:47 2009 ynnor [...] mm.st - Correspondence added
Subject: Re: [rt.cpan.org #46648] Error in POD format?
Date: Fri, 05 Jun 2009 09:32:28 +0200
To: "David Golden via RT" <bug-Capture-Tiny [...] rt.cpan.org>
From: "Ronald Fischer" <ynnor [...] mm.st>
On Wed, 03 Jun 2009 12:20 -0400, "David Golden via RT" <bug-Capture-Tiny@rt.cpan.org> wrote: Show quoted text
> <URL: https://rt.cpan.org/Ticket/Display.html?id=46648 > > > Which version of perldoc do you have? (Output of "perldoc -V")
Perldoc v3.14_02, under perl v5.010000 for MSWin32 (win32 build 1002) Show quoted text
> Capture::Tiny "compiles" its POD from the .pm file into a separate .pod > file and it seems like your perldoc isn't locating that file.
How is this compilation be done? I have (since Tiny.pm is just a single file) created the Capture directory in my lib tree and copied Tiny.pm at that place. I wasn't even aware that POD files can reside in a separate location! Ronald -- Ronald Fischer <ronaldf@eml.cc> + If a packet hits a pocket on a socket on a port, + and the bus is interrupted and the interrupt's not caught, + then the socket packet pocket has an error to report. + (cited after Peter van der Linden)
  Fri Jun 05 08:05:49 2009 dagolden [...] cpan.org - Correspondence added
Subject: Re: [rt.cpan.org #46648] Error in POD format?
Date: Fri, 5 Jun 2009 08:05:32 -0400
To: bug-Capture-Tiny [...] rt.cpan.org
From: David Golden <dagolden [...] cpan.org>
On Fri, Jun 5, 2009 at 3:32 AM, Ronald Fischer via RT<bug-Capture-Tiny@rt.cpan.org> wrote: Show quoted text
> How is this compilation be done? I have (since Tiny.pm is just a single file) > created the Capture directory in my lib tree and copied Tiny.pm at that > place. I wasn't even aware that POD files can reside in a separate location!
Ah! If you manually copied the Tiny.pm file, then you need to copy Tiny.pod as well if you want the documentation. If you had used the Build.PL or Makefile.PL file to install, the Tiny.pod file would have been installed automatically. The "compilation" actually happens on my computer before the files are packed up for CPAN. I write my documentation using Pod::WikiDoc in the .pm file, then my release scripts "compile" it to a .pod file that gets included in the distribution. I gave a lightning talk about it at YAPC::NA 2006: http://www.dagolden.com/wp-content/uploads/2009/05/pod-wikidoc.pdf -- David
  Thu Jan 28 23:39:35 2010 dagolden [...] cpan.org - Status changed from 'open' to 'resolved'