Re: New Gearman documentation
| From: | Rasmus Lerdorf | Date: | Fri, 25 Sep 2009 16:21:54 +0000 |
| Subject: | Re: New Gearman documentation | ||
| References: | 1 2 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969380916@lists.php.net to get a copy of this message | ||
Hannes Magnusson 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?
>
>> 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..)
>
> 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.
>
>
>> 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.
> 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..).
You can probably also pull some examples from my write-up from yesterday:
http://toys.lerdorf.com/archives/51-Playing-with-Gearman.html
Note that this stuff is moving pretty fast right now. The next version
of the extension is going to have a bunch of new stuff. I'll try to
pitch in as well.
-Rasmus