svn commit: r194071 - head/lib/libutil

[John Baldwin]

Author: jhb
Date: Fri Jun 12 18:13:34 2009
New Revision: 194071
URL: http://svn.freebsd.org/changeset/base/194071

Log:
  - Note that these interfaces require <sys/user.h> for the structure
    definitions.
  - Note that these functions return NULL on failure.
  
  MFC after:	3 days

Modified:
  head/lib/libutil/kinfo_getfile.3
  head/lib/libutil/kinfo_getvmmap.3

Modified: head/lib/libutil/kinfo_getfile.3
==============================================================================
--- head/lib/libutil/kinfo_getfile.3	Fri Jun 12 16:37:53 2009	(r194070)
+++ head/lib/libutil/kinfo_getfile.3	Fri Jun 12 18:13:34 2009	(r194071)
@@ -35,6 +35,7 @@
 .Lb libutil
 .Sh SYNOPSIS
 .In sys/types.h
+.In sys/user.h
 .In libutil.h
 .Ft struct kinfo_file *
 .Fn kinfo_getfile "pid_t pid" "int *cntp"
@@ -58,7 +59,7 @@ 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
@@ -67,6 +68,10 @@ The array was obtained by an internal ca
 .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: head/lib/libutil/kinfo_getvmmap.3
==============================================================================
--- head/lib/libutil/kinfo_getvmmap.3	Fri Jun 12 16:37:53 2009	(r194070)
+++ head/lib/libutil/kinfo_getvmmap.3	Fri Jun 12 18:13:34 2009	(r194071)
@@ -35,6 +35,7 @@
 .Lb libutil
 .Sh SYNOPSIS
 .In sys/types.h
+.In sys/user.h
 .In libutil.h
 .Ft struct kinfo_vmentry *
 .Fn kinfo_getfile "pid_t pid" "int *cntp"
@@ -58,7 +59,7 @@ 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
@@ -67,6 +68,10 @@ The array was obtained by an internal ca
 .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 ,