[prev in list] [next in list] [prev in thread] [next in thread] 

List:       pear-doc
Subject:    [PEAR-DOC] [PEAR-BUG] Doc #10442 [Opn->Csd]: Section about roles for package.xml 2.0 hard to navigat
From:       cweiske () php ! net
Date:       2009-05-05 19:26:37
Message-ID: 20090505202559.BC746193A1A () euk1 ! php ! net
[Download RAW message or body]

Edit report at http://pear.php.net/bugs/bug.php?id=10442&edit=1

 ID:               10442
 Updated by:       cweiske@php.net
 Reported By:      designatevoid at gmail dot com
 Summary:          Section about roles for package.xml 2.0 hard to
                    navigate and confusing
-Status:           Open
+Status:           Closed
 Type:             Documentation Problem
 Package:          Documentation
 Operating System: Any
 PHP Version:      Irrelevant
-Assigned To:      
+Assigned To:      cweiske
 Roadmap Versions: 
 New Comment:

-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.




Previous Comments:
------------------------------------------------------------------------

[2007-03-21 11:49:53] designatevoid

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://pear.php.net/bugs/bug.php?id=10442&edit=1


-- 
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread]