Commit 38785e75 authored by Glenn Morris's avatar Glenn Morris
Browse files

* lisp/window.el (with-temp-buffer-window): Doc tweak.

parent 57fc0fee
2012-11-11 Glenn Morris <rgm@gnu.org>
 
* window.el (with-temp-buffer-window): Doc tweak.
* emacs-lisp/debug.el (debugger-bury-or-kill): Doc tweak.
 
* help.el (temp-buffer-max-height):
......
......@@ -143,37 +143,36 @@ to `display-buffer'."
window))))
(defmacro with-temp-buffer-window (buffer-or-name action quit-function &rest body)
"Evaluate BODY and display buffer specified by BUFFER-OR-NAME.
BUFFER-OR-NAME must specify either a live buffer or the name of a
buffer. If no buffer with such a name exists, create one.
"Evaluate BODY and display the buffer specified by BUFFER-OR-NAME.
BUFFER-OR-NAME must specify either a live buffer, or the name of a
buffer (if it does not exist, this macro creates it).
Make sure the specified buffer is empty before evaluating BODY.
Do not make that buffer current for BODY. Instead, bind
`standard-output' to that buffer, so that output generated with
`prin1' and similar functions in BODY goes into that buffer.
After evaluating BODY, mark the specified buffer unmodified and
read-only, and display it in a window via `display-buffer'. Pass
ACTION as action argument to `display-buffer'. Automatically
shrink the window used if `temp-buffer-resize-mode' is enabled.
After evaluating BODY, this marks the specified buffer unmodified and
read-only, and displays it in a window via `display-buffer', passing
ACTION as the action argument to `display-buffer'. It automatically
shrinks the relevant window if `temp-buffer-resize-mode' is enabled.
Return the value returned by BODY unless QUIT-FUNCTION specifies
a function. In that case, run the function with two arguments -
Returns the value returned by BODY, unless QUIT-FUNCTION specifies
a function. In that case, runs the function with two arguments -
the window showing the specified buffer and the value returned by
BODY - and return the value returned by that function.
BODY - and returns the value returned by that function.
If the buffer is displayed on a new frame, the window manager may
decide to select that frame. In that case, it's usually a good
strategy if the function specified by QUIT-FUNCTION selects the
window showing the buffer before reading a value from the
minibuffer, for example, when asking a `yes-or-no-p' question.
This construct is similar to `with-output-to-temp-buffer' but
does neither put the buffer in help mode nor does it call
`temp-buffer-show-function'. It also runs different hooks,
namely `temp-buffer-window-setup-hook' (with the specified buffer
current) and `temp-buffer-window-show-hook' (with the specified
buffer current and the window showing it selected).
minibuffer; for example, when asking a `yes-or-no-p' question.
This construct is similar to `with-output-to-temp-buffer', but does
not put the buffer in help mode, or call `temp-buffer-show-function'.
It also runs different hooks, namely `temp-buffer-window-setup-hook'
\(with the specified buffer current) and `temp-buffer-window-show-hook'
\(with the specified buffer current and the window showing it selected).
Since this macro calls `display-buffer', the window displaying
the buffer is usually not selected and the specified buffer
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment