summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-10-25 08:09:00 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-10-25 08:13:47 +0200
commitfeb46875584c05f0dbd005e4b4e7eaa1af414d88 (patch)
tree55d164efe28d8a9d28c6d38fa49fa9a07acd343c
parent46dbb6dd7f92ef60ea5ba74b1b0cd6865cad5619 (diff)
downloadrtems-docs-feb46875584c05f0dbd005e4b4e7eaa1af414d88.tar.bz2
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.
-rw-r--r--c-user/rate-monotonic/directives.rst9
1 files 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: