From 62d03a13245614e54279e8612e537c8d7859e458 Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Sun, 17 Jan 2016 07:54:30 +1100 Subject: Clean up config and init. --- shell/configuration_and_init.rst | 51 ++++++++++++++++++++-------------------- 1 file changed, 25 insertions(+), 26 deletions(-) (limited to 'shell/configuration_and_init.rst') diff --git a/shell/configuration_and_init.rst b/shell/configuration_and_init.rst index ab66c92..1d1f746 100644 --- a/shell/configuration_and_init.rst +++ b/shell/configuration_and_init.rst @@ -108,7 +108,7 @@ provided an alias for ``usercmd`` named ``userecho``. #define CONFIGURE_SHELL_MOUNT_MSDOS #include -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 describes that command. This command definition structure is registered into @@ -321,15 +321,15 @@ others - to indicate a failure condition This service creates a task with the specified characteristics to run the RTEMS Shell attached to the specified ``devname``. -.. note:: +**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. +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. +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 ----------------------------------------------------- @@ -342,8 +342,8 @@ rtems_shell_login_check - Default login check handler .. code:: c bool rtems_shell_login_check( - const char \*user, - const char \*passphrase + const char *user, + const char *passphrase ); **DIRECTIVE STATUS CODES:** @@ -356,26 +356,25 @@ rtems_shell_login_check - Default login check handler This function checks if the specified passphrase is valid for the specified user. -.. note:: +**NOTES:** - As a side-effect if the specified passphrase is valid for the specified - user, this function: +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, +- 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, +- 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 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 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. +- 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. -- cgit v1.2.3