summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2014-04-09 15:01:25 +0200
committerAndreas Schneider <asn@cryptomilk.org>2014-04-22 09:09:57 +0200
commit7b133cf9f5be6b04e1d4fe690a8523e04a9289d0 (patch)
tree806c625431f407379ddd11aeaa16a2abd132aab7 /src
parent9b59f1a222e402a1127aeadb3f0607754321d785 (diff)
doc: Improve docs for ssh_channel_get_exit_status().
BUG: https://red.libssh.org/issues/154 (cherry picked from commit adf23533e02d997118d1732f91abf9f116a47cec)
Diffstat (limited to 'src')
-rw-r--r--src/channels.c5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/channels.c b/src/channels.c
index eca1a37b..ced9697a 100644
--- a/src/channels.c
+++ b/src/channels.c
@@ -3024,6 +3024,11 @@ static int ssh_channel_exit_status_termination(void *c){
* (yet).
* @warning This function may block until a timeout (or never)
* if the other side is not willing to close the channel.
+ *
+ * If you're looking for an async handling of this register a callback for the
+ * exit status.
+ *
+ * @see ssh_channel_exit_status_callback
*/
int ssh_channel_get_exit_status(ssh_channel channel) {
int rc;