Besides resolving several remaining issues listed in modperl-2.0/todo/release and solving bugs as they are reported, the only real showstopper for 2.0 release is the API finalization. As we have discussed here multiple times we might not be able to release a complete Apache 2.0 API, but only a subset of it, with further APIs released post-mod_perl 2.0 release. Since we have lots of APIs which are untested and undocumented, we aren't going to include those in the official API (read: they will be unsupported and may change).

So, we need to start working on the API finalization. That means going through
functions, constants and methods at http://perl.apache.org/docs/2.0/api/, taking each item, checking that it's fully documented and tested. If not the missing documentation and/or missing tests need to be written.


If we distribute the effort and each one of us does one function a day
or so, in a few months we may be able to get the majority of the functions covered, and we will be ready for the 2.0 release.


Everybody is welcome and invited to help to bring the release date to a sooner date. If we get enough help we may need to run some sort of wiki to coordinate the effort, so two people don't get to work on the same function.

Of course start with low hanging fruits: i.e. those that are already well tested, documented and if not documented in 2.0, 1.0 docs might be of help.
http://perl.apache.org/docs/1.0/api/.


You are absolutely welcome to ask for help here. But, please, don't just go to some obscure function and ask here what does it do. To answer the question we will need to research the issue, write tests and essentially do the whole thing. So please work on functions that you do understand and have experience with (at least in the mp1 world).

If you ask for help please start a new thread for each function.

I need to update the doc template, but these and other already documented methods will give you a good idea on how to do it:
http://perl.apache.org/docs/2.0/api/Apache/RequestRec.html#C_proxyreq_
http://perl.apache.org/docs/2.0/api/Apache/RequestUtil.html#C_get_handlers_


The items that need to be taken care of are all marked with:

META: Autogenerated - needs to be reviewed/completed

once you are done, remove that comment. If you are mostly done but something is missing you can mark with another META: tag...

You will want to work with the cvs repository, which you can read on at:
http://perl.apache.org/download/docs.html
Remember not to edit to html, but to work with pod files, as the former is autogenerated.


Also remember that a documented but not a fully tested function is not a happy function. It's the best to get the tests and documentation at once for each function. For more information on how to write tests see:

http://perl.apache.org/docs/general/testing/testing.html
http://www.perl.com/pub/a/2003/05/22/testing.html

I hope that I didn't make it sound too scary or demanding and you will be willing to give a bit of your time and may be learn a thing or two on the way.

Thank you.

__________________________________________________________________
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