[PECL-BUG] Doc #10442 [Opn->Bgs]: Section about roles for package.xml 2.0 hard to navigate and confusing
[email protected] 5 Aug 2010 20:59:05 -0000
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <[email protected]> |
Edit report at http://pecl.php.net/bugs/bug.php?id=10442&edit=1 ID: 10442 Updated by: [email protected] Reported By: designatevoid at gmail dot com -Status: Open +Status: Bogus Id: 10442 Type: Documentation Problem Package: Documentation Operating System: Any PHP Version: Irrelevant New Comment: See http://pear.php.net/bugs/bug.php?id=10442 Previous Comments: ------------------------------------------------------------------------ [2007-03-21 11:49:53] designatevoid at gmail dot com Description: ------------ Greetings, The information about roles and install directories for package.xml 2.0 is currently confusing, hard to navigate and could use a bit more documentation, at least for a first time developer who has started with package.xml 2.0. First off, there is no information about roles for package.xml 2.0. The information about roles is under the docs for version 1.0 with the clear statement that 1.0 is now obsolete and the 1.0 documentation shouldn't be referenced. The only way I found the role information is from a link under the file page (http://pear.php.net/manual/en/guide.developers.package2.file.php). Secondly, it would be very helpful if the information about roles would include a reference to the command 'pear config-show'. The roles section references PEAR_data_dir, PEAR_configuration_dir and PEAR_documentation_dir but doesn't give any information about how to find the values of said variables currently. In short, it would make the roles section *much* more easy to read and navigate if role information was integrated into the package.xml 2.0 chapter and if it cross referenced how to find the values of the PEAR_*_dirs that it mentions. I truely hope this was concise, clear and helpful. Thank you for your time. ------------------------------------------------------------------------ -- Edit this bug report at http://pecl.php.net/bugs/bug.php?id=10442&edit=1