Merge branch 'kh/doc-replay-config' into jch

Doc update for "git replay" to actually refer to its configuration
variables.

* kh/doc-replay-config:
  doc: replay: move “default” to the right-hand side
  doc: replay: use a nested description list
  doc: replay: improve config description
  doc: link to config for git-replay(1)
This commit is contained in:
Junio C Hamano
2026-06-12 15:57:16 -07:00
3 changed files with 27 additions and 10 deletions

View File

@@ -513,6 +513,8 @@ include::config/remotes.adoc[]
include::config/repack.adoc[]
include::config/replay.adoc[]
include::config/rerere.adoc[]
include::config/revert.adoc[]

View File

@@ -1,11 +1,18 @@
replay.refAction::
Specifies the default mode for handling reference updates in
`git replay`. The value can be:
Specifies the default mode for handling reference updates.
The value can be:
+
--
* `update`: Update refs directly using an atomic transaction (default behavior).
* `print`: Output update-ref commands for pipeline use.
////
These use the first sentences from the description list in git-replay(1).
////
`update`;; (default) Update refs directly using an atomic transaction.
`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.
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[]

View File

@@ -80,10 +80,13 @@ incompatible with `--contained` (which is a modifier for `--onto` only).
Control how references are updated. The mode can be:
+
--
* `update` (default): Update refs directly using an atomic transaction.
All refs are updated or none are (all-or-nothing behavior).
* `print`: Output update-ref commands for pipeline use. This is the
traditional behavior where output can be piped to `git update-ref --stdin`.
////
Expanded description list compared to 'replay.refAction'.
////
`update`;; (default) Update refs directly using an atomic transaction.
All refs are updated or none are (all-or-nothing behavior).
`print`;; Output update-ref commands for pipeline use. This is the
traditional behavior where output can be piped to `git update-ref --stdin`.
--
+
The default mode can be configured via the `replay.refAction` configuration variable.
@@ -209,6 +212,11 @@ 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
-------------
:git-replay: 1
include::config/replay.adoc[]
GIT
---
Part of the linkgit:git[1] suite