diff mbox series

[v2] vimdiff: clarify the sigil used for marking the buffer to save

Message ID 20250324205327.79627-1-ben.knoble+github@gmail.com (mailing list archive)
State New
Headers show
Series [v2] vimdiff: clarify the sigil used for marking the buffer to save | expand

Commit Message

D. Ben Knoble March 24, 2025, 8:52 p.m. UTC
The original documentation from 7b5cf8be18 (vimdiff: add tool
documentation, 2022-03-30) mistakenly described the marker as an
asterisk, which is the character "*". The code and examples have always
looked for an arobase ("@").

Signed-off-by: D. Ben Knoble <ben.knoble+github@gmail.com>
---

- v2 signs off the patch ;)
- v1 with notes on the name arobase and scope of change: https://lore.kernel.org/git/CAPig+cQg_VTN7Ug3FTdLdkVwSPZGiQHJZSpCkA2pTxwBiT29bw@mail.gmail.com/

 Documentation/mergetools/vimdiff.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


Diff-intervalle contre v1 :
1:  5b8b824e61 ! 1:  4ab274c3c4 vimdiff: clarify the sigil used for marking the buffer to save
    @@ Commit message
         asterisk, which is the character "*". The code and examples have always
         looked for an arobase ("@").
     
    +    Signed-off-by: D. Ben Knoble <ben.knoble+github@gmail.com>
    +
      ## Documentation/mergetools/vimdiff.adoc ##
     @@ Documentation/mergetools/vimdiff.adoc: command.
      +

Comments

Fernando March 24, 2025, 10:47 p.m. UTC | #1
Good catch!

If I recall correctly, the very first version of the code used an asterisk
instead of the "@" symbol... but it looks like I forgot to update that part of
the documentation once the asterisk option was discarded.

Thanks!
diff mbox series

Patch

diff --git a/Documentation/mergetools/vimdiff.adoc b/Documentation/mergetools/vimdiff.adoc
index befa86d692..ab915df408 100644
--- a/Documentation/mergetools/vimdiff.adoc
+++ b/Documentation/mergetools/vimdiff.adoc
@@ -86,7 +86,7 @@  command.
 +
 --
 When `MERGED` is not present in the layout, you must "mark" one of the
-buffers with an asterisk. That will become the buffer you need to edit and
+buffers with an arobase (`@`). That will become the buffer you need to edit and
 save after resolving the conflicts.
 ....
 ------------------------------------------