[DOC-CVS] [doc-en] master: Document the resource_usage param for pcntl_waitid (#3854)

Author: Vladimir Vrzić (vrza)
Committer: GitHub (web-flow)
Pusher: devnexen
Date: 2025-09-01T07:24:39+01:00

Commit: https://github.com/php/doc-en/commit/8e31067f1aa8fa219cc1de11abb26ab81e5a2be0
Raw diff: https://github.com/php/doc-en/commit/8e31067f1aa8fa219cc1de11abb26ab81e5a2be0.diff

Document the resource_usage param for pcntl_waitid (#3854)

Changed paths:
  M  reference/pcntl/functions/pcntl-waitid.xml


Diff:

diff --git a/reference/pcntl/functions/pcntl-waitid.xml b/reference/pcntl/functions/pcntl-waitid.xml
index e0664aef7229..d108a9012830 100644
--- a/reference/pcntl/functions/pcntl-waitid.xml
+++ b/reference/pcntl/functions/pcntl-waitid.xml
@@ -14,6 +14,7 @@
    <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>id</parameter><initializer>&null;</initializer></methodparam>
    <methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter><initializer>[]</initializer></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>WEXITED</constant></initializer></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter role="reference">resource_usage</parameter><initializer>[]</initializer></methodparam>
   </methodsynopsis>
   <para>
    Obtains status information pertaining to termination, stop, and/or continue
@@ -245,6 +246,18 @@
      </para>
     </listitem>
    </varlistentry>
+   <varlistentry>
+    <term><parameter>resource_usage</parameter></term>
+    <listitem>
+     <para>
+      The <parameter>resource_usage</parameter> parameter is set to an array
+      containing resource usage statistics from the child process.
+
+      This is supported either if the wait6 system call is available
+      (e.g. on FreeBSD), or on Linux through the raw waitid system call.
+     </para>
+    </listitem>
+   </varlistentry>
   </variablelist>
  </refsect1>