Re: New Gearman documentation

On Fri, Sep 25, 2009 at 12:19 PM, Hannes Magnusson <hannes.magnusson@gmail.com> wrote: >On Fri, Sep 25, 2009 at 17:26, Alan J Collison <alan@collison.net> wrote: >> Hello, >> >> I have an initial pass at documentation for the Gearman >> PECL extension.  The created files can be found here: >> >> http://collison.net/gearman/phpdoc/ >> >> In that directory are: >> >> entities.reference.xml       - has the &reference.entities.gearman; added > >hmh. isn't that supposed to be in manual.xml.in? Hmm, I just followed similar entries from the Memcache extension, which has stuff in entities.reference.xml that does not appear in manual.xml.in ... > >> gearman_reference.tar.gz     - the XML files > >The entities.*.xml are automatically generated by configure.php, and >should therefore be svn:ignored. >The .cvsignore file is no longer used :) (when thinking about it.. >maybe docgen.php hasn't been updated..) Yah, I just ran docgen and so what's there (including .cvsignore) must have been auto generated. I can remove that. > >You seem to have forgotten to enable the reference entity in book.xml >(&reference.gearman.reference;). >The functions seem to have a bunch of autogenerated text which should >be removed. Actually, I left out that one on purpose. The focus at the Gearman site is on the OO interface, so I decided in the initial documentation I'd also focus on the OO stuff as well and omit the functions. In this case, should I remove the function XML files? (I'm guessing yes :)) > > >> Please let me know anything I've done incorrectly and how to fix. >> This is my first contribution to PHP documentation, so to commit >> I will need an SVN account - if this all looks sane to you :) > >Quickly browsing it, looks very good. Thanks. >You can file for an SVN account by filling out the form at >http://php.net/svn-php correctly (be sure to read the entire >page, and >the forms questions..). Cool. I will do so. alan