changeset 58748:e347a194391a

(Undo): Document undo-in-progress.
author Richard M. Stallman <rms@gnu.org>
date Fri, 03 Dec 2004 11:27:02 +0000
parents e3dfd80003ea
children 6f8d4406a676
files lispref/text.texi
diffstat 1 files changed, 8 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/text.texi	Fri Dec 03 00:57:23 2004 +0000
+++ b/lispref/text.texi	Fri Dec 03 11:27:02 2004 +0000
@@ -1244,6 +1244,12 @@
 undo individual replacements one by one.
 @end defun
 
+@defvar undo-in-progress
+This variable is normally @code{nil}, but the undo commands bind it to
+@code{t}.  This is so that various kinds of change hooks can tell when
+they're being called for the sake of undoing.
+@end defvar
+
 @defun primitive-undo count list
 This is the basic function for undoing elements of an undo list.
 It undoes the first @var{count} elements of @var{list}, returning
@@ -1256,6 +1262,8 @@
 undo operations use and update the saved value.  The new elements added
 by undoing are not part of this saved value, so they don't interfere with
 continuing to undo.
+
+This function does not bind @code{undo-in-progress}.
 @end defun
 
 @node Maintaining Undo