GNU bug report logs - #32917
27.0.50; read-hide-char documentation

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 32917 in the body.
You can then email your comments to 32917 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: charles <at> aurox.ch (Charles A. Roelli)
To: bug-gnu-emacs <at> gnu.org
Subject: 27.0.50; read-hide-char documentation
Date: Tue, 02 Oct 2018 21:47:32 +0200

  read-hide-char is a variable defined in ‘C source code’.
  Its value is nil

  Documentation:
  Whether to hide input characters in noninteractive mode.
  It must be a character, which will be used to mask the input
  characters.  This variable should never be set globally.

First, the scope of 'read-hide-char' seems wider than what the
documentation claims (for example, it is used in read-passwd,
interactively -- not just in "noninteractive mode").

Second, it can clearly also be nil instead of a character.


Here's a suggested change for emacs-26:

diff --git a/src/minibuf.c b/src/minibuf.c
index 691fad0..f1bde91 100644
--- a/src/minibuf.c
+++ b/src/minibuf.c
@@ -2107,8 +2107,11 @@ properties.  */);
 
   DEFVAR_LISP ("read-hide-char", Vread_hide_char,
 	       doc: /* Whether to hide input characters in noninteractive mode.
-It must be a character, which will be used to mask the input
-characters.  This variable should never be set globally.  */);
+If non-nil, it must be a character, which will be used to mask the
+input characters.  This variable should never be set globally.
+
+This variable also overrides the default character that `read-passwd'
+uses to hide passwords.  */);
   Vread_hide_char = Qnil;
 
   defsubr (&Sactive_minibuffer_window);

Message #8 received at 32917 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: charles <at> aurox.ch
Cc: 32917 <at> debbugs.gnu.org
Subject: Re: bug#32917: 27.0.50; read-hide-char documentation
Date: Wed, 03 Oct 2018 05:38:42 +0300

> Date: Tue, 02 Oct 2018 21:47:32 +0200
> From: charles <at> aurox.ch (Charles A. Roelli)
> 
> Here's a suggested change for emacs-26:
> 
> diff --git a/src/minibuf.c b/src/minibuf.c
> index 691fad0..f1bde91 100644
> --- a/src/minibuf.c
> +++ b/src/minibuf.c
> @@ -2107,8 +2107,11 @@ properties.  */);
>  
>    DEFVAR_LISP ("read-hide-char", Vread_hide_char,
>  	       doc: /* Whether to hide input characters in noninteractive mode.
> -It must be a character, which will be used to mask the input
> -characters.  This variable should never be set globally.  */);
> +If non-nil, it must be a character, which will be used to mask the
> +input characters.  This variable should never be set globally.
> +
> +This variable also overrides the default character that `read-passwd'
> +uses to hide passwords.  */);

This is OK, thanks.  Please also add an index entry for read-hide-char
in the ELisp manual, where read-passwd is described, because every
variable mentioned in the manual must be indexed.

Message #11 received at 32917 <at> debbugs.gnu.org (full text, mbox):

From: charles <at> aurox.ch (Charles A. Roelli)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 32917 <at> debbugs.gnu.org
Subject: Re: bug#32917: 27.0.50; read-hide-char documentation
Date: Wed, 03 Oct 2018 20:08:23 +0200

tags 32917 fixed
close 32917 26.2

> Date: Wed, 03 Oct 2018 05:38:42 +0300
> From: Eli Zaretskii <eliz <at> gnu.org>
> CC: 32917 <at> debbugs.gnu.org
> 
> > Date: Tue, 02 Oct 2018 21:47:32 +0200
> > From: charles <at> aurox.ch (Charles A. Roelli)
> > 
> > Here's a suggested change for emacs-26:
> > 
> > diff --git a/src/minibuf.c b/src/minibuf.c
> > index 691fad0..f1bde91 100644
> > --- a/src/minibuf.c
> > +++ b/src/minibuf.c
> > @@ -2107,8 +2107,11 @@ properties.  */);
> >  
> >    DEFVAR_LISP ("read-hide-char", Vread_hide_char,
> >  	       doc: /* Whether to hide input characters in noninteractive mode.
> > -It must be a character, which will be used to mask the input
> > -characters.  This variable should never be set globally.  */);
> > +If non-nil, it must be a character, which will be used to mask the
> > +input characters.  This variable should never be set globally.
> > +
> > +This variable also overrides the default character that `read-passwd'
> > +uses to hide passwords.  */);
> 
> This is OK, thanks.  Please also add an index entry for read-hide-char
> in the ELisp manual, where read-passwd is described, because every
> variable mentioned in the manual must be indexed.

Thanks, this is now done.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.