diff options
| author | Michael Albinus | 2016-12-11 10:50:17 +0100 |
|---|---|---|
| committer | Michael Albinus | 2016-12-11 10:50:17 +0100 |
| commit | 467768f64ee109fe127619e75fee7f3b5de1fec1 (patch) | |
| tree | 92cb4e0d0d2c310419620b4f2d567b1db33e2694 | |
| parent | 6db78ae97e602f7ec06045df7e0388e4c14d0b1d (diff) | |
| download | emacs-467768f64ee109fe127619e75fee7f3b5de1fec1.tar.gz emacs-467768f64ee109fe127619e75fee7f3b5de1fec1.zip | |
Fix Bug#25162
* doc/emacs/files.texi (Reverting): Document
auto-revert-remote-files and auto-revert-verbose.
* lisp/autorevert.el (auto-revert-verbose, auto-revert-mode)
(auto-revert-tail-mode, global-auto-revert-mode): Fix docstring.
| -rw-r--r-- | doc/emacs/files.texi | 8 | ||||
| -rw-r--r-- | lisp/autorevert.el | 11 |
2 files changed, 17 insertions, 2 deletions
diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi index fc46ef7879a..264154be66f 100644 --- a/doc/emacs/files.texi +++ b/doc/emacs/files.texi | |||
| @@ -937,6 +937,8 @@ discard your changes.) | |||
| 937 | @findex auto-revert-mode | 937 | @findex auto-revert-mode |
| 938 | @findex auto-revert-tail-mode | 938 | @findex auto-revert-tail-mode |
| 939 | @vindex auto-revert-interval | 939 | @vindex auto-revert-interval |
| 940 | @vindex auto-revert-remote-files | ||
| 941 | @vindex auto-revert-verbose | ||
| 940 | You can also tell Emacs to revert buffers periodically. To do this | 942 | You can also tell Emacs to revert buffers periodically. To do this |
| 941 | for a specific buffer, enable the minor mode Auto-Revert mode by | 943 | for a specific buffer, enable the minor mode Auto-Revert mode by |
| 942 | typing @kbd{M-x auto-revert-mode}. This automatically reverts the | 944 | typing @kbd{M-x auto-revert-mode}. This automatically reverts the |
| @@ -944,7 +946,8 @@ current buffer every five seconds; you can change the interval through | |||
| 944 | the variable @code{auto-revert-interval}. To do the same for all file | 946 | the variable @code{auto-revert-interval}. To do the same for all file |
| 945 | buffers, type @kbd{M-x global-auto-revert-mode} to enable Global | 947 | buffers, type @kbd{M-x global-auto-revert-mode} to enable Global |
| 946 | Auto-Revert mode. These minor modes do not check or revert remote | 948 | Auto-Revert mode. These minor modes do not check or revert remote |
| 947 | files, because that is usually too slow. | 949 | files, because that is usually too slow. This behavior can be changed |
| 950 | by setting the variable @code{auto-revert-remote-files} to non-@code{nil}. | ||
| 948 | 951 | ||
| 949 | One use of Auto-Revert mode is to ``tail'' a file such as a system | 952 | One use of Auto-Revert mode is to ``tail'' a file such as a system |
| 950 | log, so that changes made to that file by other programs are | 953 | log, so that changes made to that file by other programs are |
| @@ -955,6 +958,9 @@ the end, use Auto-Revert Tail mode instead | |||
| 955 | (@code{auto-revert-tail-mode}). It is more efficient for this. | 958 | (@code{auto-revert-tail-mode}). It is more efficient for this. |
| 956 | Auto-Revert Tail mode works also for remote files. | 959 | Auto-Revert Tail mode works also for remote files. |
| 957 | 960 | ||
| 961 | When a buffer is auto-reverted, a message is generated. This can be | ||
| 962 | suppressed by setting @code{auto-revert-verbose} to @code{nil}. | ||
| 963 | |||
| 958 | @xref{VC Undo}, for commands to revert to earlier versions of files | 964 | @xref{VC Undo}, for commands to revert to earlier versions of files |
| 959 | under version control. @xref{VC Mode Line}, for Auto Revert | 965 | under version control. @xref{VC Mode Line}, for Auto Revert |
| 960 | peculiarities when visiting files under version control. | 966 | peculiarities when visiting files under version control. |
diff --git a/lisp/autorevert.el b/lisp/autorevert.el index b8693dfb210..d2a6213c3a8 100644 --- a/lisp/autorevert.el +++ b/lisp/autorevert.el | |||
| @@ -168,7 +168,7 @@ Thus, with this setting, Emacs might be non-responsive at times." | |||
| 168 | 168 | ||
| 169 | (defcustom auto-revert-verbose t | 169 | (defcustom auto-revert-verbose t |
| 170 | "When nil, Auto-Revert Mode does not generate any messages. | 170 | "When nil, Auto-Revert Mode does not generate any messages. |
| 171 | When non-nil, a message is generated whenever a file is reverted." | 171 | When non-nil, a message is generated whenever a buffer is reverted." |
| 172 | :group 'auto-revert | 172 | :group 'auto-revert |
| 173 | :type 'boolean) | 173 | :type 'boolean) |
| 174 | 174 | ||
| @@ -346,6 +346,9 @@ Auto Revert mode is a minor mode that affects only the current | |||
| 346 | buffer. When enabled, it reverts the buffer when the file on | 346 | buffer. When enabled, it reverts the buffer when the file on |
| 347 | disk changes. | 347 | disk changes. |
| 348 | 348 | ||
| 349 | When a buffer is reverted, a message is generated. This can be | ||
| 350 | suppressed by setting `auto-revert-verbose' to nil. | ||
| 351 | |||
| 349 | Use `global-auto-revert-mode' to automatically revert all buffers. | 352 | Use `global-auto-revert-mode' to automatically revert all buffers. |
| 350 | Use `auto-revert-tail-mode' if you know that the file will only grow | 353 | Use `auto-revert-tail-mode' if you know that the file will only grow |
| 351 | without being changed in the part that is already in the buffer." | 354 | without being changed in the part that is already in the buffer." |
| @@ -388,6 +391,9 @@ You can edit the buffer and turn this mode off and on again as | |||
| 388 | you please. But make sure the background process has stopped | 391 | you please. But make sure the background process has stopped |
| 389 | writing before you save the file! | 392 | writing before you save the file! |
| 390 | 393 | ||
| 394 | When a buffer is reverted, a message is generated. This can be | ||
| 395 | suppressed by setting `auto-revert-verbose' to nil. | ||
| 396 | |||
| 391 | Use `auto-revert-mode' for changes other than appends!" | 397 | Use `auto-revert-mode' for changes other than appends!" |
| 392 | :group 'find-file :lighter auto-revert-tail-mode-text | 398 | :group 'find-file :lighter auto-revert-tail-mode-text |
| 393 | (when auto-revert-tail-mode | 399 | (when auto-revert-tail-mode |
| @@ -452,6 +458,9 @@ documentation of that variable. It ignores buffers with modes | |||
| 452 | matching `global-auto-revert-ignore-modes', and buffers with a | 458 | matching `global-auto-revert-ignore-modes', and buffers with a |
| 453 | non-nil vale of `global-auto-revert-ignore-buffer'. | 459 | non-nil vale of `global-auto-revert-ignore-buffer'. |
| 454 | 460 | ||
| 461 | When a buffer is reverted, a message is generated. This can be | ||
| 462 | suppressed by setting `auto-revert-verbose' to nil. | ||
| 463 | |||
| 455 | This function calls the hook `global-auto-revert-mode-hook'. | 464 | This function calls the hook `global-auto-revert-mode-hook'. |
| 456 | It displays the text that `global-auto-revert-mode-text' | 465 | It displays the text that `global-auto-revert-mode-text' |
| 457 | specifies in the mode line." | 466 | specifies in the mode line." |