summaryrefslogtreecommitdiff
path: root/lisp/help.el
diff options
context:
space:
mode:
authorPaul Eggert <eggert@cs.ucla.edu>2018-03-20 08:59:39 -0700
committerPaul Eggert <eggert@cs.ucla.edu>2018-03-20 08:59:39 -0700
commita5f190dd658419e9328a846a1044b8294a7632d9 (patch)
tree551602b98e8d918935d9e36d5f03daafbc710305 /lisp/help.el
parent97608c60b8e0d01d59d51e32a9fdbd2bb3e2da58 (diff)
parent23527013c79607ba19536ccce85725a91b0033a5 (diff)
downloademacs-a5f190dd658419e9328a846a1044b8294a7632d9.tar.gz
Merge from origin/emacs-26
23527013c7 ; Rewrap doc string 4328d5f744 Correct Info link markup 2fb52abd9e Improve documentation of 'with-help-window' ec08c62f03 Minor improvements in building.texi 663aafe1ff * lisp/textmodes/bibtex.el (bibtex-mark-entry): activate mark 05781b2e88 ; Spelling fix aa40014ba3 * doc/emacs/building.texi (Starting GUD): Mention 'guiler'. 23072e468f Yet more proofreading of the Emacs manual ba5a372540 * doc/emacs/rmail.texi: Fix broken link. 6b2210cc29 ; Spelling fix 067c8c4f5b Fix recently-added POP doc glitch fb3dc0e8aa More proofreading of the Emacs manual a776ce7be6 Fix typo in the Emacs manual's VC chapter 7f27d42f0b Pass json-readtable-error data as a list (bug#30489) 10bd3b3af8 Improve word motion docs (Bug#30815) 2b8507fbdc Replace "carriage-return" by "carriage return" in manuals 2616cd94f1 Minor copyedits in mule.texi 36a1d52814 Fix problems caused by fontconfig-2.13.0
Diffstat (limited to 'lisp/help.el')
-rw-r--r--lisp/help.el19
1 files changed, 9 insertions, 10 deletions
diff --git a/lisp/help.el b/lisp/help.el
index 0830dc5d3cf..90be45777b0 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -1309,15 +1309,14 @@ Return VALUE."
;; (4) A marker (`help-window-point-marker') to move point in the help
;; window to an arbitrary buffer position.
-(defmacro with-help-window (buffer-name &rest body)
- "Display buffer named BUFFER-NAME in a help window.
-Evaluate the forms in BODY with standard output bound to a buffer
-called BUFFER-NAME (creating it if it does not exist), put that
-buffer in `help-mode', display the buffer in a window (see
-`with-temp-buffer-window' for details) and issue a message how to
-deal with that \"help\" window when it's no more needed. Select
-the help window if the current value of the user option
-`help-window-select' says so. Return last value in BODY."
+(defmacro with-help-window (buffer-or-name &rest body)
+ "Evaluate BODY, send output to BUFFER-OR-NAME and show in a help window.
+This construct is like `with-temp-buffer-window' but unlike that
+puts the buffer specified by BUFFER-OR-NAME in `help-mode' and
+displays a message about how to delete the help window when it's no
+longer needed. The help window will be selected if
+`help-window-select' is non-nil. See `help-window-setup' for
+more options."
(declare (indent 1) (debug t))
`(progn
;; Make `help-window-point-marker' point nowhere. The only place
@@ -1329,7 +1328,7 @@ the help window if the current value of the user option
(cons 'help-mode-finish temp-buffer-window-show-hook)))
(setq help-window-old-frame (selected-frame))
(with-temp-buffer-window
- ,buffer-name nil 'help-window-setup (progn ,@body)))))
+ ,buffer-or-name nil 'help-window-setup (progn ,@body)))))
;; Called from C, on encountering `help-char' when reading a char.
;; Don't print to *Help*; that would clobber Help history.