builtin/config: introduce subcommands
PATCH v4 10/14 builtin/config: introduce "unset" subcommand
In reply to Patrick SteinhardtIntroduce a new "unset" subcommand to git-config(1). Please refer to preceding commits regarding the motivation behind this change.
--- Documentation/git-config.txt | 27 +++++++++++++--------- builtin/config.c | 39 ++++++++++++++++++++++++++++++++ t/t1300-config.sh | 44 ++++++++++++++++++++++++------------ 3 files changed, 84 insertions(+), 26 deletions(-)
Documentation/git-config.txt +16 -11
@@ -11,9 +11,8 @@ SYNOPSIS [verse] 'git config list' [<file-option>] [<display-option>] [--includes] 'git config get' [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name> -'git config set' [<file-option>] [--type=<type>] [--comment=<message>] [--all] [--value=<value>] [--fixed-value] <name> <value> -'git config' [<file-option>] [--fixed-value] --unset <name> [<value-pattern>] -'git config' [<file-option>] [--fixed-value] --unset-all <name> [<value-pattern>] +'git config set' [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value> +'git config unset' [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value> 'git config' [<file-option>] --rename-section <old-name> <new-name> 'git config' [<file-option>] --remove-section <name> 'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>]
@@ -87,6 +86,12 @@ set:: `--value=` will replace all config options whose values match the given pattern. +unset:: + Unset value for one or more config options. By default, this command + refuses to unset multi-valued keys. Passing `--all` will unset all + multi-valued config options, whereas `--value` will unset all config + options whose values match the given pattern. + [[OPTIONS]] OPTIONS -------
@@ -190,12 +195,6 @@ See also <<FILES>>. --rename-section:: Rename the given section to a new name. ---unset:: - Remove the line matching the key from config file. - ---unset-all:: - Remove all lines matching the key from config file. - --fixed-value:: When used with the `value-pattern` argument, treat `value-pattern` as an exact string instead of a regular expression. This will restrict
@@ -325,6 +324,12 @@ recommended to migrate to the new syntax. --add <name> <value>:: Replaced by `git config set --append <name> <value>`. +--unset <name> [<value-pattern>]:: + Replaced by `git config unset [--value=<pattern>] <name>`. + +--unset-all <name> [<value-pattern>]:: + Replaced by `git config unset [--value=<pattern>] --all <name>`. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when
@@ -372,7 +377,7 @@ values of a key from all files will be used. By default, options are only written to the repository specific configuration file. Note that this also affects options like `set` -and `--unset`. *'git config' will only ever change one file at a time*. +and `unset`. *'git config' will only ever change one file at a time*. You can limit which configuration sources are read from or written to by specifying the path of a file with the `--file` option, or by specifying a
@@ -523,7 +528,7 @@ This makes sure that only the key/value pair for kernel.org is replaced. To delete the entry for renames, do ------------ -% git config --unset diff.renames +% git config unset diff.renames ------------ If you want to delete an entry for a multivar (like core.gitproxy above),
builtin/config.c +39 -0
@@ -19,6 +19,7 @@ static const char *const builtin_config_usage[] = {N_ ("git config list [<file-option>] [<display-option>] [--includes]" ),N_ ("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name>" ),N_ ("git config set [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ), +N_ ("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ), NULL };
@@ -37,6 +38,11 @@ static const char *const builtin_config_set_usage[] = { NULL }; +static const char *const builtin_config_unset_usage[] = { +N_ ("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ), +NULL +}; +static char *key;static regex_t *key_regexp;static const char *value_pattern;
@@ -911,10 +917,43 @@ static int cmd_config_set(int argc, const char **argv, const char *prefix)return ret; } +static int cmd_config_unset (int argc,const char **argv,const char *prefix) +{ +const char *value_pattern =NULL ; +int flags =0 ; +struct option opts[] = { +CONFIG_LOCATION_OPTIONS , +OPT_GROUP (N_ ("Filter" )), +OPT_BIT (0 ,"all" , &flags,N_ ("replace multi-valued config option with new value" ),CONFIG_FLAGS_MULTI_REPLACE ), +OPT_STRING (0 ,"value" , &value_pattern,N_ ("pattern" ),N_ ("show config with values matching the pattern" )), +OPT_BIT (0 ,"fixed-value" , &flags,N_ ("use string equality when comparing values to value pattern" ),CONFIG_FLAGS_FIXED_VALUE ), +OPT_END (), + }; + + argc =parse_options (argc, argv, prefix, opts, builtin_config_unset_usage, +PARSE_OPT_STOP_AT_NON_OPTION ); +check_write (); +check_argc (argc,1 ,1 ); + +if ((flags &CONFIG_FLAGS_FIXED_VALUE ) && !value_pattern) +die (_ ("--fixed-value only applies with 'value-pattern'" )); + +handle_config_location (prefix); + +if ((flags &CONFIG_FLAGS_MULTI_REPLACE ) || value_pattern) +return git_config_set_multivar_in_file_gently (given_config_source.file, + argv[0 ],NULL , value_pattern, +NULL , flags); +else +return git_config_set_in_file_gently (given_config_source.file, argv[0 ], +NULL ,NULL ); +} +static struct option builtin_subcommand_options[] = {OPT_SUBCOMMAND ("list" , &subcommand, cmd_config_list),OPT_SUBCOMMAND ("get" , &subcommand, cmd_config_get),OPT_SUBCOMMAND ("set" , &subcommand, cmd_config_set), +OPT_SUBCOMMAND ("unset" , &subcommand, cmd_config_unset),OPT_END (), };
t/t1300-config.sh +29 -15
143 lines not on this page · raw message
Signature · 1 line
2.45.0
PATCH v4 11/14 builtin/config: introduce "rename-section" subcommand
In reply to Patrick SteinhardtIntroduce a new "rename-section" subcommand to git-config(1). Please refer to preceding commits regarding the motivation behind this change.
--- Documentation/git-config.txt | 11 +++++++---- builtin/config.c | 32 ++++++++++++++++++++++++++++++++ t/t1300-config.sh | 22 +++++++++++----------- 3 files changed, 50 insertions(+), 15 deletions(-)
Documentation/git-config.txt +7 -4
@@ -13,7 +13,7 @@ SYNOPSIS 'git config get' [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name> 'git config set' [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value> 'git config unset' [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value> -'git config' [<file-option>] --rename-section <old-name> <new-name> +'git config rename-section' [<file-option>] <old-name> <new-name> 'git config' [<file-option>] --remove-section <name> 'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>] 'git config' [<file-option>] -e | --edit
@@ -92,6 +92,9 @@ unset:: multi-valued config options, whereas `--value` will unset all config options whose values match the given pattern. +rename-section:: + Rename the given section to a new name. + [[OPTIONS]] OPTIONS -------
@@ -192,9 +195,6 @@ See also <<FILES>>. --remove-section:: Remove the given section from the configuration file. ---rename-section:: - Rename the given section to a new name. - --fixed-value:: When used with the `value-pattern` argument, treat `value-pattern` as an exact string instead of a regular expression. This will restrict
@@ -330,6 +330,9 @@ recommended to migrate to the new syntax. --unset-all <name> [<value-pattern>]:: Replaced by `git config unset [--value=<pattern>] --all <name>`. +--rename-section <old-name> <new-name>:: + Replaced by `git config rename-section <old-name> <new-name>`. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when
builtin/config.c +32 -0
@@ -20,6 +20,7 @@ static const char *const builtin_config_usage[] = {N_ ("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name>" ),N_ ("git config set [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ),N_ ("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ), +N_ ("git config rename-section [<file-option>] <old-name> <new-name>" ), NULL };
@@ -43,6 +44,11 @@ static const char *const builtin_config_unset_usage[] = { NULL }; +static const char *const builtin_config_rename_section_usage[] = { +N_ ("git config rename-section [<file-option>] <old-name> <new-name>" ), +NULL +}; +static char *key;static regex_t *key_regexp;static const char *value_pattern;
@@ -949,11 +955,37 @@ static int cmd_config_unset(int argc, const char **argv, const char *prefix) NULL, NULL); } +static int cmd_config_rename_section (int argc,const char **argv,const char *prefix) +{ +struct option opts[] = { +CONFIG_LOCATION_OPTIONS , +OPT_END (), + }; +int ret; + + argc =parse_options (argc, argv, prefix, opts, builtin_config_rename_section_usage, +PARSE_OPT_STOP_AT_NON_OPTION ); +check_write (); +check_argc (argc,2 ,2 ); + +handle_config_location (prefix); + + ret =git_config_rename_section_in_file (given_config_source.file, + argv[0 ], argv[1 ]); +if (ret <0 ) +return ret; +else if (!ret) +die (_ ("no such section: %s" ), argv[0 ]); + +return 0 ; +} +static struct option builtin_subcommand_options[] = {OPT_SUBCOMMAND ("list" , &subcommand, cmd_config_list),OPT_SUBCOMMAND ("get" , &subcommand, cmd_config_get),OPT_SUBCOMMAND ("set" , &subcommand, cmd_config_set),OPT_SUBCOMMAND ("unset" , &subcommand, cmd_config_unset), +OPT_SUBCOMMAND ("rename-section" , &subcommand, cmd_config_rename_section),OPT_END (), };
t/t1300-config.sh +11 -11
@@ -699,7 +699,7 @@ weird EOF test_expect_success 'rename section' ' - git config --rename-section branch.eins branch.zwei + git config ${mode_prefix}rename-section branch.eins branch.zwei ' cat > expect << EOF
@@ -718,7 +718,7 @@ test_expect_success 'rename succeeded' ' ' test_expect_success 'rename non-existing section' ' - test_must_fail git config --rename-section \ + test_must_fail git config ${mode_prefix}rename-section \ branch."world domination" branch.drei '
@@ -727,7 +727,7 @@ test_expect_success 'rename succeeded' ' ' test_expect_success 'rename another section' ' - git config --rename-section branch."1 234 blabl/a" branch.drei + git config ${mode_prefix}rename-section branch."1 234 blabl/a" branch.drei ' cat > expect << EOF
@@ -750,7 +750,7 @@ cat >> .git/config << EOF EOF test_expect_success 'rename a section with a var on the same line' ' - git config --rename-section branch.vier branch.zwei + git config ${mode_prefix}rename-section branch.vier branch.zwei ' cat > expect << EOF
@@ -771,11 +771,11 @@ test_expect_success 'rename succeeded' ' ' test_expect_success 'renaming empty section name is rejected' ' - test_must_fail git config --rename-section branch.zwei "" + test_must_fail git config ${mode_prefix}rename-section branch.zwei "" ' test_expect_success 'renaming to bogus section is rejected' ' - test_must_fail git config --rename-section branch.zwei "bogus name" + test_must_fail git config ${mode_prefix}rename-section branch.zwei "bogus name" ' test_expect_success 'renaming a section with a long line' '
@@ -784,7 +784,7 @@ test_expect_success 'renaming a section with a long line' ' printf " c = d %1024s [a] e = f\\n" " " && printf "[a] g = h\\n" } >y && - git config -f y --rename-section a xyz && + git config ${mode_prefix}rename-section -f y a xyz && test_must_fail git config -f y b.e '
@@ -794,7 +794,7 @@ test_expect_success 'renaming an embedded section with a long line' ' printf " c = d %1024s [a] [foo] e = f\\n" " " && printf "[a] g = h\\n" } >y && - git config -f y --rename-section a xyz && + git config ${mode_prefix}rename-section -f y a xyz && test_must_fail git config -f y foo.e '
@@ -804,7 +804,7 @@ test_expect_success 'renaming a section with an overly-long line' ' printf " c = d %525000s e" " " && printf "[a] g = h\\n" } >y && - test_must_fail git config -f y --rename-section a xyz 2>err && + test_must_fail git config ${mode_prefix}rename-section -f y a xyz 2>err && grep "refusing to work with overly long line in .y. on line 2" err '
@@ -2112,7 +2112,7 @@ test_expect_success POSIXPERM,PERL 'preserves existing permissions' ' git config imap.pass Hunter2 && perl -e \ "die q(badset) if ((stat(q(.git/config)))[2] & 07777) != 0600" && - git config --rename-section imap pop && + git config ${mode_prefix}rename-section imap pop && perl -e \ "die q(badrename) if ((stat(q(.git/config)))[2] & 07777) != 0600" '
@@ -2601,7 +2601,7 @@ test_expect_success 'refuse --fixed-value for incompatible actions' ' test_must_fail git config --file=config --fixed-value --add dev.null bogus && test_must_fail git config --file=config --fixed-value --get-urlmatch dev.null bogus && test_must_fail git config --file=config --fixed-value --get-urlmatch dev.null bogus && - test_must_fail git config --file=config --fixed-value --rename-section dev null && + test_must_fail git config ${mode_prefix}rename-section --file=config --fixed-value dev null && test_must_fail git config --file=config --fixed-value --remove-section dev && test_must_fail git config ${mode_prefix}list --file=config --fixed-value && test_must_fail git config --file=config --fixed-value --get-color dev.null &&
Signature · 1 line
2.45.0
PATCH v4 12/14 builtin/config: introduce "remove-section" subcommand
In reply to Patrick SteinhardtIntroduce a new "remove-section" subcommand to git-config(1). Please refer to preceding commits regarding the motivation behind this change.
--- Documentation/git-config.txt | 11 +++++++---- builtin/config.c | 32 ++++++++++++++++++++++++++++++++ t/t1300-config.sh | 4 ++-- 3 files changed, 41 insertions(+), 6 deletions(-)
Documentation/git-config.txt +7 -4
@@ -14,7 +14,7 @@ SYNOPSIS 'git config set' [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value> 'git config unset' [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value> 'git config rename-section' [<file-option>] <old-name> <new-name> -'git config' [<file-option>] --remove-section <name> +'git config remove-section' [<file-option>] <name> 'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>] 'git config' [<file-option>] -e | --edit
@@ -95,6 +95,9 @@ unset:: rename-section:: Rename the given section to a new name. +remove-section:: + Remove the given section from the configuration file. + [[OPTIONS]] OPTIONS -------
@@ -192,9 +195,6 @@ See also <<FILES>>. section in linkgit:gitrevisions[7] for a more complete list of ways to spell blob names. ---remove-section:: - Remove the given section from the configuration file. - --fixed-value:: When used with the `value-pattern` argument, treat `value-pattern` as an exact string instead of a regular expression. This will restrict
@@ -333,6 +333,9 @@ recommended to migrate to the new syntax. --rename-section <old-name> <new-name>:: Replaced by `git config rename-section <old-name> <new-name>`. +--remove-section <name>:: + Replaced by `git config remove-section <name>`. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when
builtin/config.c +32 -0
@@ -21,6 +21,7 @@ static const char *const builtin_config_usage[] = {N_ ("git config set [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ),N_ ("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ),N_ ("git config rename-section [<file-option>] <old-name> <new-name>" ), +N_ ("git config remove-section [<file-option>] <name>" ), NULL };
@@ -49,6 +50,11 @@ static const char *const builtin_config_rename_section_usage[] = { NULL }; +static const char *const builtin_config_remove_section_usage[] = { +N_ ("git config remove-section [<file-option>] <name>" ), +NULL +}; +static char *key;static regex_t *key_regexp;static const char *value_pattern;
@@ -980,12 +986,38 @@ static int cmd_config_rename_section(int argc, const char **argv, const char *prreturn 0 ; } +static int cmd_config_remove_section (int argc,const char **argv,const char *prefix) +{ +struct option opts[] = { +CONFIG_LOCATION_OPTIONS , +OPT_END (), + }; +int ret; + + argc =parse_options (argc, argv, prefix, opts, builtin_config_remove_section_usage, +PARSE_OPT_STOP_AT_NON_OPTION ); +check_write (); +check_argc (argc,1 ,1 ); + +handle_config_location (prefix); + + ret =git_config_rename_section_in_file (given_config_source.file, + argv[0 ],NULL ); +if (ret <0 ) +return ret; +else if (!ret) +die (_ ("no such section: %s" ), argv[0 ]); + +return 0 ; +} +static struct option builtin_subcommand_options[] = {OPT_SUBCOMMAND ("list" , &subcommand, cmd_config_list),OPT_SUBCOMMAND ("get" , &subcommand, cmd_config_get),OPT_SUBCOMMAND ("set" , &subcommand, cmd_config_set),OPT_SUBCOMMAND ("unset" , &subcommand, cmd_config_unset),OPT_SUBCOMMAND ("rename-section" , &subcommand, cmd_config_rename_section), +OPT_SUBCOMMAND ("remove-section" , &subcommand, cmd_config_remove_section),OPT_END (), };
t/t1300-config.sh +2 -2
@@ -813,7 +813,7 @@ cat >> .git/config << EOF EOF test_expect_success 'remove section' ' - git config --remove-section branch.zwei + git config ${mode_prefix}remove-section branch.zwei ' cat > expect << EOF
@@ -2602,7 +2602,7 @@ test_expect_success 'refuse --fixed-value for incompatible actions' ' test_must_fail git config --file=config --fixed-value --get-urlmatch dev.null bogus && test_must_fail git config --file=config --fixed-value --get-urlmatch dev.null bogus && test_must_fail git config ${mode_prefix}rename-section --file=config --fixed-value dev null && - test_must_fail git config --file=config --fixed-value --remove-section dev && + test_must_fail git config ${mode_prefix}remove-section --file=config --fixed-value dev && test_must_fail git config ${mode_prefix}list --file=config --fixed-value && test_must_fail git config --file=config --fixed-value --get-color dev.null && test_must_fail git config --file=config --fixed-value --get-colorbool dev.null &&
Signature · 1 line
2.45.0
PATCH v4 13/14 builtin/config: introduce "edit" subcommand
In reply to Patrick SteinhardtIntroduce a new "edit" subcommand to git-config(1). Please refer to preceding commits regarding the motivation behind this change.
--- Documentation/git-config.txt | 17 ++++---- builtin/config.c | 81 ++++++++++++++++++++++++------------ t/t1300-config.sh | 6 +-- 3 files changed, 68 insertions(+), 36 deletions(-)
Documentation/git-config.txt +10 -7
@@ -15,8 +15,8 @@ SYNOPSIS 'git config unset' [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value> 'git config rename-section' [<file-option>] <old-name> <new-name> 'git config remove-section' [<file-option>] <name> +'git config edit' [<file-option>] 'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>] -'git config' [<file-option>] -e | --edit DESCRIPTION -----------
@@ -98,6 +98,11 @@ rename-section:: remove-section:: Remove the given section from the configuration file. +edit:: + Opens an editor to modify the specified config file; either + `--system`, `--global`, `--local` (default), `--worktree`, or + `--file <config-file>`. + [[OPTIONS]] OPTIONS -------
@@ -274,12 +279,6 @@ Valid `<type>`'s include: When the color setting for `name` is undefined, the command uses `color.ui` as fallback. --e:: ---edit:: - Opens an editor to modify the specified config file; either - `--system`, `--global`, `--local` (default), `--worktree`, or - `--file <config-file>`. - --[no-]includes:: Respect `include.*` directives in config files when looking up values. Defaults to `off` when a specific file is given (e.g.,
@@ -336,6 +335,10 @@ recommended to migrate to the new syntax. --remove-section <name>:: Replaced by `git config remove-section <name>`. +-e:: +--edit:: + Replaced by `git config edit`. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when
builtin/config.c +55 -26
111 lines not on this page · raw message
t/t1300-config.sh +3 -3
@@ -666,7 +666,7 @@ test_expect_success 'setting a value in stdin is an error' ' ' test_expect_success 'editing stdin is an error' ' - test_must_fail git config --file - --edit + test_must_fail git config ${mode_prefix}edit --file - ' test_expect_success 'refer config from subdirectory' '
@@ -1768,7 +1768,7 @@ test_expect_success 'command line overrides environment config' ' test_expect_success 'git config --edit works' ' git config -f tmp test.value no && echo test.value=yes >expect && - GIT_EDITOR="echo [test]value=yes >" git config -f tmp --edit && + GIT_EDITOR="echo [test]value=yes >" git config ${mode_prefix}edit -f tmp && git config ${mode_prefix}list -f tmp >actual && test_cmp expect actual '
@@ -1777,7 +1777,7 @@ test_expect_success 'git config --edit respects core.editor' ' git config -f tmp test.value no && echo test.value=yes >expect && test_config core.editor "echo [test]value=yes >" && - git config -f tmp --edit && + git config ${mode_prefix}edit -f tmp && git config ${mode_prefix}list -f tmp >actual && test_cmp expect actual '
Signature · 1 line
2.45.0
PATCH v4 14/14 builtin/config: display subcommand help
In reply to Patrick SteinhardtUntil now, git config -h would have printed help for the old-style syntax. Now that all modes have proper subcommands though it is preferable to instead display the subcommand help.
Drop the NO_INTERNAL_HELP flag to do so. While at it, drop the help mismatch in t0450 and add the --get-colorbool option to the usage such that git-config(1)'s synopsis and git config -h match.
--- builtin/config.c | 5 +++-- t/t0450/txt-help-mismatches | 1 - 2 files changed, 3 insertions(+), 3 deletions(-)
builtin/config.c +3 -2
@@ -23,6 +23,7 @@ static const char *const builtin_config_usage[] = {N_ ("git config rename-section [<file-option>] <old-name> <new-name>" ),N_ ("git config remove-section [<file-option>] <name>" ),N_ ("git config edit [<file-option>]" ), +N_ ("git config [<file-option>] --get-colorbool <name> [<stdout-is-tty>]" ), NULL };
@@ -1093,10 +1094,10 @@ int cmd_config(int argc, const char **argv, const char *prefix)* us when parsing the legacy-style modes that don't use subcommands. */ argc =parse_options (argc, argv, prefix, builtin_subcommand_options, builtin_config_usage, -PARSE_OPT_SUBCOMMAND_OPTIONAL |PARSE_OPT_NO_INTERNAL_HELP |PARSE_OPT_KEEP_ARGV0 |PARSE_OPT_KEEP_UNKNOWN_OPT ); +PARSE_OPT_SUBCOMMAND_OPTIONAL |PARSE_OPT_KEEP_ARGV0 |PARSE_OPT_KEEP_UNKNOWN_OPT );if (subcommand) { argc =parse_options (argc, argv, prefix, builtin_subcommand_options, builtin_config_usage, -PARSE_OPT_SUBCOMMAND_OPTIONAL |PARSE_OPT_NO_INTERNAL_HELP |PARSE_OPT_KEEP_UNKNOWN_OPT ); +PARSE_OPT_SUBCOMMAND_OPTIONAL |PARSE_OPT_KEEP_UNKNOWN_OPT );return subcommand (argc, argv, prefix); }
t/t0450/txt-help-mismatches +0 -1
@@ -10,7 +10,6 @@ checkout checkout-index clone column -config credential credential-cache credential-store
Signature · 1 line
2.45.0
Hello Patrick,
Quoted 5 lines · Patrick Steinhardt
this is the fourth version of my patch series that introduces subcommands for git-config(1).
Changes compared to v3:
Quoted 7 lines
- Rebased on top of
d4cc1ec35f(Start the 2.46 cycle, 2024-04-30).- Implemented support for
git config set --comment. This switch has been added since the last version of this patch series.Here's hoping that there's a bit more interest in this patch series at the beginning of the release cycle :)
FWIW, I find the introduction of the subcommands really great. It makes the way git-config(1) works much more intuitive.
Quoted 5 lines · Patrick Steinhardt
this is the fourth version of my patch series that introduces subcommands for git-config(1).
Changes compared to v3:
Quoted 7 lines
- Rebased on top of
d4cc1ec35f(Start the 2.46 cycle, 2024-04-30).- Implemented support for
git config set --comment. This switch has been added since the last version of this patch series.Here's hoping that there's a bit more interest in this patch series at the beginning of the release cycle :)
As you made the cover letter of v4 a response to the cover letter of v1, and because the primary motivation of the series has not changed since the very beginning, it was very easy to find the cover letter of the original series that outlined the motivation (including why it does not risk ambiguity) quite well. People cannot go directly back to v2 and v3 with the information alone, but at that point, we can visit https://lore.kernel.org/git/[email protected]/
and everything is there on one page.
Thanks for not forgetting the "comment" thing that was added since the last round.
v5 cover builtin/config: introduce subcommands
In reply to Patrick SteinhardtHi,
this is the fifth and hopefully last version of my patch sthat introduces subcommands into git-config(1).
The only changes compared to v4 are some fixes to commit messages. Otherwise I'm not aware of any other feedback that would need to be addressed.
Patrick
Patrick Steinhardt (14):
config: clarify memory ownership when preparing comment strings builtin/config: move option array around builtin/config: move "fixed-value" option to correct group builtin/config: use OPT_CMDMODE() to specify modes builtin/config: pull out function to handle config location builtin/config: pull out function to handle --null builtin/config: introduce "list" subcommand builtin/config: introduce "get" subcommand builtin/config: introduce "set" subcommand builtin/config: introduce "unset" subcommand builtin/config: introduce "rename-section" subcommand builtin/config: introduce "remove-section" subcommand builtin/config: introduce "edit" subcommand builtin/config: display subcommand help
Documentation/git-config.txt | 219 ++++++++------- builtin/config.c | 512 ++++++++++++++++++++++++++++------- config.c | 16 +- config.h | 2 +- t/t0450/txt-help-mismatches | 1 - t/t1300-config.sh | 432 +++++++++++++++++------------ 6 files changed, 812 insertions(+), 370 deletions(-)
Range-diff against v4:
1: 3aa26d5bff ! 1: 881d2b5426 config: clarify memory ownership when preparing comment strings
@@ Commit message
not like this micro-optimization really matters. Thus, callers are now always responsible for freeing the value.
+ Signed-off-by: Patrick Steinhardt <[email protected]>
+
## builtin/config.c ##
@@ builtin/config.c: static struct config_options config_options;
static int show_origin;
2: 8f0804ab48 = 2: 66dffaa8f2 builtin/config: move option array around 3: ddcd8031d7 ! 3: 36abda0e02 builtin/config: move "fixed-value" option to correct group
@@ Commit message
builtin/config: move "fixed-value" option to correct group
The --fixed-value option can be used to alter how the value-pattern
- parameter is interpreted for the various submodes of git-config(1). But
- while it is an option, it is currently listed as part of the submodes
- group the command, which is wrong.
+ parameter is interpreted for the various actions of git-config(1). But
+ while it is an option, it is currently listed as part of the actions
+ group, which is wrong.
Move the option to the "Other" group, which hosts the various options known to git-config(1).
4: 1bc3918840 = 4: 34b66f9c87 builtin/config: use `OPT_CMDMODE()` to specify modes 5: 3754812309 = 5: 4f90f206e7 builtin/config: pull out function to handle config location 6: cb1714c493 = 6: df1a6f14e6 builtin/config: pull out function to handle `--null` 7: b3f3c3ba6a ! 7: 1df76a9970 builtin/config: introduce "list" subcommand
@@ Commit message
builtin/config: introduce "list" subcommand
While git-config(1) has several modes, those modes are not exposed with
- subcommands but instead by specifying e.g. --unset or --list. This
- user interface is not really in line with how our more modern commands
- work, where it is a lot more customary to say e.g. git remote list.
- Furthermore, to add to the confusion, git-config(1) also allows the user
- to request modes implicitly by just specifying the correct number of
- arguments. Thus, git config foo.bar will retrieve the value of
- "foo.bar" while git config foo.bar baz will set it to "baz".
+ subcommands but instead by specifying action flags like --unset or
+ --list. This user interface is not really in line with how our more
+ modern commands work, where it is a lot more customary to say e.g. `git
+ remote list`. Furthermore, to add to the confusion, git-config(1) also
+ allows the user to request modes implicitly by just specifying the
+ correct number of arguments. Thus, git config foo.bar will retrieve
+ the value of "foo.bar" while git config foo.bar baz will set it to
+ "baz".
Overall, this makes for a confusing interface that could really use a makeover. It hurts discoverability of what you can do with git-config(1)
8: 0e6da909ac = 8: 29676b81e0 builtin/config: introduce "get" subcommand 9: 8a623a31b9 = 9: 94afb5a5b7 builtin/config: introduce "set" subcommand 10: e25e5b69cd = 10: e525c2326a builtin/config: introduce "unset" subcommand 11: f24008d356 = 11: a797889890 builtin/config: introduce "rename-section" subcommand 12: fc2ddd3201 = 12: 8ec214755e builtin/config: introduce "remove-section" subcommand 13: 4c2d817eff = 13: 1893c23afc builtin/config: introduce "edit" subcommand 14: 4c351b12b8 = 14: 97a48ab81d builtin/config: display subcommand help
base-commit: d4cc1ec35f3bcce816b69986ca41943f6ce21377
Signature · 1 line
2.45.0
PATCH v5 1/14 config: clarify memory ownership when preparing comment strings
The ownership of memory returned when preparing a comment string is quite intricate: when the returned value is different than the passed value, then the caller is responsible to free the memory. This is quite subtle, and it's even easier to miss because the returned value is in fact a const char *.
Adapt the function to always return either NULL or a newly allocated string. The function is called at most once per git-config(1), so it's not like this micro-optimization really matters. Thus, callers are now always responsible for freeing the value.
--- builtin/config.c | 11 ++++++----- config.c | 16 ++++++---------- config.h | 2 +- 3 files changed, 13 insertions(+), 16 deletions(-)
builtin/config.c +6 -5
@@ -44,7 +44,7 @@ static struct config_options config_options;static int show_origin;static int show_scope;static int fixed_value; -static const char *comment; +static const char *comment_arg;#define ACTION_GET (1<<0)#define ACTION_GET_ALL (1<<1)
@@ -174,7 +174,7 @@ static struct option builtin_config_options[] = {OPT_BOOL (0 ,"show-origin" , &show_origin,N_ ("show origin of config (file, standard input, blob, command line)" )),OPT_BOOL (0 ,"show-scope" , &show_scope,N_ ("show scope of config (worktree, local, global, system, command)" )),OPT_STRING (0 ,"default" , &default_value,N_ ("value" ),N_ ("with --get, use default value when missing entry" )), -OPT_STRING (0 ,"comment" , &comment,N_ ("value" ),N_ ("human-readable comment string (# will be prepended as needed)" )), +OPT_STRING (0 ,"comment" , &comment_arg,N_ ("value" ),N_ ("human-readable comment string (# will be prepended as needed)" )), OPT_END(), };
@@ -674,7 +674,7 @@ static char *default_user_config(void)int cmd_config (int argc,const char **argv,const char *prefix) {int nongit = !startup_info->have_repository; -char *value =NULL ; +char *value =NULL , *comment =NULL ;int flags =0 ;int ret =0 ;struct key_value_info default_kvi =KVI_INIT ;
@@ -799,7 +799,7 @@ int cmd_config(int argc, const char **argv, const char *prefix)usage_builtin_config (); } -if (comment && +if (comment_arg && !(actions & (ACTION_ADD |ACTION_SET |ACTION_SET_ALL |ACTION_REPLACE_ALL ))) {error (_ ("--comment is only applicable to add/set/replace operations" ));usage_builtin_config ();
@@ -841,7 +841,7 @@ int cmd_config(int argc, const char **argv, const char *prefix) flags |=CONFIG_FLAGS_FIXED_VALUE ; } - comment =git_config_prepare_comment_string (comment); + comment =git_config_prepare_comment_string (comment_arg);if (actions &PAGING_ACTIONS )setup_auto_pager ("config" ,1 );
@@ -993,6 +993,7 @@ int cmd_config(int argc, const char **argv, const char *prefix)return get_colorbool (argv[0 ], argc ==2 ); } +free (comment);free (value);return ret; }
config.c +6 -10
@@ -3182,14 +3182,10 @@ void git_config_set(const char *key, const char *value)trace2_cmd_set_config (key, value); } -/* -* The ownership rule is that the caller will own the string -* if it receives a piece of memory different from what it passed -* as the parameter. -*/ -const char *git_config_prepare_comment_string (const char *comment) +char *git_config_prepare_comment_string (const char *comment) {size_t leading_blanks; +char *prepared;if (!comment)return NULL ;
@@ -3210,13 +3206,13 @@ const char *git_config_prepare_comment_string(const char *comment) leading_blanks =strspn (comment," \t" );if (leading_blanks && comment[leading_blanks] =='#' ) - ;/* use it as-is */ + prepared =xstrdup (comment);/* use it as-is */ else if (comment[0 ] =='#' ) - comment =xstrfmt (" %s" , comment); + prepared =xstrfmt (" %s" , comment);else - comment =xstrfmt (" # %s" , comment); + prepared =xstrfmt (" # %s" , comment); -return comment; +return prepared; }static void validate_comment_string (const char *comment)
config.h +1 -1
@@ -338,7 +338,7 @@ void git_config_set_multivar(const char *, const char *, const char *, unsigned)int repo_config_set_multivar_gently (struct repository *,const char *,const char *,const char *,unsigned );int git_config_set_multivar_in_file_gently (const char *,const char *,const char *,const char *,const char *,unsigned ); -const char *git_config_prepare_comment_string (const char *); +char *git_config_prepare_comment_string (const char *);/** * takes four parameters:
Signature · 1 line
2.45.0
PATCH v5 2/14 builtin/config: move option array around
In reply to Patrick SteinhardtMove around the option array. This will help us with a follow-up commit that introduces subcommands to git-config(1).
--- builtin/config.c | 96 ++++++++++++++++++++++++------------------------ 1 file changed, 48 insertions(+), 48 deletions(-)
builtin/config.c +48 -48
@@ -135,54 +135,6 @@ static int option_parse_type(const struct option *opt, const char *arg,return 0 ; } -static struct option builtin_config_options[] = { -OPT_GROUP (N_ ("Config file location" )), -OPT_BOOL (0 ,"global" , &use_global_config,N_ ("use global config file" )), -OPT_BOOL (0 ,"system" , &use_system_config,N_ ("use system config file" )), -OPT_BOOL (0 ,"local" , &use_local_config,N_ ("use repository config file" )), -OPT_BOOL (0 ,"worktree" , &use_worktree_config,N_ ("use per-worktree config file" )), -OPT_STRING ('f' ,"file" , &given_config_source.file,N_ ("file" ),N_ ("use given config file" )), -OPT_STRING (0 ,"blob" , &given_config_source.blob,N_ ("blob-id" ),N_ ("read config from given blob object" )), -OPT_GROUP (N_ ("Action" )), -OPT_BIT (0 ,"get" , &actions,N_ ("get value: name [value-pattern]" ),ACTION_GET ), -OPT_BIT (0 ,"get-all" , &actions,N_ ("get all values: key [value-pattern]" ),ACTION_GET_ALL ), -OPT_BIT (0 ,"get-regexp" , &actions,N_ ("get values for regexp: name-regex [value-pattern]" ),ACTION_GET_REGEXP ), -OPT_BIT (0 ,"get-urlmatch" , &actions,N_ ("get value specific for the URL: section[.var] URL" ),ACTION_GET_URLMATCH ), -OPT_BIT (0 ,"replace-all" , &actions,N_ ("replace all matching variables: name value [value-pattern]" ),ACTION_REPLACE_ALL ), -OPT_BIT (0 ,"add" , &actions,N_ ("add a new variable: name value" ),ACTION_ADD ), -OPT_BIT (0 ,"unset" , &actions,N_ ("remove a variable: name [value-pattern]" ),ACTION_UNSET ), -OPT_BIT (0 ,"unset-all" , &actions,N_ ("remove all matches: name [value-pattern]" ),ACTION_UNSET_ALL ), -OPT_BIT (0 ,"rename-section" , &actions,N_ ("rename section: old-name new-name" ),ACTION_RENAME_SECTION ), -OPT_BIT (0 ,"remove-section" , &actions,N_ ("remove a section: name" ),ACTION_REMOVE_SECTION ), -OPT_BIT ('l' ,"list" , &actions,N_ ("list all" ),ACTION_LIST ), -OPT_BOOL (0 ,"fixed-value" , &fixed_value,N_ ("use string equality when comparing values to 'value-pattern'" )), -OPT_BIT ('e' ,"edit" , &actions,N_ ("open an editor" ),ACTION_EDIT ), -OPT_BIT (0 ,"get-color" , &actions,N_ ("find the color configured: slot [default]" ),ACTION_GET_COLOR ), -OPT_BIT (0 ,"get-colorbool" , &actions,N_ ("find the color setting: slot [stdout-is-tty]" ),ACTION_GET_COLORBOOL ), -OPT_GROUP (N_ ("Type" )), -OPT_CALLBACK ('t' ,"type" , &type,N_ ("type" ),N_ ("value is given this type" ), option_parse_type), -OPT_CALLBACK_VALUE (0 ,"bool" , &type,N_ ("value is \"true\" or \"false\"" ),TYPE_BOOL ), -OPT_CALLBACK_VALUE (0 ,"int" , &type,N_ ("value is decimal number" ),TYPE_INT ), -OPT_CALLBACK_VALUE (0 ,"bool-or-int" , &type,N_ ("value is --bool or --int" ),TYPE_BOOL_OR_INT ), -OPT_CALLBACK_VALUE (0 ,"bool-or-str" , &type,N_ ("value is --bool or string" ),TYPE_BOOL_OR_STR ), -OPT_CALLBACK_VALUE (0 ,"path" , &type,N_ ("value is a path (file or directory name)" ),TYPE_PATH ), -OPT_CALLBACK_VALUE (0 ,"expiry-date" , &type,N_ ("value is an expiry date" ),TYPE_EXPIRY_DATE ), -OPT_GROUP (N_ ("Other" )), -OPT_BOOL ('z' ,"null" , &end_nul,N_ ("terminate values with NUL byte" )), -OPT_BOOL (0 ,"name-only" , &omit_values,N_ ("show variable names only" )), -OPT_BOOL (0 ,"includes" , &respect_includes_opt,N_ ("respect include directives on lookup" )), -OPT_BOOL (0 ,"show-origin" , &show_origin,N_ ("show origin of config (file, standard input, blob, command line)" )), -OPT_BOOL (0 ,"show-scope" , &show_scope,N_ ("show scope of config (worktree, local, global, system, command)" )), -OPT_STRING (0 ,"default" , &default_value,N_ ("value" ),N_ ("with --get, use default value when missing entry" )), -OPT_STRING (0 ,"comment" , &comment_arg,N_ ("value" ),N_ ("human-readable comment string (# will be prepended as needed)" )), -OPT_END (), -}; - -static NORETURN void usage_builtin_config(void) -{ -usage_with_options (builtin_config_usage, builtin_config_options); -} -static void check_argc (int argc,int min,int max) {if (argc >= min && argc <= max)
@@ -671,6 +623,54 @@ static char *default_user_config(void)return strbuf_detach (&buf,NULL ); } +static struct option builtin_config_options[] = { +OPT_GROUP (N_ ("Config file location" )), +OPT_BOOL (0 ,"global" , &use_global_config,N_ ("use global config file" )), +OPT_BOOL (0 ,"system" , &use_system_config,N_ ("use system config file" )), +OPT_BOOL (0 ,"local" , &use_local_config,N_ ("use repository config file" )), +OPT_BOOL (0 ,"worktree" , &use_worktree_config,N_ ("use per-worktree config file" )), +OPT_STRING ('f' ,"file" , &given_config_source.file,N_ ("file" ),N_ ("use given config file" )), +OPT_STRING (0 ,"blob" , &given_config_source.blob,N_ ("blob-id" ),N_ ("read config from given blob object" )), +OPT_GROUP (N_ ("Action" )), +OPT_BIT (0 ,"get" , &actions,N_ ("get value: name [value-pattern]" ),ACTION_GET ), +OPT_BIT (0 ,"get-all" , &actions,N_ ("get all values: key [value-pattern]" ),ACTION_GET_ALL ), +OPT_BIT (0 ,"get-regexp" , &actions,N_ ("get values for regexp: name-regex [value-pattern]" ),ACTION_GET_REGEXP ), +OPT_BIT (0 ,"get-urlmatch" , &actions,N_ ("get value specific for the URL: section[.var] URL" ),ACTION_GET_URLMATCH ), +OPT_BIT (0 ,"replace-all" , &actions,N_ ("replace all matching variables: name value [value-pattern]" ),ACTION_REPLACE_ALL ), +OPT_BIT (0 ,"add" , &actions,N_ ("add a new variable: name value" ),ACTION_ADD ), +OPT_BIT (0 ,"unset" , &actions,N_ ("remove a variable: name [value-pattern]" ),ACTION_UNSET ), +OPT_BIT (0 ,"unset-all" , &actions,N_ ("remove all matches: name [value-pattern]" ),ACTION_UNSET_ALL ), +OPT_BIT (0 ,"rename-section" , &actions,N_ ("rename section: old-name new-name" ),ACTION_RENAME_SECTION ), +OPT_BIT (0 ,"remove-section" , &actions,N_ ("remove a section: name" ),ACTION_REMOVE_SECTION ), +OPT_BIT ('l' ,"list" , &actions,N_ ("list all" ),ACTION_LIST ), +OPT_BOOL (0 ,"fixed-value" , &fixed_value,N_ ("use string equality when comparing values to 'value-pattern'" )), +OPT_BIT ('e' ,"edit" , &actions,N_ ("open an editor" ),ACTION_EDIT ), +OPT_BIT (0 ,"get-color" , &actions,N_ ("find the color configured: slot [default]" ),ACTION_GET_COLOR ), +OPT_BIT (0 ,"get-colorbool" , &actions,N_ ("find the color setting: slot [stdout-is-tty]" ),ACTION_GET_COLORBOOL ), +OPT_GROUP (N_ ("Type" )), +OPT_CALLBACK ('t' ,"type" , &type,N_ ("type" ),N_ ("value is given this type" ), option_parse_type), +OPT_CALLBACK_VALUE (0 ,"bool" , &type,N_ ("value is \"true\" or \"false\"" ),TYPE_BOOL ), +OPT_CALLBACK_VALUE (0 ,"int" , &type,N_ ("value is decimal number" ),TYPE_INT ), +OPT_CALLBACK_VALUE (0 ,"bool-or-int" , &type,N_ ("value is --bool or --int" ),TYPE_BOOL_OR_INT ), +OPT_CALLBACK_VALUE (0 ,"bool-or-str" , &type,N_ ("value is --bool or string" ),TYPE_BOOL_OR_STR ), +OPT_CALLBACK_VALUE (0 ,"path" , &type,N_ ("value is a path (file or directory name)" ),TYPE_PATH ), +OPT_CALLBACK_VALUE (0 ,"expiry-date" , &type,N_ ("value is an expiry date" ),TYPE_EXPIRY_DATE ), +OPT_GROUP (N_ ("Other" )), +OPT_BOOL ('z' ,"null" , &end_nul,N_ ("terminate values with NUL byte" )), +OPT_BOOL (0 ,"name-only" , &omit_values,N_ ("show variable names only" )), +OPT_BOOL (0 ,"includes" , &respect_includes_opt,N_ ("respect include directives on lookup" )), +OPT_BOOL (0 ,"show-origin" , &show_origin,N_ ("show origin of config (file, standard input, blob, command line)" )), +OPT_BOOL (0 ,"show-scope" , &show_scope,N_ ("show scope of config (worktree, local, global, system, command)" )), +OPT_STRING (0 ,"default" , &default_value,N_ ("value" ),N_ ("with --get, use default value when missing entry" )), +OPT_STRING (0 ,"comment" , &comment_arg,N_ ("value" ),N_ ("human-readable comment string (# will be prepended as needed)" )), +OPT_END (), +}; + +static NORETURN void usage_builtin_config(void) +{ +usage_with_options (builtin_config_usage, builtin_config_options); +} +int cmd_config (int argc,const char **argv,const char *prefix) {int nongit = !startup_info->have_repository;
Signature · 1 line
2.45.0
PATCH v5 3/14 builtin/config: move "fixed-value" option to correct group
In reply to Patrick SteinhardtThe --fixed-value option can be used to alter how the value-pattern parameter is interpreted for the various actions of git-config(1). But while it is an option, it is currently listed as part of the actions group, which is wrong.
Move the option to the "Other" group, which hosts the various options known to git-config(1).
--- builtin/config.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
builtin/config.c +1 -1
@@ -643,7 +643,6 @@ static struct option builtin_config_options[] = {OPT_BIT (0 ,"rename-section" , &actions,N_ ("rename section: old-name new-name" ),ACTION_RENAME_SECTION ),OPT_BIT (0 ,"remove-section" , &actions,N_ ("remove a section: name" ),ACTION_REMOVE_SECTION ),OPT_BIT ('l' ,"list" , &actions,N_ ("list all" ),ACTION_LIST ), -OPT_BOOL (0 ,"fixed-value" , &fixed_value,N_ ("use string equality when comparing values to 'value-pattern'" )),OPT_BIT ('e' ,"edit" , &actions,N_ ("open an editor" ),ACTION_EDIT ),OPT_BIT (0 ,"get-color" , &actions,N_ ("find the color configured: slot [default]" ),ACTION_GET_COLOR ), OPT_BIT(0, "get-colorbool", &actions, N_("find the color setting: slot [stdout-is-tty]"), ACTION_GET_COLORBOOL),
@@ -663,6 +662,7 @@ static struct option builtin_config_options[] = {OPT_BOOL (0 ,"show-scope" , &show_scope,N_ ("show scope of config (worktree, local, global, system, command)" )),OPT_STRING (0 ,"default" , &default_value,N_ ("value" ),N_ ("with --get, use default value when missing entry" )),OPT_STRING (0 ,"comment" , &comment_arg,N_ ("value" ),N_ ("human-readable comment string (# will be prepended as needed)" )), +OPT_BOOL (0 ,"fixed-value" , &fixed_value,N_ ("use string equality when comparing values to 'value-pattern'" )), OPT_END(), };
Signature · 1 line
2.45.0
PATCH v5 4/14 builtin/config: use `OPT_CMDMODE()` to specify modes
In reply to Patrick SteinhardtThe 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>].
--- builtin/config.c | 32 ++++++++++++++------------------ t/t1300-config.sh | 13 +++++++++++++ 2 files changed, 27 insertions(+), 18 deletions(-)
builtin/config.c +14 -18
@@ -632,20 +632,20 @@ static struct option builtin_config_options[] = {OPT_STRING ('f' ,"file" , &given_config_source.file,N_ ("file" ),N_ ("use given config file" )),OPT_STRING (0 ,"blob" , &given_config_source.blob,N_ ("blob-id" ),N_ ("read config from given blob object" )),OPT_GROUP (N_ ("Action" )), -OPT_BIT (0 ,"get" , &actions,N_ ("get value: name [value-pattern]" ),ACTION_GET ), -OPT_BIT (0 ,"get-all" , &actions,N_ ("get all values: key [value-pattern]" ),ACTION_GET_ALL ), -OPT_BIT (0 ,"get-regexp" , &actions,N_ ("get values for regexp: name-regex [value-pattern]" ),ACTION_GET_REGEXP ), -OPT_BIT (0 ,"get-urlmatch" , &actions,N_ ("get value specific for the URL: section[.var] URL" ),ACTION_GET_URLMATCH ), -OPT_BIT (0 ,"replace-all" , &actions,N_ ("replace all matching variables: name value [value-pattern]" ),ACTION_REPLACE_ALL ), -OPT_BIT (0 ,"add" , &actions,N_ ("add a new variable: name value" ),ACTION_ADD ), -OPT_BIT (0 ,"unset" , &actions,N_ ("remove a variable: name [value-pattern]" ),ACTION_UNSET ), -OPT_BIT (0 ,"unset-all" , &actions,N_ ("remove all matches: name [value-pattern]" ),ACTION_UNSET_ALL ), -OPT_BIT (0 ,"rename-section" , &actions,N_ ("rename section: old-name new-name" ),ACTION_RENAME_SECTION ), -OPT_BIT (0 ,"remove-section" , &actions,N_ ("remove a section: name" ),ACTION_REMOVE_SECTION ), -OPT_BIT ('l' ,"list" , &actions,N_ ("list all" ),ACTION_LIST ), -OPT_BIT ('e' ,"edit" , &actions,N_ ("open an editor" ),ACTION_EDIT ), -OPT_BIT (0 ,"get-color" , &actions,N_ ("find the color configured: slot [default]" ),ACTION_GET_COLOR ), -OPT_BIT (0 ,"get-colorbool" , &actions,N_ ("find the color setting: slot [stdout-is-tty]" ),ACTION_GET_COLORBOOL ), +OPT_CMDMODE (0 ,"get" , &actions,N_ ("get value: name [<value-pattern>]" ),ACTION_GET ), +OPT_CMDMODE (0 ,"get-all" , &actions,N_ ("get all values: key [<value-pattern>]" ),ACTION_GET_ALL ), +OPT_CMDMODE (0 ,"get-regexp" , &actions,N_ ("get values for regexp: name-regex [<value-pattern>]" ),ACTION_GET_REGEXP ), +OPT_CMDMODE (0 ,"get-urlmatch" , &actions,N_ ("get value specific for the URL: section[.var] URL" ),ACTION_GET_URLMATCH ), +OPT_CMDMODE (0 ,"replace-all" , &actions,N_ ("replace all matching variables: name value [<value-pattern>]" ),ACTION_REPLACE_ALL ), +OPT_CMDMODE (0 ,"add" , &actions,N_ ("add a new variable: name value" ),ACTION_ADD ), +OPT_CMDMODE (0 ,"unset" , &actions,N_ ("remove a variable: name [<value-pattern>]" ),ACTION_UNSET ), +OPT_CMDMODE (0 ,"unset-all" , &actions,N_ ("remove all matches: name [<value-pattern>]" ),ACTION_UNSET_ALL ), +OPT_CMDMODE (0 ,"rename-section" , &actions,N_ ("rename section: old-name new-name" ),ACTION_RENAME_SECTION ), +OPT_CMDMODE (0 ,"remove-section" , &actions,N_ ("remove a section: name" ),ACTION_REMOVE_SECTION ), +OPT_CMDMODE ('l' ,"list" , &actions,N_ ("list all" ),ACTION_LIST ), +OPT_CMDMODE ('e' ,"edit" , &actions,N_ ("open an editor" ),ACTION_EDIT ), +OPT_CMDMODE (0 ,"get-color" , &actions,N_ ("find the color configured: slot [<default>]" ),ACTION_GET_COLOR ), +OPT_CMDMODE (0 ,"get-colorbool" , &actions,N_ ("find the color setting: slot [<stdout-is-tty>]" ),ACTION_GET_COLORBOOL ),OPT_GROUP (N_ ("Type" )),OPT_CALLBACK ('t' ,"type" , &type,N_ ("type" ),N_ ("value is given this type" ), option_parse_type), 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)usage_builtin_config (); } -if (HAS_MULTI_BITS (actions)) { -error (_ ("only one action at a time" )); -usage_builtin_config (); - }if (actions ==0 )switch (argc) {case 1 : actions =ACTION_GET ;break ;
t/t1300-config.sh +13 -0
@@ -2738,4 +2738,17 @@ test_expect_success 'includeIf.hasconfig:remote.*.url forbids remote url in such grep "fatal: remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url" err ' +test_expect_success 'negated mode causes failure' ' + test_must_fail git config --no-get 2>err && + grep "unknown option \`no-get${SQ}" err +' + +test_expect_success 'specifying multiple modes causes failure' ' + cat >expect <<-EOF && + error: options ${SQ}--get-all${SQ} and ${SQ}--get${SQ} cannot be used together + EOF + test_must_fail git config --get --get-all 2>err && + test_cmp expect err +' + test_done
Signature · 1 line
2.45.0
PATCH v5 5/14 builtin/config: pull out function to handle config location
In reply to Patrick SteinhardtThere's quite a bunch of options to git-config(1) that allow the user to specify which config location to use when reading or writing config options. The logic to handle this is thus by necessity also quite involved.
Pull it out into a separate function so that we can reuse it in subsequent commits which introduce proper subcommands.
--- builtin/config.c | 133 ++++++++++++++++++++++++----------------------- 1 file changed, 68 insertions(+), 65 deletions(-)
builtin/config.c +68 -65
@@ -623,68 +623,8 @@ static char *default_user_config(void)return strbuf_detach (&buf,NULL ); } -static struct option builtin_config_options[] = { -OPT_GROUP (N_ ("Config file location" )), -OPT_BOOL (0 ,"global" , &use_global_config,N_ ("use global config file" )), -OPT_BOOL (0 ,"system" , &use_system_config,N_ ("use system config file" )), -OPT_BOOL (0 ,"local" , &use_local_config,N_ ("use repository config file" )), -OPT_BOOL (0 ,"worktree" , &use_worktree_config,N_ ("use per-worktree config file" )), -OPT_STRING ('f' ,"file" , &given_config_source.file,N_ ("file" ),N_ ("use given config file" )), -OPT_STRING (0 ,"blob" , &given_config_source.blob,N_ ("blob-id" ),N_ ("read config from given blob object" )), -OPT_GROUP (N_ ("Action" )), -OPT_CMDMODE (0 ,"get" , &actions,N_ ("get value: name [<value-pattern>]" ),ACTION_GET ), -OPT_CMDMODE (0 ,"get-all" , &actions,N_ ("get all values: key [<value-pattern>]" ),ACTION_GET_ALL ), -OPT_CMDMODE (0 ,"get-regexp" , &actions,N_ ("get values for regexp: name-regex [<value-pattern>]" ),ACTION_GET_REGEXP ), -OPT_CMDMODE (0 ,"get-urlmatch" , &actions,N_ ("get value specific for the URL: section[.var] URL" ),ACTION_GET_URLMATCH ), -OPT_CMDMODE (0 ,"replace-all" , &actions,N_ ("replace all matching variables: name value [<value-pattern>]" ),ACTION_REPLACE_ALL ), -OPT_CMDMODE (0 ,"add" , &actions,N_ ("add a new variable: name value" ),ACTION_ADD ), -OPT_CMDMODE (0 ,"unset" , &actions,N_ ("remove a variable: name [<value-pattern>]" ),ACTION_UNSET ), -OPT_CMDMODE (0 ,"unset-all" , &actions,N_ ("remove all matches: name [<value-pattern>]" ),ACTION_UNSET_ALL ), -OPT_CMDMODE (0 ,"rename-section" , &actions,N_ ("rename section: old-name new-name" ),ACTION_RENAME_SECTION ), -OPT_CMDMODE (0 ,"remove-section" , &actions,N_ ("remove a section: name" ),ACTION_REMOVE_SECTION ), -OPT_CMDMODE ('l' ,"list" , &actions,N_ ("list all" ),ACTION_LIST ), -OPT_CMDMODE ('e' ,"edit" , &actions,N_ ("open an editor" ),ACTION_EDIT ), -OPT_CMDMODE (0 ,"get-color" , &actions,N_ ("find the color configured: slot [<default>]" ),ACTION_GET_COLOR ), -OPT_CMDMODE (0 ,"get-colorbool" , &actions,N_ ("find the color setting: slot [<stdout-is-tty>]" ),ACTION_GET_COLORBOOL ), -OPT_GROUP (N_ ("Type" )), -OPT_CALLBACK ('t' ,"type" , &type,N_ ("type" ),N_ ("value is given this type" ), option_parse_type), -OPT_CALLBACK_VALUE (0 ,"bool" , &type,N_ ("value is \"true\" or \"false\"" ),TYPE_BOOL ), -OPT_CALLBACK_VALUE (0 ,"int" , &type,N_ ("value is decimal number" ),TYPE_INT ), -OPT_CALLBACK_VALUE (0 ,"bool-or-int" , &type,N_ ("value is --bool or --int" ),TYPE_BOOL_OR_INT ), -OPT_CALLBACK_VALUE (0 ,"bool-or-str" , &type,N_ ("value is --bool or string" ),TYPE_BOOL_OR_STR ), -OPT_CALLBACK_VALUE (0 ,"path" , &type,N_ ("value is a path (file or directory name)" ),TYPE_PATH ), -OPT_CALLBACK_VALUE (0 ,"expiry-date" , &type,N_ ("value is an expiry date" ),TYPE_EXPIRY_DATE ), -OPT_GROUP (N_ ("Other" )), -OPT_BOOL ('z' ,"null" , &end_nul,N_ ("terminate values with NUL byte" )), -OPT_BOOL (0 ,"name-only" , &omit_values,N_ ("show variable names only" )), -OPT_BOOL (0 ,"includes" , &respect_includes_opt,N_ ("respect include directives on lookup" )), -OPT_BOOL (0 ,"show-origin" , &show_origin,N_ ("show origin of config (file, standard input, blob, command line)" )), -OPT_BOOL (0 ,"show-scope" , &show_scope,N_ ("show scope of config (worktree, local, global, system, command)" )), -OPT_STRING (0 ,"default" , &default_value,N_ ("value" ),N_ ("with --get, use default value when missing entry" )), -OPT_STRING (0 ,"comment" , &comment_arg,N_ ("value" ),N_ ("human-readable comment string (# will be prepended as needed)" )), -OPT_BOOL (0 ,"fixed-value" , &fixed_value,N_ ("use string equality when comparing values to 'value-pattern'" )), -OPT_END (), -}; - -static NORETURN void usage_builtin_config(void) +static void handle_config_location (const char *prefix) { -usage_with_options (builtin_config_usage, builtin_config_options); -} - -int cmd_config (int argc,const char **argv,const char *prefix) -{ -int nongit = !startup_info->have_repository; -char *value =NULL , *comment =NULL ; -int flags =0 ; -int ret =0 ; -struct key_value_info default_kvi =KVI_INIT ; - - given_config_source.file =xstrdup_or_null (getenv (CONFIG_ENVIRONMENT )); - - argc =parse_options (argc, argv, prefix, builtin_config_options, - builtin_config_usage, -PARSE_OPT_STOP_AT_NON_OPTION ); -if (use_global_config + use_system_config + use_local_config + use_worktree_config + !!given_config_source.file + !!given_config_source.blob >1 ) {
@@ -692,14 +632,13 @@ int cmd_config(int argc, const char **argv, const char *prefix)usage_builtin_config (); } -if (nongit) { +if (!startup_info->have_repository) {if (use_local_config)die (_ ("--local can only be used inside a git repository" ));if (given_config_source.blob)die (_ ("--blob can only be used inside a git repository" ));if (use_worktree_config)die (_ ("--worktree can only be used inside a git repository" )); - } if (given_config_source.file &&
@@ -753,10 +692,74 @@ int cmd_config(int argc, const char **argv, const char *prefix) config_options.respect_includes = !given_config_source.file; else config_options.respect_includes = respect_includes_opt; -if (!nongit) { +if (startup_info->have_repository) { config_options.commondir =get_git_common_dir (); config_options.git_dir =get_git_dir (); } +} + +static struct option builtin_config_options[] = { +OPT_GROUP (N_ ("Config file location" )), +OPT_BOOL (0 ,"global" , &use_global_config,N_ ("use global config file" )), +OPT_BOOL (0 ,"system" , &use_system_config,N_ ("use system config file" )), +OPT_BOOL (0 ,"local" , &use_local_config,N_ ("use repository config file" )), +OPT_BOOL (0 ,"worktree" , &use_worktree_config,N_ ("use per-worktree config file" )), +OPT_STRING ('f' ,"file" , &given_config_source.file,N_ ("file" ),N_ ("use given config file" )), +OPT_STRING (0 ,"blob" , &given_config_source.blob,N_ ("blob-id" ),N_ ("read config from given blob object" )), +OPT_GROUP (N_ ("Action" )), +OPT_CMDMODE (0 ,"get" , &actions,N_ ("get value: name [<value-pattern>]" ),ACTION_GET ), +OPT_CMDMODE (0 ,"get-all" , &actions,N_ ("get all values: key [<value-pattern>]" ),ACTION_GET_ALL ), +OPT_CMDMODE (0 ,"get-regexp" , &actions,N_ ("get values for regexp: name-regex [<value-pattern>]" ),ACTION_GET_REGEXP ), +OPT_CMDMODE (0 ,"get-urlmatch" , &actions,N_ ("get value specific for the URL: section[.var] URL" ),ACTION_GET_URLMATCH ), +OPT_CMDMODE (0 ,"replace-all" , &actions,N_ ("replace all matching variables: name value [<value-pattern>]" ),ACTION_REPLACE_ALL ), +OPT_CMDMODE (0 ,"add" , &actions,N_ ("add a new variable: name value" ),ACTION_ADD ), +OPT_CMDMODE (0 ,"unset" , &actions,N_ ("remove a variable: name [<value-pattern>]" ),ACTION_UNSET ), +OPT_CMDMODE (0 ,"unset-all" , &actions,N_ ("remove all matches: name [<value-pattern>]" ),ACTION_UNSET_ALL ), +OPT_CMDMODE (0 ,"rename-section" , &actions,N_ ("rename section: old-name new-name" ),ACTION_RENAME_SECTION ), +OPT_CMDMODE (0 ,"remove-section" , &actions,N_ ("remove a section: name" ),ACTION_REMOVE_SECTION ), +OPT_CMDMODE ('l' ,"list" , &actions,N_ ("list all" ),ACTION_LIST ), +OPT_CMDMODE ('e' ,"edit" , &actions,N_ ("open an editor" ),ACTION_EDIT ), +OPT_CMDMODE (0 ,"get-color" , &actions,N_ ("find the color configured: slot [<default>]" ),ACTION_GET_COLOR ), +OPT_CMDMODE (0 ,"get-colorbool" , &actions,N_ ("find the color setting: slot [<stdout-is-tty>]" ),ACTION_GET_COLORBOOL ), +OPT_GROUP (N_ ("Type" )), +OPT_CALLBACK ('t' ,"type" , &type,N_ ("type" ),N_ ("value is given this type" ), option_parse_type), +OPT_CALLBACK_VALUE (0 ,"bool" , &type,N_ ("value is \"true\" or \"false\"" ),TYPE_BOOL ), +OPT_CALLBACK_VALUE (0 ,"int" , &type,N_ ("value is decimal number" ),TYPE_INT ), +OPT_CALLBACK_VALUE (0 ,"bool-or-int" , &type,N_ ("value is --bool or --int" ),TYPE_BOOL_OR_INT ), +OPT_CALLBACK_VALUE (0 ,"bool-or-str" , &type,N_ ("value is --bool or string" ),TYPE_BOOL_OR_STR ), +OPT_CALLBACK_VALUE (0 ,"path" , &type,N_ ("value is a path (file or directory name)" ),TYPE_PATH ), +OPT_CALLBACK_VALUE (0 ,"expiry-date" , &type,N_ ("value is an expiry date" ),TYPE_EXPIRY_DATE ), +OPT_GROUP (N_ ("Other" )), +OPT_BOOL ('z' ,"null" , &end_nul,N_ ("terminate values with NUL byte" )), +OPT_BOOL (0 ,"name-only" , &omit_values,N_ ("show variable names only" )), +OPT_BOOL (0 ,"includes" , &respect_includes_opt,N_ ("respect include directives on lookup" )), +OPT_BOOL (0 ,"show-origin" , &show_origin,N_ ("show origin of config (file, standard input, blob, command line)" )), +OPT_BOOL (0 ,"show-scope" , &show_scope,N_ ("show scope of config (worktree, local, global, system, command)" )), +OPT_STRING (0 ,"default" , &default_value,N_ ("value" ),N_ ("with --get, use default value when missing entry" )), +OPT_STRING (0 ,"comment" , &comment_arg,N_ ("value" ),N_ ("human-readable comment string (# will be prepended as needed)" )), +OPT_BOOL (0 ,"fixed-value" , &fixed_value,N_ ("use string equality when comparing values to 'value-pattern'" )), +OPT_END (), +}; + +static NORETURN void usage_builtin_config(void) +{ +usage_with_options (builtin_config_usage, builtin_config_options); +} + +int cmd_config (int argc,const char **argv,const char *prefix) +{ +char *value =NULL , *comment =NULL ; +int flags =0 ; +int ret =0 ; +struct key_value_info default_kvi =KVI_INIT ; + + given_config_source.file =xstrdup_or_null (getenv (CONFIG_ENVIRONMENT )); + + argc =parse_options (argc, argv, prefix, builtin_config_options, + builtin_config_usage, +PARSE_OPT_STOP_AT_NON_OPTION ); + +handle_config_location (prefix);if (end_nul) { term ='\0' ;
@@ -858,7 +861,7 @@ int cmd_config(int argc, const char **argv, const char *prefix)char *config_file;check_argc (argc,0 ,0 ); -if (!given_config_source.file && nongit) +if (!given_config_source.file && !startup_info->have_repository)die (_ ("not in a git directory" ));if (given_config_source.use_stdin)die (_ ("editing stdin is not supported" ));
Signature · 1 line
2.45.0
PATCH v5 6/14 builtin/config: pull out function to handle `--null`
In reply to Patrick SteinhardtPull out function to handle the --null option, which we are about to reuse in subsequent commits.
--- builtin/config.c | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-)
builtin/config.c +9 -6
@@ -698,6 +698,14 @@ static void handle_config_location(const char *prefix) } } +static void handle_nul (void ) { +if (end_nul) { + term ='\0' ; + delim ='\n' ; + key_delim ='\n' ; + } +} +static struct option builtin_config_options[] = {OPT_GROUP (N_ ("Config file location" )),OPT_BOOL (0 ,"global" , &use_global_config,N_ ("use global config file" )),
@@ -760,12 +768,7 @@ int cmd_config(int argc, const char **argv, const char *prefix) PARSE_OPT_STOP_AT_NON_OPTION);handle_config_location (prefix); - -if (end_nul) { - term ='\0' ; - delim ='\n' ; - key_delim ='\n' ; - } +handle_nul ();if ((actions & (ACTION_GET_COLOR |ACTION_GET_COLORBOOL )) && type) {error (_ ("--get-color and variable type are incoherent" ));
Signature · 1 line
2.45.0
PATCH v5 7/14 builtin/config: introduce "list" subcommand
In reply to Patrick SteinhardtWhile git-config(1) has several modes, those modes are not exposed with subcommands but instead by specifying action flags like --unset or --list. This user interface is not really in line with how our more modern commands work, where it is a lot more customary to say e.g. git remote list. Furthermore, to add to the confusion, git-config(1) also allows the user to request modes implicitly by just specifying the correct number of arguments. Thus, git config foo.bar will retrieve the value of "foo.bar" while git config foo.bar baz will set it to "baz".
Overall, this makes for a confusing interface that could really use a makeover. It hurts discoverability of what you can do with git-config(1) and is comparatively easy to get wrong. Converting the command to have subcommands instead would go a long way to help address these issues.
One concern in this context is backwards compatibility. Luckily, we can introduce subcommands without breaking backwards compatibility at all. This is because all the implicit modes of git-config(1) require that the first argument is a properly formatted config key. And as config keys _must_ have a dot in their name, any value without a dot would have been discarded by git-config(1) previous to this change. Thus, given that none of the subcommands do have a dot, they are unambiguous.
Introduce the first such new subcommand, which is "git config list". To retain backwards compatibility we only conditionally use subcommands and will fall back to the old syntax in case no subcommand was detected. This should help to transition to the new-style syntax until we eventually deprecate and remove the old-style syntax.
Note that the way we handle this we're duplicating some functionality across old and new syntax. While this isn't pretty, it helps us to ensure that there really is no change in behaviour for the old syntax.
Amend tests such that we run them both with old and new style syntax. As tests are now run twice, state from the first run may be still be around in the second run and thus cause tests to fail. Add cleanup logic as required to fix such tests.
--- Documentation/git-config.txt | 26 ++++++--- builtin/config.c | 90 ++++++++++++++++++++++++---- t/t1300-config.sh | 110 +++++++++++++++++++++-------------- 3 files changed, 162 insertions(+), 64 deletions(-)
Documentation/git-config.txt +19 -7
@@ -9,6 +9,7 @@ git-config - Get and set repository or global options SYNOPSIS -------- [verse] +'git config list' [<file-option>] [<display-option>] [--includes] 'git config' [<file-option>] [--type=<type>] [--comment=<message>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] <name> [<value> [<value-pattern>]] 'git config' [<file-option>] [--type=<type>] [--comment=<message>] --add <name> <value> 'git config' [<file-option>] [--type=<type>] [--comment=<message>] [--fixed-value] --replace-all <name> <value> [<value-pattern>]
@@ -20,7 +21,6 @@ SYNOPSIS 'git config' [<file-option>] [--fixed-value] --unset-all <name> [<value-pattern>] 'git config' [<file-option>] --rename-section <old-name> <new-name> 'git config' [<file-option>] --remove-section <name> -'git config' [<file-option>] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list 'git config' [<file-option>] --get-color <name> [<default>] 'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>] 'git config' [<file-option>] -e | --edit
@@ -74,6 +74,12 @@ On success, the command returns the exit code 0. A list of all available configuration variables can be obtained using the `git help --config` command. +COMMANDS +-------- + +list:: + List all variables set in config file, along with their values. + [[OPTIONS]] OPTIONS -------
@@ -190,10 +196,6 @@ See also <<FILES>>. --unset-all:: Remove all lines matching the key from config file. --l:: ---list:: - List all variables set in config file, along with their values. - --fixed-value:: When used with the `value-pattern` argument, treat `value-pattern` as an exact string instead of a regular expression. This will restrict
@@ -248,7 +250,7 @@ Valid `<type>`'s include: contain line breaks. --name-only:: - Output only the names of config variables for `--list` or + Output only the names of config variables for `list` or `--get-regexp`. --show-origin::
@@ -300,10 +302,20 @@ Valid `<type>`'s include: When using `--get`, and the requested variable is not found, behave as if <value> were the value assigned to that variable. +DEPRECATED MODES +---------------- + +The following modes have been deprecated in favor of subcommands. It is +recommended to migrate to the new syntax. + +-l:: +--list:: + Replaced by `git config list`. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when -using `--list` or any of the `--get-*` which may return multiple results. +using `list` or any of the `--get-*` which may return multiple results. The default is to use a pager. [[FILES]]
builtin/config.c +78 -12
135 lines not on this page · raw message
t/t1300-config.sh +65 -45
378 lines not on this page · raw message
Signature · 1 line
2.45.0
PATCH v5 8/14 builtin/config: introduce "get" subcommand
In reply to Patrick SteinhardtIntroduce a new "get" subcommand to git-config(1). Please refer to preceding commits regarding the motivation behind this change.
--- Documentation/git-config.txt | 93 ++++++++++++------------- builtin/config.c | 69 +++++++++++++++--- t/t1300-config.sh | 131 ++++++++++++++++++++++++----------- 3 files changed, 194 insertions(+), 99 deletions(-)
Documentation/git-config.txt +45 -48
@@ -10,18 +10,14 @@ SYNOPSIS -------- [verse] 'git config list' [<file-option>] [<display-option>] [--includes] +'git config get' [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name> 'git config' [<file-option>] [--type=<type>] [--comment=<message>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] <name> [<value> [<value-pattern>]] 'git config' [<file-option>] [--type=<type>] [--comment=<message>] --add <name> <value> 'git config' [<file-option>] [--type=<type>] [--comment=<message>] [--fixed-value] --replace-all <name> <value> [<value-pattern>] -'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get <name> [<value-pattern>] -'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all <name> [<value-pattern>] -'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp <name-regex> [<value-pattern>] -'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch <name> <URL> 'git config' [<file-option>] [--fixed-value] --unset <name> [<value-pattern>] 'git config' [<file-option>] [--fixed-value] --unset-all <name> [<value-pattern>] 'git config' [<file-option>] --rename-section <old-name> <new-name> 'git config' [<file-option>] --remove-section <name> -'git config' [<file-option>] --get-color <name> [<default>] 'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>] 'git config' [<file-option>] -e | --edit
@@ -80,6 +76,12 @@ COMMANDS list:: List all variables set in config file, along with their values. +get:: + Emits the value of the specified key. If key is present multiple times + in the configuration, emits the last value. If `--all` is specified, + emits all values associated with key. Returns error code 1 if key is + not present. + [[OPTIONS]] OPTIONS -------
@@ -105,22 +107,16 @@ OPTIONS not contain linefeed characters (no multi-line comments are permitted). ---get:: - Get the value for a given key (optionally filtered by a regex - matching the value). Returns error code 1 if the key was not - found and the last value if multiple key values were found. - ---get-all:: - Like get, but returns all values for a multi-valued key. +--all:: + With `get`, return all values for a multi-valued key. ---get-regexp:: - Like --get-all, but interprets the name as a regular expression and - writes out the key names. Regular expression matching is currently - case-sensitive and done against a canonicalized version of the key - in which section and variable names are lowercased, but subsection - names are not. +---regexp:: + With `get`, interpret the name as a regular expression. Regular + expression matching is currently case-sensitive and done against a + canonicalized version of the key in which section and variable names + are lowercased, but subsection names are not. ---get-urlmatch <name> <URL>:: +--url=<URL>:: When given a two-part <name> as <section>.<key>, the value for <section>.<URL>.<key> whose <URL> part matches the best to the given URL is returned (if no such key exists, the value for
@@ -251,7 +247,7 @@ Valid `<type>`'s include: --name-only:: Output only the names of config variables for `list` or - `--get-regexp`. + `get`. --show-origin:: Augment the output of all queried config options with the
@@ -275,17 +271,6 @@ Valid `<type>`'s include: When the color setting for `name` is undefined, the command uses `color.ui` as fallback. ---get-color <name> [<default>]:: - - Find the color configured for `name` (e.g. `color.diff.new`) and - output it as the ANSI color escape sequence to the standard - output. The optional `default` parameter is used instead, if - there is no color configured for `name`. -+ -`--type=color [--default=<default>]` is preferred over `--get-color` -(but note that `--get-color` will omit the trailing newline printed by -`--type=color`). - -e:: --edit:: Opens an editor to modify the specified config file; either
@@ -299,7 +284,7 @@ Valid `<type>`'s include: config files. --default <value>:: - When using `--get`, and the requested variable is not found, behave as if + When using `get`, and the requested variable is not found, behave as if <value> were the value assigned to that variable. DEPRECATED MODES
@@ -308,15 +293,33 @@ DEPRECATED MODES The following modes have been deprecated in favor of subcommands. It is recommended to migrate to the new syntax. +'git config <name>':: + Replaced by `git config get <name>`. + -l:: --list:: Replaced by `git config list`. +--get <name> [<value-pattern>]:: + Replaced by `git config get [--value=<pattern>] <name>`. + +--get-all <name> [<value-pattern>]:: + Replaced by `git config get [--value=<pattern>] --all --show-names <name>`. + +--get-regexp <name-regexp>:: + Replaced by `git config get --all --show-names --regexp <name-regexp>`. + +--get-urlmatch <name> <URL>:: + Replaced by `git config get --all --show-names --url=<URL> <name>`. + +--get-color <name> [<default>]:: + Replaced by `git config get --type=color [--default=<default>] <name>`. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when -using `list` or any of the `--get-*` which may return multiple results. -The default is to use a pager. +using `list` or `get` which may return multiple results. The default is to use +a pager. [[FILES]] FILES
@@ -519,25 +522,19 @@ you have to provide a regex matching the value of exactly one line. To query the value for a given key, do ------------ -% git config --get core.filemode ------------- - -or - ------------- -% git config core.filemode +% git config get core.filemode ------------ or, to query a multivar: ------------ -% git config --get core.gitproxy "for kernel.org$" +% git config get --value="for kernel.org$" core.gitproxy ------------ If you want to know all the values for a multivar, do: ------------ -% git config --get-all core.gitproxy +% git config get --all --show-names core.gitproxy ------------ If you like to live dangerously, you can replace *all* core.gitproxy by a
@@ -571,8 +568,8 @@ script: ------------ #!/bin/sh -WS=$(git config --get-color color.diff.whitespace "blue reverse") -RESET=$(git config --get-color "" "reset") +WS=$(git config get --type=color --default="blue reverse" color.diff.whitespace) +RESET=$(git config get --type=color --default="reset" "") echo "${WS}your whitespace color or blue reverse${RESET}" ------------
@@ -580,11 +577,11 @@ For URLs in `https://weak.example.com`, `http.sslVerify` is set to false, while it is set to `true` for all others: ------------ -% git config --type=bool --get-urlmatch http.sslverify https://good.example.com +% git config get --type=bool --url=https://good.example.com http.sslverify true -% git config --type=bool --get-urlmatch http.sslverify https://weak.example.com +% git config get --type=bool --url=https://weak.example.com http.sslverify false -% git config --get-urlmatch http https://weak.example.com +% git config get --url=https://weak.example.com http http.cookieFile /tmp/cookie.txt http.sslverify false ------------
builtin/config.c +60 -9
101 lines not on this page · raw message
t/t1300-config.sh +89 -42
441 lines not on this page · raw message
Signature · 1 line
2.45.0
Re: [PATCH v5 08/14] builtin/config: introduce "get" subcommand
Quoted 36 lines · Patrick Steinhardt
Introduce a new "get" subcommand to git-config(1). Please refer to preceding commits regarding the motivation behind this change.
Signed-off-by Patrick Steinhardt <[email protected]>---
Documentation/git-config.txt +3
-9@@ -519,25 +522,19 @@ you have to provide a regex matching the value of exactly one line. To query the value for a given key, do ------------ -% git config --get core.filemode ------------- - -or - ------------- -% git config core.filemode +% git config get core.filemode ------------ or, to query a multivar: ------------ -% git config --get core.gitproxy "for kernel.org$" +% git config get --value="for kernel.org$" core.gitproxy ------------ If you want to know all the values for a multivar, do: ------------ -% git config --get-all core.gitproxy +% git config get --all --show-names core.gitproxy ------------ If you like to live dangerously, you can replace *all* core.gitproxy by a
Documentation/git-config.txt script: · line 573
Quoted 8 lines
Documentation/git-config.txt +2
-2@@ -571,8 +568,8 @@ script: ------------ #!/bin/sh -WS=$(git config --get-color color.diff.whitespace "blue reverse") -RESET=$(git config --get-color "" "reset") +WS=$(git config get --type=color --default="blue reverse" color.diff.whitespace) +RESET=$(git config get --type=color --default="reset" "") echo "${WS}your whitespace color or blue reverse${RESET}"
In this example the second command in the postimage doesn't work:
$ RESET=$(git config get --type=color --default="reset" "") error: key does not contain a section:
Consequently, the last command doesn't work as expected anymore, because the color is not reset at the end of the output.
Luckily, the commands in the preimage still work.
Re: [PATCH v5 08/14] builtin/config: introduce "get" subcommand
Quoted 9 lines · SZEDER Gábor
Documentation/git-config.txt script: · line 573
Quoted 6 lines
#!/bin/sh
Documentation/git-config.txt +2
-2-WS=$(git config --get-color color.diff.whitespace "blue reverse") -RESET=$(git config --get-color "" "reset") +WS=$(git config get --type=color --default="blue reverse" color.diff.whitespace) +RESET=$(git config get --type=color --default="reset" "") echo "${WS}your whitespace color or blue reverse${RESET}"In this example the second command in the postimage doesn't work:
Quoted 7 lines
$ RESET=$(git config get --type=color --default="reset" "") error: key does not contain a section:Consequently, the last command doesn't work as expected anymore, because the color is not reset at the end of the output.
Luckily, the commands in the preimage still work.
Instead of an empty string as a configuration variable, using something like no.such.variable that does not exist would also be a workaround. I.e.,
RESET=$(git config get --type=color --default=reset no.such.variable)
What is bad about this is that there is no generic variable that is guaranteed to be unset.
Re: [PATCH v5 08/14] builtin/config: introduce "get" subcommand
Quoted 19 lines · Junio C Hamano
Quoted 9 lines · SZEDER Gábor
Documentation/git-config.txt script: · line 573
Quoted 6 lines
#!/bin/sh
Documentation/git-config.txt +2
-2-WS=$(git config --get-color color.diff.whitespace "blue reverse") -RESET=$(git config --get-color "" "reset") +WS=$(git config get --type=color --default="blue reverse" color.diff.whitespace) +RESET=$(git config get --type=color --default="reset" "") echo "${WS}your whitespace color or blue reverse${RESET}"In this example the second command in the postimage doesn't work:
Quoted 7 lines
$ RESET=$(git config get --type=color --default="reset" "") error: key does not contain a section:Consequently, the last command doesn't work as expected anymore, because the color is not reset at the end of the output.
Luckily, the commands in the preimage still work.
Quoted 8 lines
Instead of an empty string as a configuration variable, using something like no.such.variable that does not exist would also be a workaround. I.e.,
RESET=$(git config get --type=color --default=reset no.such.variable)What is bad about this is that there is no generic variable that is guaranteed to be unset.
In fact that's even what our tests in t4026 do:
color()
{
actual=$(git config --get-color no.such.slot "$1") &&
test "$actual" = "${2:+$ESC}$2"
}But that's certainly not great.
I'd say that the current behaviour is just a plain bug. In fact, there's even two bugs:
1. We set up the pager when asked to print color codes. This does not make any sense whatsoever, as these should never go to the pager but should always be printed to stdout directly.
2. We don't recognize the special case where we have are asked for a color, have an empty key but a default value.
I'll send a patch series to fix these.
Patrick
PATCH v5 9/14 builtin/config: introduce "set" subcommand
In reply to Patrick SteinhardtIntroduce a new "set" subcommand to git-config(1). Please refer to preceding commits regarding the motivation behind this change.
--- Documentation/git-config.txt | 38 ++++++++----- builtin/config.c | 63 ++++++++++++++++++++++ t/t1300-config.sh | 102 ++++++++++++++++++----------------- 3 files changed, 140 insertions(+), 63 deletions(-)
Documentation/git-config.txt +24 -14
@@ -11,9 +11,7 @@ SYNOPSIS [verse] 'git config list' [<file-option>] [<display-option>] [--includes] 'git config get' [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name> -'git config' [<file-option>] [--type=<type>] [--comment=<message>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] <name> [<value> [<value-pattern>]] -'git config' [<file-option>] [--type=<type>] [--comment=<message>] --add <name> <value> -'git config' [<file-option>] [--type=<type>] [--comment=<message>] [--fixed-value] --replace-all <name> <value> [<value-pattern>] +'git config set' [<file-option>] [--type=<type>] [--comment=<message>] [--all] [--value=<value>] [--fixed-value] <name> <value> 'git config' [<file-option>] [--fixed-value] --unset <name> [<value-pattern>] 'git config' [<file-option>] [--fixed-value] --unset-all <name> [<value-pattern>] 'git config' [<file-option>] --rename-section <old-name> <new-name>
@@ -27,7 +25,7 @@ You can query/set/replace/unset options with this command. The name is actually the section and the key separated by a dot, and the value will be escaped. -Multiple lines can be added to an option by using the `--add` option. +Multiple lines can be added to an option by using the `--append` option. If you want to update or unset an option which can occur on multiple lines, a `value-pattern` (which is an extended regular expression, unless the `--fixed-value` option is given) needs to be given. Only the
@@ -82,6 +80,13 @@ get:: emits all values associated with key. Returns error code 1 if key is not present. +set:: + Set value for one or more config options. By default, this command + refuses to write multi-valued config options. Passing `--all` will + replace all multi-valued config options with the new value, whereas + `--value=` will replace all config options whose values match the given + pattern. + [[OPTIONS]] OPTIONS -------
@@ -90,10 +95,9 @@ OPTIONS Default behavior is to replace at most one line. This replaces all lines matching the key (and optionally the `value-pattern`). ---add:: +--append:: Adds a new line to the option without altering any existing - values. This is the same as providing '^$' as the `value-pattern` - in `--replace-all`. + values. This is the same as providing '--value=^$' in `set`. --comment <message>:: Append a comment at the end of new or modified lines.
@@ -296,6 +300,9 @@ recommended to migrate to the new syntax. 'git config <name>':: Replaced by `git config get <name>`. +'git config <name> <value> [<value-pattern>]':: + Replaced by `git config set [--value=<pattern>] <name> <value>`. + -l:: --list:: Replaced by `git config list`.
@@ -315,6 +322,9 @@ recommended to migrate to the new syntax. --get-color <name> [<default>]:: Replaced by `git config get --type=color [--default=<default>] <name>`. +--add <name> <value>:: + Replaced by `git config set --append <name> <value>`. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when
@@ -361,7 +371,7 @@ precedence over values read earlier. When multiple values are taken then all values of a key from all files will be used. By default, options are only written to the repository specific -configuration file. Note that this also affects options like `--replace-all` +configuration file. Note that this also affects options like `set` and `--unset`. *'git config' will only ever change one file at a time*. You can limit which configuration sources are read from or written to by
@@ -497,7 +507,7 @@ Given a .git/config like this: you can set the filemode to true with ------------ -% git config core.filemode true +% git config set core.filemode true ------------ The hypothetical proxy command entries actually have a postfix to discern
@@ -505,7 +515,7 @@ what URL they apply to. Here is how to change the entry for kernel.org to "ssh". ------------ -% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$' +% git config set --value='for kernel.org$' core.gitproxy '"ssh" for kernel.org' ------------ This makes sure that only the key/value pair for kernel.org is replaced.
@@ -541,26 +551,26 @@ If you like to live dangerously, you can replace *all* core.gitproxy by a new one with ------------ -% git config --replace-all core.gitproxy ssh +% git config set --all core.gitproxy ssh ------------ However, if you really only want to replace the line for the default proxy, i.e. the one without a "for ..." postfix, do something like this: ------------ -% git config core.gitproxy ssh '! for ' +% git config set --value='! for ' core.gitproxy ssh ------------ To actually match only values with an exclamation mark, you have to ------------ -% git config section.key value '[!]' +% git config set --value='[!]' section.key value ------------ To add a new proxy, without altering any of the existing ones, use ------------ -% git config --add core.gitproxy '"proxy-command" for example.com' +% git config set --append core.gitproxy '"proxy-command" for example.com' ------------ An example to use customized color from the configuration in your
builtin/config.c +63 -0
84 lines not on this page · raw message
t/t1300-config.sh +53 -49
284 lines not on this page · raw message
Signature · 1 line
2.45.0
PATCH v5 10/14 builtin/config: introduce "unset" subcommand
In reply to Patrick SteinhardtIntroduce a new "unset" subcommand to git-config(1). Please refer to preceding commits regarding the motivation behind this change.
--- Documentation/git-config.txt | 27 +++++++++++++--------- builtin/config.c | 39 ++++++++++++++++++++++++++++++++ t/t1300-config.sh | 44 ++++++++++++++++++++++++------------ 3 files changed, 84 insertions(+), 26 deletions(-)
Documentation/git-config.txt +16 -11
@@ -11,9 +11,8 @@ SYNOPSIS [verse] 'git config list' [<file-option>] [<display-option>] [--includes] 'git config get' [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name> -'git config set' [<file-option>] [--type=<type>] [--comment=<message>] [--all] [--value=<value>] [--fixed-value] <name> <value> -'git config' [<file-option>] [--fixed-value] --unset <name> [<value-pattern>] -'git config' [<file-option>] [--fixed-value] --unset-all <name> [<value-pattern>] +'git config set' [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value> +'git config unset' [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value> 'git config' [<file-option>] --rename-section <old-name> <new-name> 'git config' [<file-option>] --remove-section <name> 'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>]
@@ -87,6 +86,12 @@ set:: `--value=` will replace all config options whose values match the given pattern. +unset:: + Unset value for one or more config options. By default, this command + refuses to unset multi-valued keys. Passing `--all` will unset all + multi-valued config options, whereas `--value` will unset all config + options whose values match the given pattern. + [[OPTIONS]] OPTIONS -------
@@ -190,12 +195,6 @@ See also <<FILES>>. --rename-section:: Rename the given section to a new name. ---unset:: - Remove the line matching the key from config file. - ---unset-all:: - Remove all lines matching the key from config file. - --fixed-value:: When used with the `value-pattern` argument, treat `value-pattern` as an exact string instead of a regular expression. This will restrict
@@ -325,6 +324,12 @@ recommended to migrate to the new syntax. --add <name> <value>:: Replaced by `git config set --append <name> <value>`. +--unset <name> [<value-pattern>]:: + Replaced by `git config unset [--value=<pattern>] <name>`. + +--unset-all <name> [<value-pattern>]:: + Replaced by `git config unset [--value=<pattern>] --all <name>`. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when
@@ -372,7 +377,7 @@ values of a key from all files will be used. By default, options are only written to the repository specific configuration file. Note that this also affects options like `set` -and `--unset`. *'git config' will only ever change one file at a time*. +and `unset`. *'git config' will only ever change one file at a time*. You can limit which configuration sources are read from or written to by specifying the path of a file with the `--file` option, or by specifying a
@@ -523,7 +528,7 @@ This makes sure that only the key/value pair for kernel.org is replaced. To delete the entry for renames, do ------------ -% git config --unset diff.renames +% git config unset diff.renames ------------ If you want to delete an entry for a multivar (like core.gitproxy above),
builtin/config.c +39 -0
@@ -19,6 +19,7 @@ static const char *const builtin_config_usage[] = {N_ ("git config list [<file-option>] [<display-option>] [--includes]" ),N_ ("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name>" ),N_ ("git config set [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ), +N_ ("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ), NULL };
@@ -37,6 +38,11 @@ static const char *const builtin_config_set_usage[] = { NULL }; +static const char *const builtin_config_unset_usage[] = { +N_ ("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ), +NULL +}; +static char *key;static regex_t *key_regexp;static const char *value_pattern;
@@ -911,10 +917,43 @@ static int cmd_config_set(int argc, const char **argv, const char *prefix)return ret; } +static int cmd_config_unset (int argc,const char **argv,const char *prefix) +{ +const char *value_pattern =NULL ; +int flags =0 ; +struct option opts[] = { +CONFIG_LOCATION_OPTIONS , +OPT_GROUP (N_ ("Filter" )), +OPT_BIT (0 ,"all" , &flags,N_ ("replace multi-valued config option with new value" ),CONFIG_FLAGS_MULTI_REPLACE ), +OPT_STRING (0 ,"value" , &value_pattern,N_ ("pattern" ),N_ ("show config with values matching the pattern" )), +OPT_BIT (0 ,"fixed-value" , &flags,N_ ("use string equality when comparing values to value pattern" ),CONFIG_FLAGS_FIXED_VALUE ), +OPT_END (), + }; + + argc =parse_options (argc, argv, prefix, opts, builtin_config_unset_usage, +PARSE_OPT_STOP_AT_NON_OPTION ); +check_write (); +check_argc (argc,1 ,1 ); + +if ((flags &CONFIG_FLAGS_FIXED_VALUE ) && !value_pattern) +die (_ ("--fixed-value only applies with 'value-pattern'" )); + +handle_config_location (prefix); + +if ((flags &CONFIG_FLAGS_MULTI_REPLACE ) || value_pattern) +return git_config_set_multivar_in_file_gently (given_config_source.file, + argv[0 ],NULL , value_pattern, +NULL , flags); +else +return git_config_set_in_file_gently (given_config_source.file, argv[0 ], +NULL ,NULL ); +} +static struct option builtin_subcommand_options[] = {OPT_SUBCOMMAND ("list" , &subcommand, cmd_config_list),OPT_SUBCOMMAND ("get" , &subcommand, cmd_config_get),OPT_SUBCOMMAND ("set" , &subcommand, cmd_config_set), +OPT_SUBCOMMAND ("unset" , &subcommand, cmd_config_unset),OPT_END (), };
t/t1300-config.sh +29 -15
143 lines not on this page · raw message
Signature · 1 line
2.45.0
PATCH v5 11/14 builtin/config: introduce "rename-section" subcommand
In reply to Patrick SteinhardtIntroduce a new "rename-section" subcommand to git-config(1). Please refer to preceding commits regarding the motivation behind this change.
--- Documentation/git-config.txt | 11 +++++++---- builtin/config.c | 32 ++++++++++++++++++++++++++++++++ t/t1300-config.sh | 22 +++++++++++----------- 3 files changed, 50 insertions(+), 15 deletions(-)
Documentation/git-config.txt +7 -4
@@ -13,7 +13,7 @@ SYNOPSIS 'git config get' [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name> 'git config set' [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value> 'git config unset' [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value> -'git config' [<file-option>] --rename-section <old-name> <new-name> +'git config rename-section' [<file-option>] <old-name> <new-name> 'git config' [<file-option>] --remove-section <name> 'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>] 'git config' [<file-option>] -e | --edit
@@ -92,6 +92,9 @@ unset:: multi-valued config options, whereas `--value` will unset all config options whose values match the given pattern. +rename-section:: + Rename the given section to a new name. + [[OPTIONS]] OPTIONS -------
@@ -192,9 +195,6 @@ See also <<FILES>>. --remove-section:: Remove the given section from the configuration file. ---rename-section:: - Rename the given section to a new name. - --fixed-value:: When used with the `value-pattern` argument, treat `value-pattern` as an exact string instead of a regular expression. This will restrict
@@ -330,6 +330,9 @@ recommended to migrate to the new syntax. --unset-all <name> [<value-pattern>]:: Replaced by `git config unset [--value=<pattern>] --all <name>`. +--rename-section <old-name> <new-name>:: + Replaced by `git config rename-section <old-name> <new-name>`. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when
builtin/config.c +32 -0
@@ -20,6 +20,7 @@ static const char *const builtin_config_usage[] = {N_ ("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name>" ),N_ ("git config set [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ),N_ ("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ), +N_ ("git config rename-section [<file-option>] <old-name> <new-name>" ), NULL };
@@ -43,6 +44,11 @@ static const char *const builtin_config_unset_usage[] = { NULL }; +static const char *const builtin_config_rename_section_usage[] = { +N_ ("git config rename-section [<file-option>] <old-name> <new-name>" ), +NULL +}; +static char *key;static regex_t *key_regexp;static const char *value_pattern;
@@ -949,11 +955,37 @@ static int cmd_config_unset(int argc, const char **argv, const char *prefix) NULL, NULL); } +static int cmd_config_rename_section (int argc,const char **argv,const char *prefix) +{ +struct option opts[] = { +CONFIG_LOCATION_OPTIONS , +OPT_END (), + }; +int ret; + + argc =parse_options (argc, argv, prefix, opts, builtin_config_rename_section_usage, +PARSE_OPT_STOP_AT_NON_OPTION ); +check_write (); +check_argc (argc,2 ,2 ); + +handle_config_location (prefix); + + ret =git_config_rename_section_in_file (given_config_source.file, + argv[0 ], argv[1 ]); +if (ret <0 ) +return ret; +else if (!ret) +die (_ ("no such section: %s" ), argv[0 ]); + +return 0 ; +} +static struct option builtin_subcommand_options[] = {OPT_SUBCOMMAND ("list" , &subcommand, cmd_config_list),OPT_SUBCOMMAND ("get" , &subcommand, cmd_config_get),OPT_SUBCOMMAND ("set" , &subcommand, cmd_config_set),OPT_SUBCOMMAND ("unset" , &subcommand, cmd_config_unset), +OPT_SUBCOMMAND ("rename-section" , &subcommand, cmd_config_rename_section),OPT_END (), };
t/t1300-config.sh +11 -11
@@ -699,7 +699,7 @@ weird EOF test_expect_success 'rename section' ' - git config --rename-section branch.eins branch.zwei + git config ${mode_prefix}rename-section branch.eins branch.zwei ' cat > expect << EOF
@@ -718,7 +718,7 @@ test_expect_success 'rename succeeded' ' ' test_expect_success 'rename non-existing section' ' - test_must_fail git config --rename-section \ + test_must_fail git config ${mode_prefix}rename-section \ branch."world domination" branch.drei '
@@ -727,7 +727,7 @@ test_expect_success 'rename succeeded' ' ' test_expect_success 'rename another section' ' - git config --rename-section branch."1 234 blabl/a" branch.drei + git config ${mode_prefix}rename-section branch."1 234 blabl/a" branch.drei ' cat > expect << EOF
@@ -750,7 +750,7 @@ cat >> .git/config << EOF EOF test_expect_success 'rename a section with a var on the same line' ' - git config --rename-section branch.vier branch.zwei + git config ${mode_prefix}rename-section branch.vier branch.zwei ' cat > expect << EOF
@@ -771,11 +771,11 @@ test_expect_success 'rename succeeded' ' ' test_expect_success 'renaming empty section name is rejected' ' - test_must_fail git config --rename-section branch.zwei "" + test_must_fail git config ${mode_prefix}rename-section branch.zwei "" ' test_expect_success 'renaming to bogus section is rejected' ' - test_must_fail git config --rename-section branch.zwei "bogus name" + test_must_fail git config ${mode_prefix}rename-section branch.zwei "bogus name" ' test_expect_success 'renaming a section with a long line' '
@@ -784,7 +784,7 @@ test_expect_success 'renaming a section with a long line' ' printf " c = d %1024s [a] e = f\\n" " " && printf "[a] g = h\\n" } >y && - git config -f y --rename-section a xyz && + git config ${mode_prefix}rename-section -f y a xyz && test_must_fail git config -f y b.e '
@@ -794,7 +794,7 @@ test_expect_success 'renaming an embedded section with a long line' ' printf " c = d %1024s [a] [foo] e = f\\n" " " && printf "[a] g = h\\n" } >y && - git config -f y --rename-section a xyz && + git config ${mode_prefix}rename-section -f y a xyz && test_must_fail git config -f y foo.e '
@@ -804,7 +804,7 @@ test_expect_success 'renaming a section with an overly-long line' ' printf " c = d %525000s e" " " && printf "[a] g = h\\n" } >y && - test_must_fail git config -f y --rename-section a xyz 2>err && + test_must_fail git config ${mode_prefix}rename-section -f y a xyz 2>err && grep "refusing to work with overly long line in .y. on line 2" err '
@@ -2112,7 +2112,7 @@ test_expect_success POSIXPERM,PERL 'preserves existing permissions' ' git config imap.pass Hunter2 && perl -e \ "die q(badset) if ((stat(q(.git/config)))[2] & 07777) != 0600" && - git config --rename-section imap pop && + git config ${mode_prefix}rename-section imap pop && perl -e \ "die q(badrename) if ((stat(q(.git/config)))[2] & 07777) != 0600" '
@@ -2601,7 +2601,7 @@ test_expect_success 'refuse --fixed-value for incompatible actions' ' test_must_fail git config --file=config --fixed-value --add dev.null bogus && test_must_fail git config --file=config --fixed-value --get-urlmatch dev.null bogus && test_must_fail git config --file=config --fixed-value --get-urlmatch dev.null bogus && - test_must_fail git config --file=config --fixed-value --rename-section dev null && + test_must_fail git config ${mode_prefix}rename-section --file=config --fixed-value dev null && test_must_fail git config --file=config --fixed-value --remove-section dev && test_must_fail git config ${mode_prefix}list --file=config --fixed-value && test_must_fail git config --file=config --fixed-value --get-color dev.null &&
Signature · 1 line
2.45.0
PATCH v5 12/14 builtin/config: introduce "remove-section" subcommand
In reply to Patrick SteinhardtIntroduce a new "remove-section" subcommand to git-config(1). Please refer to preceding commits regarding the motivation behind this change.
--- Documentation/git-config.txt | 11 +++++++---- builtin/config.c | 32 ++++++++++++++++++++++++++++++++ t/t1300-config.sh | 4 ++-- 3 files changed, 41 insertions(+), 6 deletions(-)
Documentation/git-config.txt +7 -4
@@ -14,7 +14,7 @@ SYNOPSIS 'git config set' [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value> 'git config unset' [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value> 'git config rename-section' [<file-option>] <old-name> <new-name> -'git config' [<file-option>] --remove-section <name> +'git config remove-section' [<file-option>] <name> 'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>] 'git config' [<file-option>] -e | --edit
@@ -95,6 +95,9 @@ unset:: rename-section:: Rename the given section to a new name. +remove-section:: + Remove the given section from the configuration file. + [[OPTIONS]] OPTIONS -------
@@ -192,9 +195,6 @@ See also <<FILES>>. section in linkgit:gitrevisions[7] for a more complete list of ways to spell blob names. ---remove-section:: - Remove the given section from the configuration file. - --fixed-value:: When used with the `value-pattern` argument, treat `value-pattern` as an exact string instead of a regular expression. This will restrict
@@ -333,6 +333,9 @@ recommended to migrate to the new syntax. --rename-section <old-name> <new-name>:: Replaced by `git config rename-section <old-name> <new-name>`. +--remove-section <name>:: + Replaced by `git config remove-section <name>`. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when
builtin/config.c +32 -0
@@ -21,6 +21,7 @@ static const char *const builtin_config_usage[] = {N_ ("git config set [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ),N_ ("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value>" ),N_ ("git config rename-section [<file-option>] <old-name> <new-name>" ), +N_ ("git config remove-section [<file-option>] <name>" ), NULL };
@@ -49,6 +50,11 @@ static const char *const builtin_config_rename_section_usage[] = { NULL }; +static const char *const builtin_config_remove_section_usage[] = { +N_ ("git config remove-section [<file-option>] <name>" ), +NULL +}; +static char *key;static regex_t *key_regexp;static const char *value_pattern;
@@ -980,12 +986,38 @@ static int cmd_config_rename_section(int argc, const char **argv, const char *prreturn 0 ; } +static int cmd_config_remove_section (int argc,const char **argv,const char *prefix) +{ +struct option opts[] = { +CONFIG_LOCATION_OPTIONS , +OPT_END (), + }; +int ret; + + argc =parse_options (argc, argv, prefix, opts, builtin_config_remove_section_usage, +PARSE_OPT_STOP_AT_NON_OPTION ); +check_write (); +check_argc (argc,1 ,1 ); + +handle_config_location (prefix); + + ret =git_config_rename_section_in_file (given_config_source.file, + argv[0 ],NULL ); +if (ret <0 ) +return ret; +else if (!ret) +die (_ ("no such section: %s" ), argv[0 ]); + +return 0 ; +} +static struct option builtin_subcommand_options[] = {OPT_SUBCOMMAND ("list" , &subcommand, cmd_config_list),OPT_SUBCOMMAND ("get" , &subcommand, cmd_config_get),OPT_SUBCOMMAND ("set" , &subcommand, cmd_config_set),OPT_SUBCOMMAND ("unset" , &subcommand, cmd_config_unset),OPT_SUBCOMMAND ("rename-section" , &subcommand, cmd_config_rename_section), +OPT_SUBCOMMAND ("remove-section" , &subcommand, cmd_config_remove_section),OPT_END (), };
t/t1300-config.sh +2 -2
@@ -813,7 +813,7 @@ cat >> .git/config << EOF EOF test_expect_success 'remove section' ' - git config --remove-section branch.zwei + git config ${mode_prefix}remove-section branch.zwei ' cat > expect << EOF
@@ -2602,7 +2602,7 @@ test_expect_success 'refuse --fixed-value for incompatible actions' ' test_must_fail git config --file=config --fixed-value --get-urlmatch dev.null bogus && test_must_fail git config --file=config --fixed-value --get-urlmatch dev.null bogus && test_must_fail git config ${mode_prefix}rename-section --file=config --fixed-value dev null && - test_must_fail git config --file=config --fixed-value --remove-section dev && + test_must_fail git config ${mode_prefix}remove-section --file=config --fixed-value dev && test_must_fail git config ${mode_prefix}list --file=config --fixed-value && test_must_fail git config --file=config --fixed-value --get-color dev.null && test_must_fail git config --file=config --fixed-value --get-colorbool dev.null &&
Signature · 1 line
2.45.0
PATCH v5 13/14 builtin/config: introduce "edit" subcommand
In reply to Patrick SteinhardtIntroduce a new "edit" subcommand to git-config(1). Please refer to preceding commits regarding the motivation behind this change.
--- Documentation/git-config.txt | 17 ++++---- builtin/config.c | 81 ++++++++++++++++++++++++------------ t/t1300-config.sh | 6 +-- 3 files changed, 68 insertions(+), 36 deletions(-)
Documentation/git-config.txt +10 -7
@@ -15,8 +15,8 @@ SYNOPSIS 'git config unset' [<file-option>] [--all] [--value=<value>] [--fixed-value] <name> <value> 'git config rename-section' [<file-option>] <old-name> <new-name> 'git config remove-section' [<file-option>] <name> +'git config edit' [<file-option>] 'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>] -'git config' [<file-option>] -e | --edit DESCRIPTION -----------
@@ -98,6 +98,11 @@ rename-section:: remove-section:: Remove the given section from the configuration file. +edit:: + Opens an editor to modify the specified config file; either + `--system`, `--global`, `--local` (default), `--worktree`, or + `--file <config-file>`. + [[OPTIONS]] OPTIONS -------
@@ -274,12 +279,6 @@ Valid `<type>`'s include: When the color setting for `name` is undefined, the command uses `color.ui` as fallback. --e:: ---edit:: - Opens an editor to modify the specified config file; either - `--system`, `--global`, `--local` (default), `--worktree`, or - `--file <config-file>`. - --[no-]includes:: Respect `include.*` directives in config files when looking up values. Defaults to `off` when a specific file is given (e.g.,
@@ -336,6 +335,10 @@ recommended to migrate to the new syntax. --remove-section <name>:: Replaced by `git config remove-section <name>`. +-e:: +--edit:: + Replaced by `git config edit`. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when
builtin/config.c +55 -26
111 lines not on this page · raw message
t/t1300-config.sh +3 -3
@@ -666,7 +666,7 @@ test_expect_success 'setting a value in stdin is an error' ' ' test_expect_success 'editing stdin is an error' ' - test_must_fail git config --file - --edit + test_must_fail git config ${mode_prefix}edit --file - ' test_expect_success 'refer config from subdirectory' '
@@ -1768,7 +1768,7 @@ test_expect_success 'command line overrides environment config' ' test_expect_success 'git config --edit works' ' git config -f tmp test.value no && echo test.value=yes >expect && - GIT_EDITOR="echo [test]value=yes >" git config -f tmp --edit && + GIT_EDITOR="echo [test]value=yes >" git config ${mode_prefix}edit -f tmp && git config ${mode_prefix}list -f tmp >actual && test_cmp expect actual '
@@ -1777,7 +1777,7 @@ test_expect_success 'git config --edit respects core.editor' ' git config -f tmp test.value no && echo test.value=yes >expect && test_config core.editor "echo [test]value=yes >" && - git config -f tmp --edit && + git config ${mode_prefix}edit -f tmp && git config ${mode_prefix}list -f tmp >actual && test_cmp expect actual '
Signature · 1 line
2.45.0
PATCH v5 14/14 builtin/config: display subcommand help
In reply to Patrick SteinhardtUntil now, git config -h would have printed help for the old-style syntax. Now that all modes have proper subcommands though it is preferable to instead display the subcommand help.
Drop the NO_INTERNAL_HELP flag to do so. While at it, drop the help mismatch in t0450 and add the --get-colorbool option to the usage such that git-config(1)'s synopsis and git config -h match.
--- builtin/config.c | 5 +++-- t/t0450/txt-help-mismatches | 1 - 2 files changed, 3 insertions(+), 3 deletions(-)
builtin/config.c +3 -2
@@ -23,6 +23,7 @@ static const char *const builtin_config_usage[] = {N_ ("git config rename-section [<file-option>] <old-name> <new-name>" ),N_ ("git config remove-section [<file-option>] <name>" ),N_ ("git config edit [<file-option>]" ), +N_ ("git config [<file-option>] --get-colorbool <name> [<stdout-is-tty>]" ), NULL };
@@ -1093,10 +1094,10 @@ int cmd_config(int argc, const char **argv, const char *prefix)* us when parsing the legacy-style modes that don't use subcommands. */ argc =parse_options (argc, argv, prefix, builtin_subcommand_options, builtin_config_usage, -PARSE_OPT_SUBCOMMAND_OPTIONAL |PARSE_OPT_NO_INTERNAL_HELP |PARSE_OPT_KEEP_ARGV0 |PARSE_OPT_KEEP_UNKNOWN_OPT ); +PARSE_OPT_SUBCOMMAND_OPTIONAL |PARSE_OPT_KEEP_ARGV0 |PARSE_OPT_KEEP_UNKNOWN_OPT );if (subcommand) { argc =parse_options (argc, argv, prefix, builtin_subcommand_options, builtin_config_usage, -PARSE_OPT_SUBCOMMAND_OPTIONAL |PARSE_OPT_NO_INTERNAL_HELP |PARSE_OPT_KEEP_UNKNOWN_OPT ); +PARSE_OPT_SUBCOMMAND_OPTIONAL |PARSE_OPT_KEEP_UNKNOWN_OPT );return subcommand (argc, argv, prefix); }
t/t0450/txt-help-mismatches +0 -1
@@ -10,7 +10,6 @@ checkout checkout-index clone column -config credential credential-cache credential-store
Signature · 1 line
2.45.0
Quoted 95 lines · Patrick Steinhardt
Hi,
this is the fifth and hopefully last version of my patch sthat introduces subcommands into git-config(1).
The only changes compared to v4 are some fixes to commit messages. Otherwise I'm not aware of any other feedback that would need to be addressed.
Patrick
Patrick Steinhardt (14):
config: clarify memory ownership when preparing comment strings builtin/config: move option array around builtin/config: move "fixed-value" option to correct group builtin/config: useOPT_CMDMODE()to specify modes builtin/config: pull out function to handle config location builtin/config: pull out function to handle--nullbuiltin/config: introduce "list" subcommand builtin/config: introduce "get" subcommand builtin/config: introduce "set" subcommand builtin/config: introduce "unset" subcommand builtin/config: introduce "rename-section" subcommand builtin/config: introduce "remove-section" subcommand builtin/config: introduce "edit" subcommand builtin/config: display subcommand helpDocumentation/git-config.txt | 219 ++++++++------- builtin/config.c | 512 ++++++++++++++++++++++++++++------- config.c | 16 +- config.h | 2 +- t/t0450/txt-help-mismatches | 1 - t/t1300-config.sh | 432 +++++++++++++++++------------ 6 files changed, 812 insertions(+), 370 deletions(-)Range-diff against v4:
1:3aa26d5bff! 1:881d2b5426config: clarify memory ownership when preparing comment strings
@@ Commit message
not like this micro-optimization really matters. Thus, callers are now always responsible for freeing the value.+ Signed-off-by: Patrick Steinhardt <[email protected]>
+
##builtin/config.c##
@@builtin/config.c: static structconfig_optionsconfig_options;
static intshow_origin;2: 8f0804ab48 = 2: 66dffaa8f2 builtin/config: move option array around 3: ddcd8031d7 ! 3: 36abda0e02 builtin/config: move "fixed-value" option to correct group@@ Commit message
builtin/config: move "fixed-value" option to correct groupThe
--fixed-valueoption can be used to alter how the value-pattern
- parameter is interpreted for the various submodes of git-config(1). But
- while it is an option, it is currently listed as part of the submodes
- group the command, which is wrong.
+ parameter is interpreted for the various actions of git-config(1). But
+ while it is an option, it is currently listed as part of the actions
+ group, which is wrong.Move the option to the "Other" group, which hosts the various options known to git-config(1).
4: 1bc3918840 = 4: 34b66f9c87 builtin/config: use `OPT_CMDMODE()` to specify modes 5: 3754812309 = 5: 4f90f206e7 builtin/config: pull out function to handle config location 6: cb1714c493 = 6: df1a6f14e6 builtin/config: pull out function to handle `--null` 7: b3f3c3ba6a ! 7: 1df76a9970 builtin/config: introduce "list" subcommand@@ Commit message
builtin/config: introduce "list" subcommandWhile git-config(1) has several modes, those modes are not exposed with
- subcommands but instead by specifying e.g.--unsetor--list. This
- user interface is not really in line with how our more modern commands
- work, where it is a lot more customary to say e.g.git remote list.
- Furthermore, to add to the confusion, git-config(1) also allows the user
- to request modes implicitly by just specifying the correct number of
- arguments. Thus,git config foo.barwill retrieve the value of
- "foo.bar" whilegit config foo.bar bazwill set it to "baz".
+ subcommands but instead by specifying action flags like--unsetor
+--list. This user interface is not really in line with how our more
+ modern commands work, where it is a lot more customary to say e.g. `git
+ remote list`. Furthermore, to add to the confusion, git-config(1) also
+ allows the user to request modes implicitly by just specifying the
+ correct number of arguments. Thus,git config foo.barwill retrieve
+ the value of "foo.bar" whilegit config foo.bar bazwill set it to
+ "baz".Overall, this makes for a confusing interface that could really use a makeover. It hurts discoverability of what you can do with git-config(1)
8: 0e6da909ac = 8: 29676b81e0 builtin/config: introduce "get" subcommand 9: 8a623a31b9 = 9: 94afb5a5b7 builtin/config: introduce "set" subcommand 10: e25e5b69cd = 10: e525c2326a builtin/config: introduce "unset" subcommand 11: f24008d356 = 11: a797889890 builtin/config: introduce "rename-section" subcommand 12: fc2ddd3201 = 12: 8ec214755e builtin/config: introduce "remove-section" subcommand 13: 4c2d817eff = 13: 1893c23afc builtin/config: introduce "edit" subcommand 14: 4c351b12b8 = 14: 97a48ab81d builtin/config: display subcommand help
Quoted 3 lines
base-commit:
d4cc1ec35f3bcce816b69986ca41943f6ce21377--
2.45.0
The range diff looks good. Overall I have nothing more to add to this series.
Thanks
Karthik
Quoted 8 lines · Patrick Steinhardt
Hi,
this is the fifth and hopefully last version of my patch sthat introduces subcommands into git-config(1).
The only changes compared to v4 are some fixes to commit messages. Otherwise I'm not aware of any other feedback that would need to be addressed.
Thanks for the new round. I took a close look through the series, and couldn't see any remaining issues. I appreciate the translation guide you included in the documentation to indicate "git config --add" is replaced by things like "git config set --append".
Thanks,
Taylor
Quoted 6 lines · Taylor Blau
Quoted 5 lines · Patrick Steinhardt
Hi,
this is the fifth and hopefully last version of my patch sthat introduces subcommands into git-config(1).
Quoted 8 lines
Quoted 3 lines
The only changes compared to v4 are some fixes to commit messages. Otherwise I'm not aware of any other feedback that would need to be addressed.
Thanks for the new round. I took a close look through the series, and couldn't see any remaining issues. I appreciate the translation guide you included in the documentation to indicate "git config --add" is replaced by things like "git config set --append".
Please make sure that there is a compatibility mode available for some large period. There are huge numbers of scripts in the customer base I deal with that use config extensively. Changing the CLI for this will be dire consequences.
Quoted 16 lines · On Mon, May 06, 2024 at 04:38:59PM -0400, [email protected] wrote:
Quoted 6 lines · Taylor Blau
Quoted 5 lines · Patrick Steinhardt
Hi,
this is the fifth and hopefully last version of my patch sthat introduces subcommands into git-config(1).
Quoted 8 lines
Quoted 3 lines
The only changes compared to v4 are some fixes to commit messages. Otherwise I'm not aware of any other feedback that would need to be addressed.
Thanks for the new round. I took a close look through the series, and couldn't see any remaining issues. I appreciate the translation guide you included in the documentation to indicate "git config --add" is replaced by things like "git config set --append".
Quoted 4 lines
Please make sure that there is a compatibility mode available for some large period. There are huge numbers of scripts in the customer base I deal with that use config extensively. Changing the CLI for this will be dire consequences.
Yes, that's a very sensible thing to ask for. I think the bare minimum we should aim for is a year (4 releases), where two years (8 releases) feels a bit more sensible. Do you feel like that is reasonable, or do you think it would be too short?
Patrick