threads / patch / 64961

patchdoc: rerere-options.adoc: link to git-rerere(1)

Subject: [PATCH] doc: rerere-options.adoc: link to git-rerere(1)

## tl;dr

10 messages between Feb 9, 2026 and Feb 12, 2026. Diffs are folded; open one to read it.

replies: 9people: 4as markdown or json

kristofferhaugsbakk@fastmail.com· Feb 9, 2026, 18:13 UTC · lore
From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Five commands include these options. Let’s link to the command so that the curious user can learn more about what “rerere” is about.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
    Topic name: kh/doc-link-rerere
 Documentation/rerere-options.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/rerere-options.adoc +1 −1
diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
index b0b920144a6..115882edab1 100644
--- a/Documentation/rerere-options.adoc
+++ b/Documentation/rerere-options.adoc
@@ -4,6 +4,6 @@
 	the current conflict to update the files in the working
 	tree, allow it to also update the index with the result of
 	resolution.  `--no-rerere-autoupdate` is a good way to
-	double-check what `rerere` did and catch potential
+	double-check what linkgit:git-rerere[1] did and catch potential
 	mismerges, before committing the result to the index with a
 	separate `git add`.

base-commit: 67ad42147a7acc2af6074753ebd03d904476118f
-- 
2.53.0.26.g2afa8602a26
D. Ben Knoble· Feb 9, 2026, 21:57 UTC · re: kristofferhaugsbakk@fastmail.com · lore

Re: [PATCH] doc: rerere-options.adoc: link to git-rerere(1)

On Mon, Feb 9, 2026 at 1:14 PM <kristofferhaugsbakk@fastmail.com> wrote:
Show 27 quoted lines
>
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> Five commands include these options. Let’s link to the command so that
> the curious user can learn more about what “rerere” is about.
>
> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
> ---
>
> Notes (series):
>     Topic name: kh/doc-link-rerere
>
>  Documentation/rerere-options.adoc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
> index b0b920144a6..115882edab1 100644
> --- a/Documentation/rerere-options.adoc
> +++ b/Documentation/rerere-options.adoc
> @@ -4,6 +4,6 @@
>         the current conflict to update the files in the working
>         tree, allow it to also update the index with the result of
>         resolution.  `--no-rerere-autoupdate` is a good way to
> -       double-check what `rerere` did and catch potential
> +       double-check what linkgit:git-rerere[1] did and catch potential
>         mismerges, before committing the result to the index with a
>         separate `git add`.
Minor: should this adjacent be linkgit too? I thought yes, but on
second read we really are talking about the command.
Anyway, agreed that rerere should get linked. Thanks!
-- 
D. Ben Knoble
Junio C Hamano· Feb 9, 2026, 22:21 UTC · re: D. Ben Knoble · lore

Re: [PATCH] doc: rerere-options.adoc: link to git-rerere(1)

"D. Ben Knoble" <ben.knoble@gmail.com> writes:
Show 17 quoted lines
>> diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
>> index b0b920144a6..115882edab1 100644
>> --- a/Documentation/rerere-options.adoc
>> +++ b/Documentation/rerere-options.adoc
>> @@ -4,6 +4,6 @@
>>         the current conflict to update the files in the working
>>         tree, allow it to also update the index with the result of
>>         resolution.  `--no-rerere-autoupdate` is a good way to
>> -       double-check what `rerere` did and catch potential
>> +       double-check what linkgit:git-rerere[1] did and catch potential
>>         mismerges, before committing the result to the index with a
>>         separate `git add`.
>
> Minor: should this adjacent be linkgit too? I thought yes, but on
> second read we really are talking about the command.
>
> Anyway, agreed that rerere should get linked. Thanks!

If you are happy with the end result, I would not complain, but which _other_ potential thing were you wondering if it should acquire "linkgit:"?

Ben Knoble· Feb 9, 2026, 23:12 UTC · re: Junio C Hamano · lore

Re: [PATCH] doc: rerere-options.adoc: link to git-rerere(1)

Show 23 quoted lines
> Le 9 févr. 2026 à 17:21, Junio C Hamano <gitster@pobox.com> a écrit :
> 
> "D. Ben Knoble" <ben.knoble@gmail.com> writes:
> 
>>> diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
>>> index b0b920144a6..115882edab1 100644
>>> --- a/Documentation/rerere-options.adoc
>>> +++ b/Documentation/rerere-options.adoc
>>> @@ -4,6 +4,6 @@
>>>       the current conflict to update the files in the working
>>>       tree, allow it to also update the index with the result of
>>>       resolution.  `--no-rerere-autoupdate` is a good way to
>>> -       double-check what `rerere` did and catch potential
>>> +       double-check what linkgit:git-rerere[1] did and catch potential
>>>       mismerges, before committing the result to the index with a
>>>       separate `git add`.
>> Minor: should this adjacent be linkgit too? I thought yes, but on
>> second read we really are talking about the command.
>> Anyway, agreed that rerere should get linked. Thanks!
> 
> If you are happy with the end result, I would not complain, but
> which _other_ potential thing were you wondering if it should
> acquire "linkgit:"?
Doh, typo: the « git add » as Kristoffer read my mind ;)
Kristoffer Haugsbakk· Feb 9, 2026, 22:23 UTC · re: D. Ben Knoble · lore

