procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

(Help Functions): Clean up last change.

Browse source
This commit is contained in:
Richard M. Stallman 2007-11-25 03:51:14 +00:00
parent b1baed0bc2
commit a07c9a8b5b
2 changed files with 21 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/lispref/ChangeLog
View file

@ -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.

17
doc/lispref/help.texi
View file

@ -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