[Emacs-diffs] emacs-26 4587d8e: Document 'minibuffer-with-setup-hook'

[Eli Zaretskii]

branch: emacs-26
commit 4587d8e0ef3302e9a2d99e2981897537eb320168
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>

    Document 'minibuffer-with-setup-hook'
    
    * doc/lispref/minibuf.texi (Minibuffer Misc): Document
    minibuffer-with-setup-hook.  (Bug#28877)
---
 doc/lispref/minibuf.texi | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index afd44b7..1ece899 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -2407,6 +2407,19 @@ This is a normal hook that is run whenever the 
minibuffer is entered.
 @xref{Hooks}.
 @end defvar
 
address@hidden minibuffer-with-setup-hook function &rest body
+This macro executes @var{body} after arranging for the specified
address@hidden to be called via @code{minibuffer-setup-hook}.  By
+default, @var{function} is called before the other functions in the
address@hidden list, but if @var{function} is of the
+form @address@hidden(:append @var{func})}}, @var{func} will be called
address@hidden the other hook functions.
+
+The @var{body} forms should not use the minibuffer more than once.  If
+the minibuffer is re-entered recursively, @var{function} will only be
+called once, for the outermost use of the minibuffer.
address@hidden defmac
+
 @defvar minibuffer-exit-hook
 This is a normal hook that is run whenever the minibuffer is exited.
 @xref{Hooks}.