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.
This commit is contained in:
parent
6db78ae97e
commit
467768f64e
2 changed files with 17 additions and 2 deletions
|
@ -937,6 +937,8 @@ discard your changes.)
|
||||||
@findex auto-revert-mode
|
@findex auto-revert-mode
|
||||||
@findex auto-revert-tail-mode
|
@findex auto-revert-tail-mode
|
||||||
@vindex auto-revert-interval
|
@vindex auto-revert-interval
|
||||||
|
@vindex auto-revert-remote-files
|
||||||
|
@vindex auto-revert-verbose
|
||||||
You can also tell Emacs to revert buffers periodically. To do this
|
You can also tell Emacs to revert buffers periodically. To do this
|
||||||
for a specific buffer, enable the minor mode Auto-Revert mode by
|
for a specific buffer, enable the minor mode Auto-Revert mode by
|
||||||
typing @kbd{M-x auto-revert-mode}. This automatically reverts the
|
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
|
||||||
the variable @code{auto-revert-interval}. To do the same for all file
|
the variable @code{auto-revert-interval}. To do the same for all file
|
||||||
buffers, type @kbd{M-x global-auto-revert-mode} to enable Global
|
buffers, type @kbd{M-x global-auto-revert-mode} to enable Global
|
||||||
Auto-Revert mode. These minor modes do not check or revert remote
|
Auto-Revert mode. These minor modes do not check or revert remote
|
||||||
files, because that is usually too slow.
|
files, because that is usually too slow. This behavior can be changed
|
||||||
|
by setting the variable @code{auto-revert-remote-files} to non-@code{nil}.
|
||||||
|
|
||||||
One use of Auto-Revert mode is to ``tail'' a file such as a system
|
One use of Auto-Revert mode is to ``tail'' a file such as a system
|
||||||
log, so that changes made to that file by other programs are
|
log, so that changes made to that file by other programs are
|
||||||
|
@ -955,6 +958,9 @@ the end, use Auto-Revert Tail mode instead
|
||||||
(@code{auto-revert-tail-mode}). It is more efficient for this.
|
(@code{auto-revert-tail-mode}). It is more efficient for this.
|
||||||
Auto-Revert Tail mode works also for remote files.
|
Auto-Revert Tail mode works also for remote files.
|
||||||
|
|
||||||
|
When a buffer is auto-reverted, a message is generated. This can be
|
||||||
|
suppressed by setting @code{auto-revert-verbose} to @code{nil}.
|
||||||
|
|
||||||
@xref{VC Undo}, for commands to revert to earlier versions of files
|
@xref{VC Undo}, for commands to revert to earlier versions of files
|
||||||
under version control. @xref{VC Mode Line}, for Auto Revert
|
under version control. @xref{VC Mode Line}, for Auto Revert
|
||||||
peculiarities when visiting files under version control.
|
peculiarities when visiting files under version control.
|
||||||
|
|
|
@ -168,7 +168,7 @@ Thus, with this setting, Emacs might be non-responsive at times."
|
||||||
|
|
||||||
(defcustom auto-revert-verbose t
|
(defcustom auto-revert-verbose t
|
||||||
"When nil, Auto-Revert Mode does not generate any messages.
|
"When nil, Auto-Revert Mode does not generate any messages.
|
||||||
When non-nil, a message is generated whenever a file is reverted."
|
When non-nil, a message is generated whenever a buffer is reverted."
|
||||||
:group 'auto-revert
|
:group 'auto-revert
|
||||||
:type 'boolean)
|
:type 'boolean)
|
||||||
|
|
||||||
|
@ -346,6 +346,9 @@ Auto Revert mode is a minor mode that affects only the current
|
||||||
buffer. When enabled, it reverts the buffer when the file on
|
buffer. When enabled, it reverts the buffer when the file on
|
||||||
disk changes.
|
disk changes.
|
||||||
|
|
||||||
|
When a buffer is reverted, a message is generated. This can be
|
||||||
|
suppressed by setting `auto-revert-verbose' to nil.
|
||||||
|
|
||||||
Use `global-auto-revert-mode' to automatically revert all buffers.
|
Use `global-auto-revert-mode' to automatically revert all buffers.
|
||||||
Use `auto-revert-tail-mode' if you know that the file will only grow
|
Use `auto-revert-tail-mode' if you know that the file will only grow
|
||||||
without being changed in the part that is already in the buffer."
|
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
|
||||||
you please. But make sure the background process has stopped
|
you please. But make sure the background process has stopped
|
||||||
writing before you save the file!
|
writing before you save the file!
|
||||||
|
|
||||||
|
When a buffer is reverted, a message is generated. This can be
|
||||||
|
suppressed by setting `auto-revert-verbose' to nil.
|
||||||
|
|
||||||
Use `auto-revert-mode' for changes other than appends!"
|
Use `auto-revert-mode' for changes other than appends!"
|
||||||
:group 'find-file :lighter auto-revert-tail-mode-text
|
:group 'find-file :lighter auto-revert-tail-mode-text
|
||||||
(when auto-revert-tail-mode
|
(when auto-revert-tail-mode
|
||||||
|
@ -452,6 +458,9 @@ documentation of that variable. It ignores buffers with modes
|
||||||
matching `global-auto-revert-ignore-modes', and buffers with a
|
matching `global-auto-revert-ignore-modes', and buffers with a
|
||||||
non-nil vale of `global-auto-revert-ignore-buffer'.
|
non-nil vale of `global-auto-revert-ignore-buffer'.
|
||||||
|
|
||||||
|
When a buffer is reverted, a message is generated. This can be
|
||||||
|
suppressed by setting `auto-revert-verbose' to nil.
|
||||||
|
|
||||||
This function calls the hook `global-auto-revert-mode-hook'.
|
This function calls the hook `global-auto-revert-mode-hook'.
|
||||||
It displays the text that `global-auto-revert-mode-text'
|
It displays the text that `global-auto-revert-mode-text'
|
||||||
specifies in the mode line."
|
specifies in the mode line."
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue