summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2012-03-01 22:00:15 -0500
committerGlenn Morris <rgm@gnu.org>2012-03-01 22:00:15 -0500
commit6945faa62fb1ab93074e757a6c92e9091a793763 (patch)
tree730dd7dc2697cb915727e89763bd10e0df6b5dfe
parent96a72ee9ff50672d69e58255f5953481bcf0a6ee (diff)
downloademacs-6945faa62fb1ab93074e757a6c92e9091a793763.tar.gz
emacs-6945faa62fb1ab93074e757a6c92e9091a793763.tar.bz2
emacs-6945faa62fb1ab93074e757a6c92e9091a793763.zip
Tiny change for lispref "Reverting"
* doc/lispref/backups.texi (Reverting): Un-duplicate revert-buffer-in-progress-p, and relocate entry. Mention buffer-stale-function. * doc/emacs/arevert-xtra.texi: Comment.
-rw-r--r--doc/emacs/arevert-xtra.texi3
-rw-r--r--doc/lispref/ChangeLog3
-rw-r--r--doc/lispref/backups.texi22
3 files changed, 21 insertions, 7 deletions
diff --git a/doc/emacs/arevert-xtra.texi b/doc/emacs/arevert-xtra.texi
index 350f16f51dc..4032c0b9882 100644
--- a/doc/emacs/arevert-xtra.texi
+++ b/doc/emacs/arevert-xtra.texi
@@ -1,5 +1,5 @@
@c This is part of the Emacs manual.
-@c Copyright (C) 2004-2012 Free Software Foundation, Inc.
+@c Copyright (C) 2004-2012 Free Software Foundation, Inc.
@c See file emacs.texi for copying conditions.
@c
@c This file is included either in emacs-xtra.texi (when producing the
@@ -96,6 +96,7 @@ Neither are Dired buffers for which you used shell wildcards or file
arguments to list only some of the files. @samp{*Find*} and
@samp{*Locate*} buffers do not auto-revert either.
+@c FIXME? This should be in the elisp manual?
@node Supporting additional buffers
@subsection Adding Support for Auto-Reverting additional Buffers.
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 5dd028341b7..254ad0ae83b 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,5 +1,8 @@
2012-03-02 Glenn Morris <rgm@gnu.org>
+ * backups.texi (Reverting): Un-duplicate revert-buffer-in-progress-p,
+ and relocate entry. Mention buffer-stale-function.
+
* elisp.texi, vol1.texi, vol2.texi: Standardize some menu entries.
* hooks.texi (Standard Hooks): General update.
diff --git a/doc/lispref/backups.texi b/doc/lispref/backups.texi
index 2bcb768aea8..a1c5f20f28c 100644
--- a/doc/lispref/backups.texi
+++ b/doc/lispref/backups.texi
@@ -699,11 +699,13 @@ operation, reverting preserves all the markers. If they are not
identical, reverting does change the buffer; in that case, it preserves
the markers in the unchanged text (if any) at the beginning and end of
the buffer. Preserving any additional markers would be problematical.
-
-This command binds @code{revert-buffer-in-progress-p} to a
-non-@code{nil} value while it operates.
@end deffn
+@defvar revert-buffer-in-progress-p
+@code{revert-buffer} binds this variable to a non-@code{nil} value
+while it is working.
+@end defvar
+
You can customize how @code{revert-buffer} does its work by setting
the variables described in the rest of this section.
@@ -758,7 +760,15 @@ the modified contents---but only if @code{revert-buffer-function} is
@code{nil}.
@end defvar
-@defvar revert-buffer-in-progress-p
-This variable is bound to a non-@code{nil} value by
-@code{revert-buffer} while it is working.
+@c FIXME? Move this section from arevert-xtra to here?
+@defvar buffer-stale-function
+The value of this variable, if non-@code{nil}, specifies a function
+to call to check whether a non-file buffer needs reverting
+@iftex
+(@pxref{Supporting additional buffers,,, emacs-xtra, Specialized Emacs Features}).
+@end iftex
+@ifnottex
+(@pxref{Supporting additional buffers,,, emacs}).
+@end ifnottex
@end defvar
+