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

Request #11304 The manual should show a "deprecated" warning when the package is
Submitted: 2007-06-13 07:23 UTC
From: arnaud Assigned:
Status: Open Package: pearweb
PHP Version: Irrelevant OS:
Roadmaps: (Not assigned)    
Subscription  


 [2007-06-13 07:23 UTC] arnaud (Arnaud Limbourg)
Description: ------------ When a package is marked as deprecated the corresponding section in the manual should show this.

Comments

 [2007-06-13 11:19 UTC] wiesemann (Mark Wiesemann)
This is an issue that can only be solved in pearweb IMO. The manual build process doesn't know about which packages are deprecated. And adding notes to every page for every deprecated page is too much work. Easy solution: Use my package detection (it's used for providing the links to package info page, to the API docs, and to the bug tracker) and put a note on top of every manual page that is related to a deprecated package. I'll take care of it for 1.17.0.
 [2007-06-16 23:02 UTC] dufuz (Helgi Þormar)
Well the build process could query the REST service and find out that way, then we could have the manual well more static since it only happens once every week instead of on each load :P My 2 cents
 [2007-06-17 05:05 UTC] cellog (Greg Beaver)
better yet - how about a cron job that checks manual pages for a deprecated package and mails the pear-doc list once a month?
 [2007-06-17 16:15 UTC] wiesemann (Mark Wiesemann)
Greg, if PEAR would have a documentation team (like PHP has), such a reminder email would help. My proposal is also not the best because this automatic solution wouldn't be easy for subpackages and other exceptions. Helgi's proposal would have the benefit that all variants of the docs (HTML, website, CHM etc.) would be affected, but would have the same problem as my proposal. => Adding this information manually seems to be the only reasonable solution. Problem: Who will do it? To preserve the task of adding the information, we could generate a doc bug for the package that is marked deprecated. This could be done once for all currently deprecated packages, and then directly after marking a package as deprecated.
 [2007-06-17 18:12 UTC] cellog (Greg Beaver)
good, the last suggestion is the best
 [2007-08-04 00:23 UTC] cweiske (Christian Weiske)
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. I did this some weeks ago.
 [2007-08-04 21:26 UTC] cweiske (Christian Weiske)
still needs pearweb to open a bug report or send an email once a package is marked deprecated.
 [2008-01-10 19:48 UTC] dufuz (Helgi Þormar Þorbjörnsson)
Were all the deprecated packages already covered or do we still need a scrip that does a one run over the database and opens up the reports ?
 [2008-01-11 19:21 UTC] wiesemann (Mark Wiesemann)
> Were all the deprecated packages already covered or do we > still need a scrip that does a one run over the database > and opens up the reports ? Yes, it's still needed because any package can be marked deprecated at any time.