svn commit: r194291 - stable/7/lib/libutil

[John Baldwin]

Author: jhb
Date: Tue Jun 16 13:39:09 2009
New Revision: 194291
URL: http://svn.freebsd.org/changeset/base/194291

Log:
  MFC: Note that these routines return NULL on failure and that the
  structures they return arrays of are defined in <sys/user.h>.

Modified:
  stable/7/lib/libutil/   (props changed)
  stable/7/lib/libutil/kinfo_getfile.3
  stable/7/lib/libutil/kinfo_getvmmap.3

Modified: stable/7/lib/libutil/kinfo_getfile.3
==============================================================================
--- stable/7/lib/libutil/kinfo_getfile.3	Tue Jun 16 13:31:01 2009	(r194290)
+++ stable/7/lib/libutil/kinfo_getfile.3	Tue Jun 16 13:39:09 2009	(r194291)
@@ -58,15 +58,20 @@ mib.
 While the kernel returns a packed structure, this function expands the
 data into a fixed record format.
 .Sh RETURN VALUES
-The
+On success the
 .Fn kinfo_getfile
 function returns a pointer to an array of
 .Vt struct kinfo_file
-structures.
+structures as defined by
+.In sys/user.h .
 The array was obtained by an internal call to
 .Xr malloc 3
 and must be freed by the caller with a call to
 .Xr free 3 .
+On failure the
+.Fn kinfo_getfile
+function returns
+.Dv NULL .
 .Sh SEE ALSO
 .Xr free 3 ,
 .Xr kinfo_getvmmap 3 ,

Modified: stable/7/lib/libutil/kinfo_getvmmap.3
==============================================================================
--- stable/7/lib/libutil/kinfo_getvmmap.3	Tue Jun 16 13:31:01 2009	(r194290)
+++ stable/7/lib/libutil/kinfo_getvmmap.3	Tue Jun 16 13:39:09 2009	(r194291)
@@ -58,15 +58,20 @@ mib.
 While the kernel returns a packed structure, this function expands the
 data into a fixed record format.
 .Sh RETURN VALUES
-The
+On success the
 .Fn kinfo_getvmmap
 function returns a pointer to an array of
 .Vt struct kinfo_vmentry
-structures.
+structures as defined by
+.In sys/user.h .
 The array was obtained by an internal call to
 .Xr malloc 3
 and must be freed by the caller with a call to
 .Xr free 3 .
+On failure the
+.Fn kinfo_getvmmap
+function returns
+.Dv NULL .
 .Sh SEE ALSO
 .Xr free 3 ,
 .Xr kinfo_getfile 3 ,