summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorBernhard R. Link <brlink@debian.org>2011-02-18 17:50:50 +0100
committerAndreas Schneider <asn@cryptomilk.org>2011-02-18 18:01:45 +0100
commiteca8b5386899ca7c065867c313bf459dc0647f13 (patch)
treefd8b7920492f1da85b20b9561978ee92f86ab2fa /src
parentb8767be373242917dcb78654fdd2e97acf1dbee1 (diff)
downloadlibssh-eca8b5386899ca7c065867c313bf459dc0647f13.tar.gz
libssh-eca8b5386899ca7c065867c313bf459dc0647f13.tar.xz
libssh-eca8b5386899ca7c065867c313bf459dc0647f13.zip
channel: Improve ssh_channel_open_reverse_forward documentation.
(cherry picked from commit 23b3c46fd60201147c8a40d4dae5fe86f36bfd86)
Diffstat (limited to 'src')
-rw-r--r--src/channels.c9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/channels.c b/src/channels.c
index 34ce069c..e0f505c1 100644
--- a/src/channels.c
+++ b/src/channels.c
@@ -889,11 +889,12 @@ int ssh_channel_open_session(ssh_channel channel) {
*
* @param[in] remoteport The remote port.
*
- * @param[in] sourcehost The source host (your local computer). It's optional
- * and for logging purpose.
+ * @param[in] sourcehost The numeric IP address of the machine from where the
+ * connection request originates. This is mostly for
+ * logging purposes.
*
- * @param[in] localport The source port (your local computer). It's optional
- * and for logging purpose.
+ * @param[in] localport The port on the host from where the connection
+ * originated. This is mostly for logging purposes.
*
* @return SSH_OK on success, SSH_ERROR if an error occured.
*