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>

diff --git a/Documentation/git-history.adoc b/Documentation/git-history.adoc
index df2900ac2ff54fc379c5ec9f050854e8814c712c..4dbe665ec4fdd95aae28b01785ffeb679e398cad 100644 (file)
--- a/Documentation/git-history.adoc
+++ b/Documentation/git-history.adoc
@@ -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

diff --git a/builtin/history.c b/builtin/history.c
index c135361c6754f3ade3bb1eb2c291af8ace77ee7d..1cf6c668cfd81465961f49de14ce9050717591e9 100644 (file)
--- a/builtin/history.c
+++ b/builtin/history.c
@@ -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")),

diff --git a/t/t3451-history-reword.sh b/t/t3451-history-reword.sh
index 702d40dc06de78fc656bb765cd2604f23ad6417c..de7b357685db4adb66bcee0a12bc0832273db038 100755 (executable)
--- a/t/t3451-history-reword.sh
+++ b/t/t3451-history-reword.sh
@@ -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 &&