Re: [PATCH 1/4] doc: link to config for git-replay(1)
From: Junio C Hamano <hidden>
Date: 2026-05-30 22:18:43
kristofferhaugsbakk@fastmail.com writes:
From: Kristoffer Haugsbakk <redacted> 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 <redacted> --- 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?
quoted hunk ↗ jump to hunk
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.
quoted hunk ↗ jump to hunk
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