Skip to content

Document the resource_usage param for pcntl_waitid #3854

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

Merged
merged 2 commits into from
Sep 1, 2025
Merged

Document the resource_usage param for pcntl_waitid #3854

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b69181
Document the resource_usage param for pcntl_waitid
vrza Oct 10, 2024
088d09f
Merge branch 'master' into pcntl-waitid-rusage
vrza Jun 25, 2025
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
13 changes: 13 additions & 0 deletions reference/pcntl/functions/pcntl-waitid.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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>

Expand Down