# HG changeset patch
# User Bruno Haible <bruno@clisp.org>
# Date 1263043017 -3600
# Node ID 80d708efef7d5f335755573543448848f2358ef1
# Parent  887426b7b1d620d2cd90c948372b728c5846dbbc
getlogin_r: Add comment.

diff --git a/ChangeLog b/ChangeLog
--- 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'.
diff --git a/lib/unistd.in.h b/lib/unistd.in.h
--- 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));