options: Document that the caller needs to close the socket

Signed-off-by: Andreas Schneider <asn@cryptomilk.org>
Reviewed-by: Jakub Jelen <jjelen@redhat.com>
This commit is contained in:
Andreas Schneider
2022-04-19 16:22:41 +02:00
committed by Jakub Jelen
parent 4b20d7ad18
commit ca51565056
2 changed files with 9 additions and 3 deletions

View File

@@ -693,8 +693,13 @@ int ssh_get_openssh_version(ssh_session session)
/**
* @brief Disconnect from a session (client or server).
*
* The session can then be reused to open a new session.
*
* @note Note that this function wont close the socket if it was set with
* @ssh_options_set and SSH_OPTIONS_FD. You're responsible for closing the
* socket. This is new behavior in libssh 0.10.
*
* @param[in] session The SSH session to use.
*/
void