aboutsummaryrefslogtreecommitdiff
path: root/libssh
diff options
context:
space:
mode:
authorAris Adamantiadis <aris@0xbadc0de.be>2009-09-14 23:18:07 +0200
committerAris Adamantiadis <aris@0xbadc0de.be>2009-09-14 23:18:07 +0200
commitffca268bee7be749eab6643348ce58584abfca5b (patch)
treef8c8560e96446e08992105bc6fe37735c4cba237 /libssh
parentf28352707ab8aa7e1717cea53e4cdcf46f1dc156 (diff)
downloadlibssh-ffca268bee7be749eab6643348ce58584abfca5b.tar.gz
libssh-ffca268bee7be749eab6643348ce58584abfca5b.tar.xz
libssh-ffca268bee7be749eab6643348ce58584abfca5b.zip
Add warning in channel_open_forward documentation
Tell users it does not do magic (yet)
Diffstat (limited to 'libssh')
-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