aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2019-12-22 21:02:48 +0200
committerEli Zaretskii2019-12-22 21:02:48 +0200
commitd7ab4edd93d44b33df72a4697b4628ee1133ca41 (patch)
treedd88ab8aa5f107469b9d4765046aa903afb51a7e
parent753389448de3b0da608f0631349aa84c2281ee1f (diff)
downloademacs-d7ab4edd93d44b33df72a4697b4628ee1133ca41.tar.gz
emacs-d7ab4edd93d44b33df72a4697b4628ee1133ca41.zip
Fix wording of recent documentation changes
* src/xdisp.c (syms_of_xdisp): * lisp/minibuffer.el (minibuffer-message-clear-timeout): * etc/NEWS: * doc/lispref/display.texi (Displaying Messages): Minor changes of wording of a recent commit. (Bug#38457)
-rw-r--r--doc/lispref/display.texi31
-rw-r--r--etc/NEWS7
-rw-r--r--lisp/minibuffer.el7
-rw-r--r--src/xdisp.c16
4 files changed, 33 insertions, 28 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 0085f3b6750..6952cb58130 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -307,28 +307,29 @@ reformatted, with undesirable results. Instead, use @code{(message
307@end defun 307@end defun
308 308
309@defvar set-message-function 309@defvar set-message-function
310When this variable is non-@code{nil}, @code{message} and related functions 310If this variable is non-@code{nil}, it should be a function of one
311call it as a function with one argument that is the message to show. 311argument, the text of a message to display in the echo area. This
312 312function will be called by @code{message} and related functions. If
313When this function returns @code{nil}, the message is displayed in the 313the function returns @code{nil}, the message is displayed in the echo
314echo area as usual. When the function returns a string, the returned 314area as usual. If this function returns a string, that string is
315string is displayed in the echo area. When this function returns 315displayed in the echo area instead of the original one. If this
316other non-@code{nil} values, this means that the message was handled 316function returns other non-@code{nil} values, that means the message
317specially, so the same message is not displayed in the echo area. 317was already handled, so @code{message} will not display anything in
318See also @code{clear-message-function} that can be used to clear the 318the echo area. See also @code{clear-message-function} that can be
319message displayed by this function. 319used to clear the message displayed by this function.
320 320
321The default value is the function that displays the message at the end 321The default value is the function that displays the message at the end
322of the minibuffer when the minibuffer is active. 322of the minibuffer when the minibuffer is active.
323@end defvar 323@end defvar
324 324
325@defvar clear-message-function 325@defvar clear-message-function
326When this variable is non-@code{nil}, @code{message} and related functions 326If this variable is non-@code{nil}, @code{message} and related
327call it without arguments when their message is @code{nil} or the empty string. 327functions call it with no arguments when their argument message is
328@code{nil} or the empty string.
328 329
329Usually this function is called when the next input event arrives. 330Usually this function is called when the next input event arrives
330The function is called without arguments. It is expected to clear the 331after displaying an echo-area message. The function is expected to
331message displayed by its counterpart function specified by 332clear the message displayed by its counterpart function specified by
332@code{set-message-function}. 333@code{set-message-function}.
333 334
334The default value is the function that clears the message displayed at 335The default value is the function that clears the message displayed at
diff --git a/etc/NEWS b/etc/NEWS
index cd835f3d2a9..20288398bd3 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -782,8 +782,11 @@ the minibuffer. If non-nil, point will move to the end of the prompt
782(if point is after the end of the prompt). 782(if point is after the end of the prompt).
783 783
784+++ 784+++
785*** When the minibuffer is active, messages are displayed at the end of 785*** When the minibuffer is active, echo-area messages are displayed at
786the minibuffer instead of overwriting the minibuffer by the echo area. 786the end of the minibuffer instead of hiding the minibuffer by the echo
787area display. The new option 'minibuffer-message-clear-timeout'
788controls how messages displayed in this situation are removed from the
789minibuffer.
787 790
788--- 791---
789*** Minibuffer now uses 'minibuffer-message' to display error messages 792*** Minibuffer now uses 'minibuffer-message' to display error messages
diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el
index 96931162cc1..c0df383e288 100644
--- a/lisp/minibuffer.el
+++ b/lisp/minibuffer.el
@@ -748,9 +748,10 @@ If ARGS are provided, then pass MESSAGE through `format-message'."
748 748
749(defcustom minibuffer-message-clear-timeout nil 749(defcustom minibuffer-message-clear-timeout nil
750 "How long to display an echo-area message when the minibuffer is active. 750 "How long to display an echo-area message when the minibuffer is active.
751If the value is a number, it should be specified in seconds. 751If the value is a number, it is the time in seconds after which to
752If the value is not a number, such messages never time out, 752remove the echo-area message from the active minibuffer.
753and the text is displayed until the next input event arrives. 753If the value is not a number, such messages are never removed,
754and their text is displayed until the next input event arrives.
754Unlike `minibuffer-message-timeout' used by `minibuffer-message', 755Unlike `minibuffer-message-timeout' used by `minibuffer-message',
755this option affects the pair of functions `set-minibuffer-message' 756this option affects the pair of functions `set-minibuffer-message'
756and `clear-minibuffer-message' called automatically via 757and `clear-minibuffer-message' called automatically via
diff --git a/src/xdisp.c b/src/xdisp.c
index 8cba5c5028d..2dfc4cbfeb4 100644
--- a/src/xdisp.c
+++ b/src/xdisp.c
@@ -34968,19 +34968,19 @@ display table takes effect; in this case, Emacs does not consult
34968 Vdebug_on_message = Qnil; 34968 Vdebug_on_message = Qnil;
34969 34969
34970 DEFVAR_LISP ("set-message-function", Vset_message_function, 34970 DEFVAR_LISP ("set-message-function", Vset_message_function,
34971 doc: /* If non-nil, function to show the message. 34971 doc: /* If non-nil, function to handle display of echo-area messages.
34972The function is called with one argument that is the message. 34972The function is called with one argument that is the text of a message.
34973When this function returns nil, the message is displayed in the echo 34973If this function returns nil, the message is displayed in the echo area
34974area as usual. When the function returns a string, the returned 34974as usual. If the function returns a string, the returned string is
34975string is displayed in the echo area. When this function returns 34975displayed in the echo area. If this function returns any other non-nil
34976other non-nil values, this means that the message was handled 34976value, this means that the message was already handled, and the original
34977specially, so the same message is not displayed in the echo area. 34977message text will not be displayed in the echo area.
34978See also `clear-message-function' that can be used to clear the 34978See also `clear-message-function' that can be used to clear the
34979message displayed by this function. */); 34979message displayed by this function. */);
34980 Vset_message_function = Qnil; 34980 Vset_message_function = Qnil;
34981 34981
34982 DEFVAR_LISP ("clear-message-function", Vclear_message_function, 34982 DEFVAR_LISP ("clear-message-function", Vclear_message_function,
34983 doc: /* If non-nil, function to clear message. 34983 doc: /* If non-nil, function to clear echo-area messages.
34984Usually this function is called when the next input event arrives. 34984Usually this function is called when the next input event arrives.
34985The function is called without arguments. It is expected to clear the 34985The function is called without arguments. It is expected to clear the
34986message displayed by its counterpart function specified by 34986message displayed by its counterpart function specified by