branch: externals/denote
commit 4723147554802af516b4a53d306e7e70cf1d4573
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Update the manual for denote-rename-file to mention
denote-rename-confirmations
This new user option was contributed by Jean-Philippe Gagné Guay in
pull request 324: <https://github.com/protesilaos/denote/pull/324>.
---
README.org | 25 +++++++++++++------------
1 file changed, 13 insertions(+), 12 deletions(-)
diff --git a/README.org b/README.org
index 1d17336d7c..fef1f20ae2 100644
--- a/README.org
+++ b/README.org
@@ -1248,18 +1248,19 @@ When renaming =FILE=, the command reads its file type
extension (like
=.org=) and preserves it through the renaming process. Files that have
no extension are left without one.
-As a final step, it asks for confirmation, showing the difference
-between old and new file names. It does not ask for confirmation if
-the user option ~denote-rename-no-confirm~ is set to a non-nil value
-([[#h:a2ae9090-c49e-4b32-bcf5-eb8944241fd7][The ~denote-rename-no-confirm~
option]]).
-
-If =FILE= has front matter for =TITLE= and =KEYWORDS=,
-~denote-rename-file~ asks to rewrite their values in order to reflect
-the new input, unless ~denote-rename-no-confirm~ is non-nil. When the
-~denote-rename-no-confirm~ is nil (the default), the underlying buffer
-is not saved, giving the user the change to invoking ~diff-buffer-with-file~ to
-double-check the effect. The rewrite of the =TITLE= and =KEYWORDS= in
-the front matter should not affect the rest of the front matter.
+As a final step, ask for confirmation, showing the difference
+between old and new file names. Do not ask for confirmation if
+the user option ~denote-rename-confirmations~ does not contain
+the symbol ~modify-file-name~ ([[#h:a2ae9090-c49e-4b32-bcf5-eb8944241fd7][The
~denote-rename-confirmations~ option]]).
+
+If =FILE= has front matter for =TITLE= and =KEYWORDS=, ask to rewrite
+their values in order to reflect the new input, unless
+~denote-rename-confirmations~ lacks ~rewrite-front-matter~. When the
+~denote-save-buffers~ is nil (the default), do not save the underlying
+buffer, thus giving the user the option to double-check the result,
+such as by invoking the command ~diff-buffer-with-file~. The rewrite
+of the =TITLE= and =KEYWORDS= in the front matter should not affect
+the rest of the front matter.
If the file does not have front matter but is among the supported file
types (per ~denote-file-type~), the ~denote-rename-file~ adds front
