poll: Document errno will be set for ssh_event_dopoll()

Signed-off-by: Andreas Schneider <asn@cryptomilk.org>
Reviewed-by: Jakub Jelen <jjelen@redhat.com>
This commit is contained in:
Andreas Schneider 2022-05-23 11:11:18 +02:00 committed by Jakub Jelen
parent b34f8e6efa
commit 63e09908f1

View File

@ -979,7 +979,8 @@ int ssh_event_add_connector(ssh_event event, ssh_connector connector)
* means an infinite timeout. This parameter is passed to
* the poll() function.
* @returns SSH_OK on success.
* SSH_ERROR Error happened during the poll.
* SSH_ERROR Error happened during the poll. Check errno to get more
* details about why it failed.
* SSH_AGAIN Timeout occured
*/
int ssh_event_dopoll(ssh_event event, int timeout)