git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2] vimdiff: clarify the sigil used for marking the buffer to save
@ 2025-03-24 20:52 D. Ben Knoble
  2025-03-24 22:47 ` Fernando Ramos
  0 siblings, 1 reply; 2+ messages in thread
From: D. Ben Knoble @ 2025-03-24 20:52 UTC (permalink / raw)
  To: git; +Cc: D. Ben Knoble, Fernando Ramos, Junio C Hamano

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 --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.
 ....
 ------------------------------------------

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.
      +
-- 
2.48.1


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH v2] vimdiff: clarify the sigil used for marking the buffer to save
  2025-03-24 20:52 [PATCH v2] vimdiff: clarify the sigil used for marking the buffer to save D. Ben Knoble
@ 2025-03-24 22:47 ` Fernando Ramos
  0 siblings, 0 replies; 2+ messages in thread
From: Fernando Ramos @ 2025-03-24 22:47 UTC (permalink / raw)
  To: D. Ben Knoble; +Cc: git, Junio C Hamano

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!

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2025-03-24 22:48 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-03-24 20:52 [PATCH v2] vimdiff: clarify the sigil used for marking the buffer to save D. Ben Knoble
2025-03-24 22:47 ` Fernando Ramos

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).