]> Savannah Git Hosting - gnulib.git/commitdiff
putenv-gnu: Update documentation.
authorBruno Haible <bruno@clisp.org>
Fri, 17 May 2024 09:36:47 +0000 (11:36 +0200)
committerBruno Haible <bruno@clisp.org>
Fri, 17 May 2024 09:49:38 +0000 (11:49 +0200)
* doc/posix-functions/putenv.texi: Refer also to the glibc
documentation. Use the usual doc structure.

ChangeLog
doc/posix-functions/putenv.texi

index 7a08db245c586ce9476e285eef28e6a0dff9cc67..8c78faa41063f99bed44106ac566f7b5cfe14ac7 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2024-05-17  Bruno Haible  <bruno@clisp.org>
+
+       putenv-gnu: Update documentation.
+       * doc/posix-functions/putenv.texi: Refer also to the glibc
+       documentation. Use the usual doc structure.
+
 2024-05-17  Collin Funk  <collin.funk1@gmail.com>
 
        doc: Update outdated module name.
index ff06ea506239d6c1a09de3a7daa42dc8c6d6b512..87fc2f295c4306105548e7b8560ddd027ff8d4b8 100644 (file)
@@ -2,18 +2,32 @@
 @section @code{putenv}
 @findex putenv
 
-POSIX specification:@* @url{https://pubs.opengroup.org/onlinepubs/9699919799/functions/putenv.html}
+POSIX specification:@* @url{https://pubs.opengroup.org/onlinepubs/9699919799/functions/putenv.html},
+amended through @url{https://www.austingroupbugs.net/view.php?id=1598}.
+
+Documentation:@*
+@ifinfo
+@ref{Environment Access,,Environment Access,libc}.
+@end ifinfo
+@ifnotinfo
+@url{https://www.gnu.org/software/libc/manual/html_node/Environment-Access.html}.
+@end ifnotinfo
+
+Note: POSIX @code{putenv} supports
+adding or changing the value of an environment variable,
+while glibc also supports removing an environment variable
+(as if by @code{unsetenv}).
 
 Gnulib module: putenv-gnu
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+This function does not support removing an environment variable
+on some platforms:
+macOS 12.5, FreeBSD 14.0, NetBSD 10.0, OpenBSD 7.5, AIX 7.3.1, HP-UX 11.31, Solaris 11.4, mingw, MSVC 14, Android 11.0.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
 @end itemize
-
-Extension: Gnulib provides a module @samp{putenv-gnu} that substitutes a
-@code{putenv} implementation that can also be used to remove environment
-variables.