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>

src/client.c

@@ -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

src/options.c

@@ -265,9 +265,10 @@ int ssh_options_set_algo(ssh_session session,
  *                The file descriptor to use (socket_t).\n
  *                \n
  *                If you wish to open the socket yourself for a reason
- *                or another, set the file descriptor. Don't forget to
- *                set the hostname as the hostname is used as a key in
- *                the known_host mechanism.
+ *                or another, set the file descriptor and take care of closing
+ *                it (this is new behavior in libssh 0.10).
+ *                Don't forget to set the hostname as the hostname is used
+ *                as a key in the known_host mechanism.
  *
  *              - SSH_OPTIONS_BINDADDR:
  *                The address to bind the client to (const char *).