Doc #54228 [Opn->Csd]: PHP I/O doc page does not describe all options

Edit report at http://bugs.php.net/bug.php?id=54228&edit=1 ID: 54228 Updated by: aharvey@php.net Reported by: php at falconfour dot com Summary: PHP I/O doc page does not describe all options -Status: Open +Status: Closed Type: Documentation Problem Package: Documentation problem Operating System: N/A PHP Version: 5.3.5 -Assigned To: +Assigned To: aharvey Block user comment: N Private report: N New Comment: This bug has been fixed in the documentation's XML sources. Since the online and downloadable versions of the documentation need some time to get updated, we would like to ask you to be a bit patient. Thank you for the report, and for helping us make our documentation better. Done, although I've ended up reworking the page a bit beyond just the scope of this bug report. Previous Comments: ------------------------------------------------------------------------ [2011-06-14 18:18:43] aharvey@php.net Automatic comment from SVN on behalf of aharvey Revision: http://svn.php.net/viewvc/?view=revision&revision=312157 Log: Significantly refactor the PHP wrappers page: - Added an introduction separate to the description of the individual wrappers. - Used refsect2 elements to add more hierarchy to the description of the wrappers and make it more obvious which parts of the description match to which wrappers. - Separated the examples out from the description fully (there were bits of description dangling between examples, presumably from an earlier refactor). - Removed the now-extraneous option listing. - Added documentation for php://filter's parameters separate from the examples. - Linked to the filters page. This also fixes doc bug #54228 (PHP I/O doc page does not describe all options), which was why I actually started looking at this in the first place. ------------------------------------------------------------------------ [2011-03-11 19:19:31] php at falconfour dot com Description: ------------ The documentation for "PHP Input/Output" describes many options, like stdin and output, but leaves lots of holes in describing the other options. For example, "filter" leaves the last line in "description" hanging, saying "The php://filter target takes the following 'parameters' as parts of its 'path'". That's the end of the section, no "following parameters". Of particular note, php://temp and php://memory are *completely* undefined, leaving just their names in there. Is temp written to a file? Is memory direct access? Can I use memory as temporary I/O for file-only functions without worrying if it's leaving a temp file laying around? And this bug report form seems very "documentation feedback unfriendly"... I really can't add anything to the script/patch/expected/actual fields, so I guess "take it or leave it", but I think anyone looking for info on those I/O options would be glad to have the options explained... --- From manual page: http://www.php.net/wrappers.php#Options --- ------------------------------------------------------------------------ -- Edit this bug report at http://bugs.php.net/bug.php?id=54228&edit=1