svn: /phpdoc/en/trunk/reference/misc/functions/ sleep.xml
| From: | Adam Harvey | Date: | Mon, 29 Nov 2010 03:21:50 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/misc/functions/ sleep.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7478@lists.php.net to get a copy of this message | ||
aharvey Mon, 29 Nov 2010 03:21:50 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=305811
Log:
Updated the sleep() manual page to reflect the new Windows behaviour by
reintegrating some of the old return values text, adding a specific note based
on how SleepEx() is documented to behave on Windows, and adding a Changelog
section to document the pre-5.3.4 behaviour.
Changed paths:
U phpdoc/en/trunk/reference/misc/functions/sleep.xml
Modified: phpdoc/en/trunk/reference/misc/functions/sleep.xml
===================================================================
--- phpdoc/en/trunk/reference/misc/functions/sleep.xml 2010-11-29 02:43:22 UTC (rev 305810)
+++ phpdoc/en/trunk/reference/misc/functions/sleep.xml 2010-11-29 03:21:50 UTC (rev 305811)
@@ -37,17 +37,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- On all platforms, <function>sleep</function> returns &false; if the
- <parameter>seconds</parameter> parameter is invalid.
+ Returns zero on success, or &false; on error.
</para>
<para>
- On Windows, provided the aforementioned <parameter>seconds</parameter>
- parameter is valid, <function>sleep</function> always returns &null;.
+ If the call was interrupted by a signal, <function>sleep</function> returns
+ a non-zero value. On Windows, this value will always be
+ <literal>192</literal> (the value of the
+ <constant>WAIT_IO_COMPLETION</constant> constant within the Windows API).
+ On other platforms, the return value will be the number of seconds left to
+ sleep.
</para>
- <para>
- On other platforms, <function>sleep</function> returns zero on success, or
- the number of seconds left to sleep if interrupted by a signal.
- </para>
</refsect1>
<refsect1 role="errors">
@@ -58,6 +57,32 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>5.3.4</entry>
+ <entry>
+ Before PHP 5.3.4, on Windows, <function>sleep</function> always
+ returns &null; when sleep has occurred, regardless of whether the
+ sleep was interrupted or not.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>