Skip to content

pcntl: fix the reference pages and document the 8.4 failure return #5767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lacatoire wants to merge 1 commit into
base: master
Choose a base branch
from
Open

pcntl: fix the reference pages and document the 8.4 failure return #5767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions reference/pcntl/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -641,17 +641,6 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.si-msggq">
<term>
<constant>SI_MSGGQ</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.si-asyncio">
<term>
<constant>SI_ASYNCIO</constant>
Expand Down
7 changes: 4 additions & 3 deletions reference/pcntl/functions/pcntl-exec.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,10 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &false;.
</para>
<simpara>
Returns &false; on failure. On success the function does not return, because
the current process image is replaced by the executed program.
</simpara>
</refsect1>

</refentry>
Expand Down
21 changes: 10 additions & 11 deletions reference/pcntl/functions/pcntl-sigprocmask.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,28 +83,29 @@
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>signal</parameter>
is empty.
A <exceptionname>ValueError</exceptionname> is thrown if <parameter>signals</parameter>
is empty, unless <parameter>mode</parameter> is
<constant>SIG_SETMASK</constant>.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>TypeError</classname> is thrown if <parameter>signal</parameter>
A <exceptionname>TypeError</exceptionname> is thrown if <parameter>signals</parameter>
value is not an <type>int</type>.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>signal</parameter>
A <exceptionname>ValueError</exceptionname> is thrown if <parameter>signals</parameter>
value is invalid.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>mode</parameter>
A <exceptionname>ValueError</exceptionname> is thrown if <parameter>mode</parameter>
value is not <constant>SIG_BLOCK</constant>, <constant>SIG_UNBLOCK</constant> or
<constant>SIG_SETMASK</constant>.
</entry>
Expand Down Expand Up @@ -134,12 +135,10 @@ pcntl_sigprocmask(SIG_UNBLOCK, array(SIGHUP), $oldset);

<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pcntl_sigwaitinfo</function></member>
<member><function>pcntl_sigtimedwait</function></member>
</simplelist>
</para>
<simplelist>
<member><function>pcntl_sigwaitinfo</function></member>
<member><function>pcntl_sigtimedwait</function></member>
</simplelist>
</refsect1>

</refentry>
Expand Down
31 changes: 18 additions & 13 deletions reference/pcntl/functions/pcntl-sigtimedwait.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,42 +87,49 @@
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>signal</parameter>
On failure, &false; is now returned; previously
<literal>-1</literal> was returned in some cases.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <exceptionname>ValueError</exceptionname> is thrown if <parameter>signals</parameter>
is empty.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>TypeError</classname> is thrown if <parameter>signal</parameter>
A <exceptionname>TypeError</exceptionname> is thrown if <parameter>signals</parameter>
value is not an <type>int</type>.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>signal</parameter>
A <exceptionname>ValueError</exceptionname> is thrown if <parameter>signals</parameter>
value is invalid.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>seconds</parameter>
A <exceptionname>ValueError</exceptionname> is thrown if <parameter>seconds</parameter>
value is less than <literal>0</literal>.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>nanoseconds</parameter>
value is less than <literal>0</literal>.
A <exceptionname>ValueError</exceptionname> is thrown if <parameter>nanoseconds</parameter>
value is not between <literal>0</literal> and <literal>1e9</literal>.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if both <parameter>seconds</parameter> and
A <exceptionname>ValueError</exceptionname> is thrown if both <parameter>seconds</parameter> and
<parameter>nanoseconds</parameter> values are <literal>0</literal>.
</entry>
</row>
Expand All @@ -133,12 +140,10 @@

<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pcntl_sigprocmask</function></member>
<member><function>pcntl_sigwaitinfo</function></member>
</simplelist>
</para>
<simplelist>
<member><function>pcntl_sigprocmask</function></member>
<member><function>pcntl_sigwaitinfo</function></member>
</simplelist>
</refsect1>

