diff options
| author | Glenn Morris | 2014-04-03 22:09:35 -0400 |
|---|---|---|
| committer | Glenn Morris | 2014-04-03 22:09:35 -0400 |
| commit | 8a1d24b11ef7bfed0752896cbfbcdd793f100b03 (patch) | |
| tree | 23cfe23968dcc68b9649c745d76eae05d0ab720c /doc | |
| parent | 0360792967fa95567a9ec2d767f3a33563c1bbc5 (diff) | |
| download | emacs-8a1d24b11ef7bfed0752896cbfbcdd793f100b03.tar.gz emacs-8a1d24b11ef7bfed0752896cbfbcdd793f100b03.zip | |
Doc updates for buffer-stale-function now applying to file buffers too
* doc/emacs/arevert-xtra.texi (Supporting additional buffers):
* doc/lispref/backups.texi (Reverting):
Update for buffer-stale-function also applying to file-buffers.
* lisp/autorevert.el (auto-revert-buffers):
* lisp/files.el (buffer-stale--default-function)
(buffer-stale-function, revert-buffer--default): Doc tweaks.
* etc/NEWS: Related edits.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs/ChangeLog | 2 | ||||
| -rw-r--r-- | doc/emacs/arevert-xtra.texi | 6 | ||||
| -rw-r--r-- | doc/lispref/ChangeLog | 2 | ||||
| -rw-r--r-- | doc/lispref/backups.texi | 4 |
4 files changed, 10 insertions, 4 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index bd593f49db3..c0581424833 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -3,6 +3,8 @@ | |||
| 3 | * files.texi (Backup Names): | 3 | * files.texi (Backup Names): |
| 4 | * arevert-xtra.texi (Supporting additional buffers): | 4 | * arevert-xtra.texi (Supporting additional buffers): |
| 5 | Update for default values of some -function vars no longer being nil. | 5 | Update for default values of some -function vars no longer being nil. |
| 6 | (Supporting additional buffers): | ||
| 7 | Update for buffer-stale-function also applying to file-buffers. | ||
| 6 | 8 | ||
| 7 | 2014-03-16 Dmitry Gutov <dgutov@yandex.ru> | 9 | 2014-03-16 Dmitry Gutov <dgutov@yandex.ru> |
| 8 | 10 | ||
diff --git a/doc/emacs/arevert-xtra.texi b/doc/emacs/arevert-xtra.texi index 0f05d1db0e1..dcb73bc96de 100644 --- a/doc/emacs/arevert-xtra.texi +++ b/doc/emacs/arevert-xtra.texi | |||
| @@ -107,11 +107,11 @@ To support auto-reverting the buffer must first of all have a suitable | |||
| 107 | @code{revert-buffer-function}. @xref{Definition of | 107 | @code{revert-buffer-function}. @xref{Definition of |
| 108 | revert-buffer-function,, Reverting, elisp, the Emacs Lisp Reference Manual}. | 108 | revert-buffer-function,, Reverting, elisp, the Emacs Lisp Reference Manual}. |
| 109 | 109 | ||
| 110 | In addition, it must have a @code{buffer-stale-function}. | 110 | In addition, it must have a suitable @code{buffer-stale-function}. |
| 111 | 111 | ||
| 112 | @c FIXME only defvar in all of doc/emacs! | 112 | @c FIXME only defvar in all of doc/emacs! |
| 113 | @defvar buffer-stale-function | 113 | @defvar buffer-stale-function |
| 114 | The value of this variable is a function to check whether a non-file | 114 | The value of this variable is a function to check whether a |
| 115 | buffer needs reverting. This should be a function with one optional | 115 | buffer needs reverting. This should be a function with one optional |
| 116 | argument @var{noconfirm}. The function should return non-@code{nil} | 116 | argument @var{noconfirm}. The function should return non-@code{nil} |
| 117 | if the buffer should be reverted. The buffer is current when this | 117 | if the buffer should be reverted. The buffer is current when this |
| @@ -132,7 +132,7 @@ If you just want to automatically auto-revert every | |||
| 132 | @code{auto-revert-interval} seconds (like the Buffer Menu), use: | 132 | @code{auto-revert-interval} seconds (like the Buffer Menu), use: |
| 133 | 133 | ||
| 134 | @example | 134 | @example |
| 135 | (set (make-local-variable 'buffer-stale-function) | 135 | (setq-local buffer-stale-function |
| 136 | #'(lambda (&optional noconfirm) 'fast)) | 136 | #'(lambda (&optional noconfirm) 'fast)) |
| 137 | @end example | 137 | @end example |
| 138 | 138 | ||
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 456c2cbdc12..1fb664893f8 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -2,6 +2,8 @@ | |||
| 2 | 2 | ||
| 3 | * backups.texi (Making Backups, Reverting): | 3 | * backups.texi (Making Backups, Reverting): |
| 4 | Update for default values of some -function vars no longer being nil. | 4 | Update for default values of some -function vars no longer being nil. |
| 5 | (Reverting): Update for buffer-stale-function | ||
| 6 | also applying to file-buffers. | ||
| 5 | 7 | ||
| 6 | 2014-03-25 Eli Zaretskii <eliz@gnu.org> | 8 | 2014-03-25 Eli Zaretskii <eliz@gnu.org> |
| 7 | 9 | ||
diff --git a/doc/lispref/backups.texi b/doc/lispref/backups.texi index 9fa97fc1300..63f8f227c84 100644 --- a/doc/lispref/backups.texi +++ b/doc/lispref/backups.texi | |||
| @@ -764,7 +764,9 @@ may or may not run this hook. | |||
| 764 | @c FIXME? Move this section from arevert-xtra to here? | 764 | @c FIXME? Move this section from arevert-xtra to here? |
| 765 | @defvar buffer-stale-function | 765 | @defvar buffer-stale-function |
| 766 | The value of this variable specifies a function to call to check | 766 | The value of this variable specifies a function to call to check |
| 767 | whether a non-file buffer needs reverting | 767 | whether a buffer needs reverting. The default value only handles |
| 768 | buffers that are visiting files, by checking their modification time. | ||
| 769 | Buffers that are not visiting files require a custom function | ||
| 768 | @iftex | 770 | @iftex |
| 769 | (@pxref{Supporting additional buffers,,, emacs-xtra, Specialized Emacs Features}). | 771 | (@pxref{Supporting additional buffers,,, emacs-xtra, Specialized Emacs Features}). |
| 770 | @end iftex | 772 | @end iftex |