diff options
| author | Jon Simons <jon@jonsimons.org> | 2014-01-28 20:42:59 -0800 |
|---|---|---|
| committer | Andreas Schneider <asn@cryptomilk.org> | 2014-02-02 22:19:46 +0100 |
| commit | f7b61bf5572531664146c12a10a419d4176c4a6c (patch) | |
| tree | f920e498d49726e09e3a39ef5fa923677c7307e7 /src | |
| parent | adf4d4f14748b6373e3b490f6b5216378801e7e7 (diff) | |
doc: correct ssh_channel_read_timeout units
Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
Diffstat (limited to 'src')
| -rw-r--r-- | src/channels.c | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/channels.c b/src/channels.c index 6974301d..b6f59f5f 100644 --- a/src/channels.c +++ b/src/channels.c @@ -2747,16 +2747,16 @@ int ssh_channel_read(ssh_channel channel, void *dest, uint32_t count, int is_std /** * @brief Reads data from a channel. * - * @param[in] channel The channel to read from. + * @param[in] channel The channel to read from. * - * @param[in] dest The destination buffer which will get the data. + * @param[in] dest The destination buffer which will get the data. * - * @param[in] count The count of bytes to be read. + * @param[in] count The count of bytes to be read. * - * @param[in] is_stderr A boolean value to mark reading from the stderr flow. + * @param[in] is_stderr A boolean value to mark reading from the stderr flow. * - * @param[in] timeout A timeout in seconds. A value of -1 means infinite - * timeout. + * @param[in] timeout_ms A timeout in milliseconds. A value of -1 means + * infinite timeout. * * @return The number of bytes read, 0 on end of file or SSH_ERROR * on error. In nonblocking mode it Can return 0 if no data |