diff options
author | rwatson <rwatson@FreeBSD.org> | 2005-07-24 01:41:47 +0000 |
---|---|---|
committer | rwatson <rwatson@FreeBSD.org> | 2005-07-24 01:41:47 +0000 |
commit | 560d460544dfe9f0c7701b09b72a5cb644278eca (patch) | |
tree | 4c4accb460ee9ff6aeea1f182a6dd60357adfa68 /lib/libmemstat/libmemstat.3 | |
parent | f689e777d1bf190fcd7b2185bd64f3ca6a46c45c (diff) | |
download | FreeBSD-src-560d460544dfe9f0c7701b09b72a5cb644278eca.zip FreeBSD-src-560d460544dfe9f0c7701b09b72a5cb644278eca.tar.gz |
Having decided not to provide a libmemstat(3) error number to text
conversion routine, now change my mind and add one, memstat_strerror(3),
which returns a const char * pointer to a string describing the error,
to be used on the results of memstat_mtl_geterror().
While here, also correct a minor typo in the HISTORY man page.
Pointers on improving ease of internationalization would be
appreciated.
MFC after: 1 day
Diffstat (limited to 'lib/libmemstat/libmemstat.3')
-rw-r--r-- | lib/libmemstat/libmemstat.3 | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/lib/libmemstat/libmemstat.3 b/lib/libmemstat/libmemstat.3 index 2e9f0bf..0bc3410 100644 --- a/lib/libmemstat/libmemstat.3 +++ b/lib/libmemstat/libmemstat.3 @@ -35,6 +35,9 @@ .Sh SYNOPSIS .In sys/types.h .In memstat.h +.Ss General Functions +.Ft const char * +.Fn memstat_strerror "int error" .Ss Memory Type List Management Functions .Ft struct memory_type_list * .Fn memstat_mtl_alloc "void" @@ -150,7 +153,9 @@ Repeated calls will incrementally update the list of memory types, permitting tracking over time without recreating all list state. If an error is detected during a query call, error condition information may be retrieved using -.Fn memstat_mtl_geterror . +.Fn memstat_mtl_geterror , +and converted to a user-readable string using +.Fn memstat_strerror . .Pp Freeing the list will free all memory type data in the list, and so invalidates any outstanding pointers to entries in the list. @@ -356,7 +361,10 @@ on success, or on failure. If a failure is returned, the list error access method, .Fn memstat_mtl_geterror , -may be used to retrieve the error state. Possible error values are: +may be used to retrieve the error state. +The string representation of the error may be retrieved using +.Fn memstat_strerror . +Possible error values are: .Pp .Bl -tag -width "MEMSTAT_ERROR_TOOMANYCPUS" -compact -offset wee .It Dv MEMSTAT_ERROR_UNDEFINED @@ -426,7 +434,7 @@ printf("Mbufs: %llu\\n", (unsigned long long)mbuf_count); .Xr uma 9 .Sh HISTORY The -.Nm memstat +.Nm libmemstat library appeared in .Fx 6.0 . .Sh AUTHORS |