Describe `Auto Revert Tail Mode' in `Commentary' section.

(auto-revert-handler): Do not check `auto-revert-tail-mode' for
non-file buffers.  We know it is nil.

2 files changed, 19 insertions, 4 deletions

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index f508879cb01..1877f9c0281 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,10 @@
+2004-07-17  Luc Teirlinck  <teirllm@auburn.edu>
+
+        * autorevert.el: Describe `Auto Revert Tail Mode' in `Commentary'
+        section.
+        (auto-revert-handler): Do not check `auto-revert-tail-mode' for
+        non-file buffers.  We know it is nil.
+
 2004-07-17  Kai Grossjohann  <kai.grossjohann@gmx.net>
 
         Sync with Tramp 2.0.43.
@@ -8,7 +15,7 @@
         global lock.
         (tramp-sh-file-name-handler): Use them to implement the global
         lock.
-        
+
 2004-07-13  Michael Albinus  <michael.albinus@gmx.de>
 
         * net/tramp.el (all): Code cleanup.  Change all `tramp-handle-xxx'
@@ -36,7 +43,7 @@
 
         * net/tramp-vc.el (all): Code cleanup.  Change all
         `tramp-handle-xxx' calls to respective `xxx` calls.
-        
+
 2004-07-17  Jonathan Yavner  <jyavner@member.fsf.org>
 
         * emacs-lisp/testcover.el: New category "potentially-1valued" for
diff --git a/lisp/autorevert.el b/lisp/autorevert.el
index 596c7ff8997..ef438eb4b97 100644
--- a/lisp/autorevert.el
+++ b/lisp/autorevert.el
@@ -34,7 +34,8 @@
 ;;
 ;; This package contains two minor modes: Global Auto-Revert Mode and
 ;; Auto-Revert Mode.  Both modes automatically revert buffers
-;; whenever the corresponding files have been changed on disk.
+;; whenever the corresponding files have been changed on disk and the
+;; buffer contains no unsaved changes.
 ;;
 ;; Auto-Revert Mode can be activated for individual buffers.  Global
 ;; Auto-Revert Mode applies to all file buffers. (If the user option
@@ -59,6 +60,13 @@
 ;; Just put point at the end of the buffer and it will stay there.
 ;; These rules apply to file buffers. For non-file buffers, the
 ;; behavior may be mode dependent.
+;;
+;; While you can use Auto Revert Mode to tail a file, this package
+;; contains a third minor mode, Auto Revert Tail Mode, which does so
+;; more efficiently, as long as you are sure that the file will only
+;; change by growing at the end.  It only appends the new output,
+;; instead of reverting the entire buffer.  It does so even if the
+;; buffer contains unsaved changes.  (Because they will not be lost.)
 
 ;; Usage:
 ;;
@@ -389,7 +397,7 @@ This is an internal function used by Auto-Revert Mode."
                      (not (file-remote-p buffer-file-name))
                      (file-readable-p buffer-file-name)
                      (not (verify-visited-file-modtime buffer)))
-                (and (or auto-revert-mode auto-revert-tail-mode
+                (and (or auto-revert-mode
                          global-auto-revert-non-file-buffers)
                      revert-buffer-function
                      (boundp 'buffer-stale-function)