RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

cpukit: Correct rtems_chain_get_with_wait() doc.

Browse Source 
The Doxygen documentation for rtems_chain_get_with_wait() appears to be
incorrect based on a copy-paste from rtems_chain_get_with_notification().

Correct the documentation to describe the get and wait mechanism.
This commit is contained in:
Martin Erik Werner
2025-08-17 14:41:10 +02:00
committed by Kinsey Moore
parent 3e160df4aa
commit cec22d9b66
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
cpukit/include/rtems/chain.h
View File

@@ -138,8 +138,15 @@ rtems_status_code rtems_chain_get_with_notification(
);
/**
* @brief Gets the first @a node of the @a chain and sends the @a events to the
* @a task if the @a chain is empty afterwards.
* @brief Gets the first @a node from the @a chain with an @a events wait if
* empty.
*
* This routine gets the first @a node of the @a chain if it is available,
* otherwise it waits for the calling task to receive all @a events and then
* tries to get the first node again. The get and wait is retried indefinitely
* until either a node is available or the event receive times out.
*
* Each event receive starts a new timeout based on the value of @a timeout.
*
* @see rtems_chain_get() and rtems_event_receive().
*