2008-10-15 Joel Sherrill <joel.sherrill@oarcorp.com>

	PR 1331/networking
	* libmisc/shell/shell.c, telnetd/check_passwd.c, telnetd/telnetd.c,
	telnetd/telnetd.h: Improve comments and explanation of options to
	rtems_telnetd_initialize. Add extra newline to login sequence from
	shell.

1 files changed, 18 insertions, 13 deletions

diff --git a/cpukit/telnetd/telnetd.h b/cpukit/telnetd/telnetd.h
index afebd20a16..db0ea94162 100644
--- a/cpukit/telnetd/telnetd.h
+++ b/cpukit/telnetd/telnetd.h
@@ -17,26 +17,31 @@
 extern "C" {
 #endif	
 
-/*
- *  Initialize the telnetd subsystem.
+/**
+ *  This method initializes the telnetd subsystem.
  *
- *  cmd              - function which is the "shell" telnetd invokes
- *  arg              - context pointer to cmd
- *  dontSpawn        - TRUE if telnetd takes over this task.
- *                     FALSE to create another task for the shell.
- *  stack            - stack size of spawned task 
- *  priority         - initial priority of spawned task
- *  askForPassword   - TRUE if telnetd asks for password
- *                     FALSE to invoke "cmd" with no password check.
- *                        This may be OK if "cmd" includes its own check.
+ *  @param[in] cmd is the function which is the "shell" telnetd invokes
+ *  @param[in] arg is the context pointer to cmd
+ *  @param[in] remainOnCallerSTDIO is set to TRUE if telnetd takes over the
+ *    standard in, out and error associated with task.  In this case,
+ *    it will be NOT be listening on any sockets.  When this parameters
+ *    is FALSE the telnetd will create other tasks for the shell
+ *    which listen on sockets.
+ *  @param[in] stack is stack size of spawned task.
+ *  @param[in] priority is the initial priority of spawned task(s).  If
+ *    this parameter is less than 2, then the default priority of 100 is used.
+ *  @param[in] askForPassword is set to TRUE if telnetd is to ask for a
+ *    password. This is set to FALSE to invoke "cmd" with no password check.
+ *    This may be OK if "cmd" includes its own check and indeed the RTEMS Shell
+ *    uses a login with a user name and password so this is the usual case.
  */
 int rtems_telnetd_initialize(
   void               (*cmd)(char *, void *),
   void                *arg,
-  int                  dontSpawn,
+  bool                 remainOnCallerSTDIO,
   size_t               stack,
   rtems_task_priority  priority,
-  int                  askForPassword
+  bool                 askForPassword
 );
 
 #ifdef __cplusplus