xnu-2422.1.72.tar.gz

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

diff --git a/osfmk/man/processor_exit.html b/osfmk/man/processor_exit.html
old mode 100755 (executable)
new mode 100644 (file)
index 0e8cd75..e791fd5
--- a/osfmk/man/processor_exit.html
+++ b/osfmk/man/processor_exit.html
@@ -1 +1,44 @@
-<h2>processor_exit</h2>\r<hr>\r<p>\r<strong>Function</strong> - Exit a processor.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   processor_exit</strong>\r                <strong>(processor_t</strong>   <var>processor</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>processor</var> \r<dd>\r[in processor send right]\rThe processor to be controlled.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>processor_exit</strong> function allows privileged software\rto exit a processor in a \rmulti-processor that so allows it.  An exited processor is removed from the\rprocessor set to which it was assigned and ceases to be active.\rThe interpretation of \rthis operation is machine dependent.\r<h3>NOTES</h3>\r<p>\rThis operation is machine dependent.  It may do nothing.\r<h3>CAUTIONS</h3>\r<p>\rThe ability to restart an exited processor is machine dependent.\r<h3>RETURN VALUES</h3>\r<dl>\r<dt> <strong>KERN_FAILURE</strong>\r<dd>\rThe operation was not performed.  A likely reason is that it\ris not supported on this processor.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="processor_control.html">processor_control</a>,\r<a href="processor_start.html">processor_start</a>,\r<a href="processor_info.html">processor_info</a>,\r<a href="host_processors.html">host_processors</a>.\r
\ No newline at end of file
+<h2>processor_exit</h2>
+<hr>
+<p>
+<strong>Function</strong> - Exit a processor.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t  processor_exit</strong>
+               <strong>(processor_t</strong>   <var>processor</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<dt> <var>processor</var> 
+<dd>
+[in processor send right]
+The processor to be controlled.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>processor_exit</strong> function allows privileged software
+to exit a processor in a 
+multi-processor that so allows it.  An exited processor is removed from the
+processor set to which it was assigned and ceases to be active.
+The interpretation of 
+this operation is machine dependent.
+<h3>NOTES</h3>
+<p>
+This operation is machine dependent.  It may do nothing.
+<h3>CAUTIONS</h3>
+<p>
+The ability to restart an exited processor is machine dependent.
+<h3>RETURN VALUES</h3>
+<dl>
+<dt> <strong>KERN_FAILURE</strong>
+<dd>
+The operation was not performed.  A likely reason is that it
+is not supported on this processor.
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="processor_control.html">processor_control</a>,
+<a href="processor_start.html">processor_start</a>,
+<a href="processor_info.html">processor_info</a>,
+<a href="host_processors.html">host_processors</a>.