So here is a sample manpage which demonstrates how all API docs will look like:
http://perl.apache.org/docs/2.0/api/APR/Socket.html

It has two parts:
http://perl.apache.org/docs/2.0/api/APR/Socket.html#API
which is what parts of the API are scheduled to be supported for 2.0 release

and:
http://perl.apache.org/docs/2.0/api/APR/Socket.html#Unsupported_API
which explains:

"APR::Socket also provides auto-generated perl interface for a few other methods which aren't tested at the moment and therefore their API is a subject to change. These methods will be added later as a need arises. If you need any of these methods please contact the mod_perl development mailing list, present your case, showing us some sample code and we will take care of adding the new method."

So, that's the plan - completely document/test/polish the APIs that are most likely to be used for 2.0 release. Other, least likely to be used, methods can be added post 2.0 as a need arises. This will allows us to deliver 2.0 much sooner, than if we have tried to cover them all.

The new file modperl-2.0/todo/api_status is the map where we are with the API completion. For manpages that are completed for 2.0 it lists those methods that will be supported later, so it's easy to spot them.

Your comments are very welcome.

--
__________________________________________________________________
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/     mod_perl Guide ---> http://perl.apache.org
mailto:[EMAIL PROTECTED] http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org   http://ticketmaster.com

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Reply via email to