civodul pushed a commit to branch stable-2.0
in repository guile.
commit 680135b6a363fddfe331e749f2bb3fdb44c76524
Author: Ludovic Courtès <l...@gnu.org>
Date: Wed Dec 3 19:07:28 2014 +0100
doc: Clarify the unit of the 'offset' argument of 'seek'.
Reported in <http://bugs.gnu.org/18520>
by David Kastrup <d...@gnu.org>.
* doc/ref/api-io.texi (Random Access): Clarify the unit of the 'offset'
argument to 'seek'.
---
doc/ref/api-io.texi | 10 +++++++---
1 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/doc/ref/api-io.texi b/doc/ref/api-io.texi
index 02d92a2..8331378 100644
--- a/doc/ref/api-io.texi
+++ b/doc/ref/api-io.texi
@@ -443,8 +443,12 @@ open.
@deffn {Scheme Procedure} seek fd_port offset whence
@deffnx {C Function} scm_seek (fd_port, offset, whence)
Sets the current position of @var{fd_port} to the integer
-@var{offset}, which is interpreted according to the value of
-@var{whence}.
+@var{offset}. For a file port, @var{offset} is expressed
+as a number of bytes; for other types of ports, such as string
+ports, @var{offset} is an abstract representation of the
+position within the port's data, not necessarily expressed
+as a number of bytes. @var{offset} is interpreted according to
+the value of @var{whence}.
One of the following variables should be supplied for
@var{whence}:
@@ -460,7 +464,7 @@ Seek from the end of the file.
If @var{fd_port} is a file descriptor, the underlying system
call is @code{lseek}. @var{port} may be a string port.
-The value returned is the new position in the file. This means
+The value returned is the new position in @var{fd_port}. This means
that the current position of a port can be obtained using:
@lisp
(seek port 0 SEEK_CUR)
