#41493 [Opn->Csd]: Update doc ref. behaviour of function disk_free_space() in 3 OS's

ID: 41493 Updated by: didou@php.net Reported By: tayloj1 at uk dot ibm dot com -Status: Open +Status: Closed Bug Type: Documentation problem Operating System: linux PHP Version: 5.2.2 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. Previous Comments: ------------------------------------------------------------------------ [2007-06-21 17:28:40] tayloj1 at uk dot ibm dot com Changing this back to a documentation problem. Here's the suggested patch: Index: en/reference/filesystem/functions/disk-free-space.xml =================================================================== RCS file: /repository/phpdoc/en/reference/filesystem/functions/disk-free-space.xml,v retrieving revision 1.7 diff -u -r1.7 disk-free-space.xml --- en/reference/filesystem/functions/disk-free-space.xml 20 Jun 2007 22:24:27 -0000 1.7 +++ en/reference/filesystem/functions/disk-free-space.xml 21 Jun 2007 16:57:49 -0000 @@ -17,6 +17,10 @@ number of bytes available on the corresponding filesystem or disk partition. </para> + <para> + Given a file name instead of a directory, the behaviour of the function + is unspecified and may differ between operating systems and PHP versions. + </para> </refsect1> <refsect1 role="parameters"> ------------------------------------------------------------------------ [2007-05-29 14:57:06] tayloj1 at uk dot ibm dot com Well it would improve the functionality for Win32 users and provide useful behavioural consistency across platforms. Otherwise, to achieve consistency, we're back to (1) limit Linux and OS2 behaviour to give error when filename supplied - or - (2) change doc to cater for discrepancies in behaviour between OS's as per tayloj1 comment, 29 May 11:09am ------------------------------------------------------------------------ [2007-05-29 13:39:08] tony2001@php.net Reclassified as feature request. At the moment I see no reasons to apply some hacks to make it work on Win32 the way it works on decent platforms. ------------------------------------------------------------------------ [2007-05-29 13:13:53] tayloj1 at uk dot ibm dot com Editing submission to change bug category from 'Documentation' to 'Filesystem function related', and to update Summary line. As per preceding discussion, please change implementation of function disk_free_space()so that the behaviour is the same for Linux, OS2 and Windows. Ideal result would be for all 3 OS's to accept a directory or filename as input, ref. rquadling comment, 29 May 10:35am. If this is implemented, then please update doc also: "Given a string containing a directory <insert: "or filename">, this function will return the number of bytes available in the corresponding filesystem or disk partition. " ------------------------------------------------------------------------ [2007-05-29 11:55:03] rquadling@php.net I would raise a bug as 2 of the 3 os's which have different implementations of this function support the supplying of a filename. Only windows has (is?) the problem. And it makes sense to ask how much space in on the drive holding a file. ------------------------------------------------------------------------ The remainder of the comments for this report are too long. To view the rest of the comments, please view the bug report online at http://bugs.php.net/41493 -- Edit this bug report at http://bugs.php.net/?id=41493&edit=1