From: Charles A. Roelli <charles@aurox.ch>
Date: Wed, 3 Oct 2018 17:59:34 +0000 (+0200)
Subject: Improve documentation of 'read-hide-char'
X-Git-Tag: emacs-26.1.90~110
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=ac3622c81acb93fa340a1e0e73188b1587b3970a;p=emacs.git

Improve documentation of 'read-hide-char'

* src/minibuf.c (syms_of_minibuf) <Vread_hide_char>: Clarify
documentation and mention where else the variable is used.
* doc/lispref/minibuf.texi (Reading a Password): Add an index
entry for 'read-hide-char'.
---

diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index 2951ef5aaec..97797d00096 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -2236,6 +2236,7 @@ Here is an example of using this function:
   To read a password to pass to another program, you can use the
 function @code{read-passwd}.
 
+@vindex read-hide-char
 @defun read-passwd prompt &optional confirm default
 This function reads a password, prompting with @var{prompt}.  It does
 not echo the password as the user types it; instead, it echoes
diff --git a/src/minibuf.c b/src/minibuf.c
index 691fad07b79..f1bde913fc9 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);