xnu-2422.1.72.tar.gz

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

diff --git a/osfmk/man/bootstrap_completed.html b/osfmk/man/bootstrap_completed.html
old mode 100755 (executable)
new mode 100644 (file)
index 74da3ed..9982136
--- a/osfmk/man/bootstrap_completed.html
+++ b/osfmk/man/bootstrap_completed.html
@@ -1 +1,59 @@
-<h2>bootstrap_completed</h2>\r<hr>\r<p>\r<strong>Server Interface</strong> - Inform bootstrap server that\rinitialization is complete.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   bootstrap_completed</strong>\r                <strong>(mach_port_t</strong>                     <var>bootstrap_port</var>,\r                 <strong>task_t</strong>                                    <var>task</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>bootstrap_port</var> \r<dd>\rThe port representing the calling task's bootstrap server.\r<p>\r<dt> <var>task</var> \r<dd>\rThis parameter represents the calling task.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThis interface allows a given server task to inform the bootstrap\rserver that it is fully initialized and ready to handle requests.\rUpon receiving such notification, the bootstrap server can initialize\rany additional servers that may require services provided by the\rpreviously initialized server.\r<p>\rNote the following:  not all servers that may be invoked by the bootstrap server\rsend this message upon startup.  If the bootstrap server is told to\rwait for this message before spawning further servers (via setting a\rflag in the <strong>bootstrap.conf</strong> file) and the server just invoked never\rsends this message, the bootstrap server will wait forever.\r<h3>NOTES</h3>\r<p>\rCurrently, this interface is used exclusively by the default\rpager server so that the bootstrap server can defer initializing the\rOS server until the default pager is in place.  (In small memory\rconfigurations, an OS server may not be able to initialize\rsuccessfully unless the default pager is ready to handle paging\rrequests.)\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>KERN_SUCCESS</strong>\r<dd>\rThe bootstrap server has updated the calling server's state with\rrespect to bootstrap completion.\r<p>\r<dt> <strong>KERN_INVALID_ARGUMENT</strong>\r<dd>\rThe bootstrap server does not recognize the calling server (the task\rspecified by the <var>task</var> parameter).\r</dl>  \r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r
\ No newline at end of file
+<h2>bootstrap_completed</h2>
+<hr>
+<p>
+<strong>Server Interface</strong> - Inform bootstrap server that
+initialization is complete.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   bootstrap_completed</strong>
+                <strong>(mach_port_t</strong>                     <var>bootstrap_port</var>,
+                 <strong>task_t</strong>                                    <var>task</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>bootstrap_port</var> 
+<dd>
+The port representing the calling task's bootstrap server.
+<p>
+<dt> <var>task</var> 
+<dd>
+This parameter represents the calling task.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+This interface allows a given server task to inform the bootstrap
+server that it is fully initialized and ready to handle requests.
+Upon receiving such notification, the bootstrap server can initialize
+any additional servers that may require services provided by the
+previously initialized server.
+<p>
+Note the following:  not all servers that may be invoked by the bootstrap server
+send this message upon startup.  If the bootstrap server is told to
+wait for this message before spawning further servers (via setting a
+flag in the <strong>bootstrap.conf</strong> file) and the server just invoked never
+sends this message, the bootstrap server will wait forever.
+<h3>NOTES</h3>
+<p>
+Currently, this interface is used exclusively by the default
+pager server so that the bootstrap server can defer initializing the
+OS server until the default pager is in place.  (In small memory
+configurations, an OS server may not be able to initialize
+successfully unless the default pager is ready to handle paging
+requests.)
+<h3>RETURN VALUES</h3>
+<dl>
+<p>
+<dt> <strong>KERN_SUCCESS</strong>
+<dd>
+The bootstrap server has updated the calling server's state with
+respect to bootstrap completion.
+<p>
+<dt> <strong>KERN_INVALID_ARGUMENT</strong>
+<dd>
+The bootstrap server does not recognize the calling server (the task
+specified by the <var>task</var> parameter).
+</dl>  
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions: