From: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail•com>
To: "Junio C Hamano" <gitster@pobox•com>
Cc: git@vger•kernel.org, "Siddharth Asthana" <siddharthasthana31@gmail•com>
Subject: Re: [PATCH 1/4] doc: link to config for git-replay(1)
Date: Thu, 04 Jun 2026 22:38:15 +0200 [thread overview]
Message-ID: <13b1ac2e-3790-4553-8e55-5ea2adf8f46a@app.fastmail.com> (raw)
In-Reply-To: <xmqqse78fsn2.fsf@gitster.g>
On Sun, May 31, 2026, at 00:18, Junio C Hamano wrote:
> kristofferhaugsbakk@fastmail•com writes:
>
>> From: Kristoffer Haugsbakk <code@khaugsbakk•name>
>>
>> This config doc was added in 336ac90c (replay: add replay.refAction
>> config option, 2025-11-06) but never included anywhere. Include it in
>> git-replay(1) and git-config(1).
>>
>> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk•name>
>> ---
>> Documentation/config.adoc | 2 ++
>> Documentation/git-replay.adoc | 4 ++++
>> 2 files changed, 6 insertions(+)
>
> It is always nice to see documentation gaps filled.
>
> The `replay.refAction` configuration variable was indeed left
> dangling without a proper link from the main command documentation,
> which is embarrassing. I wonder if we can add simple "doc-lint"
> rule or two to prevent similar mistakes from happening again?
For what it’s worth this is how I found it.
I was working on the kh/doc-hook topic and noticed that my changes
didn’t trigger any `doc-diff` changes for git-config(1). So I checked
the file and nope, it wasn’t included. Then I massaged the file includes
and diffed it with `Documentation/config/`. The only missing ones were:
• replay
• fmt-merge-msg
And `fmt-merge-msg` turned out to be a false positive since it is
included via `merge` or something.
>
>> diff --git a/Documentation/config.adoc b/Documentation/config.adoc
>> index 62eebe7c545..51fabecb9b0 100644
>> --- a/Documentation/config.adoc
>> +++ b/Documentation/config.adoc
>> @@ -511,6 +511,8 @@ include::config/remotes.adoc[]
>>[snip]
next prev parent reply other threads:[~2026-06-04 20:38 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-21 18:01 [PATCH 0/4] doc: replay: fix config link kristofferhaugsbakk
2026-05-21 18:01 ` [PATCH 1/4] doc: link to config for git-replay(1) kristofferhaugsbakk
2026-05-30 22:18 ` Junio C Hamano
2026-06-04 20:38 ` Kristoffer Haugsbakk [this message]
2026-05-21 18:01 ` [PATCH 2/4] doc: replay: simplify replay.refAction description kristofferhaugsbakk
2026-05-30 22:29 ` Junio C Hamano
2026-05-30 22:37 ` Junio C Hamano
2026-06-02 11:58 ` Kristoffer Haugsbakk
2026-05-21 18:02 ` [PATCH 3/4] doc: replay: use a nested definition list kristofferhaugsbakk
2026-05-30 22:37 ` Junio C Hamano
2026-05-21 18:02 ` [PATCH 4/4] doc: replay: move “default” to the right-hand-side kristofferhaugsbakk
2026-05-30 22:37 ` Junio C Hamano
2026-05-30 22:18 ` [PATCH 0/4] doc: replay: fix config link Junio C Hamano
2026-06-03 16:04 ` [PATCH v2 " kristofferhaugsbakk
2026-06-03 16:04 ` [PATCH v2 1/4] doc: link to config for git-replay(1) kristofferhaugsbakk
2026-06-03 16:04 ` [PATCH v2 2/4] doc: replay: improve config description kristofferhaugsbakk
2026-06-04 6:27 ` Patrick Steinhardt
2026-06-04 6:31 ` Kristoffer Haugsbakk
2026-06-04 9:05 ` Patrick Steinhardt
2026-06-03 16:04 ` [PATCH v2 3/4] doc: replay: use a nested description list kristofferhaugsbakk
2026-06-03 16:04 ` [PATCH v2 4/4] doc: replay: move “default” to the right-hand side kristofferhaugsbakk
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=13b1ac2e-3790-4553-8e55-5ea2adf8f46a@app.fastmail.com \
--to=kristofferhaugsbakk@fastmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=siddharthasthana31@gmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox