summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWade A Smith <warm38@juno.com>1998-08-11 22:50:07 +0000
committerWade A Smith <warm38@juno.com>1998-08-11 22:50:07 +0000
commitb032c170af58f28934d5c1128c7a3f10bd363508 (patch)
treee71258b4a4f06c61eacbfd026f178ccc76900eea
parentUpdated the description section for the dump_setpath routine. (diff)
downloadrtems-b032c170af58f28934d5c1128c7a3f10bd363508.tar.bz2
Updated the description section of the admin_shutdown routine.
-rw-r--r--doc/new_chapters/adminiface.t15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/new_chapters/adminiface.t b/doc/new_chapters/adminiface.t
index 32d327a318..83f8c539ee 100644
--- a/doc/new_chapters/adminiface.t
+++ b/doc/new_chapters/adminiface.t
@@ -62,7 +62,20 @@ system.
@subheading DESCRIPTION:
-The @code{admin_shutdown} function restarts the system.
+
+If {_POSIX_ADMIN} is defined:
+
+ The @code{admin_shutdown} function restarts the system. The
+ @code{args} argument specifies alternate or optional behavior
+ for the @code{admin_shutdown} function. The @code{admin_type}
+ member of each element of the @code{args} array specifies the
+ optional behavior to be performed. There are som @code{admin_types}
+ values that may provoke unspecified behavior. The @code[nargs}
+ argument specifies the length of the @code{args} array.
+
+Otherwise:
+
+ The @code{admin_shutdown} function shall fail.
@subheading NOTES: