[rtems commit] rtems: Fix message manager documentation

Sebastian Huber sebh at rtems.org
Thu Sep 16 07:34:33 UTC 2021


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

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

rtems: Fix message manager documentation

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

Update #4508.

---

 cpukit/include/rtems/rtems/message.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/cpukit/include/rtems/rtems/message.h b/cpukit/include/rtems/rtems/message.h
index 4b556c1..0a76b1f 100644
--- a/cpukit/include/rtems/rtems/message.h
+++ b/cpukit/include/rtems/rtems/message.h
@@ -861,8 +861,8 @@ rtems_status_code rtems_message_queue_get_number_pending(
  * @param id is the queue identifier.
  *
  * @param[out] count is the pointer to an uint32_t object.  When the directive
- *   call is successful, the number of unblocked tasks will be stored in this
- *   object.
+ *   call is successful, the number of pending messages removed from the queue
+ *   will be stored in this object.
  *
  * This directive removes all pending messages from the queue specified by
  * ``id``.  The number of messages removed is returned in ``count``.  If no



More information about the vc mailing list