mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-20 11:40:18 +02:00
Code Activity

doc: Clarify the unit of the 'offset' argument of 'seek'.

Browse source 
Reported in <http://bugs.gnu.org/18520>
by David Kastrup <dak@gnu.org>.

* doc/ref/api-io.texi (Random Access): Clarify the unit of the 'offset'
  argument to 'seek'.
This commit is contained in:
Ludovic Courtès 2014-12-03 19:07:28 +01:00
parent 5fac1a7ada
commit 680135b6a3
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/ref/api-io.texi
View file

@ -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)