Changeset 62d03a1 in rtems-docs


Ignore:
Timestamp:
Jan 16, 2016, 8:54:30 PM (4 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, 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:
1 edited

Legend:

Unmodified
Added
Removed
  • shell/configuration_and_init.rst

    r8ca13ed r62d03a1  
    109109    #include <rtems/shellconfig.h>
    110110
    111 Notice in the above example, that the user wrote the*main* for their command
     111Notice in the above example, that the user wrote the *main* for their command
    112112(e.g. ``main_usercmd``) which looks much like any other ``main()``.  They then
    113113defined a ``rtems_shell_cmd_t`` structure named ``Shell_USERCMD_Command`` which
     
    322322Shell attached to the specified ``devname``.
    323323
    324 .. note::
    325 
    326     This method invokes the ``rtems_task_create`` and ``rtems_task_start``
    327     directives and as such may return any status code that those directives may
    328     return.
    329 
    330     There is one POSIX key necessary for all shell instances together and one
    331     POSIX key value pair per instance. You should make sure that your RTEMS
    332     configuration accounts for these resources.
     324**NOTES:**
     325
     326This method invokes the ``rtems_task_create`` and ``rtems_task_start``
     327directives and as such may return any status code that those directives may
     328return.
     329
     330There is one POSIX key necessary for all shell instances together and one POSIX
     331key value pair per instance. You should make sure that your RTEMS configuration
     332accounts for these resources.
    333333
    334334rtems_shell_login_check - Default login check handler
     
    343343
    344344    bool rtems_shell_login_check(
    345       const char \*user,
    346       const char \*passphrase
     345      const char *user,
     346      const char *passphrase
    347347    );
    348348
     
    357357user.
    358358
    359 .. note::
    360 
    361     As a side-effect if the specified passphrase is valid for the specified
    362     user, this function:
    363 
    364     - performs a filesystem change root operation to the directory of the
    365       specified user if the directory path is non-empty,
    366 
    367     - changes the owner of the current shell device to the UID of the specified
    368       user,
    369 
    370     - sets the real and effective UID of the current user environment to the
    371       UID of the specified user,
    372 
    373     - sets the real and effective GID of the current user environment to the
    374       GID of the specified user, and
    375 
    376     - sets the supplementary group IDs of the current user environment to the
    377       supplementary group IDs of the specified user.
    378 
    379     In case the filesystem change root operation fails, then the environment
    380     setup is aborted and ``false`` is returned.
    381 
     359**NOTES:**
     360
     361As a side-effect if the specified passphrase is valid for the specified user,
     362this function:
     363
     364- performs a filesystem change root operation to the directory of the specified
     365  user if the directory path is non-empty,
     366
     367- changes the owner of the current shell device to the UID of the specified
     368  user,
     369
     370- sets the real and effective UID of the current user environment to the UID of
     371  the specified user,
     372
     373- sets the real and effective GID of the current user environment to the GID of
     374  the specified user, and
     375
     376- sets the supplementary group IDs of the current user environment to the
     377  supplementary group IDs of the specified user.
     378
     379In case the filesystem change root operation fails, then the environment setup
     380is aborted and ``false`` is returned.
Note: See TracChangeset for help on using the changeset viewer.