doc UPDATE note socket closure in nc_accept_ssh_session()

Ilyes Ben Hamouda · michalvasko · commit 147b9a1d6a67 · 2025-10-06T14:57:38.000+02:00
Update nc_accept_ssh_session() documentation to highlight
that the socket is closed if is not set to the SSH session.

Signed-off-by: Ilyes Ben Hamouda &lt;ilyes.ben_hamouda@6wind.com&gt;
diff --git a/src/session_p.h b/src/session_p.h
@@ -1274,7 +1274,7 @@ struct nc_session *nc_accept_callhome_ssh_sock(int sock, const char *host, uint1
  * @brief Establish SSH transport on a socket.
  *
  * @param[in] session Session structure of the new connection.
- * @param[in] sock Socket of the new connection.
+ * @param[in] sock Socket of the new connection, closed if not set to the session.
  * @param[in] timeout Transport operations timeout in msec (not SSH authentication one).
  * @return 1 on success, 0 on timeout, -1 on error.
  */

Original file line number	Diff line number	Diff line change
`@@ -1274,7 +1274,7 @@ struct nc_session nc_accept_callhome_ssh_sock(int sock, const char host, uint1`
`1274`	`1274`	`* @brief Establish SSH transport on a socket.`
`1275`	`1275`	`*`
`1276`	`1276`	`* @param[in] session Session structure of the new connection.`
`1277`		`- * @param[in] sock Socket of the new connection.`
	`1277`	`+ * @param[in] sock Socket of the new connection, closed if not set to the session.`
`1278`	`1278`	`* @param[in] timeout Transport operations timeout in msec (not SSH authentication one).`
`1279`	`1279`	`* @return 1 on success, 0 on timeout, -1 on error.`
`1280`	`1280`	`*/`