[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Guile-commits] 03/05: doc: Document optional parameter of 'stat'.
From: |
Ludovic Courtès |
Subject: |
[Guile-commits] 03/05: doc: Document optional parameter of 'stat'. |
Date: |
Sun, 30 Jun 2019 15:49:05 -0400 (EDT) |
civodul pushed a commit to branch stable-2.2
in repository guile.
commit 63f54a7bc6adbc0f1b397872fb7eb96e84967ff1
Author: Ludovic Courtès <address@hidden>
Date: Sun Jun 30 17:26:43 2019 +0200
doc: Document optional parameter of 'stat'.
Fixes <https://bugs.gnu.org/34860>.
Reported by Tim Gesthuizen <address@hidden>.
* doc/ref/posix.texi (File System): Document 'exception_on_error'
parameter of 'stat'.
---
doc/ref/posix.texi | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/doc/ref/posix.texi b/doc/ref/posix.texi
index d273014..b1b51d0 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: