develooper Front page | perl.perl5.porters | Postings from February 2012

Re: typemap documentation

Thread Previous | Thread Next
Nicholas Clark
February 2, 2012 02:16
Re: typemap documentation
Message ID:
On Sat, Jan 28, 2012 at 02:31:14PM +0100, Steffen Mueller wrote:
> Hi all,
> On 01/16/2012 06:21 PM, Nicholas Clark wrote:
> > On Mon, Jan 16, 2012 at 05:52:28PM +0100, Steffen Mueller wrote:
> >> 3) Implement whatever to make sure we get perlxstypemaps.pod and man.
> >
> > I believe now that all is needed for plain files that contain Pod, is to
> > add the correct data into pod/perl.pod and then run perl Porting/
> > to regenerate things.
> >
> > For files in pod/ "correct data" is just the line in the table of
> > contents. For pods outside of pod/ (so far, only dual life Pods), you also
> > need to add a "path" line in the bit between =begin buildtoc and
> > =end buildtoc

> - None of those mechanisms seem really awesome for what I need. What I'd 
> want is the equivalent of the following somewhere:
>    extract_all_pod ext/XS-Typemap/Typemap.xs > pod/perltypemap.pod
> Presumably, one of the many, many POD related tools in the core does 
> this. Seems like Pod::Parser's podselect script can. But Pod::Parser is 
> on the way out. Yay.
> - I need to find a good time of the build process to include the 
> equivalent of the above command.

Timing wise, I think you can safely put the command to run inside
ext/XS-Typemap/Makefile with 'all' depending on it. I think that the only
thing later on that needs the generated Pod file is pod/buildtoc, and that
already has a dependency on all the extensions being built.

In turn, I think the flags that buildtoc reads in perl.pod would already
permit an out-of-pod/ Pod file that is generated without needing code

As to how to extract the Pod - I don't know. That might be a question for

Nicholas Clark

Thread Previous | Thread Next Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About