aboutsummaryrefslogtreecommitdiff
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 17:50:50 +0100
commit23b3c46fd60201147c8a40d4dae5fe86f36bfd86 (patch)
tree337a4661a30835008d87b9f6a0a28ea1a0292215 /src
parent8a83990c1603a051e74d5aa7a60445a7ef5021e4 (diff)
downloadlibssh-23b3c46fd60201147c8a40d4dae5fe86f36bfd86.tar.gz
libssh-23b3c46fd60201147c8a40d4dae5fe86f36bfd86.tar.xz
libssh-23b3c46fd60201147c8a40d4dae5fe86f36bfd86.zip
channel: Improve ssh_channel_open_reverse_forward documentation.
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 19f33dfe..a8aaa5e7 100644
--- a/src/channels.c
+++ b/src/channels.c
@@ -897,11 +897,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.
*