Changeset 62d03a1 in rtems-docs

Timestamp:

01/16/16 20:54:30 (8 years ago)

Author:

Chris Johns <chrisj@…>

Branches:

4.11, 5, master

Children:

75a59fd

Parents:

8ca13ed

git-author:

Chris Johns <chrisj@…> (01/16/16 20:54:30)

git-committer:

Amar Takhar <verm@…> (05/03/16 00:51:22)

Message:

Clean up config and init.

File:

• shell/configuration_and_init.rst (modified) (4 diffs)

shell/configuration_and_init.rst

@@ -109 +109 @@
     #include <rtems/shellconfig.h>
 
-Notice in the above example, that the user wrote the*main* for their command
+Notice in the above example, that the user wrote the *main* for their command
 (e.g. ``main_usercmd``) which looks much like any other ``main()``.  They then
 defined a ``rtems_shell_cmd_t`` structure named ``Shell_USERCMD_Command`` which
@@ -322 +322 @@
 Shell attached to the specified ``devname``.
 
-.. note::
-
-    This method invokes the ``rtems_task_create`` and ``rtems_task_start``
-    directives and as such may return any status code that those directives may
-    return.
-
-    There is one POSIX key necessary for all shell instances together and one
-    POSIX key value pair per instance. You should make sure that your RTEMS
-    configuration accounts for these resources.
+**NOTES:**
+
+This method invokes the ``rtems_task_create`` and ``rtems_task_start``
+directives and as such may return any status code that those directives may
+return.
+
+There is one POSIX key necessary for all shell instances together and one POSIX
+key value pair per instance. You should make sure that your RTEMS configuration
+accounts for these resources.
 
 rtems_shell_login_check - Default login check handler
@@ -343 +343 @@
 
     bool rtems_shell_login_check(
-      const char \*user,
-      const char \*passphrase
+      const char *user,
+      const char *passphrase
     );
 
@@ -357 +357 @@
 user.
 
-.. note::
-
-    As a side-effect if the specified passphrase is valid for the specified
-    user, this function:
-
-    - performs a filesystem change root operation to the directory of the
-      specified user if the directory path is non-empty,
-
-    - changes the owner of the current shell device to the UID of the specified
-      user,
-
-    - sets the real and effective UID of the current user environment to the
-      UID of the specified user,
-
-    - sets the real and effective GID of the current user environment to the
-      GID of the specified user, and
-
-    - sets the supplementary group IDs of the current user environment to the
-      supplementary group IDs of the specified user.
-
-    In case the filesystem change root operation fails, then the environment
-    setup is aborted and ``false`` is returned.
-
+**NOTES:**
+
+As a side-effect if the specified passphrase is valid for the specified user,
+this function:
+
+- performs a filesystem change root operation to the directory of the specified
+  user if the directory path is non-empty,
+
+- changes the owner of the current shell device to the UID of the specified
+  user,
+
+- sets the real and effective UID of the current user environment to the UID of
+  the specified user,
+
+- sets the real and effective GID of the current user environment to the GID of
+  the specified user, and
+
+- sets the supplementary group IDs of the current user environment to the
+  supplementary group IDs of the specified user.
+
+In case the filesystem change root operation fails, then the environment setup
+is aborted and ``false`` is returned.