RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

Documented the admin_shutdown function

Browse Source
This commit is contained in:
Wade A Smith
1998-08-10 14:54:01 +00:00
parent ebc67925f5
commit b044905b12
1 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
doc/new_chapters/adminiface.t
View File

@@ -16,7 +16,7 @@ administration interface manager is ...
The directives provided by the administration interface manager are: The directives provided by the administration interface manager are:
@itemize @bullet @itemize @bullet
@item @code{admin_shutdown} - @item @code{admin_shutdown} - Shutdown the system
@end itemize @end itemize
@section Background @section Background
@@ -31,13 +31,15 @@ and describes the calling sequence, related constants, usage,
and status codes. and status codes.
@page @page
@subsection admin_shutdown - @subsection admin_shutdown - Shutdown the system
@subheading CALLING SEQUENCE: @subheading CALLING SEQUENCE:
@ifset is-C @ifset is-C
@example @example
int admin_shutdown( int admin_shutdown(
struct admin_args_ *args[],
size_t nargs
); );
@end example @end example
@end ifset @end ifset
@@ -48,12 +50,19 @@ int admin_shutdown(
@subheading STATUS CODES: @subheading STATUS CODES:
@table @b @table @b
@item E @item EINVAL
The An invalid argument was passed to the function call.
@item ENOSYS
The function admin_shutdown() is not supported by this implementation.
@item EPERM
The caller does not have appropriate permission for shutting down the
system.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
The @code{admin_shutdown} function restarts the system.
@subheading NOTES: @subheading NOTES: