Hi Logan On 4/25/07, Buesching, Logan J <[EMAIL PROTECTED]> wrote:
Thanks for the compliments! I was going to wait on getting the documents made and have a quick glance over them before I sent the patch out, but after about 1.5 hours of it chunking away on my laptop, and only having about 2200 HTML documents to show, I decided that it was going to take a _long_ time before it finished. (Don't try to make it using cygwin, on vista, with a 3 year old laptop). So I just decided to send the patch first. You guys weren't kidding when you said it takes awhile to make the documentation! I believe I was able to download Ubuntu, load it on one of my desktops, download the tools and documentation, and make the documents in about the same time that it took for me to just make the documentation on Vista.
The short version: don't use windows/cygwin. The long version: Unfortunately cygwin bundles libxslt 1.1.17 (or even .16, don't remember) which is kickassdeadslow. Trying to compile libxslt 1.1.18 (or newer) will force you to upgrade libxml2 too - and compiling something on cygwin is not a task for a sane man, takes your literally days to get it done, not to mention all the compatibility issues you will face. However, upgrading to libxslt 1.1.18 will cut the build time down to ~70minutes on a "sane hardware" (takes my almost-two-years-old-laptop 74minutes..) Here I am of course talking about the _xsl targets, the dsssl ones can take up to 24hours to complete. The silver line: xsltproc --stringparam rootid "ref.posix" phpbook/phpbook-xsl/html.xsl manual.xml This command shouldn't take more than 5minutes :)
Anyways, back on topic... did you want me to send in a patch for the whole POSIX system when I finish, or just whatever is left that I didn't document?
Send a complete patch of everything when you are done (cvs diff -u en/reference/posix > posix.patch)
Thanks again and I hope to have more patches coming in.
Looking forward to it! :) (A minor side-note: don't top-post :) -Hannes
-----Original Message----- From: Philip Olson [mailto:[EMAIL PROTECTED] Sent: Wednesday, April 25, 2007 10:59 AM To: Buesching, Logan J Cc: phpdoc@lists.php.net Subject: Re: [PHP-DOC] Helping with PHP documentation > I have been reading about how to get involved with the PHP > documentation team, and it pointed me to this list. I would like > to become involved in helping out the PHP documentation efforts. I > looked at the TODO list, and noticed that you guys wanted to have > every function documented. I looked into the list, and found one > section in which I believe I could do a pretty good job in > contributing in, which was the POSIX extension. I am pretty > familiar with UNIX systems and wouldn't mind improving the > documentation for these functions to get my feet wet in the > documentation. I have attached a patch file for a handful of the > POSIX functions for review and feedback. If you want, I can also > finish up documenting the rest of the POSIX extension, and move > onto other undocumented functions. Hello Logan, Welcome to the team! Sounds good, and I was wondering who this purdue guy was that left good doc bug comments within bugs.php.net :) The patch looks good, thank you for worrying about whitespace. The only problem is that the notes role does not use a <simplelist> like the seealso role does, but rather it uses the <note> tag to separate each note. <note><para>foo</para></note>. This is not clear in the howto/skeletons so they will be updated. As far as undocumented functions go, there are several hundred. There is a tool (affectionally named "the tool") that is being worked on to pinpoint problems including functions that aren't documented. For now, the doc.php.net site can perform that task but currently lacks the "missing functions" (functions without skeletons in the manual) information. The point here is that the future looks bright! Please finish up POSIX and when it looks good we'll move towards getting you karma. In your CVS request* you might then say "To work on the documentation, I already created patches that were accepted for the POSIX extension." Regards, Philip * http://php.net/cvs-php.php
