Skip to content

Commit 8e31067

Browse files
authored
Document the resource_usage param for pcntl_waitid (php#3854)
1 parent 44b98de commit 8e31067

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

reference/pcntl/functions/pcntl-waitid.xml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>id</parameter><initializer>&null;</initializer></methodparam>
1515
<methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter><initializer>[]</initializer></methodparam>
1616
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>WEXITED</constant></initializer></methodparam>
17+
<methodparam choice="opt"><type>array</type><parameter role="reference">resource_usage</parameter><initializer>[]</initializer></methodparam>
1718
</methodsynopsis>
1819
<para>
1920
Obtains status information pertaining to termination, stop, and/or continue
@@ -245,6 +246,18 @@
245246
</para>
246247
</listitem>
247248
</varlistentry>
249+
<varlistentry>
250+
<term><parameter>resource_usage</parameter></term>
251+
<listitem>
252+
<para>
253+
The <parameter>resource_usage</parameter> parameter is set to an array
254+
containing resource usage statistics from the child process.
255+
256+
This is supported either if the wait6 system call is available
257+
(e.g. on FreeBSD), or on Linux through the raw waitid system call.
258+
</para>
259+
</listitem>
260+
</varlistentry>
248261
</variablelist>
249262
</refsect1>
250263

0 commit comments

Comments
 (0)