All of lore.kernel.org
 help / color / mirror / Atom feed
From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>,
	Siddharth Asthana <siddharthasthana31@gmail.com>
Subject: [PATCH 2/4] doc: replay: simplify replay.refAction description
Date: Thu, 21 May 2026 20:01:59 +0200	[thread overview]
Message-ID: <simplify_replay.refAction.70b@msgid.xyz> (raw)
In-Reply-To: <CV_doc_replay_config.709@msgid.xyz>

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

We don’t need to list what each argument does since the documentation
for `--ref-action` does that. So let’s simplify the `replay.refAction`
description by referring to git-replay(1).

Also make sure to not self-link for the git-replay(1) inclusion.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/config/replay.adoc | 17 +++++++----------
 Documentation/git-replay.adoc    |  1 +
 2 files changed, 8 insertions(+), 10 deletions(-)

diff --git a/Documentation/config/replay.adoc b/Documentation/config/replay.adoc
index 7d549d2f0e5..42e521694d1 100644
--- a/Documentation/config/replay.adoc
+++ b/Documentation/config/replay.adoc
@@ -1,11 +1,8 @@
 replay.refAction::
-	Specifies the default mode for handling reference updates in
-	`git replay`. The value can be:
-+
---
-	* `update`: Update refs directly using an atomic transaction (default behavior).
-	* `print`: Output update-ref commands for pipeline use.
---
-+
-This setting can be overridden with the `--ref-action` command-line option.
-When not configured, `git replay` defaults to `update` mode.
+	Specifies the default mode for handling reference updates. Either `update` or `print`.
+ifdef::git-replay[]
+See `--ref-action`.
+endif::git-replay[]
+ifndef::git-replay[]
+See `--ref-action` for linkgit:git-replay[1] for details.
+endif::git-replay[]
diff --git a/Documentation/git-replay.adoc b/Documentation/git-replay.adoc
index f9ca2db2833..4de85088d6c 100644
--- a/Documentation/git-replay.adoc
+++ b/Documentation/git-replay.adoc
@@ -211,6 +211,7 @@ to use bare commit IDs instead of branch names.
 
 CONFIGURATION
 -------------
+:git-replay: 1
 include::config/replay.adoc[]
 
 GIT
-- 
2.54.0.13.g9c7419e39f8


  parent reply	other threads:[~2026-05-21 18:02 UTC|newest]

Thread overview: 26+ 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
2026-05-21 18:01 ` kristofferhaugsbakk [this message]
2026-05-30 22:29   ` [PATCH 2/4] doc: replay: simplify replay.refAction description 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
2026-06-05 13:55   ` [PATCH v3 0/4] doc: replay: fix config link kristofferhaugsbakk
2026-06-05 13:55     ` [PATCH v3 1/4] doc: link to config for git-replay(1) kristofferhaugsbakk
2026-06-05 13:56     ` [PATCH v3 2/4] doc: replay: improve config description kristofferhaugsbakk
2026-06-05 13:56     ` [PATCH v3 3/4] doc: replay: use a nested description list kristofferhaugsbakk
2026-06-05 13:56     ` [PATCH v3 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=simplify_replay.refAction.70b@msgid.xyz \
    --to=kristofferhaugsbakk@fastmail.com \
    --cc=code@khaugsbakk.name \
    --cc=git@vger.kernel.org \
    --cc=siddharthasthana31@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.