changeset 12610:80d708efef7d

getlogin_r: Add comment.
author Bruno Haible <bruno@clisp.org>
date Sat, 09 Jan 2010 14:16:57 +0100
parents 887426b7b1d6
children 42a30e18244c
files ChangeLog lib/unistd.in.h
diffstat 2 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2010-01-09  Bruno Haible  <bruno@clisp.org>
+
+	* lib/unistd.in.h (getlogin_r): Add comment.
+
 2010-01-09  Bruno Haible  <bruno@clisp.org>
 
 	Tests for module 'getlogin_r'.
--- a/lib/unistd.in.h
+++ b/lib/unistd.in.h
@@ -485,6 +485,11 @@
    provided (this case is hopefully rare but is left open by the POSIX spec).
 
    See <http://www.opengroup.org/susv3xsh/getlogin.html>.
+
+   Most programs don't need to use this function, because the information is
+   available through environment variables:
+     ${LOGNAME-$USER}        on Unix platforms,
+     $USERNAME               on native Windows platforms.
  */
 # if !@HAVE_DECL_GETLOGIN_R@
 extern int getlogin_r (char *name, size_t size) _GL_ARG_NONNULL ((1));