Re: [PATCH] doc: rerere-options.adoc: link to git-rerere(1)

On Mon, Feb 9, 2026, at 22:57, D. Ben Knoble wrote:
Show 18 quoted lines
>>[snip]
>> diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
>> index b0b920144a6..115882edab1 100644
>> --- a/Documentation/rerere-options.adoc
>> +++ b/Documentation/rerere-options.adoc
>> @@ -4,6 +4,6 @@
>>         the current conflict to update the files in the working
>>         tree, allow it to also update the index with the result of
>>         resolution.  `--no-rerere-autoupdate` is a good way to
>> -       double-check what `rerere` did and catch potential
>> +       double-check what linkgit:git-rerere[1] did and catch potential
>>         mismerges, before committing the result to the index with a
>>         separate `git add`.
>
> Minor: should this adjacent be linkgit too? I thought yes, but on
> second read we really are talking about the command.
>
> Anyway, agreed that rerere should get linked. Thanks!

The `git add`? Good question. I considered it. At first it seemed like too much of a “apply this command”, if that even makes sense. But now I think rendering it as

    separate git-add(1).
Makes sense.
Thanks for taking a look. :)
kristofferhaugsbakk@fastmail.com· Feb 10, 2026, 19:56 UTC · re: kristofferhaugsbakk@fastmail.com · lore

[PATCH v2] doc: rerere-options.adoc: link to git-rerere(1)

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Five commands include these options. Let’s link to the command so that the curious user can learn more about what “rerere” is about.

It’s also better to consistently refer to things like e.g. “git-subcommand(1)” over `git subcommand` or `subcommand`.

Also apply the same treatment to git-add(1).
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
    Topic name (applied): kh/doc-rerere-options-xref
    
    v2: Same for git-add(1) and expand on the more general point of it all.
 Documentation/rerere-options.adoc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Show changes to Documentation/rerere-options.adoc +2 −2
diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
index b0b920144a6..4395fe05356 100644
--- a/Documentation/rerere-options.adoc
+++ b/Documentation/rerere-options.adoc
@@ -4,6 +4,6 @@
 	the current conflict to update the files in the working
 	tree, allow it to also update the index with the result of
 	resolution.  `--no-rerere-autoupdate` is a good way to
-	double-check what `rerere` did and catch potential
+	double-check what linkgit:git-rerere[1] did and catch potential
 	mismerges, before committing the result to the index with a
-	separate `git add`.
+	separate linkgit:git-add[1].

Interdiff against v1:
  diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
  index 115882edab1..4395fe05356 100644
  --- a/Documentation/rerere-options.adoc
  +++ b/Documentation/rerere-options.adoc
  @@ -6,4 +6,4 @@
   	resolution.  `--no-rerere-autoupdate` is a good way to
   	double-check what linkgit:git-rerere[1] did and catch potential
   	mismerges, before committing the result to the index with a
  -	separate `git add`.
  +	separate linkgit:git-add[1].

base-commit: 67ad42147a7acc2af6074753ebd03d904476118f
-- 
2.53.0.26.g2afa8602a26
D. Ben Knoble· Feb 10, 2026, 21:33 UTC · re: kristofferhaugsbakk@fastmail.com · lore

Re: [PATCH v2] doc: rerere-options.adoc: link to git-rerere(1)

On Tue, Feb 10, 2026 at 2:57 PM <kristofferhaugsbakk@fastmail.com> wrote:
Show 51 quoted lines
>
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> Five commands include these options. Let’s link to the command so that
> the curious user can learn more about what “rerere” is about.
>
> It’s also better to consistently refer to things like
> e.g. “git-subcommand(1)” over `git subcommand` or `subcommand`.
>
> Also apply the same treatment to git-add(1).
>
> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
> ---
>
> Notes (series):
>     Topic name (applied): kh/doc-rerere-options-xref
>
>     v2: Same for git-add(1) and expand on the more general point of it all.
>
>  Documentation/rerere-options.adoc | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
> index b0b920144a6..4395fe05356 100644
> --- a/Documentation/rerere-options.adoc
> +++ b/Documentation/rerere-options.adoc
> @@ -4,6 +4,6 @@
>         the current conflict to update the files in the working
>         tree, allow it to also update the index with the result of
>         resolution.  `--no-rerere-autoupdate` is a good way to
> -       double-check what `rerere` did and catch potential
> +       double-check what linkgit:git-rerere[1] did and catch potential
>         mismerges, before committing the result to the index with a
> -       separate `git add`.
> +       separate linkgit:git-add[1].
>
> Interdiff against v1:
>   diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
>   index 115882edab1..4395fe05356 100644
>   --- a/Documentation/rerere-options.adoc
>   +++ b/Documentation/rerere-options.adoc
>   @@ -6,4 +6,4 @@
>         resolution.  `--no-rerere-autoupdate` is a good way to
>         double-check what linkgit:git-rerere[1] did and catch potential
>         mismerges, before committing the result to the index with a
>   -     separate `git add`.
>   +     separate linkgit:git-add[1].
>
> base-commit: 67ad42147a7acc2af6074753ebd03d904476118f
> --
> 2.53.0.26.g2afa8602a26
Excellent, thanks for also including the rationale. LGTM!
-- 
D. Ben Knoble
Jean-Noël Avila· Feb 11, 2026, 07:14 UTC · re: kristofferhaugsbakk@fastmail.com · lore

