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

doc: Document optional parameter of 'stat'.

Browse source 
Fixes <https://bugs.gnu.org/34860>.
Reported by Tim Gesthuizen <tim.gesthuizen@yahoo.de>.

* doc/ref/posix.texi (File System): Document 'exception_on_error'
parameter of 'stat'.
This commit is contained in:
Ludovic Courtès 2019-06-30 17:26:43 +02:00
parent a152a67d38
commit 63f54a7bc6
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/ref/posix.texi
View file

@ -658,14 +658,20 @@ The GNU C Library Reference Manual}.
@end deffn @end deffn
@findex fstat @findex fstat
@deffn {Scheme Procedure} stat object @deffn {Scheme Procedure} stat object [exception-on-error?]
@deffnx {C Function} scm_stat (object) @deffnx {C Function} scm_stat (object, exception_on_error)
Return an object containing various information about the file Return an object containing various information about the file
determined by @var{object}. @var{object} can be a string containing determined by @var{object}. @var{object} can be a string containing
a file name or a port or integer file descriptor which is open a file name or a port or integer file descriptor which is open
on a file (in which case @code{fstat} is used as the underlying on a file (in which case @code{fstat} is used as the underlying
system call). system call).
If the optional @var{exception_on_error} argument is true, which
is the default, an exception will be raised if the underlying
system call returns an error, for example if the file is not
found or is not readable. Otherwise, an error will cause
@code{stat} to return @code{#f}.
The object returned by @code{stat} can be passed as a single The object returned by @code{stat} can be passed as a single
parameter to the following procedures, all of which return parameter to the following procedures, all of which return
integers: integers: