git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/4] doc: link to config for git-replay(1)

From
Junio C Hamano <gitster@pobox.com>
Date
May 30, 2026, 22:18 UTC
Message-ID
<xmqqse78fsn2.fsf@gitster.g>
In-Reply-To
<doc_replay_link_config.70a@msgid.xyz>
kristofferhaugsbakk@fastmail.com writes:
Show 11 quoted lines
> 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?

Show 13 quoted lines
> 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[]
>  
>  include::config/repack.adoc[]
>  
> +include::config/replay.adoc[]
> +
>  include::config/rerere.adoc[]
>  
>  include::config/revert.adoc[]

Placing `include::config/replay.adoc[]` in `config.adoc` alphabetically between `repack` and `rerere` is correct, as the list is alphabetical.

Show 12 quoted lines
> diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
> index a32f72aead3..f9ca2db2833 100644
> --- a/Documentation/git-replay.adoc
> +++ b/Documentation/git-replay.adoc
> @@ -209,6 +209,10 @@ This replays the range `aabbcc..ddeeff` onto commit `112233` and updates
>  `refs/heads/mybranch` to point at the result. This can be useful when you want
>  to use bare commit IDs instead of branch names.
>  
> +CONFIGURATION
> +-------------
> +include::config/replay.adoc[]
> +

Adding the `CONFIGURATION` section near the end of `git-replay.adoc` is also the standard way we expose configuration variables to the command's manual page.

Looking good.
>  GIT
>  ---
>  Part of the linkgit:git[1] suite
Previous: kristofferhaugsbakk@fastmail.comNext: Kristoffer Haugsbakk
Message 3 of 40 in “doc: replay: fix config link”
  1. 0/4 doc: replay: fix config linkkristofferhaugsbakk@fastmail.com, May 21, 2026
  2. 1/4 doc: link to config for git-replay(1)kristofferhaugsbakk@fastmail.com, May 21, 2026
  3. Junio C HamanoMay 30, 2026
  4. Kristoffer HaugsbakkJun 4, 2026
  5. 2/4 doc: replay: simplify replay.refAction descriptionkristofferhaugsbakk@fastmail.com, May 21, 2026
  6. Junio C HamanoMay 30, 2026
  7. Junio C HamanoMay 30, 2026
  8. Kristoffer HaugsbakkJun 2, 2026
  9. 3/4 doc: replay: use a nested definition listkristofferhaugsbakk@fastmail.com, May 21, 2026
  10. Junio C HamanoMay 30, 2026
  11. 4/4 doc: replay: move “default” to the right-hand-sidekristofferhaugsbakk@fastmail.com, May 21, 2026
  12. Junio C HamanoMay 30, 2026
  13. Junio C HamanoMay 30, 2026
  14. 0/4 doc: replay: fix config linkkristofferhaugsbakk@fastmail.com, Jun 3, 2026
  15. 1/4 doc: link to config for git-replay(1)kristofferhaugsbakk@fastmail.com, Jun 3, 2026
  16. 2/4 doc: replay: improve config descriptionkristofferhaugsbakk@fastmail.com, Jun 3, 2026
  17. Patrick SteinhardtJun 4, 2026
  18. Kristoffer HaugsbakkJun 4, 2026
  19. Patrick SteinhardtJun 4, 2026
  20. 3/4 doc: replay: use a nested description listkristofferhaugsbakk@fastmail.com, Jun 3, 2026
  21. 4/4 doc: replay: move “default” to the right-hand sidekristofferhaugsbakk@fastmail.com, Jun 3, 2026
  22. 0/4 doc: replay: fix config linkkristofferhaugsbakk@fastmail.com, Jun 5, 2026
  23. 1/4 doc: link to config for git-replay(1)kristofferhaugsbakk@fastmail.com, Jun 5, 2026
  24. 2/4 doc: replay: improve config descriptionkristofferhaugsbakk@fastmail.com, Jun 5, 2026
  25. Toon ClaesJul 8, 2026
  26. Kristoffer HaugsbakkJul 30, 2026
  27. 3/4 doc: replay: use a nested description listkristofferhaugsbakk@fastmail.com, Jun 5, 2026
  28. 4/4 doc: replay: move “default” to the right-hand sidekristofferhaugsbakk@fastmail.com, Jun 5, 2026
  29. Toon ClaesJul 8, 2026
  30. Junio C HamanoJul 23, 2026
  31. Kristoffer HaugsbakkJul 30, 2026
  32. 0/4 doc: replay: fix config linkkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  33. 1/4 doc: link to config for git-replay(1)kristofferhaugsbakk@fastmail.com, Jul 30, 2026
  34. 2/4 doc: replay: improve config descriptionkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  35. 3/4 doc: replay: use a nested description listkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  36. 4/4 doc: replay: move “default” to the right-hand sidekristofferhaugsbakk@fastmail.com, Jul 30, 2026
  37. Junio C HamanoJul 30, 2026
  38. Kristoffer HaugsbakkJul 30, 2026
  39. Toon ClaesJul 31, 2026
  40. Junio C HamanoJul 31, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.