From bac3d6df3562c814e5892f63225b94e2fedd4684 Mon Sep 17 00:00:00 2001
From: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Mon, 17 Nov 2014 15:42:57 +0100
Subject: shell: Rename HALT to SHUTDOWN command

Use a normal command for shutdown via exit().
---
 doc/shell/rtems.t | 37 +++++++++++++------------------------
 1 file changed, 13 insertions(+), 24 deletions(-)

(limited to 'doc/shell/rtems.t')

diff --git a/doc/shell/rtems.t b/doc/shell/rtems.t
index 06618693a7..5ebead3e4e 100644
--- a/doc/shell/rtems.t
+++ b/doc/shell/rtems.t
@@ -11,7 +11,7 @@ The RTEMS shell has the following rtems commands:
 
 @itemize @bullet
 
-@item @code{halt} - Shutdown the system
+@item @code{shutdown} - Shutdown the system
 @item @code{cpuuse} - print or reset per thread cpu usage
 @item @code{stackuse} - print per thread stack usage
 @item @code{perioduse} - print or reset per period usage
@@ -42,14 +42,14 @@ command as well as providing an example usage.
 @c
 @c
 @page
-@subsection halt - Shutdown the system
+@subsection shutdown - Shutdown the system
 
-@pgindex halt
+@pgindex shutdown
 
 @subheading SYNOPSYS:
 
 @example
-halt
+shutdown
 @end example
 
 @subheading DESCRIPTION:
@@ -65,10 +65,11 @@ This command does not return.
 
 @subheading EXAMPLES:
 
-The following is an example of how to use @code{halt}:
+The following is an example of how to use @code{shutdown}:
 
 @example
-SHLL [/] $ halt
+SHLL [/] $ shutdown
+System shutting down at user request
 @end example
 
 The user will not see another prompt and the system will 
@@ -76,37 +77,25 @@ shutdown.
 
 @subheading CONFIGURATION:
 
-@findex CONFIGURE_SHELL_NO_COMMAND_HALT
-@findex CONFIGURE_SHELL_COMMAND_HALT
+@findex CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN
+@findex CONFIGURE_SHELL_COMMAND_SHUTDOWN
 
 This command is included in the default shell command set.  
 When building a custom command set, define
-@code{CONFIGURE_SHELL_COMMAND_HALT} to have this
+@code{CONFIGURE_SHELL_COMMAND_SHUTDOWN} to have this
 command included.
 
 This command can be excluded from the shell command set by
-defining @code{CONFIGURE_SHELL_NO_COMMAND_HALT} when all
+defining @code{CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN} when all
 shell commands have been configured.
 
 @subheading PROGRAMMING INFORMATION:
 
-@findex rtems_shell_rtems_main_halt
-
-The @code{halt} is implemented by a C language function
-which has the following prototype:
-
-@example
-int rtems_shell_rtems_main_halt(
-  int    argc,
-  char **argv
-);
-@end example
-
-The configuration structure for the @code{halt} has the
+The configuration structure for the @code{shutdown} has the
 following prototype:
 
 @example
-extern rtems_shell_cmd_t rtems_shell_HALT_Command;
+extern rtems_shell_cmd_t rtems_shell_SHUTDOWN_Command;
 @end example
 
 @c
-- 
cgit v1.2.3