From cec22d9b6677246cdc8267a71d41b06defed2470 Mon Sep 17 00:00:00 2001 From: Martin Erik Werner Date: Sun, 17 Aug 2025 14:41:10 +0200 Subject: [PATCH] cpukit: Correct rtems_chain_get_with_wait() doc. 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. --- cpukit/include/rtems/chain.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/cpukit/include/rtems/chain.h b/cpukit/include/rtems/chain.h index 4f9f9495d5..6f36a16535 100644 --- a/cpukit/include/rtems/chain.h +++ b/cpukit/include/rtems/chain.h @@ -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(). *