[src/trunk]: src/lib/libc/sys In getvfsstat(2), clarify that the size argumen...

[dholland <dholland%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/5ed60a9aab28
branches:  trunk
changeset: 981965:5ed60a9aab28
user:      dholland <dholland%NetBSD.org@localhost>
date:      Sat Mar 27 23:35:37 2021 +0000

description:
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.

diffstat:

 lib/libc/sys/getvfsstat.2 |  10 ++++++++--
 1 files changed, 8 insertions(+), 2 deletions(-)

diffs (31 lines):

diff -r 45ef1a0f39ed -r 5ed60a9aab28 lib/libc/sys/getvfsstat.2
--- a/lib/libc/sys/getvfsstat.2 Sat Mar 27 23:18:37 2021 +0000
+++ b/lib/libc/sys/getvfsstat.2 Sat Mar 27 23:35:37 2021 +0000
@@ -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 @@
 .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