aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref
diff options
context:
space:
mode:
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/ChangeLog4
-rw-r--r--doc/lispref/display.texi48
-rw-r--r--doc/lispref/elisp.texi1
-rw-r--r--doc/lispref/vol1.texi1
-rw-r--r--doc/lispref/vol2.texi1
5 files changed, 55 insertions, 0 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 9a0730d82a7..0d2ac33f4c8 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,7 @@
12012-04-04 Chong Yidong <cyd@gnu.org>
2
3 * display.texi (Delayed Warnings): New node.
4
12012-04-04 Glenn Morris <rgm@gnu.org> 52012-04-04 Glenn Morris <rgm@gnu.org>
2 6
3 * os.texi (Notifications): Copyedits. 7 * os.texi (Notifications): Copyedits.
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 12b30dc599c..8382c2a1555 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -572,6 +572,7 @@ possible problem, but continue running.
572* Warning Basics:: Warnings concepts and functions to report them. 572* Warning Basics:: Warnings concepts and functions to report them.
573* Warning Variables:: Variables programs bind to customize their warnings. 573* Warning Variables:: Variables programs bind to customize their warnings.
574* Warning Options:: Variables users set to control display of warnings. 574* Warning Options:: Variables users set to control display of warnings.
575* Delayed Warnings:: Deferring a warning until the end of a command.
575@end menu 576@end menu
576 577
577@node Warning Basics 578@node Warning Basics
@@ -750,6 +751,53 @@ symbols. If it matches the first few elements in a warning type, then
750that warning is not logged. 751that warning is not logged.
751@end defopt 752@end defopt
752 753
754@node Delayed Warnings
755@subsection Delayed Warnings
756
757Sometimes, you may wish to avoid showing a warning while a command is
758running, and only show it only after the end of the command. You can
759use the variable @code{delayed-warnings-list} for this.
760
761@defvar delayed-warnings-list
762The value of this variable is a list of warnings to be displayed after
763the current command has finished. Each element must be a list
764
765@smallexample
766(@var{type} @var{message} [@var{level} [@var{buffer-name}]])
767@end smallexample
768
769@noindent
770with the same form, and the same meanings, as the argument list of
771@code{display-warning} (@pxref{Warning Basics}). Immediately after
772running @code{post-command-hook} (@pxref{Command Overview}), the Emacs
773command loop displays all the warnings specified by this variable,
774then resets it to @code{nil}.
775@end defvar
776
777 Programs which need to further customize the delayed warnings
778mechanism can change the variable @code{delayed-warnings-hook}:
779
780@defvar delayed-warnings-hook
781This is a normal hook which is run by the Emacs command loop, after
782@code{post-command-hook}, in order to to process and display delayed
783warnings.
784
785Its default value is a list of two functions:
786
787@smallexample
788(collapse-delayed-warnings display-delayed-warnings)
789@end smallexample
790
791@findex collapse-delayed-warnings
792@findex display-delayed-warnings
793@noindent
794The function @code{collapse-delayed-warnings} iterates through
795@code{delayed-warnings-list}, removing repeated entries. The function
796@code{display-delayed-warnings} calls @code{display-warning} on each
797of the entries in @code{delayed-warnings-list}, in turn, and then sets
798@code{delayed-warnings-list} to @code{nil}.
799@end defvar
800
753@node Invisible Text 801@node Invisible Text
754@section Invisible Text 802@section Invisible Text
755 803
diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi
index 22fc5fac0f0..508b0251a7a 100644
--- a/doc/lispref/elisp.texi
+++ b/doc/lispref/elisp.texi
@@ -1284,6 +1284,7 @@ Reporting Warnings
1284* Warning Variables:: Variables programs bind to customize 1284* Warning Variables:: Variables programs bind to customize
1285 their warnings. 1285 their warnings.
1286* Warning Options:: Variables users set to control display of warnings. 1286* Warning Options:: Variables users set to control display of warnings.
1287* Delayed Warnings:: Deferring a warning until the end of a command.
1287 1288
1288Overlays 1289Overlays
1289 1290
diff --git a/doc/lispref/vol1.texi b/doc/lispref/vol1.texi
index a4af27cf279..52681510a51 100644
--- a/doc/lispref/vol1.texi
+++ b/doc/lispref/vol1.texi
@@ -1306,6 +1306,7 @@ Reporting Warnings
1306* Warning Variables:: Variables programs bind to customize 1306* Warning Variables:: Variables programs bind to customize
1307 their warnings. 1307 their warnings.
1308* Warning Options:: Variables users set to control display of warnings. 1308* Warning Options:: Variables users set to control display of warnings.
1309* Delayed Warnings:: Deferring warning display until the end of a command.
1309 1310
1310Overlays 1311Overlays
1311 1312
diff --git a/doc/lispref/vol2.texi b/doc/lispref/vol2.texi
index af4e455788d..3be2628f5e1 100644
--- a/doc/lispref/vol2.texi
+++ b/doc/lispref/vol2.texi
@@ -1305,6 +1305,7 @@ Reporting Warnings
1305* Warning Variables:: Variables programs bind to customize 1305* Warning Variables:: Variables programs bind to customize
1306 their warnings. 1306 their warnings.
1307* Warning Options:: Variables users set to control display of warnings. 1307* Warning Options:: Variables users set to control display of warnings.
1308* Delayed Warnings:: Deferring a warning until the end of a command.
1308 1309
1309Overlays 1310Overlays
1310 1311