Skip to content

Commit bf48952

Browse files
committed
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)
2 parents e0f6011 + 60575c7 commit bf48952

3 files changed

Lines changed: 27 additions & 10 deletions

File tree

Documentation/config.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -513,6 +513,8 @@ include::config/remotes.adoc[]
513513

514514
include::config/repack.adoc[]
515515

516+
include::config/replay.adoc[]
517+
516518
include::config/rerere.adoc[]
517519

518520
include::config/revert.adoc[]

Documentation/config/replay.adoc

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
replay.refAction::
2-
Specifies the default mode for handling reference updates in
3-
`git replay`. The value can be:
2+
Specifies the default mode for handling reference updates.
3+
The value can be:
44
+
55
--
6-
* `update`: Update refs directly using an atomic transaction (default behavior).
7-
* `print`: Output update-ref commands for pipeline use.
6+
////
7+
These use the first sentences from the description list in git-replay(1).
8+
////
9+
`update`;; (default) Update refs directly using an atomic transaction.
10+
`print`;; Output update-ref commands for pipeline use.
811
--
912
+
10-
This setting can be overridden with the `--ref-action` command-line option.
11-
When not configured, `git replay` defaults to `update` mode.
13+
ifdef::git-replay[]
14+
See `--ref-action`.
15+
endif::git-replay[]
16+
ifndef::git-replay[]
17+
See `--ref-action` for linkgit:git-replay[1] for details.
18+
endif::git-replay[]

Documentation/git-replay.adoc

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,13 @@ incompatible with `--contained` (which is a modifier for `--onto` only).
8080
Control how references are updated. The mode can be:
8181
+
8282
--
83-
* `update` (default): Update refs directly using an atomic transaction.
84-
All refs are updated or none are (all-or-nothing behavior).
85-
* `print`: Output update-ref commands for pipeline use. This is the
86-
traditional behavior where output can be piped to `git update-ref --stdin`.
83+
////
84+
Expanded description list compared to 'replay.refAction'.
85+
////
86+
`update`;; (default) Update refs directly using an atomic transaction.
87+
All refs are updated or none are (all-or-nothing behavior).
88+
`print`;; Output update-ref commands for pipeline use. This is the
89+
traditional behavior where output can be piped to `git update-ref --stdin`.
8790
--
8891
+
8992
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
209212
`refs/heads/mybranch` to point at the result. This can be useful when you want
210213
to use bare commit IDs instead of branch names.
211214

215+
CONFIGURATION
216+
-------------
217+
:git-replay: 1
218+
include::config/replay.adoc[]
219+
212220
GIT
213221
---
214222
Part of the linkgit:git[1] suite

0 commit comments

Comments
 (0)