[PATCH 5.5.63] Autogenerate API docs, define Perl API

["Benjamin Stuhl" <sho_pi@hotmail.com>]

This patch to embed.pl makes it only add functions marked as being
part of the API to the various export mechanisms (global.sym, perlapi.c, 
etc.), and also makes it autogenerate a new documentation file, perlapi.pod. 
For the moment, this is nothing more that the API listing from perlguts.pod, 
but it makes it easier to document new
functions. Simply add 'd' to the function's flags in embed.pl, add an
entry about it in pod/apidocs.in, rerun embed.pl, and presto! it's 
documented.

Someone (or several someones) with a Win32, OS/2, or AIX machine
(they're the only ones I know of with enforced export lists for the Perl 
library) should try this out by building and testing every XS
extension they have (especially Tk!) with a perl build with this patch. If 
the tests fail in DynaLoader or XSLoader, try

nm extobj.o | grep Perl_ | less

and look for functions that are not marked with flag 'A' in embed.pl (change 
it, rerun 'make regen_headers', rebuild perl, and try again).
Then please tell us what functions besides those I already marked are 
already being used as part of the API so we can make it official.

Enjoy!

-- BKS

P.S. apply with patch -Np1, and be sure to run 'make regen_headers',
since I didn't include the autogenerated files in my patch!
______________________________________________________
Get Your Private, Free Email at http://www.hotmail.com

apidocs.patch

---

Follow-Ups from:

Gurusamy Sarathy <gsar@activestate.com>

---

[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index][Thread Index][Top&Search][Original]

---