summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authoralfred <alfred@FreeBSD.org>2004-07-16 01:18:13 +0000
committeralfred <alfred@FreeBSD.org>2004-07-16 01:18:13 +0000
commit4bc282eb72bf227a5706f710b20fed6d5dbabe98 (patch)
tree8ce4c83bc8f2fb37e8cd61b413306ef02ef10515 /lib
parent1c9ffd247a8f327334a1c919423b707fe464ffac (diff)
downloadFreeBSD-src-4bc282eb72bf227a5706f710b20fed6d5dbabe98.zip
FreeBSD-src-4bc282eb72bf227a5706f710b20fed6d5dbabe98.tar.gz
Clarify getfsstat(2) usage.
The getfsstat(2) function expects a buffer and a count, and returns a count. The confusing part is that the count it takes is a byte count, while the return value is a count of the number of structures it has filled out. Spell this out.
Diffstat (limited to 'lib')
-rw-r--r--lib/libc/sys/getfsstat.27
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/libc/sys/getfsstat.2 b/lib/libc/sys/getfsstat.2
index 41d9904..3100d93 100644
--- a/lib/libc/sys/getfsstat.2
+++ b/lib/libc/sys/getfsstat.2
@@ -63,8 +63,13 @@ Fields that are undefined for a particular file system are set to -1.
The buffer is filled with an array of
.Fa fsstat
structures, one for each mounted file system
-up to the size specified by
+up to the byte count specified by
.Fa bufsize .
+Note, the
+.Fa bufsize
+argument is the number of bytes that
+.Fa buf
+can hold, not the count of statfs structures it will hold.
.Pp
If
.Fa buf
OpenPOWER on IntegriCloud