Improve auto-revert-mode and revert-buffer doc strings

* lisp/autorevert.el (auto-revert-mode):
* lisp/files.el (revert-buffer): Mention that there is
revert-buffer-with-fine-grain that is better suited for markers
preservation (bug#49661).
This commit is contained in:
Konstantin Kharlamov 2021-07-20 16:38:55 +02:00 committed by Lars Ingebrigtsen
parent b4fabb316d
commit 61c1522dde
2 changed files with 8 additions and 2 deletions

View file

@ -391,6 +391,11 @@ disk changes.
When a buffer is reverted, a message is generated. This can be
suppressed by setting `auto-revert-verbose' to nil.
Reverting may also break markers in the buffer. To avoid that
you may set `revert-buffer-insert-file-contents-function' to the
slower function `revert-buffer-insert-file-contents-delicately'.
See its description for details.
Use `global-auto-revert-mode' to automatically revert all buffers.
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."

View file

@ -6278,8 +6278,9 @@ This undoes all changes since the file was visited or saved.
With a prefix argument, offer to revert from latest auto-save file, if
that is more recent than the visited file.
Reverting a buffer will try to preserve markers in the buffer;
see the Info node `(elisp)Reverting' for details.
Reverting a buffer will try to preserve markers in the buffer,
but for better results see `revert-buffer-with-fine-grain'. For
details see the Info node `(elisp)Reverting'.
This command also implements an interface for special buffers
that contain text that doesn't come from a file, but reflects