xnu-792.21.3.tar.gz

[apple/xnu.git] / osfmk / man / P_set_policy_enable.html

diff --git a/osfmk/man/P_set_policy_enable.html b/osfmk/man/P_set_policy_enable.html
index 8bb760d6afa3b27215469fd49f2339c7954b1f27..966c80d958f31f50d402843f0255f790c5ebf3a6 100755 (executable)
--- a/osfmk/man/P_set_policy_enable.html
+++ b/osfmk/man/P_set_policy_enable.html
@@ -1 +1,38 @@
-<h2>processor_set_policy_enable</h2>\r<hr>\r<p>\r<strong>Function</strong> - Enables a scheduling policy for a processor set.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>#include&lt mach/mach_host.h&gt</strong>\r\r<strong>kern_return_t     processor_set_policy_enable</strong>\r           <strong>(processor_set_t</strong>       <var>processor_set</var>,\r              <strong>int</strong>    <var>policy</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>processor_set</var>\r<dd>\r[in processor-set-control port] The control port for the processor set for which a scheduling policy is to be enabled.\r<dt> <var>policy</var>\r<dd>\r[in scalar] Policy to be enabled. The values currently defined are POLICY_TIMESHARE and POLICY_FIXEDPRI.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>processor_set_policy_enable</strong>\rfunction extends the set of scheduling policies allowed for\r<var>processor_set</var>. The set of scheduling policies allowed for a\rprocessor set is the set of policies allowed to be set for threads\rassigned to that processor set. The current set of permitted policies\rcan be obtained from <strong>processor_set_info</strong>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="processor_set_info.html">processor_set_info</a>,\r<a href="P_set_policy_disable.html">processor_set_policy_disable</a>,\r<a href="thread_policy.html">thread_policy</a>.\r
\ No newline at end of file
+<h2>processor_set_policy_enable</h2>
+<hr>
+<p>
+<strong>Function</strong> - Enables a scheduling policy for a processor set.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>#include&lt mach/mach_host.h&gt</strong>
+
+<strong>kern_return_t  processor_set_policy_enable</strong>
+               <strong>(processor_set_t</strong>       <var>processor_set</var>,
+               <strong>int</strong>    <var>policy</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<dt> <var>processor_set</var>
+<dd>
+[in processor-set-control port] The control port for the processor set for which a scheduling policy is to be enabled.
+<dt> <var>policy</var>
+<dd>
+[in scalar] Policy to be enabled. The values currently defined are POLICY_TIMESHARE and POLICY_FIXEDPRI.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>processor_set_policy_enable</strong>
+function extends the set of scheduling policies allowed for
+<var>processor_set</var>. The set of scheduling policies allowed for a
+processor set is the set of policies allowed to be set for threads
+assigned to that processor set. The current set of permitted policies
+can be obtained from <strong>processor_set_info</strong>.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="processor_set_info.html">processor_set_info</a>,
+<a href="P_set_policy_disable.html">processor_set_policy_disable</a>,
+<a href="thread_policy.html">thread_policy</a>.