Module Name: src
Committed By: dholland
Date: Sat Mar 27 23:35:37 UTC 2021
Modified Files:
src/lib/libc/sys: getvfsstat.2
Log Message:
In getvfsstat(2), clarify that the size argument is in bytes.
That the size argument is in bytes (not the count of structures) and
the return value is the count of structures (not bytes) is
counterintuitive.
To generate a diff of this commit:
cvs rdiff -u -r1.3 -r1.4 src/lib/libc/sys/getvfsstat.2
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libc/sys/getvfsstat.2
diff -u src/lib/libc/sys/getvfsstat.2:1.3 src/lib/libc/sys/getvfsstat.2:1.4
--- src/lib/libc/sys/getvfsstat.2:1.3 Fri May 19 17:59:28 2006
+++ src/lib/libc/sys/getvfsstat.2 Sat Mar 27 23:35:37 2021
@@ -1,4 +1,4 @@
-.\" $NetBSD: getvfsstat.2,v 1.3 2006/05/19 17:59:28 tsutsui Exp $
+.\" $NetBSD: getvfsstat.2,v 1.4 2021/03/27 23:35:37 dholland Exp $
.\"
.\" Copyright (c) 1989, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -29,7 +29,7 @@
.\"
.\" @(#)getvfsstat.2 8.3 (Berkeley) 5/25/95
.\"
-.Dd May 19, 2006
+.Dd March 27, 2021
.Dt GETVFSSTAT 2
.Os
.Sh NAME
@@ -79,6 +79,12 @@ Thus, some of the information will be ou
.Fn getvfsstat
will not block waiting for information from a file system that is
unable to respond.
+.Pp
+Note that
+.Fa bufsize
+is the size of the buffer in bytes, not the count of structures that
+will fit in it, and the return value is the count of structures, not
+the size.
.Sh RETURN VALUES
Upon successful completion, the number of
.Fa statvfs
