Skip to content

Commit ab661bb

Browse files
edith007gitster
authored andcommitted
replay: add replay.refAction config option
Add a configuration option to control the default behavior of git replay for updating references. This allows users who prefer the traditional pipeline output to set it once in their config instead of passing --ref-action=print with every command. The config option uses string values that mirror the behavior modes: * replay.refAction = update (default): atomic ref updates * replay.refAction = print: output commands for pipeline The command-line --ref-action option always overrides the config setting, allowing users to temporarily change behavior for a single invocation. Implementation details: In cmd_replay(), after parsing command-line options, we check if --ref-action was provided. If not, we read the configuration using repo_config_get_string_tmp(). If the config variable is set, we validate the value and use it to set the ref_action_str: Config value Internal mode Behavior ────────────────────────────────────────────────────────────── "update" "update" Atomic ref updates (default) "print" "print" Pipeline output (not set) "update" Atomic ref updates (default) (invalid) error Die with helpful message If an invalid value is provided, we die() immediately with an error message explaining the valid options. This catches configuration errors early and provides clear guidance to users. The command-line --ref-action option, when provided, overrides the config value. This precedence allows users to set their preferred default while still having per-invocation control: git config replay.refAction print # Set default git replay --ref-action=update --onto main topic # Override once The config and command-line option use the same value names ('update' and 'print') for consistency and clarity. This makes it immediately obvious how the config maps to the command-line option, addressing feedback about the relationship between configuration and command-line options being clear to users. Examples: $ git config --global replay.refAction print $ git replay --onto main topic1..topic2 | git update-ref --stdin $ git replay --ref-action=update --onto main topic1..topic2 $ git config replay.refAction update $ git replay --onto main topic1..topic2 # Updates refs directly The implementation follows Git's standard configuration precedence: command-line options override config values, which matches user expectations across all Git commands. Helped-by: Junio C Hamano <gitster@pobox.com> Helped-by: Elijah Newren <newren@gmail.com> Helped-by: Christian Couder <christian.couder@gmail.com> Helped-by: Phillip Wood <phillip.wood123@gmail.com> Signed-off-by: Siddharth Asthana <siddharthasthana31@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 25e7f01 commit ab661bb

3 files changed

Lines changed: 68 additions & 1 deletion

File tree

Documentation/config/replay.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
replay.refAction::
2+
Specifies the default mode for handling reference updates in
3+
`git replay`. The value can be:
4+
+
5+
--
6+
* `update`: Update refs directly using an atomic transaction (default behavior).
7+
* `print`: Output update-ref commands for pipeline use.
8+
--
9+
+
10+
This setting can be overridden with the `--ref-action` command-line option.
11+
When not configured, `git replay` defaults to `update` mode.

builtin/replay.c

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
#include "git-compat-util.h"
99

1010
#include "builtin.h"
11+
#include "config.h"
1112
#include "environment.h"
1213
#include "hex.h"
1314
#include "lockfile.h"
@@ -367,7 +368,20 @@ int cmd_replay(int argc,
367368
die_for_incompatible_opt2(!!advance_name_opt, "--advance",
368369
contained, "--contained");
369370

370-
/* Default to update mode if not specified */
371+
/* Set default mode from config if not specified on command line */
372+
if (!ref_action_str) {
373+
const char *config_value = NULL;
374+
if (!repo_config_get_string_tmp(repo, "replay.refAction", &config_value)) {
375+
if (!strcmp(config_value, "update"))
376+
ref_action_str = "update";
377+
else if (!strcmp(config_value, "print"))
378+
ref_action_str = "print";
379+
else
380+
die(_("invalid value for replay.refAction: '%s'"), config_value);
381+
}
382+
}
383+
384+
/* Default to update mode if still not set */
371385
if (!ref_action_str)
372386
ref_action_str = "update";
373387

t/t3650-replay-basics.sh

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,4 +217,46 @@ test_expect_success 'merge.directoryRenames=false' '
217217
--onto rename-onto rename-onto..rename-from
218218
'
219219

220+
test_expect_success 'replay.refAction config option' '
221+
# Store original state
222+
START=$(git rev-parse topic2) &&
223+
test_when_finished "git branch -f topic2 $START && git config --unset replay.refAction" &&
224+
225+
# Set config to print
226+
git config replay.refAction print &&
227+
git replay --onto main topic1..topic2 >output &&
228+
test_line_count = 1 output &&
229+
grep "^update refs/heads/topic2 " output &&
230+
231+
# Reset and test update mode
232+
git branch -f topic2 $START &&
233+
git config replay.refAction update &&
234+
git replay --onto main topic1..topic2 >output &&
235+
test_must_be_empty output &&
236+
237+
# Verify ref was updated
238+
git log --format=%s topic2 >actual &&
239+
test_write_lines E D M L B A >expect &&
240+
test_cmp expect actual
241+
'
242+
243+
test_expect_success 'command-line --ref-action overrides config' '
244+
# Store original state
245+
START=$(git rev-parse topic2) &&
246+
test_when_finished "git branch -f topic2 $START && git config --unset replay.refAction" &&
247+
248+
# Set config to update but use --ref-action=print
249+
git config replay.refAction update &&
250+
git replay --ref-action=print --onto main topic1..topic2 >output &&
251+
test_line_count = 1 output &&
252+
grep "^update refs/heads/topic2 " output
253+
'
254+
255+
test_expect_success 'invalid replay.refAction value' '
256+
test_when_finished "git config --unset replay.refAction" &&
257+
git config replay.refAction invalid &&
258+
test_must_fail git replay --onto main topic1..topic2 2>error &&
259+
grep "invalid value for replay.refAction" error
260+
'
261+
220262
test_done

0 commit comments

Comments
 (0)