Re: [PATCH] doc: rerere-options.adoc: link to git-rerere(1)

Le 09/02/2026 à 19:13, kristofferhaugsbakk@fastmail.com a écrit :
Show 28 quoted lines
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
> 
> Five commands include these options. Let’s link to the command so that
> the curious user can learn more about what “rerere” is about.
> 
> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
> ---
> 
> Notes (series):
>     Topic name: kh/doc-link-rerere
> 
>  Documentation/rerere-options.adoc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
> index b0b920144a6..115882edab1 100644
> --- a/Documentation/rerere-options.adoc
> +++ b/Documentation/rerere-options.adoc
> @@ -4,6 +4,6 @@
>  	the current conflict to update the files in the working
>  	tree, allow it to also update the index with the result of
>  	resolution.  `--no-rerere-autoupdate` is a good way to
> -	double-check what `rerere` did and catch potential
> +	double-check what linkgit:git-rerere[1] did and catch potential
>  	mismerges, before committing the result to the index with a
>  	separate `git add`.
> 
> base-commit: 67ad42147a7acc2af6074753ebd03d904476118f

I'm not fond of introducing linkgit macro that can create auto-reference in manual pages. At the moment, we need to use conditional inclusion in the manual pages source, but I wonder if we could simply filter out the links in the macro itself.

Junio C Hamano· Feb 11, 2026, 15:43 UTC · re: Jean-Noël Avila · lore

Re: [PATCH] doc: rerere-options.adoc: link to git-rerere(1)

Jean-Noël Avila <jn.avila@free.fr> writes:
Show 19 quoted lines
>> diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
>> index b0b920144a6..115882edab1 100644
>> --- a/Documentation/rerere-options.adoc
>> +++ b/Documentation/rerere-options.adoc
>> @@ -4,6 +4,6 @@
>>  	the current conflict to update the files in the working
>>  	tree, allow it to also update the index with the result of
>>  	resolution.  `--no-rerere-autoupdate` is a good way to
>> -	double-check what `rerere` did and catch potential
>> +	double-check what linkgit:git-rerere[1] did and catch potential
>>  	mismerges, before committing the result to the index with a
>>  	separate `git add`.
>> 
>> base-commit: 67ad42147a7acc2af6074753ebd03d904476118f
>
> I'm not fond of introducing linkgit macro that can create auto-reference
> in manual pages. At the moment, we need to use conditional inclusion in
> the manual pages source, but I wonder if we could simply filter out the
> links in the macro itself.

FWIW, before deciding to accept the patch, I did check if git-rerere.adoc included this file (it didn't), but if we can make the macro smarter to do so, it would be great, as that would avoid people including this file there later without realizing that they now need to make the mark-up conditional.

This particular patch does not have to be blocked waiting for such an improvement, though, right?

Jean-Noël Avila· Feb 12, 2026, 05:37 UTC · re: Junio C Hamano · lore

Re: [PATCH] doc: rerere-options.adoc: link to git-rerere(1)

Le 11/02/2026 à 16:43, Junio C Hamano a écrit :
Show 27 quoted lines
> Jean-Noël Avila <jn.avila@free.fr> writes:
> 
>>> diff --git a/Documentation/rerere-options.adoc b/Documentation/rerere-options.adoc
>>> index b0b920144a6..115882edab1 100644
>>> --- a/Documentation/rerere-options.adoc
>>> +++ b/Documentation/rerere-options.adoc
>>> @@ -4,6 +4,6 @@
>>>  	the current conflict to update the files in the working
>>>  	tree, allow it to also update the index with the result of
>>>  	resolution.  `--no-rerere-autoupdate` is a good way to
>>> -	double-check what `rerere` did and catch potential
>>> +	double-check what linkgit:git-rerere[1] did and catch potential
>>>  	mismerges, before committing the result to the index with a
>>>  	separate `git add`.
>>>
>>> base-commit: 67ad42147a7acc2af6074753ebd03d904476118f
>>
>> I'm not fond of introducing linkgit macro that can create auto-reference
>> in manual pages. At the moment, we need to use conditional inclusion in
>> the manual pages source, but I wonder if we could simply filter out the
>> links in the macro itself.
> 
> FWIW, before deciding to accept the patch, I did check if
> git-rerere.adoc included this file (it didn't), but if we can make
> the macro smarter to do so, it would be great, as that would avoid
> people including this file there later without realizing that they
> now need to make the mark-up conditional.

Ah, adding the options of rerere in git-rerere manual page is then something that will need to be done when reworking it.

> 
> This particular patch does not have to be blocked waiting for such
> an improvement, though, right?
> 
No it doesn't. I don't intend to scratch this itch soon.

← back to recent threads