builtin/config: use `OPT_CMDMODE()` to specify modes
The git-config(1) command has various different modes which are accessible via e.g. `--get-urlmatch` or `--unset-all`. These modes are declared with `OPT_BIT()`, which causes two minor issues: - The respective modes also have a negated form `--no-get-urlmatch`, which is unintended. - We have to manually handle exclusiveness of the modes. Switch these options to instead use `OPT_CMDMODE()`, which is made exactly for this usecase. Remove the now-unneeded check that only a single mode is given, which is now handled by the parse-options interface. While at it, format optional placeholders for arguments to conform to our style guidelines by using `[<placeholder>]`. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Patrick Steinhardt committed
May 6, 2024 at 10:56 UTC
daa33250240406fd0ff9dfc7625b3784138a8978
2 files changed
+27
-18
builtin/config.c
+14
-18
@@ -632,20 +632,20 @@ static struct option builtin_config_options[] = {
632
OPT_STRING('f', "file", &given_config_source.file, N_("file"), N_("use given config file")),
633
OPT_STRING(0, "blob", &given_config_source.blob, N_("blob-id"), N_("read config from given blob object")),
634
OPT_GROUP(N_("Action")),
635
- OPT_BIT(0, "get", &actions, N_("get value: name [value-pattern]"), ACTION_GET),
636
- OPT_BIT(0, "get-all", &actions, N_("get all values: key [value-pattern]"), ACTION_GET_ALL),
637
- OPT_BIT(0, "get-regexp", &actions, N_("get values for regexp: name-regex [value-pattern]"), ACTION_GET_REGEXP),
638
- OPT_BIT(0, "get-urlmatch", &actions, N_("get value specific for the URL: section[.var] URL"), ACTION_GET_URLMATCH),
639
- OPT_BIT(0, "replace-all", &actions, N_("replace all matching variables: name value [value-pattern]"), ACTION_REPLACE_ALL),
640
- OPT_BIT(0, "add", &actions, N_("add a new variable: name value"), ACTION_ADD),
641
- OPT_BIT(0, "unset", &actions, N_("remove a variable: name [value-pattern]"), ACTION_UNSET),
642
- OPT_BIT(0, "unset-all", &actions, N_("remove all matches: name [value-pattern]"), ACTION_UNSET_ALL),
643
- OPT_BIT(0, "rename-section", &actions, N_("rename section: old-name new-name"), ACTION_RENAME_SECTION),
644
- OPT_BIT(0, "remove-section", &actions, N_("remove a section: name"), ACTION_REMOVE_SECTION),
645
- OPT_BIT('l', "list", &actions, N_("list all"), ACTION_LIST),
646
- OPT_BIT('e', "edit", &actions, N_("open an editor"), ACTION_EDIT),
647
- OPT_BIT(0, "get-color", &actions, N_("find the color configured: slot [default]"), ACTION_GET_COLOR),
648
- OPT_BIT(0, "get-colorbool", &actions, N_("find the color setting: slot [stdout-is-tty]"), ACTION_GET_COLORBOOL),
635
+ OPT_CMDMODE(0, "get", &actions, N_("get value: name [<value-pattern>]"), ACTION_GET),
636
+ OPT_CMDMODE(0, "get-all", &actions, N_("get all values: key [<value-pattern>]"), ACTION_GET_ALL),
637
+ OPT_CMDMODE(0, "get-regexp", &actions, N_("get values for regexp: name-regex [<value-pattern>]"), ACTION_GET_REGEXP),
638
+ OPT_CMDMODE(0, "get-urlmatch", &actions, N_("get value specific for the URL: section[.var] URL"), ACTION_GET_URLMATCH),
639
+ OPT_CMDMODE(0, "replace-all", &actions, N_("replace all matching variables: name value [<value-pattern>]"), ACTION_REPLACE_ALL),
640
+ OPT_CMDMODE(0, "add", &actions, N_("add a new variable: name value"), ACTION_ADD),
641
+ OPT_CMDMODE(0, "unset", &actions, N_("remove a variable: name [<value-pattern>]"), ACTION_UNSET),
642
+ OPT_CMDMODE(0, "unset-all", &actions, N_("remove all matches: name [<value-pattern>]"), ACTION_UNSET_ALL),
643
+ OPT_CMDMODE(0, "rename-section", &actions, N_("rename section: old-name new-name"), ACTION_RENAME_SECTION),
644
+ OPT_CMDMODE(0, "remove-section", &actions, N_("remove a section: name"), ACTION_REMOVE_SECTION),
645
+ OPT_CMDMODE('l', "list", &actions, N_("list all"), ACTION_LIST),
646
+ OPT_CMDMODE('e', "edit", &actions, N_("open an editor"), ACTION_EDIT),
647
+ OPT_CMDMODE(0, "get-color", &actions, N_("find the color configured: slot [<default>]"), ACTION_GET_COLOR),
648
+ OPT_CMDMODE(0, "get-colorbool", &actions, N_("find the color setting: slot [<stdout-is-tty>]"), ACTION_GET_COLORBOOL),
649
OPT_GROUP(N_("Type")),
650
OPT_CALLBACK('t', "type", &type, N_("type"), N_("value is given this type"), option_parse_type),
651
OPT_CALLBACK_VALUE(0, "bool", &type, N_("value is \"true\" or \"false\""), TYPE_BOOL),
@@ -769,10 +769,6 @@ int cmd_config(int argc, const char **argv, const char *prefix)
769
usage_builtin_config();
770
}
771
772
- if (HAS_MULTI_BITS(actions)) {
773
- error(_("only one action at a time"));
774
- usage_builtin_config();
775
- }
772
if (actions == 0)
773
switch (argc) {
774
case 1: actions = ACTION_GET; break;
t/t1300-config.sh
+13
@@ -2738,4 +2738,17 @@ test_expect_success 'includeIf.hasconfig:remote.*.url forbids remote url in such
2738
grep "fatal: remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url" err
2739
'
2740
2741
+test_expect_success 'negated mode causes failure' '
2742
+ test_must_fail git config --no-get 2>err &&
2743
+ grep "unknown option \`no-get${SQ}" err
2744
+'
2745
+
2746
+test_expect_success 'specifying multiple modes causes failure' '
2747
+ cat >expect <<-EOF &&
2748
+ error: options ${SQ}--get-all${SQ} and ${SQ}--get${SQ} cannot be used together
2749
+ EOF
2750
+ test_must_fail git config --get --get-all 2>err &&
2751
+ test_cmp expect err
2752
+'
2753
+
2754
test_done