</refentry>
Expand Down
23 changes: 14 additions & 9 deletions reference/pcntl/functions/pcntl-sigwaitinfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,21 +102,28 @@
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>signal</parameter>
On failure, &false; is now returned; previously
<literal>-1</literal> was returned in some cases.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <exceptionname>ValueError</exceptionname> is thrown if <parameter>signals</parameter>
is empty.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>TypeError</classname> is thrown if <parameter>signal</parameter>
A <exceptionname>TypeError</exceptionname> is thrown if <parameter>signals</parameter>
value is not an <type>int</type>.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
A <classname>ValueError</classname> is thrown if <parameter>signal</parameter>
A <exceptionname>ValueError</exceptionname> is thrown if <parameter>signals</parameter>
value is invalid.
</entry>
</row>
Expand Down Expand Up @@ -151,12 +158,10 @@ pcntl_sigwaitinfo(array(SIGHUP), $info);

<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pcntl_sigprocmask</function></member>
<member><function>pcntl_sigtimedwait</function></member>
</simplelist>
</para>
<simplelist>
<member><function>pcntl_sigprocmask</function></member>
<member><function>pcntl_sigtimedwait</function></member>
</simplelist>
</refsect1>

</refentry>
Expand Down
16 changes: 7 additions & 9 deletions reference/pcntl/functions/pcntl-unshare.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,20 +47,18 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns <literal>0</literal> on success, <literal>-1</literal> otherwise.
<simpara>
Returns &true; on success or &false; on failure.
On failure it sets an error code, that can be retrieved with <function>pcntl_get_last_error</function>.
</para>
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="pcntl.constants.clone">PCNTL Constants</link></member>
<member><function>pcntl_get_last_error</function></member>
</simplelist>
</para>
<simplelist>
<member><link linkend="pcntl.constants.clone">PCNTL Constants</link></member>
<member><function>pcntl_get_last_error</function></member>
</simplelist>
</refsect1>

</refentry>
Expand Down
4 changes: 4 additions & 0 deletions reference/pcntl/versions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@
<function name="pcntl_errno" from="PHP 5 &gt;= 5.3.4, PHP 7, PHP 8"/>
<function name="pcntl_exec" from="PHP 4 &gt;= 4.2.0, PHP 5, PHP 7, PHP 8"/>
<function name="pcntl_fork" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>
<function name="pcntl_forkx" from="PHP 8 &gt;= 8.2.0"/>
<function name="pcntl_getcpu" from="PHP 8 &gt;= 8.4.0"/>
<function name="pcntl_getcpuaffinity" from="PHP 8 &gt;= 8.4.0"/>
<function name="pcntl_getqos_class" from="PHP 8 &gt;= 8.4.0"/>
<function name="pcntl_getpriority" from="PHP 5, PHP 7, PHP 8"/>
<function name="pcntl_get_last_error" from="PHP 5 &gt;= 5.3.4, PHP 7, PHP 8"/>
<function name="pcntl_rfork" from="PHP 8 &gt;= 8.1.0"/>
<function name="pcntl_setcpuaffinity" from="PHP 8 &gt;= 8.4.0"/>
<function name="pcntl_setns" from="PHP 8 &gt;= 8.4.0"/>
<function name="pcntl_setpriority" from="PHP 5, PHP 7, PHP 8"/>
<function name="pcntl_setqos_class" from="PHP 8 &gt;= 8.4.0"/>
<function name="pcntl_signal" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>
Expand All @@ -27,6 +30,7 @@
<function name="pcntl_waitpid" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>
<function name="pcntl_waitid" from="PHP 8 &gt;= 8.4.0"/>
<function name="pcntl_wexitstatus" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>
<function name="pcntl_wifcontinued" from="PHP 7, PHP 8"/>
<function name="pcntl_wifexited" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>
<function name="pcntl_wifsignaled" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>
<function name="pcntl_wifstopped" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>
Expand Down