Report new bug | New search | Development Roadmap Status: Open | Feedback | All

Doc Bug #10442 Section about roles for package.xml 2.0 hard to navigate and confusing
Submitted: 2007-03-21 15:49 UTC
From: designatevoid Assigned: cweiske
Status: Closed Package: Documentation
PHP Version: Irrelevant OS: Any
Roadmaps: (Not assigned)    
Subscription  
Comments Add Comment Add patch


Anyone can comment on a bug. Have a simpler test case? Does it work for you on a different platform? Let us know! Just going to say 'Me too!'? Don't clutter the database with that please !
Your email address:
MUST BE VALID
Solve the problem : 5 - 5 = ?

 
 [2007-03-21 15:49 UTC] designatevoid (Michael "Vladimyr" Gower)
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.

Comments

 [2009-05-06 01:25 UTC] cweiske (Christian Weiske)
-Status: Open +Status: Closed -Assigned To: +Assigned To: cweiske
This bug has been fixed in CVS. If this was a documentation problem, the fix will appear on pear.php.net by the end of next Sunday (CET). If this was a problem with the pear.php.net website, the change should be live shortly. Otherwise, the fix will appear in the package's next release. Thank you for the report and for helping us make PEAR better.