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

Doc Bug #15891 End User Docs
Submitted: 2009-02-11 21:39 UTC
From: ifeghali Assigned: kvz
Status: Closed Package: System_Daemon
PHP Version: 5.2.8 OS:
Roadmaps: (Not assigned)    
Subscription  


 [2009-02-11 21:39 UTC] ifeghali (Igor Feghali)
Description: ------------ It would be super to have some end user docs. The examples at "docs/examples" are not clear enough on basic program usage for the newbie user. Some important points are unclear, like what all those die()s are doing along the code, how to correctly loops your code etc. For instance, in "logparser.php" one's code (line 107) is outside the loop (line 120). so how is that supposed to work ? newbie users to parallel programming and threads might not get the idea behind the package without proper end user documentation. Maybe some prose just about the basic concepts can be enough. Test script: --------------- Expected result: ---------------- Actual result: --------------

Comments

 [2009-02-11 21:49 UTC] ifeghali (Igor Feghali)
By the way I just found your blog: http://kevin.vanzonneveld.net/techblog/article/create_daemons_in_php/ That definitely would be a great addition to PEAR docs :) Please let me know if you need help "porting" it to here.
 [2009-02-12 06:58 UTC] doconnor (Daniel O'Connor)
As a temporary fix, I just added http://kevin.vanzonneveld.net/techblog/article/create_daemons_in_php/ to the external documentation link of the package.
 [2009-02-15 17:23 UTC] kvz (Kevin van Zonneveld)
-Assigned To: +Assigned To: kvz
 [2009-02-15 17:29 UTC] kvz (Kevin van Zonneveld)
I wonder, do I need to strip layout & place that external document somewhere else as well? I would rather not because of duplication (it will be a drag to keep multiple places up to date) & the ability for users to place comments as it is. Let me know
 [2009-02-15 18:41 UTC] ifeghali (Igor Feghali)
Yeh we have a repository for package specific documentation here: http://cvs.php.net/viewvc.cgi/peardoc/en/package/ Not sure whether its just fine to keep the docs outside of PEAR infra-structure though. I recall some thread discouraging outside docs some time ago but as far as I remember it was just a suggestion. I believe you can keep it this way. If you want to be sure you should ask at pear-qa@.
 [2009-02-20 21:57 UTC] kvz (Kevin van Zonneveld)
So I've asked pear-qa and they really do like to have that document as a part of peardoc. It will probably need some attention, but the basis is here: http://cvs.php.net/viewvc.cgi/peardoc/en/package/system/system-daemon/ I will further perfect it (with the help of cweiske) and close this bug if that's allright with you.
 [2009-02-20 21:58 UTC] kvz (Kevin van Zonneveld)
-Status: Assigned +Status: Closed
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.