[src/trunk]: src/lib/libc/gen Document the return values of the _r functions.

[christos <christos%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/aee4bb5a4d0c
branches:  trunk
changeset: 579903:aee4bb5a4d0c
user:      christos <christos%NetBSD.org@localhost>
date:      Thu Mar 31 04:17:05 2005 +0000

description:
Document the return values of the _r functions.

diffstat:

 lib/libc/gen/getpwent.3 |  11 +++++++++--
 1 files changed, 9 insertions(+), 2 deletions(-)

diffs (32 lines):

diff -r 3f47a18bbf44 -r aee4bb5a4d0c lib/libc/gen/getpwent.3
--- a/lib/libc/gen/getpwent.3   Thu Mar 31 04:14:42 2005 +0000
+++ b/lib/libc/gen/getpwent.3   Thu Mar 31 04:17:05 2005 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: getpwent.3,v 1.25 2004/10/05 13:52:09 wiz Exp $
+.\"    $NetBSD: getpwent.3,v 1.26 2005/03/31 04:17:05 christos Exp $
 .\"
 .\" Copyright (c) 1988, 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -29,7 +29,7 @@
 .\"
 .\"     @(#)getpwent.3 8.2 (Berkeley) 12/11/93
 .\"
-.Dd October 5, 2004
+.Dd March 30, 2005
 .Dt GETPWENT 3
 .Os
 .Sh NAME
@@ -194,6 +194,13 @@
 .Fn setpwent
 functions
 have no return value.
+The functions
+.Fn getpwnam_r ,
+and
+.Fn getpwuid_r 
+return
+.Dv 0
+on success and non-zero on failure.
 .Sh FILES
 .Bl -tag -width /etc/master.passwd -compact
 .It Pa /etc/pwd.db