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

Re: typemap documentation

Thread Previous | Thread Next
Steffen Mueller
January 16, 2012 08:52
Re: typemap documentation
Message ID:
On 01/16/2012 01:08 PM, David Mertens wrote:
> On Mon, Jan 16, 2012 at 3:46 AM, Tony Cook <
> <>> wrote:
>     I would love improved typemap documentation.
>     Not just the predefined types, but documentation of $var, $arg, $ntype
>     and any other variables set in XS rules.
> I second this, and I would also be happy to help in whatever way I can.
> All I know about typemaps is from Extending and Embedding Perl, which
> did not leave me with a sense of mastery of the topic.

I can't say I feel a sense of mastery of the topic myself and I've 
touched most bits of code in the XS/typemap system one way or another...

That being said, my plan is roughly:

1) Go through the typemaps covered by ext/XS-Typemaps together with the 
actual list of typemaps in the core typemap file and assert that:
- The docs for the existing typemaps are correct.
- There are tests for all of them.
- All typemaps are documented and tested (at least this is not true).

2) Write the more general docs as Tony suggests. Probably in the same 
place as the docs on each individual typemap. Above it, to be more precise.

While I slog through the list of typemaps to complete it, I'll be 
contemplating about how to best have the documentation that lives in the 
XS file in ext/XS-Typemaps now appear as a perlxstypemaps manpage/pod 
document/whatever without completely separating the test code from the 

3) Implement whatever to make sure we get perlxstypemaps.pod and man.

I could use help with all three of these and particularly part 1) is 
easily parallelizable!

Best regards,

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