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

Re: typemap documentation

Thread Previous | Thread Next
Steffen Mueller
January 28, 2012 05:31
Re: typemap documentation
Message ID:
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

I just briefly looked into this and so far, this is what I think I learned:

- If I had a plain .pod file for inclusion, then what Nicholas outlined 
above would likely just work. Even if it's not in pod/

- The examples of "this .pod file is generated at build time" I could 
find are: does perlintern.pod and perlapi.pod by parsing out 
the POD directives manually from various files. perlfunc is also generated.

- 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.

Input particularly on the last two items would be very welcome.


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