[rtems-docs commit] c-user: rtems_rate_monotonic_get_status()

[Sebastian Huber]

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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Mon Oct 25 08:09:00 2021 +0200

c-user: rtems_rate_monotonic_get_status()

Mention that resetting the processor usage time of tasks has no impact
on the period status and statistics.

Remove no longer relevant RTEMS_NOT_DEFINED error status.

Close #4528.

---

 c-user/rate-monotonic/directives.rst | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/c-user/rate-monotonic/directives.rst b/c-user/rate-monotonic/directives.rst
index 2e48aac..b7374ff 100644
--- a/c-user/rate-monotonic/directives.rst
+++ b/c-user/rate-monotonic/directives.rst
@@ -366,6 +366,11 @@ length of the period.
 :c:macro:`RTEMS_TIMEOUT`
     The rate monotonic period has expired.
 
+.. rubric:: NOTES:
+
+Resetting the processor usage time of tasks has no impact on the period status
+and statistics.
+
 .. rubric:: CONSTRAINTS:
 
 The following constraints apply to this directive:
@@ -448,10 +453,6 @@ members of the period status object referenced by ``status``:
     The ``status`` parameter was `NULL
     <https://en.cppreference.com/w/c/types/NULL>`_.
 
-:c:macro:`RTEMS_NOT_DEFINED`
-    There was no status available due to a reset of the processor time usage of
-    the owner task of the period.
-
 .. rubric:: CONSTRAINTS:
 
 The following constraints apply to this directive: