xnu-2422.1.72.tar.gz

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

diff --git a/osfmk/man/task_assign.html b/osfmk/man/task_assign.html
old mode 100755 (executable)
new mode 100644 (file)
index f466718..6a182ec
--- a/osfmk/man/task_assign.html
+++ b/osfmk/man/task_assign.html
@@ -1 +1,49 @@
-<h2>task_assign</h2>\r<hr>\r<p>\r<strong>Function</strong> - Assign a task to a processor set.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   task_assign</strong>\r                <strong>(task_t</strong>                                    <var>task</var>,\r                 <strong>processor_set_t</strong>                  <var>processor_set</var>,\r                 <strong>boolean_t</strong>                       <var>assign_threads</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>task</var> \r<dd>\r[in task send right]\rThe port for the task to be assigned.\r<dt> <var>processor_set</var> \r<dd>\r[in processor-set-control send right]\rThe control port for the processor \rset into which the task is to be assigned.\r<dt> <var>assign_threads</var> \r<dd>\r[in scalar]\rTrue if this assignment should apply as well to the threads \rwithin the task.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>task_assign</strong> function assigns <var>task</var> to the set \r<var>processor_set</var>.\rAfter the assignment is completed, newly created threads within this task\rwill be assigned to \rthis processor set.  Any previous assignment of the task is nullified. \r<p>\rIf <var>assign_threads</var> is <strong>TRUE</strong>, existing threads within the task \rwill also be assigned to the processor set.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="task_assign_default.html"><strong>task_assign_default</strong></a>,\r<a href="task_get_assignment.html"><strong>task_get_assignment</strong></a>,\r<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,\r<a href="processor_set_info.html"><strong>processor_set_info</strong></a>,\r<a href="thread_assign.html"><strong>thread_assign</strong></a>.\r
\ No newline at end of file
+<h2>task_assign</h2>
+<hr>
+<p>
+<strong>Function</strong> - Assign a task to a processor set.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   task_assign</strong>
+                <strong>(task_t</strong>                                    <var>task</var>,
+                 <strong>processor_set_t</strong>                  <var>processor_set</var>,
+                 <strong>boolean_t</strong>                       <var>assign_threads</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<dt> <var>task</var> 
+<dd>
+[in task send right]
+The port for the task to be assigned.
+<dt> <var>processor_set</var> 
+<dd>
+[in processor-set-control send right]
+The control port for the processor 
+set into which the task is to be assigned.
+<dt> <var>assign_threads</var> 
+<dd>
+[in scalar]
+True if this assignment should apply as well to the threads 
+within the task.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>task_assign</strong> function assigns <var>task</var> to the set 
+<var>processor_set</var>.
+After the assignment is completed, newly created threads within this task
+will be assigned to 
+this processor set.  Any previous assignment of the task is nullified. 
+<p>
+If <var>assign_threads</var> is <strong>TRUE</strong>, existing threads within the task 
+will also be assigned to the processor set.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="task_assign_default.html"><strong>task_assign_default</strong></a>,
+<a href="task_get_assignment.html"><strong>task_get_assignment</strong></a>,
+<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
+<a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
+<a href="thread_assign.html"><strong>thread_assign</strong></a>.