[rtems-docs commit] c-user: Add & update ratemon get return values

[Sebastian Huber]

Module:    rtems-docs
Branch:    master
Commit:    2424590528e76508f78cfdca92a8e2e71d9ce5f9
Changeset: http://git.rtems.org/rtems-docs/commit/?id=2424590528e76508f78cfdca92a8e2e71d9ce5f9

Author:    Martin Erik Werner <martinerikwerner at gmail.com>
Date:      Sat Feb 29 00:52:43 2020 +0100

c-user: Add & update ratemon get return values

Add a description of the previously missing RTEMS_NOT_DEFINED return
value for rtems_rate_monotonic_get_status().

Update the RTEMS_SUCCESSFUL return value descriptions for
rtems_rate_monotonic_get_status() and
rtems_rate_monotonic_get_statistics() which incorrectly used the same
description as rtems_rate_monotonic_period().

---

 c-user/rate_monotonic_manager.rst | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/c-user/rate_monotonic_manager.rst b/c-user/rate_monotonic_manager.rst
index 1cc55fe..6152005 100644
--- a/c-user/rate_monotonic_manager.rst
+++ b/c-user/rate_monotonic_manager.rst
@@ -871,11 +871,14 @@ DIRECTIVE STATUS CODES:
      :class: rtems-table
 
      * - ``RTEMS_SUCCESSFUL``
-       - period initiated successfully
+       - period status retrieved successfully
      * - ``RTEMS_INVALID_ID``
        - invalid rate monotonic period id
      * - ``RTEMS_INVALID_ADDRESS``
        - invalid address of status
+     * - ``RTEMS_NOT_DEFINED``
+       - no status is available due to the cpu usage of the task having been
+         reset since the period initiated
 
 *DESCRIPTION:
     This directive returns status information associated with the rate
@@ -938,7 +941,7 @@ DIRECTIVE STATUS CODES:
      :class: rtems-table
 
      * - ``RTEMS_SUCCESSFUL``
-       - period initiated successfully
+       - period statistics retrieved successfully
      * - ``RTEMS_INVALID_ID``
        - invalid rate monotonic period id
      * - ``RTEMS_INVALID_ADDRESS``