Re: PECL/mysqlnd_ms documentation draft looking for review

On Apr 17, 2011, at 10:45 AM, Ulf Wendel wrote: > Hi Philip, > > thanks for your input! > > Am 17.04.2011 00:30, schrieb Philip Olson: >> Looks good. A few minor issues, most namely using<literal> in places >> where<function> or<constant> would be more appropriate, and some whitespace issues >> (one space), here's a quick review: > > Done. I checked all files for literal vs. constant vs. function and whitespace (single instead > of double). > > Though, <function> seems not be be linked to the actual function in my XHTML output. This > is what I did to render the XHTML: > > php configure.php && phd -d .manual.xml -f xhtml -t chunkedhtml That's close but -t isn't a valid option for this task. And use the PHP package (not Generic) to have more success for php.net centric items (as one of PhD's goals is to work with non-php.net stuff). Try this instead: php configure.php && phd -d .manual.xml -P PHP -f xhtml I don't remember the partial builds information offhand but it'd speed things up a little, as would -I (not rebuild index) but anyway, the above will work better. Pass in -I if you're testing minor changes because indexing takes the most time and probably won't affect what you're changing. >> From versions.xml >> - It's missing mysqlnd_ms_get_stats(), and I'm guessing the initial version >> number will be 0.1 for all these (not Unknown) > > Fixed. If possible, I'd like to use 1.0.0 for the first release not 0.1. > > I've uploaded the latest version to: > > XML - http://blog.ulf-wendel.de/tmp/mysqlnd_ms.zip > XHTML - http://blog.ulf-wendel.de/tmp/book.mysqlnd-ms.html > > What are my next steps to get the proposed PECL/mysqlnd_ms documentation into the manual? > Should I give a bit more time for feedback and review? Would you or any other PHP documentation team > member add the materials to the manual? I'd appreciate if the initial commit is done by anybody > who knows the task. I think the next steps are: 1. You submit/commit the extension to pecl 2. Once accepted, you commit the documentation here I think you should make the commit so we can find you within the annotations/blame log. Just add all the files except entities.* and commit. Or ask further questions here or within the #php.doc IRC channel on EFnet first. You won't break anything, as this is why we use SVN ;) > >> Also, nice domain name for your email ;) > > I hope, I'm not offending anybody! I've been using ulf.wendel@phpdoc.de as my main > private email address for the past eleven years. In 2000, I've given a talk at the first german > PHP conference about a JavaDoc counterpart which I called phpDoc. Ancient history... :) Regards, Philip