Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 0.9.3

Bug #4415 Docs directory goes into wrong directory
Submitted: 2005-05-24 04:16 UTC Modified: 2006-12-17 05:14 UTC
From: post at mark-wiesemann dot de Assigned: wiesemann
Status: Closed Package: Structures_DataGrid
PHP Version: Irrelevant OS: Irrelevant
Roadmaps: (Not assigned)    
Subscription  


 [2005-05-24 04:16 UTC] post at mark-wiesemann dot de
Description: ------------ The documentation files (example*.php) should not go into the package directory but in the PEAR docs directory. If I understand the package.xml definition right, you need to change role="php" in <dir name="Docs" role="php"> to role="doc" (e.g. DB package uses <dir name="doc" role="doc">).

Comments

 [2005-11-21 13:03 UTC] post at mark-wiesemann dot de
I did some further investigations on this. role="doc" was the right way, but this is not enough. I suggest to change the directory structure according to this document: http://pear.php.net/group/docs/20031114-pds.php This means: Docs/Examples/*.* goes one directory up, and "Docs" is renamed to "docs", "Examples" to "examples". The rest of the files and directories can remain as they are. After this move, the following patch for package.xml will give the desired directory structure with the examples files in [PEAR-DOC-DIR]/Structures_DataGrid/docs/examples/. Patch: http://www.markwiesemann.de/php/Structures_DataGrid/package.xml.diff After using an example version number and release date (instead of "?"), package-validate returned no errors and the packaged package was installed as expected.
 [2005-12-21 15:46 UTC] wiesemann
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.