aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--libssh/channels.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/libssh/channels.c b/libssh/channels.c
index ed405892..923ba4a3 100644
--- a/libssh/channels.c
+++ b/libssh/channels.c
@@ -672,6 +672,9 @@ int channel_open_session(ssh_channel channel) {
*
* @param localport The source port (your local computer). It's facultative
* and for logging purpose.
+ * @warning This function does not bind the local port and does not automatically
+ * forward the content of a socket to the channel. You still have to
+ * use channel_read and channel_write for this.
*
* @return SSH_OK on success\n
* SSH_ERROR on error