Skip to content

Commit

Permalink
Merge branch 'cpuaffinity_pcntl' of https://github.com/devnexen/doc-en
Browse files Browse the repository at this point in the history
…into cpuaffinity_pcntl
  • Loading branch information
devnexen committed Jan 14, 2025
2 parents 7d2248b + 903bd21 commit a6895b1
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 58 deletions.
44 changes: 19 additions & 25 deletions reference/pcntl/functions/pcntl-getcpuaffinity.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,34 +12,30 @@
<type class="union"><type>bool</type><type>array</type></type><methodname>pcntl_getcpuaffinity</methodname>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>pid</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pcntl_getcpuaffinity</function> gets the cpu affinity
<parameter>pid</parameter>.
</para>
<simpara>
Retrieve the cpu affinity of the <parameter>pid</parameter>.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pid</parameter></term>
<listitem>
<para>
If &null;, the process id of the current process is used.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>pid</parameter></term>
<listitem>
<simpara>
If &null;, the current process ID is used.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>pcntl_getcpuaffinity</function> returns the cpu affinity mask of
the process or &false; on error.
</para>
<simpara>
Returns the cpu affinity mask of the process, &return.falseforfailure;.
</simpara>
&return.falseproblem;
</refsect1>

Expand All @@ -61,11 +57,9 @@

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

</refentry>
Expand Down
61 changes: 28 additions & 33 deletions reference/pcntl/functions/pcntl-setcpuaffinity.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,42 +13,39 @@
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>pid</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>hmask</parameter></methodparam>
</methodsynopsis>
<para>
<function>pcntl_setcpuaffinity</function> sets the cpu affinity
<parameter>pid</parameter> with the cpu affinity mask <parameter>hmask</parameter>.
</para>
<simpara>
Sets the cpu affinity for the <parameter>pid</parameter> with the cpu affinity mask given by
<parameter>hmask</parameter>.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pid</parameter></term>
<listitem>
<para>
If &null;, the process id of the current process is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hmask</parameter></term>
<listitem>
<para>
The cpu affinity mask comprised of 1 or more cpu id for binding the process to.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>pid</parameter></term>
<listitem>
<simpara>
If &null;, the current process ID is used.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hmask</parameter></term>
<listitem>
<simpara>
The cpu affinity mask comprised of one or more cpu id for binding the process to.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>pcntl_setcpuaffinity</function> returns &true; if the cpu binding
is successful or &false; on error.
</para>
<simpara>
&return.success;
</simpara>
&return.falseproblem;
</refsect1>

Expand All @@ -64,11 +61,9 @@

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

</refentry>
Expand Down

0 comments on commit a6895b1

Please sign in to comment.