[rtems commit] rtems: rtems_rate_monotonic_get_status()

[Sebastian Huber]

Module:    rtems
Branch:    master
Commit:    24922d0f54eb6cff02428dc9176fc7b67e6ac9bc
Changeset: http://git.rtems.org/rtems/commit/?id=24922d0f54eb6cff02428dc9176fc7b67e6ac9bc

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

rtems: 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.

Update #4528.

---

 cpukit/include/rtems/rtems/ratemon.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h
index 8823d72..7c789a2 100644
--- a/cpukit/include/rtems/rtems/ratemon.h
+++ b/cpukit/include/rtems/rtems/ratemon.h
@@ -445,6 +445,10 @@ rtems_status_code rtems_rate_monotonic_delete( rtems_id id );
  *
  * @retval ::RTEMS_TIMEOUT The rate monotonic period has expired.
  *
+ * @par Notes
+ * Resetting the processor usage time of tasks has no impact on the period
+ * status and statistics.
+ *
  * @par Constraints
  * @parblock
  * The following constraints apply to this directive:
@@ -502,9 +506,6 @@ rtems_status_code rtems_rate_monotonic_period(
  *
  * @retval ::RTEMS_INVALID_ADDRESS The ``status`` parameter was NULL.
  *
- * @retval ::RTEMS_NOT_DEFINED There was no status available due to a reset of
- *   the processor time usage of the owner task of the period.
- *
  * @par Constraints
  * @parblock
  * The following constraints apply to this directive: