document memory behavior and errno values more completely

SCCS-vsn: lib/libc/gen/getmntinfo.3 6.4

diff --git a/usr/src/lib/libc/gen/getmntinfo.3 b/usr/src/lib/libc/gen/getmntinfo.3
index 0a672f8..3e87d33 100644 (file)
--- a/usr/src/lib/libc/gen/getmntinfo.3
+++ b/usr/src/lib/libc/gen/getmntinfo.3
@@ -3,7 +3,7 @@
 .\"
 .\" %sccs.include.redist.man%
 .\"
 .\"
 .\" %sccs.include.redist.man%
 .\"

-.\"    @(#)getmntinfo.3        6.3 (Berkeley) %G%
+.\"    @(#)getmntinfo.3        6.4 (Berkeley) %G%

 .\"
 .TH GETMNTINFO 3 ""
 .UC 7
 .\"
 .TH GETMNTINFO 3 ""
 .UC 7


@@ -27,23 +27,42 @@ returns an array of
 .I statfs
 structures describing each currently mounted file system (see
 .IR statfs (2)).
 .I statfs
 structures describing each currently mounted file system (see
 .IR statfs (2)).

-.SH DIAGNOSTICS
-On successful completion,
-.I getmntinfo
-returns a count of the number of elements in the array.
-The pointer to the array is stored into
-.IR mntbufp .
-Otherwise, zero is returned and
-.I mntbufp
-is unmodified.

 .PP
 .I Getmntinfo
 passes its
 .I flags
 parameter transparently to
 .IR getfsstat (2).
 .PP
 .I Getmntinfo
 passes its
 .I flags
 parameter transparently to
 .IR getfsstat (2).

+.SH "RETURN VALUE"
+On successful completion,
+.I getmntinfo
+returns a count of the number of elements in the array.
+The pointer to the array is stored into
+.IR mntbufp .
+.PP
+If an error occurs, zero is returned and the external variable
+.I errno
+is set to indicate the error.
+Although the pointer 
+.I mntbufp
+will be unmodified, any information previously returned by 
+.I getmntinfo
+will be lost.

 .SH BUGS
 All information is contained in a static area,
 so it must be copied if it is to be saved.
 .SH BUGS
 All information is contained in a static area,
 so it must be copied if it is to be saved.

+.PP
+The memory allocated by
+.I getmntinfo
+cannot be
+.IR free 'd
+by the application.
+.SH ERRORS
+.I Getmntinfo
+may fail and set errno for any of the errors specified for the library 
+routines
+.IR getfsstat (2)
+or 
+.IR malloc (3).

 .SH SEE ALSO
 getfsstat(2), statfs(2), mount(2), mount(8)
 .SH SEE ALSO
 getfsstat(2), statfs(2), mount(2), mount(8)