kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

builtin/history: rename "--ref-action=" to "--update-refs=" 

With the preceding commit we have changed "--ref-action=" to only
control which refs are supposed to be updated, not what happens with
them. As a consequence, the option is now somewhat misnamed, as we don't
control the action itself anymore.

Rename it to "--update-refs=" to better align it with its new use.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Patrick Steinhardt 2026-02-16 07:45:47 +01:00 committed by Junio C Hamano
parent 1073fa14e1
commit 060e602dcb
3 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/git-history.adoc
View File

@ -8,7 +8,7 @@ git-history - EXPERIMENTAL: Rewrite history
SYNOPSIS
--------
[synopsis]
git history reword <commit> [--dry-run] [--ref-action=(branches|head)]
git history reword <commit> [--dry-run] [--update-refs=(branches|head)]

DESCRIPTION
-----------
@ -66,7 +66,7 @@ OPTIONS
objects will be written into the repository, so applying these printed
ref updates is generally safe.

`--ref-action=(branches|head)`::
`--update-refs=(branches|head)`::
Control which references will be updated by the command, if any. With
`branches`, all local branches that point to commits which are
descendants of the original commit will be rewritten. With `head`, only

8
builtin/history.c
View File

@ -18,7 +18,7 @@
#include "wt-status.h"

#define GIT_HISTORY_REWORD_USAGE \
N_("git history reword <commit> [--dry-run] [--ref-action=(branches|head)]")
N_("git history reword <commit> [--dry-run] [--update-refs=(branches|head)]")

static void change_data_free(void *util, const char *str UNUSED)
{
@ -258,7 +258,7 @@ static int setup_revwalk(struct repository *repo,
goto out;
} else if (!ret) {
ret = error(_("rewritten commit must be an ancestor "
"of HEAD when using --ref-action=head"));
"of HEAD when using --update-refs=head"));
goto out;
}

@ -416,8 +416,8 @@ static int cmd_history_reword(int argc,
enum ref_action action = REF_ACTION_DEFAULT;
int dry_run = 0;
struct option options[] = {
OPT_CALLBACK_F(0, "ref-action", &action, N_("<action>"),
N_("control ref update behavior (branches|head)"),
OPT_CALLBACK_F(0, "update-refs", &action, N_("<action>"),
N_("control which refs should be updated (branches|head)"),
PARSE_OPT_NONEG, parse_ref_action),
OPT_BOOL('n', "dry-run", &dry_run,
N_("perform a dry-run without updating any refs")),

8
t/t3451-history-reword.sh
View File

@ -233,7 +233,7 @@ test_expect_success '--dry-run prints ref updates without modifying repo' '
test_commit theirs &&

git refs list >refs-expect &&
reword_with_message --dry-run --ref-action=head base >updates <<-\EOF &&
reword_with_message --dry-run --update-refs=head base >updates <<-\EOF &&
reworded commit
EOF
git refs list >refs-actual &&
@ -258,7 +258,7 @@ test_expect_success '--dry-run prints ref updates without modifying repo' '
)
'

test_expect_success '--ref-action=head updates only HEAD' '
test_expect_success '--update-refs=head updates only HEAD' '
test_when_finished "rm -rf repo" &&
git init repo --initial-branch=main &&
(
@ -271,10 +271,10 @@ test_expect_success '--ref-action=head updates only HEAD' '

# When told to update HEAD, only, the command will refuse to
# rewrite commits that are not an ancestor of HEAD.
test_must_fail git -c core.editor=false history reword --ref-action=head theirs 2>err &&
test_must_fail git -c core.editor=false history reword --update-refs=head theirs 2>err &&
test_grep "rewritten commit must be an ancestor of HEAD" err &&

reword_with_message --ref-action=head base >updates <<-\EOF &&
reword_with_message --update-refs=head base >updates <<-\EOF &&
reworded base
EOF
expect_log HEAD <<-\EOF &&