RTEMS | chain: Fix documentation mismatch in rtems_chain_is_node_off_chain (fixes #4812) (!870)
Asif Khan (@Asif-2006)
gitlab at rtems.org
Wed Dec 10 15:57:41 UTC 2025
Asif Khan created a merge request: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/870
Project:Branches: Asif-2006/rtems:fix-4812-doc to rtems/rtos/rtems:main
Author: Asif Khan
## Summary
This merge request updates the documentation of\
`rtems_chain_is_node_off_chain()` to accurately reflect the actual behavior of the implementation.
The current comment states that a node is considered _off-chain_ when **both `next` and `previous` pointers are NULL**, but the implementation checks only whether the **`next` pointer is NULL** via `_Chain_Is_node_off_chain()`.
This MR updates the description to resolve this mismatch, clarifying that:
* A node is regarded as off chain when its `next` pointer is NULL.
* The `previous` pointer is not required to be NULL for this detection.
This change addresses **Issue #4812** and improves correctness and consistency of the documentation.
<!--Default settings, if it is a dropdown it will set after submission-->
--
View it on GitLab: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/870
You're receiving this email because of your account on gitlab.rtems.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20251210/1e4ef26e/attachment.htm>
More information about the bugs
mailing list