Re: getpass documentation

[Simon Josefsson]

Bruno Haible <address@hidden> writes:

> Simon Josefsson wrote:
>> Thanks, below is an updated patch.
>
> OK. Are you going to commit that?

I'm pushing it now, thanks for comments.

>> -Portability problems not fixed by Gnulib:
>> +Portability problems fixed by Gnulib module @code{getpass-gnu}:
>>  @itemize
>>  @item
>> -This function is missing on some platforms:
>> -mingw, BeOS.
>> +The gnulib implementation return a password of arbitrary length read
>> +from /dev/tty (or stdin), other implementations may truncate the
>> +password to PASS_MAX or 8 characters.
>> address@hidden itemize
>
> What's the reason that you mention "from /dev/tty (or stdin)"? Don't other
> implementations read from /dev/tty or stdin?

Without that part, I found to description to be somewhat ambiguous: it
could be interpreted as a function that returns a random password, not
one read from the user.  Do you think "from the user" is better?

/Simon

>From d96cfbe13a5e3945b8b5cb23c6315af7f859dc07 Mon Sep 17 00:00:00 2001
From: Simon Josefsson <address@hidden>
Date: Mon, 19 May 2008 09:40:59 +0200
Subject: [PATCH] doc/glibc-functions/getpass.texi: Document gnulib 
implementation.

---
 ChangeLog                        |    6 ++++++
 doc/glibc-functions/getpass.texi |   18 +++++++++++++-----
 2 files changed, 19 insertions(+), 5 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 41ea89d..e233aae 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2008-05-19  Simon Josefsson  <address@hidden>
+            Bruno Haible <address@hidden>
+
+       * doc/glibc-functions/getpass.texi: Document gnulib
+       implementation.
+
 2008-05-18  Bruno Haible  <address@hidden>
 
        * modules/propername: New file, from GNU gettext.
diff --git a/doc/glibc-functions/getpass.texi b/doc/glibc-functions/getpass.texi
index b805cf5..0f2992d 100644
--- a/doc/glibc-functions/getpass.texi
+++ b/doc/glibc-functions/getpass.texi
@@ -2,15 +2,23 @@
 @subsection @code{getpass}
 @findex getpass
 
-Gnulib module: ---
+Gnulib module: getpass or getpass-gnu
 
-Portability problems fixed by Gnulib:
+Portability problems fixed by either Gnulib module @code{getpass} or 
@code{getpass-gnu}:
 @itemize
address@hidden
+This function is missing on some platforms:
+mingw, BeOS.
 @end itemize
 
-Portability problems not fixed by Gnulib:
+Portability problems fixed by Gnulib module @code{getpass-gnu}:
 @itemize
 @item
-This function is missing on some platforms:
-mingw, BeOS.
+The gnulib implementation return a password of arbitrary length read
+from /dev/tty (or stdin), other implementations may truncate the
+password to PASS_MAX or 8 characters.
address@hidden itemize
+
+Portability problems not fixed by Gnulib:
address@hidden
 @end itemize
-- 
1.5.5.1