irchtml Wed Feb 25 11:42:00 2004 EDT
Modified files: /phpdoc/en/reference/pcntl/functions pcntl-wait.xml pcntl-waitpid.xml Log: documented pcntl_wait added note in _waitpid http://cvs.php.net/diff.php/phpdoc/en/reference/pcntl/functions/pcntl-wait.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/pcntl/functions/pcntl-wait.xml diff -u phpdoc/en/reference/pcntl/functions/pcntl-wait.xml:1.1 phpdoc/en/reference/pcntl/functions/pcntl-wait.xml:1.2 --- phpdoc/en/reference/pcntl/functions/pcntl-wait.xml:1.1 Wed Feb 25 11:00:11 2004 +++ phpdoc/en/reference/pcntl/functions/pcntl-wait.xml Wed Feb 25 11:42:00 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id='function.pcntl-wait'> <refnamediv> <refname>pcntl_wait</refname> @@ -14,7 +14,46 @@ <methodparam><type>int</type><parameter>&status</parameter></methodparam> </methodsynopsis> <para> - &warn.undocumented.func; + The wait function suspends execution of the current process until a + child has exited, or until a signal is delivered whose action is to + terminate the current process or to call a signal handling function. If a + child has already exited by the time of the call (a so-called "zombie" + process), the function returns immediately. Any system resources used by + the child are freed. Please see your system's wait(2) man page for + specific details as to how wait works on your system. + </para> + <para> + <function>pcntl_wait</function> returns the process ID of the child which + exited. + </para> + <para> + <function>pcntl_wait</function> will store status information + in the <parameter>status</parameter> parameter which can be + evaluated using the following functions: + <function>pcntl_wifexited</function>, + <function>pcntl_wifstopped</function>, + <function>pcntl_wifsignaled</function>, + <function>pcntl_wexitstatus</function>, + <function>pcntl_wtermsig</function> and + <function>pcntl_wstopsig</function>. + </para> + <note> + <para> + This function is equivalent to calling <function>pcntl_waitpid</function> + with a <literal>-1</literal> <parameter>pid</parameter> and no + <parameter>options</parameter>. + </para> + </note> + <para> + See also <function>pcntl_fork</function>, + <function>pcntl_signal</function>, + <function>pcntl_wifexited</function>, + <function>pcntl_wifstopped</function>, + <function>pcntl_wifsignaled</function>, + <function>pcntl_wexitstatus</function>, + <function>pcntl_wtermsig</function>, + <function>pcntl_wstopsig</function> and + <function>pcntl_waitpid</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pcntl/functions/pcntl-waitpid.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/pcntl/functions/pcntl-waitpid.xml diff -u phpdoc/en/reference/pcntl/functions/pcntl-waitpid.xml:1.5 phpdoc/en/reference/pcntl/functions/pcntl-waitpid.xml:1.6 --- phpdoc/en/reference/pcntl/functions/pcntl-waitpid.xml:1.5 Thu May 29 11:41:22 2003 +++ phpdoc/en/reference/pcntl/functions/pcntl-waitpid.xml Wed Feb 25 11:42:00 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pcntl.xml, last change in rev 1.1 --> <refentry id="function.pcntl-waitpid"> <refnamediv> @@ -69,6 +69,13 @@ </tgroup> </table> </para> + <note> + <para> + Specifying <literal>-1</literal> as the <parameter>pid</parameter> is + equivalent to the functionality <function>pcntl_wait</function> provides + (minus <parameter>options</parameter>). + </para> + </note> <para> <function>pcntl_waitpid</function> will store status information in the <parameter>status</parameter> parameter which can be