From 61c1522ddedc45d85804ff2786bd301e9b487b32 Mon Sep 17 00:00:00 2001 From: Konstantin Kharlamov Date: Tue, 20 Jul 2021 16:38:55 +0200 Subject: [PATCH] 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). --- lisp/autorevert.el | 5 +++++ lisp/files.el | 5 +++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/lisp/autorevert.el b/lisp/autorevert.el index edd4c7e5e45..f8fd92d02bd 100644 --- a/lisp/autorevert.el +++ b/lisp/autorevert.el @@ -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." diff --git a/lisp/files.el b/lisp/files.el index c265f33550f..01b8bdf5ff0 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -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 -- 2.39.5