X-Git-Url: http://git.hcoop.net/bpt/emacs.git/blobdiff_plain/95df8112a0cbdb06addbac5fbea03b37d4440418..52695556f3cd5d83e28461dc2a8fa348637cb793:/doc/emacs/arevert-xtra.texi diff --git a/doc/emacs/arevert-xtra.texi b/doc/emacs/arevert-xtra.texi index 374886cd95..a13f59b69b 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-2011 Free Software Foundation, Inc. +@c Copyright (C) 2004-2014 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 @@ -8,11 +8,11 @@ @section Auto Reverting Non-File Buffers Global Auto Revert Mode normally only reverts file buffers. There are -two ways to auto-revert certain non-file buffers: enabling Auto Revert -Mode in those buffers (using @kbd{M-x auto-revert-mode}); and setting -@code{global-auto-revert-non-file-buffers} non-@code{nil}. The latter -enables Auto Reverting for all types of buffers for which it is -implemented (listed in the menu below). +two ways to auto-revert certain non-file buffers: by enabling Auto +Revert Mode in those buffers (using @kbd{M-x auto-revert-mode}); and +by setting @code{global-auto-revert-non-file-buffers} to a +non-@code{nil} value. The latter enables Auto Reverting for all types +of buffers for which it is implemented (listed in the menu below). Like file buffers, non-file buffers should normally not revert while you are working on them, or while they contain information that might @@ -40,7 +40,7 @@ explained in the corresponding sections. @menu * Auto Reverting the Buffer Menu:: Auto Revert of the Buffer Menu. * Auto Reverting Dired:: Auto Revert of Dired buffers. -* Supporting additional buffers:: How to add more Auto Revert support. +* Supporting additional buffers:: How to add more Auto Revert support. @end menu @node Auto Reverting the Buffer Menu @@ -66,9 +66,9 @@ operating systems. It may not work satisfactorily on some other systems. Dired buffers only auto-revert when the file list of the buffer's main -directory changes (e.g. when a new file is added). They do not +directory changes (e.g., when a new file is added). They do not auto-revert when information about a particular file changes -(e.g. when the size changes) or when inserted subdirectories change. +(e.g., when the size changes) or when inserted subdirectories change. To be sure that @emph{all} listed information is up to date, you have to manually revert using @kbd{g}, @emph{even} if auto-reverting is enabled in the Dired buffer. Sometimes, you might get the impression @@ -93,9 +93,10 @@ deleting or changing marks or flags will mark it modified again. Remote Dired buffers are not auto-reverted (because it may be slow). 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. +arguments to list only some of the files. @file{*Find*} and +@file{*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. @@ -108,6 +109,7 @@ revert-buffer-function,, Reverting, elisp, the Emacs Lisp Reference Manual}. In addition, it @emph{must} have a @code{buffer-stale-function}. +@c FIXME only defvar in all of doc/emacs! @defvar buffer-stale-function The value of this variable is a function to check whether a non-file buffer needs reverting. This should be a function with one optional