From 07f4d5e72357a24c79dedbd2a7a2a47a27c90c94 Mon Sep 17 00:00:00 2001 From: Jakub Jelen Date: Wed, 25 May 2022 15:33:31 +0200 Subject: [PATCH] Document poll failures Resolved: https://gitlab.com/libssh/libssh-mirror/-/issues/46 Signed-off-by: Jakub Jelen Reviewed-by: Andreas Schneider --- src/poll.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/poll.c b/src/poll.c index 55285555..19147698 100644 --- a/src/poll.c +++ b/src/poll.c @@ -964,11 +964,13 @@ int ssh_event_add_connector(ssh_event event, ssh_connector connector) } /** - * @brief Poll all the sockets and sessions associated through an event object.i + * @brief Poll all the sockets and sessions associated through an event object. * * If any of the events are set after the poll, the call back functions of the * sessions or sockets will be called. * This function should be called once within the programs main loop. + * In case of failure, the errno should be consulted to find more information + * about the failure set by underlying poll imlpementation. * * @param event The ssh_event object to poll. *