aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGlenn Morris2009-06-28 00:47:58 +0000
committerGlenn Morris2009-06-28 00:47:58 +0000
commit82ec412e8d20ec4bb600fd9466bdb4ca894ce6fc (patch)
tree1858e17445b8e08a0cfd535829439ad296a4afa3
parent00242b07fdc767e6485e8b5bb9aac973e1c5174d (diff)
downloademacs-82ec412e8d20ec4bb600fd9466bdb4ca894ce6fc.tar.gz
emacs-82ec412e8d20ec4bb600fd9466bdb4ca894ce6fc.zip
Minor language tweaks.
-rw-r--r--doc/emacs/ChangeLog4
-rw-r--r--doc/emacs/arevert-xtra.texi59
2 files changed, 34 insertions, 29 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog
index d44b255eedf..b355801777a 100644
--- a/doc/emacs/ChangeLog
+++ b/doc/emacs/ChangeLog
@@ -1,3 +1,7 @@
12009-06-28 Glenn Morris <rgm@gnu.org>
2
3 * arevert-xtra.texi: Minor language tweaks.
4
12009-06-23 Miles Bader <miles@gnu.org> 52009-06-23 Miles Bader <miles@gnu.org>
2 6
3 * display.texi (Scrolling): Document `recenter-redisplay' 7 * display.texi (Scrolling): Document `recenter-redisplay'
diff --git a/doc/emacs/arevert-xtra.texi b/doc/emacs/arevert-xtra.texi
index b3457e8dab7..f2151186555 100644
--- a/doc/emacs/arevert-xtra.texi
+++ b/doc/emacs/arevert-xtra.texi
@@ -1,5 +1,6 @@
1@c This is part of the Emacs manual. 1@c This is part of the Emacs manual.
2@c Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. 2@c Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
3@c Free Software Foundation, Inc.
3@c See file emacs.texi for copying conditions. 4@c See file emacs.texi for copying conditions.
4@c 5@c
5@c This file is included either in emacs-xtra.texi (when producing the 6@c This file is included either in emacs-xtra.texi (when producing the
@@ -7,13 +8,12 @@
7@node Autorevert 8@node Autorevert
8@section Auto Reverting non-file Buffers 9@section Auto Reverting non-file Buffers
9 10
10Normally Global Auto Revert Mode only reverts file buffers. There are 11Global Auto Revert Mode normally only reverts file buffers. There are
11two ways to auto-revert certain non-file buffers: enabling Auto Revert 12two ways to auto-revert certain non-file buffers: enabling Auto Revert
12Mode in those buffers (using @kbd{M-x auto-revert-mode}) and setting 13Mode in those buffers (using @kbd{M-x auto-revert-mode}); and setting
13@code{global-auto-revert-non-file-buffers} to @code{t}. The latter 14@code{global-auto-revert-non-file-buffers} non-@code{nil}. The latter
14enables Auto Reverting for all types of buffers for which it is 15enables Auto Reverting for all types of buffers for which it is
15implemented, that is, for the types of buffers listed in the menu 16implemented (listed in the menu below).
16below.
17 17
18Like file buffers, non-file buffers should normally not revert while 18Like file buffers, non-file buffers should normally not revert while
19you are working on them, or while they contain information that might 19you are working on them, or while they contain information that might
@@ -26,10 +26,10 @@ Another tricky detail is that, for efficiency reasons, Auto Revert
26often does not try to detect all possible changes in the buffer, only 26often does not try to detect all possible changes in the buffer, only
27changes that are ``major'' or easy to detect. Hence, enabling 27changes that are ``major'' or easy to detect. Hence, enabling
28auto-reverting for a non-file buffer does not always guarantee that 28auto-reverting for a non-file buffer does not always guarantee that
29all information in the buffer is up to date and does not necessarily 29all information in the buffer is up-to-date, and does not necessarily
30make manual reverts useless. 30make manual reverts useless.
31 31
32At the other extreme, certain buffers automatically auto-revert every 32At the other extreme, certain buffers automatically revert every
33@code{auto-revert-interval} seconds. (This currently only applies to 33@code{auto-revert-interval} seconds. (This currently only applies to
34the Buffer Menu.) In this case, Auto Revert does not print any 34the Buffer Menu.) In this case, Auto Revert does not print any
35messages while reverting, even when @code{auto-revert-verbose} is 35messages while reverting, even when @code{auto-revert-verbose} is
@@ -67,14 +67,15 @@ operating systems. It may not work satisfactorily on some other
67systems. 67systems.
68 68
69Dired buffers only auto-revert when the file list of the buffer's main 69Dired buffers only auto-revert when the file list of the buffer's main
70directory changes. They do not auto-revert when information about a 70directory changes (e.g. when a new file is added). They do not
71particular file changes or when inserted subdirectories change. To be 71auto-revert when information about a particular file changes
72sure that @emph{all} listed information is up to date, you have to 72(e.g. when the size changes) or when inserted subdirectories change.
73manually revert using @kbd{g}, @emph{even} if auto-reverting is 73To be sure that @emph{all} listed information is up to date, you have
74to manually revert using @kbd{g}, @emph{even} if auto-reverting is
74enabled in the Dired buffer. Sometimes, you might get the impression 75enabled in the Dired buffer. Sometimes, you might get the impression
75that modifying or saving files listed in the main directory actually 76that modifying or saving files listed in the main directory actually
76does cause auto-reverting. This is because making changes to a file, 77does cause auto-reverting. This is because making changes to a file,
77or saving it, very often causes changes in the directory itself, for 78or saving it, very often causes changes in the directory itself; for
78instance, through backup files or auto-save files. However, this is 79instance, through backup files or auto-save files. However, this is
79not guaranteed. 80not guaranteed.
80 81
@@ -91,10 +92,10 @@ If you want auto-reverting to resume in the presence of marks and
91flags, mark the buffer non-modified using @kbd{M-~}. However, adding, 92flags, mark the buffer non-modified using @kbd{M-~}. However, adding,
92deleting or changing marks or flags will mark it modified again. 93deleting or changing marks or flags will mark it modified again.
93 94
94Remote Dired buffers are not auto-reverted. Neither are Dired buffers 95Remote Dired buffers are not auto-reverted (because it may be slow).
95for which you used shell wildcards or file arguments to list only some 96Neither are Dired buffers for which you used shell wildcards or file
96of the files. @samp{*Find*} and @samp{*Locate*} buffers do not 97arguments to list only some of the files. @samp{*Find*} and
97auto-revert either. 98@samp{*Locate*} buffers do not auto-revert either.
98 99
99@node Supporting additional buffers 100@node Supporting additional buffers
100@subsection Adding Support for Auto-Reverting additional Buffers. 101@subsection Adding Support for Auto-Reverting additional Buffers.
@@ -127,7 +128,7 @@ If the function is only going to be used for auto-reverting, you can
127ignore the @var{noconfirm} argument. 128ignore the @var{noconfirm} argument.
128 129
129If you just want to automatically auto-revert every 130If you just want to automatically auto-revert every
130@code{auto-revert-interval} seconds, use: 131@code{auto-revert-interval} seconds (like the Buffer Menu), use:
131 132
132@example 133@example
133(set (make-local-variable 'buffer-stale-function) 134(set (make-local-variable 'buffer-stale-function)
@@ -153,7 +154,7 @@ Once the buffer has a @code{revert-buffer-function} and a
153The buffer will only auto-revert if it is marked unmodified. Hence, 154The buffer will only auto-revert if it is marked unmodified. Hence,
154you will have to make sure that various functions mark the buffer 155you will have to make sure that various functions mark the buffer
155modified if and only if either the buffer contains information that 156modified if and only if either the buffer contains information that
156might be lost by reverting or there is reason to believe that the user 157might be lost by reverting, or there is reason to believe that the user
157might be inconvenienced by auto-reverting, because he is actively 158might be inconvenienced by auto-reverting, because he is actively
158working on the buffer. The user can always override this by manually 159working on the buffer. The user can always override this by manually
159adjusting the modified status of the buffer. To support this, calling 160adjusting the modified status of the buffer. To support this, calling
@@ -165,21 +166,21 @@ as a consequence of auto-reverting. Of course, moving point might be
165inevitable if the buffer radically changes. 166inevitable if the buffer radically changes.
166 167
167You should make sure that the @code{revert-buffer-function} does not 168You should make sure that the @code{revert-buffer-function} does not
168print messages that unnecessarily duplicate Auto Revert's own messages 169print messages that unnecessarily duplicate Auto Revert's own messages,
169if @code{auto-revert-verbose} is @code{t} and effectively override a 170displayed if @code{auto-revert-verbose} is @code{t}, and effectively
170@code{nil} value for @code{auto-revert-verbose}. Hence, adapting a 171override a @code{nil} value for @code{auto-revert-verbose}. Hence,
171mode for auto-reverting often involves getting rid of such messages. 172adapting a mode for auto-reverting often involves getting rid of such
172This is especially important for buffers that automatically 173messages. This is especially important for buffers that automatically
173auto-revert every @code{auto-revert-interval} seconds. 174revert every @code{auto-revert-interval} seconds.
174 175
175Also, you may want to update the documentation string of 176If the new auto-reverting is part of Emacs, you should mention it
176@code{global-auto-revert-non-file-buffers}. 177in the documentation string of @code{global-auto-revert-non-file-buffers}.
177 178
178@ifinfo 179@ifinfo
179Finally, you should add a node to this chapter's menu. This node 180Similarly, you should add a node to this chapter's menu. This node
180@end ifinfo 181@end ifinfo
181@ifnotinfo 182@ifnotinfo
182Finally, you should add a section to this chapter. This section 183Similarly, you should add a section to this chapter. This section
183@end ifnotinfo 184@end ifnotinfo
184should at the very least make clear whether enabling auto-reverting 185should at the very least make clear whether enabling auto-reverting
185for the buffer reliably assures that all information in the buffer is 186for the buffer reliably assures that all information in the buffer is