From: guenther <guenther@openbsd.org>
Date: Mon, 21 Apr 2014 08:46:59 +0000 (+0000)
Subject: Correctly document the return value of getenv(3)
X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=eb15c8a0d4ebd367e5b3e29df4ca5c0336bb4ce0;p=openbsd

Correctly document the return value of getenv(3)

From Ben Cornett (ben (at) lantern.is)
---

diff --git a/lib/libc/stdlib/getenv.3 b/lib/libc/stdlib/getenv.3
index 5239d1b0d5c..23335595161 100644
--- a/lib/libc/stdlib/getenv.3
+++ b/lib/libc/stdlib/getenv.3
@@ -29,9 +29,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\"	$OpenBSD: getenv.3,v 1.19 2013/06/05 03:39:23 tedu Exp $
+.\"	$OpenBSD: getenv.3,v 1.20 2014/04/21 08:46:59 guenther Exp $
 .\"
-.Dd $Mdocdate: June 5 2013 $
+.Dd $Mdocdate: April 21 2014 $
 .Dt GETENV 3
 .Os
 .Sh NAME
@@ -102,11 +102,13 @@ function deletes all instances of the variable name pointed to by
 .Fa name
 from the list.
 .Sh RETURN VALUES
-These functions
-return zero if successful; otherwise the global variable
-.Va errno
-is set to indicate the error and \-1 is returned.
+.Rv -std putenv setenv unsetenv
 .Pp
+The
+.Fn getenv
+function returns a pointer to the requested value, or
+.Dv NULL
+if it could not be found.
 If
 .Fn getenv
 is successful, the string returned should be considered read-only.