poll: k_poll: Document -EINTR return

In case K_POLL_STATE_NOT_READY is set the return will be set to -EINTR
indicating that the poll was interrupted.

Fixes #5026

Signed-off-by: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
This commit is contained in:
Luiz Augusto von Dentz 2017-11-20 18:53:15 +02:00 committed by Anas Nashif
commit 8beb5862c5

View file

@ -3944,6 +3944,7 @@ extern void k_poll_event_init(struct k_poll_event *event, u32_t type,
*
* @retval 0 One or more events are ready.
* @retval -EAGAIN Waiting period timed out.
* @retval -EINTR Poller thread has been interrupted.
*/
extern int k_poll(struct k_poll_event *events, int num_events,