From 773bd98c73cf6e2ab486c404928477b76bd125f0 Mon Sep 17 00:00:00 2001 From: "Peter A. Bigot" Date: Tue, 30 Apr 2019 07:06:39 -0500 Subject: [PATCH] doc: clarify behavior of k_poll_signal_raise on error k_poll_signal_raise() returns an error code to indicate that the raise was too late to notify an expiring poll. Make clear that this does not mean that the signal was lost: a subsequent poll will find it and expire immediately. Signed-off-by: Peter A. Bigot --- include/kernel.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/kernel.h b/include/kernel.h index 425024d6329..ac0ba8f6676 100644 --- a/include/kernel.h +++ b/include/kernel.h @@ -4429,6 +4429,10 @@ __syscall void k_poll_signal_check(struct k_poll_signal *signal, * passed again to k_poll() or k_poll() will consider it being signaled, and * will return immediately. * + * @note The result is stored and the 'signaled' field is set even if + * this function returns an error indicating that an expiring poll was + * not notified. The next k_poll() will detect the missed raise. + * * @param signal A poll signal. * @param result The value to store in the result field of the signal. *