diff options
| author | Ludovic Courtès <ludo@gnu.org> | 2019-06-30 17:26:43 +0200 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2019-06-30 17:26:43 +0200 |
| commit | 63f54a7bc6adbc0f1b397872fb7eb96e84967ff1 (patch) | |
| tree | 563f42e3270241209c8e881451074487ca1ef837 | |
| parent | a152a67d3865cc6e7f9d7abd8f17a6e905b8e841 (diff) | |
doc: Document optional parameter of 'stat'.
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'.
| -rw-r--r-- | doc/ref/posix.texi | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/ref/posix.texi b/doc/ref/posix.texi index d2730145c..b1b51d0d7 100644 --- a/doc/ref/posix.texi +++ b/doc/ref/posix.texi @@ -658,14 +658,20 @@ The GNU C Library Reference Manual}. @end deffn @findex fstat -@deffn {Scheme Procedure} stat object -@deffnx {C Function} scm_stat (object) +@deffn {Scheme Procedure} stat object [exception-on-error?] +@deffnx {C Function} scm_stat (object, exception_on_error) Return an object containing various information about the file determined by @var{object}. @var{object} can be a string containing 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 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 parameter to the following procedures, all of which return integers: |