threads / patch / 63186

patchvimdiff: clarify the sigil used for marking the buffer to save

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

## tl;dr

3 messages between Mar 24, 2025 and Mar 24, 2025. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

D. Ben Knoble· Mar 24, 2025, 20:45 UTC · lore

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 ("@"). ---

NB The (French) name arobase for "@" is gaining popularity in English writing but is not yet universally standard. Use of a different name when picking is fine by me.

I also did not attempt to clarify the behavior from the recent bug report [1] because I hope it is repared rather than documented.

[1]: https://lore.kernel.org/git/CAC6paJg19ue7W0VxTnGH-1ra3Zkk+pRnj6McEC755RD54xDzCA@mail.gmail.com/
 Documentation/mergetools/vimdiff.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/mergetools/vimdiff.adoc +1 −1
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.
 ....
 ------------------------------------------
-- 
2.48.1
Eric Sunshine· Mar 24, 2025, 20:47 UTC · re: D. Ben Knoble · lore

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

On Mon, Mar 24, 2025 at 4:46 PM D. Ben Knoble <ben.knoble+github@gmail.com> wrote:

Show 5 quoted lines
> 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 ("@").
> ---
Missing sign-off.
D. Ben Knoble· Mar 24, 2025, 20:51 UTC · re: Eric Sunshine · lore

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

On Mon, Mar 24, 2025 at 4:47 PM Eric Sunshine <sunshine@sunshineco.com> wrote:
Show 10 quoted lines
>
> On Mon, Mar 24, 2025 at 4:46 PM D. Ben Knoble
> <ben.knoble+github@gmail.com> wrote:
> > 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 ("@").
> > ---
>
> Missing sign-off.
doh, indeed.

← back to recent threads