PHP Documentation - Re: [PHP-DOC] Doc for PECL geoip module

Author

Re: [PHP-DOC] Doc for PECL geoip module

Hartmut Holzgraefe

2006-08-22, 6:57 pm

Olivier Hill wrote:
> Hi,
>
> I will soon make a release for the PECL geoip module. As such, I have
> written documentation about the different functions and provided some
> code examples.
>
> Should I commit this to phpdoc? Everything is inside references/geoip.
> I have done a make test as well as test_xml, everything seems fine.

IMHO you should keep it within the extension itself, phpdocs
configure script has a --with-pecl-source=... option that will
pick it up from PECL ...

--
Hartmut Holzgraefe, Senior Support Engineer .
MySQL AB, www.mysql.com

Sean Coates

2006-08-22, 6:57 pm

> IMHO you should keep it within the extension itself, phpdocs
> configure script has a --with-pecl-source=... option that will
> pick it up from PECL ...

PECL documentation has been stored in the phpdoc repository for a long
time now.

There are a few problems with putting the documentation in PECL:
- it won't get built with the manual (unless I'm mistaken... Derick?)
- normal documenter-types don't have karma for most of pecl (the doc
team won't be able to fix bugs, etc)
- there's no translation infrastructure
- no tool infrastructure (http://doc.php.net/)

Opinions?

S

Philip Olson

2006-08-22, 6:57 pm

>
> Correct, as I've never heard of this switch either :)
>
>
> Keep it in the phpdoc... however, I do think we should mark it *much*
> better that something is in PECL and not in the PHP distribution.

Agreed to keep all PECL documentation inside phpdoc. And all should
agree the PECL docs "structure" is kind of a mess right now. Due to
the almost random nature of when extensions move into PECL, or become
bundled/unbundled, it looks like [most] each extension reference will
require hand written information as opposed to only using entities
for all this (which is being attempted currently). Here's an open
bug report on this topic:

http://bugs.php.net/bug.php?id=37315

Also we need a FAQ that explains what PECL is, and means, to everyone
from average users to system administrators.

Regards,
Philip

Sponsored Links