summaryrefslogtreecommitdiff
path: root/lisp
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2021-08-12 17:14:36 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2021-08-12 17:15:52 +0200
commitafc945d0c96c37796df840a5529e54886e56c0b9 (patch)
tree7e48b4a0073e27bd89f06f4589a6196bd6a51631 /lisp
parent1678d3599bd3b4e1abac15af54d82202b842428b (diff)
downloademacs-afc945d0c96c37796df840a5529e54886e56c0b9.tar.gz
emacs-afc945d0c96c37796df840a5529e54886e56c0b9.tar.bz2
emacs-afc945d0c96c37796df840a5529e54886e56c0b9.zip
Improve minibuffer-inactive-mode documentation
* lisp/minibuffer.el (minibuffer-inactive-mode): Clarify when it's used (bug#13641).
Diffstat (limited to 'lisp')
-rw-r--r--lisp/minibuffer.el9
1 files changed, 8 insertions, 1 deletions
diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el
index 9f327df28f5..f193c420376 100644
--- a/lisp/minibuffer.el
+++ b/lisp/minibuffer.el
@@ -2706,7 +2706,14 @@ not active.")
:abbrev-table nil ;abbrev.el is not loaded yet during dump.
;; Note: this major mode is called from minibuf.c.
"Major mode to use in the minibuffer when it is not active.
-This is only used when the minibuffer area has no active minibuffer.")
+This is only used when the minibuffer area has no active minibuffer.
+
+Note that the minibuffer may change to this mode more often than
+you might expect. For instance, typing `M-x' may change the
+buffer to this mode, then to a different mode, and then back
+again to this mode upon exit. Code running from
+`minibuffer-inactive-mode-hook' has to be prepared to run
+multiple times per minibuffer invocation.")
(defvaralias 'minibuffer-mode-map 'minibuffer-local-map)