doco stat fields

doco stat fields

[Kevin Ryde]

[-- Attachment #1: Type: text/plain, Size: 1087 bytes --]

Prompted by Stefan mentioning AC_STRUCT_ST_BLOCKS, a possible few
words about stat fields not always available.

        * posix.texi (File System): stat:rdev and stat:blocks can return #f,
        stat:blksize returns a sensible size if the field is not available.

Formatted text for ease of contemplation.  The second sentence of each
is new.

      - Scheme Procedure: stat:rdev st
          Device ID; this entry is defined only for character or block
          special files.  On some systems this field is not available
          at all, in which case `stat:rdev' returns `#f'.

      - Scheme Procedure: stat:blksize st
          The optimal block size for reading or writing the file, in
          bytes.  On some systems this field is not available, in which
          case `stat:blksize' returns a sensible suggested block size.

      - Scheme Procedure: stat:blocks st
          The amount of disk space that the file occupies measured in
          units of 512 byte blocks.  On some systems this field is not
          available, in which case `stat:blocks' returns `#f'.


[-- Attachment #2: posix.texi.stat.diff --]
[-- Type: text/plain, Size: 1359 bytes --]

--- posix.texi.~1.20.~	2003-05-26 10:56:22.000000000 +1000
+++ posix.texi	2003-05-31 11:00:34.000000000 +1000
@@ -594,8 +594,9 @@
 The group ID of the file.
 @end deffn
 @deffn {Scheme Procedure} stat:rdev st
-Device ID; this entry is defined only for character or block
-special files.
+Device ID; this entry is defined only for character or block special
+files.  On some systems this field is not available at all, in which
+case @code{stat:rdev} returns @code{#f}.
 @end deffn
 @deffn {Scheme Procedure} stat:size st
 The size of a regular file in bytes.
@@ -610,12 +611,14 @@
 The last modification time for the attributes of the file.
 @end deffn
 @deffn {Scheme Procedure} stat:blksize st
-The optimal block size for reading or writing the file, in
-bytes.
+The optimal block size for reading or writing the file, in bytes.  On
+some systems this field is not available, in which case
+@code{stat:blksize} returns a sensible suggested block size.
 @end deffn
 @deffn {Scheme Procedure} stat:blocks st
-The amount of disk space that the file occupies measured in
-units of 512 byte blocks.
+The amount of disk space that the file occupies measured in units of
+512 byte blocks.  On some systems this field is not available, in
+which case @code{stat:blocks} returns @code{#f}.
 @end deffn
 
 In addition, the following procedures return the information

[-- Attachment #3: Type: text/plain, Size: 142 bytes --]

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: doco stat fields

[Kevin Ryde]

I wrote:
>
>         * posix.texi (File System): stat:rdev and stat:blocks can return #f,
>         stat:blksize returns a sensible size if the field is not available.

In absense of violent objections I made this change.

I guess it's an addition to the documented interfaces, but one
matching what the code has done anyway.


_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel