diff options
author | Richard M. Stallman <rms@gnu.org> | 2007-11-25 03:51:14 +0000 |
---|---|---|
committer | Richard M. Stallman <rms@gnu.org> | 2007-11-25 03:51:14 +0000 |
commit | a07c9a8b5bec6b3088d5f0580403e1d740648851 (patch) | |
tree | 6315865f21ec2078b33ce2e0e262a3ceea5c1b9e | |
parent | b1baed0bc232113e84f5a13e07793e089414d86c (diff) |
(Help Functions): Clean up last change.
-rw-r--r-- | doc/lispref/ChangeLog | 12 | ||||
-rw-r--r-- | doc/lispref/help.texi | 17 |
2 files changed, 21 insertions, 8 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 05245e8126..928753ff1f 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,15 @@ +2007-11-25 Richard Stallman <rms@gnu.org> + + * help.texi (Help Functions): Clean up last change. + + * advice.texi (Preactivation, Activation of Advice): Minor cleanup. + + * loading.texi (Named Features): Minor cleanup. + + * macros.texi (Eval During Expansion): Minor cleanup. + + * variables.texi (Variable Aliases): Minor cleanup. + 2007-11-24 Richard Stallman <rms@gnu.org> * functions.texi (Declaring Functions): Clarify previous change. diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index c23d680848..1454e5ab95 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi @@ -688,14 +688,15 @@ binding of @kbd{C-h C-h}. @end defmac @defmac with-help-window buffer-name body@dots{} -This macro evaluates the @var{body} forms inserting any output they -produce into a buffer named @var{buffer-name}. @code{with-help-window} -behaves like @code{with-output-to-temp-buffer} (@pxref{Temporary -Displays}) but does more accurately restore the previous window -configuration when quitting Help. It also generates the message -informing the user how to quit and scroll the help window by itself. -Hence you will regret it if you use @code{print-help-return-message} in -the body of this macro. +This macro evaluates the @var{body} forms, inserting any output they +produce into a buffer named @var{buffer-name} like +@code{with-output-to-temp-buffer} (@pxref{Temporary Displays}). It +also puts that buffer in Help mode, displays a message telling the +user how to quit and scroll the help window, and does various other +things that make a help window work better. + +Don't use @code{print-help-return-message} in the body of this macro; +it would cause bad results. @end defmac @defopt three-step-help |