Comments please. ---------- Forwarded message ---------- From: Richard Quadling <[EMAIL PROTECTED]> Date: 03-May-2007 11:26 Subject: Re: [PHP-DOC] cvs: phpdoc / funcindex.xml funclist.txt funcsummary.txt To: Philip Olson <[EMAIL PROTECTED]>
On 02/05/07, Philip Olson <[EMAIL PROTECTED]> wrote:
>> > > Modified files: >> > > /phpdoc funcindex.xml funcsummary.txt funclist.txt >> > > Log: >> > > Updated funcindex.xml funcsummary.txt funclist.txt >> > > No ZendAPI and no PECL entries. >> > >> > Hello Richard, >> > >> > Why did you remove the PECL entries? >> If you take the Cairo PECL extension (as an example), there is no >> mention of this within the online PHP manual. >> >> http://www.php.net/manual-lookup.php?pattern=cairo&lang=en >> >> reveals no cairo. >> >> So, I assume that the --with-pecl-source option is not used to build >> the online documentation. >> >> So I turned it off on my local build and did the same. >> >> I also turned off --with-source and --with-pear-source. >> >> This stops any of the ZendAPI stuff which I previously polluted these >> files with. >> >> Should PECL documentation be included? >> >> Richard. > > What I failed to say just above was with the --with-pecl-source option > enabled, you do get a whole load of additional documentation and > functions (Cairo, html-parse, libexif, mdbtools and uuid). > > But none of these are in the standard documentation, so the standard > files (quickref.txt, funclist.txt, funcsummary.txt and funcindex.xml) > now reflect the standard way of doing things. > > And also updates the PDF extension to reflect additional functions and > deprecated functions. Not every function is documented but that's slowly changing. All PECL extensions are documented within the PHP Manual, well, they all should be or at least will be. Many already are and are now missing from these files while some are in the files because they are symlinked from within php-src but that's another story... Regards, Philip
But the online manual __currently__ doesn't have them. None of the downloadable manuals have them. So it seems that whilst only a handful of PECL extensions are documented, the manuals are NOT built with the --with-pecl-source option active. So, I suppose, the next question is what else uses these files if not the manual build process? Are they rebuilt locally at make time (and not cvs committed back to the server)? The only different IS the handle of PECL extensions (Cairo, html-parse, libexif, mdbtools and uuid). That's 5 out of 201 different PECL folders! The only way to get the documentation to reflect these is to include the --with-pecl-source I've no problem having the PECL functions there, but it does seem inconsistent. For my own build I use ... ./configure --with-source=./../php-src --with-pear-source=./../pear --with-pecl-source=./../pecl --with-chm=yes --with-treesaving --with-dsssl=$HOME/phpdoc/docbook/docbook-dsssl make test make test_xml make quickref.txt funclist.txt funcsummary.txt funcindex.xml make chm_xsl and then the Windows Extended CHM stuff. So. Should these additional 5 PECL extensions have their functions in quickref.txt funclist.txt funcsummary.txt funcindex.xml on CVS, even though it seems that they are probably regenerated locally for the build process without --with-pecl-source? Happy to do whatever you all think. -- ----- Richard Quadling Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498&r=213474731 "Standing on the shoulders of some very clever giants!" -- ----- Richard Quadling Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498&r=213474731 "Standing on the shoulders of some very clever giants!"
