diff options
| author | Philip Guenther <guenther@cvs.openbsd.org> | 2014-04-21 08:47:00 +0000 |
|---|---|---|
| committer | Philip Guenther <guenther@cvs.openbsd.org> | 2014-04-21 08:47:00 +0000 |
| commit | 40a019bc1f439c736b267d748b830dfd5201093e (patch) | |
| tree | 6d93ce551ca3d5f5f186c504352af27a0f52c48c /lib/libc | |
| parent | d89dbfb93bcf26e70a17f62bcaca911acc9b0ad5 (diff) | |
Correctly document the return value of getenv(3)
From Ben Cornett (ben (at) lantern.is)
Diffstat (limited to 'lib/libc')
| -rw-r--r-- | lib/libc/stdlib/getenv.3 | 14 |
1 files changed, 8 insertions, 6 deletions
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. |