[rtems-central commit] spec: Fix message manager documentation

Sebastian Huber sebh at rtems.org
Wed Sep 15 06:02:36 UTC 2021


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Sep 14 17:40:40 2021 +0200

spec: Fix message manager documentation

Remove bogus return status from rtems_message_queue_receive().  Clarify
rtems_message_queue_flush().

---

 spec/rtems/message/if/flush.yml   | 12 ++++++++----
 spec/rtems/message/if/receive.yml |  4 ----
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/spec/rtems/message/if/flush.yml b/spec/rtems/message/if/flush.yml
index a3a5d11..d15e513 100644
--- a/spec/rtems/message/if/flush.yml
+++ b/spec/rtems/message/if/flush.yml
@@ -28,13 +28,17 @@ links:
 - role: interface-ingroup
   uid: group
 - role: constraint
-  uid: /constraint/directive-ctx-task
-- role: constraint
   uid: /constraint/directive-ctx-isr
 - role: constraint
-  uid: /constraint/directive-remote
+  uid: /constraint/directive-ctx-devinit
+- role: constraint
+  uid: /constraint/directive-ctx-task
+- role: constraint
+  uid: /constraint/directive-no-preempt
 name: rtems_message_queue_flush
-notes: null
+notes: |
+  The directive does not flush tasks waiting to receive a message from the
+  ${/glossary/waitqueue:/term} of the message queue.
 params:
 - description: |
     is the queue identifier.
diff --git a/spec/rtems/message/if/receive.yml b/spec/rtems/message/if/receive.yml
index 57e4d12..e878b30 100644
--- a/spec/rtems/message/if/receive.yml
+++ b/spec/rtems/message/if/receive.yml
@@ -132,10 +132,6 @@ return:
       The queue was empty.
     value: ${../../status/if/unsatisfied:/name}
   - description: |
-      The queue was flushed while the calling task was waiting to receive a
-      message.
-    value: ${../../status/if/unsatisfied:/name}
-  - description: |
       The timeout happened while the calling task was waiting to receive a
       message
     value: ${../../status/if/timeout:/name}



More information about the vc mailing list