[rtems-docs commit] rtems: Fix message manager documentation

Sebastian Huber sebh at rtems.org
Thu Sep 16 07:37:32 UTC 2021


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Sep 15 11:55:52 2021 +0200

rtems: Fix message manager documentation

Correct the description of the ``count`` parameter of
rtems_message_queue_flush().

Close #4508.

---

 c-user/message/directives.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/c-user/message/directives.rst b/c-user/message/directives.rst
index 7317eb4..70a22d3 100644
--- a/c-user/message/directives.rst
+++ b/c-user/message/directives.rst
@@ -1014,8 +1014,8 @@ Flushes all messages on the queue.
 ``count``
     This parameter is the pointer to an `uint32_t
     <https://en.cppreference.com/w/c/types/integer>`_ object.  When the
-    directive call is successful, the number of unblocked tasks will be stored
-    in this object.
+    directive call is successful, the number of pending messages removed from
+    the queue will be stored in this object.
 
 .. rubric:: DESCRIPTION:
 



More information about the vc mailing list