This is an automated email from the ASF dual-hosted git repository. acassis pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit 5a6242aac8069c86241131e4e1772be242b97ba9 Author: wangchengdong <[email protected]> AuthorDate: Thu Oct 30 12:43:50 2025 +0800 Documentation: Remove nxevent_tickwait_wait() description Remove the nxevent_tickwait_wait() description from events.rst, since this API was removed during the event module refactoring. Signed-off-by: Chengdong Wang <[email protected]> --- Documentation/reference/os/events.rst | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/Documentation/reference/os/events.rst b/Documentation/reference/os/events.rst index fbec25e8b05..54ff08bd5f0 100644 --- a/Documentation/reference/os/events.rst +++ b/Documentation/reference/os/events.rst @@ -123,22 +123,6 @@ Notifier Chain Interfaces :param event: Address of the event object :param mask: Bit mask specifying which event flags should be cleared -.. c:function:: nxevent_mask_t nxevent_tickwait_wait(FAR nxevent_t *event, FAR nxevent_wait_t *wait, nxevent_mask_t events, nxevent_flags_t eflags, uint32_t delay); - - Wait for all of the specified events for the specified tick time. - - This routine is functionally identical to nxevent_tickwait, except that the wait object is explicitly provided by the user. - In nxevent_tickwait, the wait object is allocated as a temporary variable on the event-wait thread's stack, and the user has no visibility or control over it. - Because this object is accessed by both the event-wait thread and the event-post thread, such an arrangement may lead to safety concerns. - To address this, the new function allows the user to supply the wait object directly, providing greater control and improving safety. - - :param event: Address of the event object - :param wait: Address of the event wait object - :param events: Set of events to wait, 0 will indicate wait from any events - :param eflags: Events flags - :param delay: Ticks to wait from the start time until the event is posted, - If ticks is zero, then this function is equivalent to nxevent_trywait(). - .. c:function:: nxevent_mask_t nxevent_getmask(FAR nxevent_t *event) This function returns the event mask value of the current event object.
