summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2013-09-16 08:40:56 +0200
committerAndreas Schneider <asn@cryptomilk.org>2013-10-01 14:47:57 +0200
commit6f10422685fd839dd35d6b3d6657caf701d1fba2 (patch)
treeb8a819f66563eee7f97083f497a87921b979e461
parent44f851d2876fad4907cde1eec8ba6f4801de846e (diff)
channel: Document SSH_AGAIN in ssh_channel_read().
BUG: https://red.libssh.org/issues/115
-rw-r--r--src/channels.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/channels.c b/src/channels.c
index f5b71a0a..48ca81d5 100644
--- a/src/channels.c
+++ b/src/channels.c
@@ -2615,8 +2615,8 @@ static int ssh_channel_read_termination(void *s){
* @param[in] is_stderr A boolean value to mark reading from the stderr flow.
*
* @return The number of bytes read, 0 on end of file or SSH_ERROR
- * on error. Can return 0 if nothing is available in nonblocking
- * mode.
+ * on error. In nonblocking mode it Can return 0 if no data
+ * is available or SSH_AGAIN.
*
* @warning This function may return less than count bytes of data, and won't
* block until count bytes have been read.