irchtml Wed Feb 25 12:36:15 2004 EDT
Modified files:
/phpdoc/en/reference/pcntl/functions pcntl-getpriority.xml
pcntl-setpriority.xml
Log:
finished up get/setpriority docs
http://cvs.php.net/diff.php/phpdoc/en/reference/pcntl/functions/pcntl-getpriority.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/pcntl/functions/pcntl-getpriority.xml
diff -u phpdoc/en/reference/pcntl/functions/pcntl-getpriority.xml:1.1
phpdoc/en/reference/pcntl/functions/pcntl-getpriority.xml:1.2
--- phpdoc/en/reference/pcntl/functions/pcntl-getpriority.xml:1.1 Wed Feb 25
11:00:11 2004
+++ phpdoc/en/reference/pcntl/functions/pcntl-getpriority.xml Wed Feb 25 12:36:15
2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id='function.pcntl-getpriority'>
<refnamediv>
<refname>pcntl_getpriority</refname>
@@ -12,11 +12,20 @@
<methodsynopsis>
<type>int</type><methodname>pcntl_getpriority</methodname>
<methodparam
choice="opt"><type>int</type><parameter>pid</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>process_identifier</parameter></methodparam>
</methodsynopsis>
<para>
- &warn.undocumented.func;
+ <function>pcntl_getpriority</function> gets the priority of
+ <parameter>pid</parameter>. If <parameter>pid</parameter> is not
+ specified, the pid of the current process is used. Because priority
+ levels can differ between system types and kernel versions, please see
+ your system's getpriority(2) man page for specific details.
</para>
+ <para>
+ <function>pcntl_getpriority</function> returns the priority of the process
+ or &false; on error. A lower numerical value causes more favorable
+ scheduling.
+ </para>
+ &return.falseproblem;
</refsect1>
</refentry>
@@ -39,4 +48,4 @@
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
--->
+-->
\ No newline at end of file
http://cvs.php.net/diff.php/phpdoc/en/reference/pcntl/functions/pcntl-setpriority.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/pcntl/functions/pcntl-setpriority.xml
diff -u phpdoc/en/reference/pcntl/functions/pcntl-setpriority.xml:1.1
phpdoc/en/reference/pcntl/functions/pcntl-setpriority.xml:1.2
--- phpdoc/en/reference/pcntl/functions/pcntl-setpriority.xml:1.1 Wed Feb 25
11:00:11 2004
+++ phpdoc/en/reference/pcntl/functions/pcntl-setpriority.xml Wed Feb 25 12:36:15
2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id='function.pcntl-setpriority'>
<refnamediv>
<refname>pcntl_setpriority</refname>
@@ -13,10 +13,23 @@
<type>bool</type><methodname>pcntl_setpriority</methodname>
<methodparam><type>int</type><parameter>priority</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pid</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>process_identifier</parameter></methodparam>
</methodsynopsis>
<para>
- &warn.undocumented.func;
+ <function>pcntl_setpriority</function> sets the priority of
+ <parameter>pid</parameter> to <parameter>priority</parameter>. If
+ <parameter>pid</parameter> is not specified, the pid of the current
+ process is used.
+ </para>
+ <para>
+ <parameter>priority</parameter> is generally a value in the range
+ <literal>-20</literal> to <literal>20</literal>. The default priority
+ is <literal>0</literal> while a lower numerical value causes more
+ favorable scheduling. Because priority levels can differ between
+ system types and kernel versions, please see your system's setpriority(2)
+ man page for specific details.
+ </para>
+ <para>
+ &return.success;
</para>
</refsect1>
</refentry>
@@ -40,4 +53,4 @@
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
--->
+-->
\ No newline at end of file
