From 86a143b455b68bc6dfffa50fd4b5d14f480eeceb Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sun, 13 Jul 2025 19:51:23 +0300 Subject: [PATCH] ; Fix documentation of a recent change * doc/emacs/vc1-xtra.texi (VC Auto-Reverting): Fix wording and cross-references. * doc/emacs/emacs.texi (Top): Update @detailmenu. (cherry picked from commit 1e3d76af5a7a16682e71f9df46f6788c0880cccd) --- doc/emacs/emacs.texi | 4 +++- doc/emacs/vc1-xtra.texi | 10 +++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index 54bb5178c0d..3ded7c30e95 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi @@ -864,7 +864,9 @@ Miscellaneous Commands and Features of VC * VC Delete/Rename:: Deleting and renaming version-controlled files. * Revision Tags:: Symbolic names for revisions. * Version Headers:: Inserting version control headers into working files. -* Editing VC Commands:: Editing the VC shell commands that Emacs will run. +* Editing VC Commands:: Editing the VC shell commands that Emacs will run. +* Preparing Patches:: Preparing and composing patches from within VC. +* VC Auto-Reverting:: Updating buffer contents after VCS operations. Customizing VC diff --git a/doc/emacs/vc1-xtra.texi b/doc/emacs/vc1-xtra.texi index fa7b3a6b3ba..197a34546ba 100644 --- a/doc/emacs/vc1-xtra.texi +++ b/doc/emacs/vc1-xtra.texi @@ -316,7 +316,7 @@ you wish to use. This will be used as the default value when invoking this as a directory local variable (@pxref{Directory Variables}). @node VC Auto-Reverting -@subsubsection Auto-Reverting Buffers Visiting Tracked Files +@subsubsection Auto-Reverting Buffers That Visit Tracked Files When Emacs executes VCS operations that it knows may change the contents of tracked files, it reverts buffers visiting those files @@ -331,16 +331,16 @@ revert buffers when you execute additional VCS operations outside of Emacs, such as at a shell prompt, or by means of scripts. If you regularly do this, and you don't use a VCS with keyword expansion (all modern VCS, absent special configuration), you may wish to enable -@code{vc-auto-revert-mode} instead, by customizing that variable to -non-@code{nil}. +@code{vc-auto-revert-mode} instead, by customizing that variable to a +non-@code{nil} value. This mode is just like @code{global-auto-revert-mode} (@pxref{Auto Revert}) except limited to files visiting VCS-tracked files. It ensures that Emacs will always revert buffers when VCS operations change their contents, regardless of whether Emacs initiated those operations. - @xref{VC Mode Line} regarding Auto Revert mode in buffers visiting -tracked files (which is what @code{vc-auto-revert-mode} enables). + @xref{VC Mode Line}, for details regarding Auto Revert mode in buffers +visiting tracked files (which is what @code{vc-auto-revert-mode} enables). @node Customizing VC @subsection Customizing VC -- 2.39.5