summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2016-11-05 22:37:44 +0100
committerArtyom V. Poptsov <poptsov.artyom@gmail.com>2016-11-06 07:17:56 +0300
commit3eca9ea3b514e23c043c8b36fd9794881be8e23b (patch)
tree5293f3977472ae1e152b6fbb9f99bb22c2662f90 /doc
parentdoc: Add procedure index. (diff)
downloadguile-ssh-3eca9ea3b514e23c043c8b36fd9794881be8e23b.tar.gz
channel.scm: Remove trailing bang from 'channel-send-eof'.
This procedure merely does I/O without mutating its argument, so it does not deserve the trailing '!' (similar to Scheme's 'write', 'put-bytevector', etc. procedures). * libguile-ssh/channel-func.c (gssh_channel_send_eof_x): Rename to... (gssh_channel_send_eof): ... this. Change Scheme name to '%channel-send-eof'. Adjust caller. * modules/ssh/channel.scm (channel-send-eof!): Rename to... (channel-send-eof): ... this. * tests/client-server.scm ("channel-send-eof!"): Rename to... ("channel-send-eof"): ... this. Adjust accordingly. * doc/api-channels.texi (Channel Management): Adjust accordingly. Signed-off-by: Artyom V. Poptsov <poptsov.artyom@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api-channels.texi4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api-channels.texi b/doc/api-channels.texi
index e3231b0..97f1e49 100644
--- a/doc/api-channels.texi
+++ b/doc/api-channels.texi
@@ -132,7 +132,7 @@ Get the session to which belongs the @var{channel}. Throw
@code{guile-ssh-error} on an error. Return the session.
@end deffn
-@deffn {Scheme Procedure} channel-send-eof! channel
+@deffn {Scheme Procedure} channel-send-eof channel
Send an end of file (EOF) on the @var{channel}. This action doesn't close the
@var{channel}; you may still read from it but not write. Throw
@code{guile-ssh-error} on an error. Return value is undefined.
@@ -165,7 +165,7 @@ Example:
;; 'wc' reads data until EOF and writes its result
;; afterwards.
- (channel-send-eof! p)
+ (channel-send-eof p)
;; Read the 'wc' output.
(read-line p))