{"thread":{"id":"51636","subject":"[PATCH 00/11] completion: complete configuration variables and values after 'git -c '","startedAt":"2019-08-13T12:27:07Z","lastAt":"2019-08-13T12:27:22Z","messageCount":12,"participants":["SZEDER Gábor"],"isPatch":true,"patchVersion":1,"patchTotal":11},"messages":[{"id":"380366","messageId":"20190813122652.16468-1-szeder.dev@gmail.com","threadId":"51636","inReplyTo":null,"subject":"[PATCH 00/11] completion: complete configuration variables and values after 'git -c '","fromName":"SZEDER Gábor","fromEmail":"szeder.dev@gmail.com","sentAt":"2019-08-13T12:26:41Z","receivedAt":"2019-08-13T12:27:07Z","isPatch":true,"sender":{"key":"szeder.dev@gmail.com","avatar":"https://avatars.githubusercontent.com/u/116324?v=4"},"body":"Recently I've been writing 'git -c foo.bar ...' often enough that\ntyping our long configuration variables got annoying...\n\nSo this patch series teaches our Bash completion script to complete\nsupported configuration variables and their values after 'git -c\n', and, while at it, after 'git clone -c ' as well.\n\n\nSZEDER Gábor (11):\n completion: fix a typo in a comment\n completion: complete more values of more 'color.*' configuration\n variables\n completion: add tests for 'git config' completion\n completion: deduplicate configuration sections\n completion: use 'sort -u' to deduplicate config variable names\n completion: simplify inner 'case' pattern in __gitcomp()\n completion: split _git_config()\n completion: complete configuration sections and variable names for\n 'git -c'\n completion: complete values of configuration variables after 'git -c\n var='\n completion: complete config variables names and values for 'git clone\n -c'\n completion: complete config variables and values for 'git clone\n --config='\n\n contrib/completion/git-completion.bash | 244 ++++++++++++++++++-------\n t/t9902-completion.sh | 63 +++++++\n 2 files changed, 243 insertions(+), 64 deletions(-)\n\n-- \n2.23.0.rc2.350.gf4fdc32db7\n\n"},{"id":"380367","messageId":"20190813122652.16468-2-szeder.dev@gmail.com","threadId":"51636","inReplyTo":"20190813122652.16468-1-szeder.dev@gmail.com","subject":"[PATCH 01/11] completion: fix a typo in a comment","fromName":"SZEDER Gábor","fromEmail":"szeder.dev@gmail.com","sentAt":"2019-08-13T12:26:42Z","receivedAt":"2019-08-13T12:27:10Z","isPatch":true,"sender":{"key":"szeder.dev@gmail.com","avatar":"https://avatars.githubusercontent.com/u/116324?v=4"},"body":"Signed-off-by: SZEDER Gábor \n---\n contrib/completion/git-completion.bash | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash\nindex e087c4bf00..cd9d8e1940 100644\n--- a/contrib/completion/git-completion.bash\n+++ b/contrib/completion/git-completion.bash\n@@ -524,7 +524,7 @@ __git_index_files ()\n \t\t\t# Even when a directory name itself does not contain\n \t\t\t# any special characters, it will still be quoted if\n \t\t\t# any of its (stripped) trailing path components do.\n-\t\t\t# Because of this we may have seen the same direcory\n+\t\t\t# Because of this we may have seen the same directory\n \t\t\t# both quoted and unquoted.\n \t\t\tif (p in paths)\n \t\t\t\t# We have seen the same directory unquoted,\n-- \n2.23.0.rc2.350.gf4fdc32db7\n\n"},{"id":"380368","messageId":"20190813122652.16468-3-szeder.dev@gmail.com","threadId":"51636","inReplyTo":"20190813122652.16468-1-szeder.dev@gmail.com","subject":"[PATCH 02/11] completion: complete more values of more 'color.*' configuration variables","fromName":"SZEDER Gábor","fromEmail":"szeder.dev@gmail.com","sentAt":"2019-08-13T12:26:43Z","receivedAt":"2019-08-13T12:27:11Z","isPatch":true,"sender":{"key":"szeder.dev@gmail.com","avatar":"https://avatars.githubusercontent.com/u/116324?v=4"},"body":"Most 'color.*' configuration variables, with the sole exception of\n'color.pager', accept the same set of values, but our completion\nscript recognizes only about half of them. We could explicitly add\nall those missing variables, but let's try to reduce future\nmaintenance burden, and use the catch-all 'color.*' pattern instead,\nso this list won't get out of sync when a similar new configuration\nvariable accepting the same values is introduced [1].\n\nFurthermore, their documentation explicitly mentions that they all\naccept the standard boolean values 'false' and 'true' as well, so list\nthese, too, among the possible values.\n\n[1] OTOH, there will be a maintenance burden if ever a new\n 'color.something' is introduced which doesn't accept the same set\n of values. We'll see which one happens first...\n\nSigned-off-by: SZEDER Gábor \n---\n\nNotes:\n I find the documentation of these configuration variables confusing.\n A so-called \"boolean\" (quoting the docs), that besides 'false' and\n 'true' (and their standard 0,no,1,yes and non-standard 'never'/'auto'\n synonyms) can have a third possible value 'always', too, is, well, not\n a boolean.\n\n contrib/completion/git-completion.bash | 9 ++++-----\n 1 file changed, 4 insertions(+), 5 deletions(-)\n\ndiff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash\nindex cd9d8e1940..c59347daee 100644\n--- a/contrib/completion/git-completion.bash\n+++ b/contrib/completion/git-completion.bash\n@@ -2277,11 +2277,6 @@ _git_config ()\n \t\t__gitcomp \"$__git_merge_strategies\"\n \t\treturn\n \t\t;;\n-\tcolor.branch|color.diff|color.interactive|\\\n-\tcolor.showbranch|color.status|color.ui)\n-\t\t__gitcomp \"always never auto\"\n-\t\treturn\n-\t\t;;\n \tcolor.pager)\n \t\t__gitcomp \"false true\"\n \t\treturn\n@@ -2293,6 +2288,10 @@ _git_config ()\n \t\t\t\"\n \t\treturn\n \t\t;;\n+\tcolor.*)\n+\t\t__gitcomp \"false true always never auto\"\n+\t\treturn\n+\t\t;;\n \tdiff.submodule)\n \t\t__gitcomp \"$__git_diff_submodule_formats\"\n \t\treturn\n-- \n2.23.0.rc2.350.gf4fdc32db7\n\n"},{"id":"380369","messageId":"20190813122652.16468-5-szeder.dev@gmail.com","threadId":"51636","inReplyTo":"20190813122652.16468-1-szeder.dev@gmail.com","subject":"[PATCH 04/11] completion: deduplicate configuration sections","fromName":"SZEDER Gábor","fromEmail":"szeder.dev@gmail.com","sentAt":"2019-08-13T12:26:45Z","receivedAt":"2019-08-13T12:27:12Z","isPatch":true,"sender":{"key":"szeder.dev@gmail.com","avatar":"https://avatars.githubusercontent.com/u/116324?v=4"},"body":"The number of configuration variables listed by the completion script\ngrew quite when we started to auto-generate it from the documentation\n[1], so we now complete them in two steps: first we list only the\nsection names, then the rest [2]. To get the section names we simply\nstrip everything following the first dot in each variable name,\nresulting in a lot of repeated section names, because most sections\ncontain more than one configuration variable. This is not a\ncorrectness issue in practice, because Bash's completion facilities\nremove all repetitions anyway, but these repetitions make testing a\nbit harder.\n\nReplace the small 'sed' script removing subsections and variable names\nwith an 'awk' script that does the same, and in addition removes any\nrepeated configuration sections as well (by first creating and filling\nan associative array indexed by all encountered configuration\nsections, and then iterating over this array and printing the indices,\ni.e. the unique section names). This change makes the failing 'git\nconfig - section' test in 't9902-completion.sh' pass.\n\nNote that this changes the order of section names in the output, and\nmakes it downright undeterministic, but this is not an issue, because\nBash sorts them before presenting them to the user, and our completion\ntests sort them as well before comparing with the expected output.\n\nYeah, it would be simpler and shorter to just append '| sort -u' to\nthat command, but that would incur the overhead of one more external\nprocess and pipeline stage every time a user completes configuration\nsections.\n\n[1] e17ca92637 (completion: drop the hard coded list of config vars,\n 2018-05-26)\n[2] f22f682695 (completion: complete general config vars in two steps,\n 2018-05-27)\n\nSigned-off-by: SZEDER Gábor \n---\n contrib/completion/git-completion.bash | 10 +++++++++-\n t/t9902-completion.sh | 2 +-\n 2 files changed, 10 insertions(+), 2 deletions(-)\n\ndiff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash\nindex c59347daee..f89324d84f 100644\n--- a/contrib/completion/git-completion.bash\n+++ b/contrib/completion/git-completion.bash\n@@ -2398,7 +2398,15 @@ _git_config ()\n \t\t;;\n \t*)\n \t\t__git_compute_config_vars\n-\t\t__gitcomp \"$(echo \"$__git_config_vars\" | sed 's/\\.[^ ]*/./g')\"\n+\t\t__gitcomp \"$(echo \"$__git_config_vars\" |\n+\t\t\t\tawk -F . '{\n+\t\t\t\t\tsections[$1] = 1\n+\t\t\t\t}\n+\t\t\t\tEND {\n+\t\t\t\t\tfor (s in sections)\n+\t\t\t\t\t\tprint s \".\"\n+\t\t\t\t}\n+\t\t\t\t')\"\n \tesac\n }\n \ndiff --git a/t/t9902-completion.sh b/t/t9902-completion.sh\nindex e15be1164d..008fba7c89 100755\n--- a/t/t9902-completion.sh\n+++ b/t/t9902-completion.sh\n@@ -1698,7 +1698,7 @@ do\n \t'\n done\n \n-test_expect_failure 'git config - section' '\n+test_expect_success 'git config - section' '\n \ttest_completion \"git config br\" <<-\\EOF\n \tbranch.Z\n \tbrowser.Z\n-- \n2.23.0.rc2.350.gf4fdc32db7\n\n"},{"id":"380370","messageId":"20190813122652.16468-4-szeder.dev@gmail.com","threadId":"51636","inReplyTo":"20190813122652.16468-1-szeder.dev@gmail.com","subject":"[PATCH 03/11] completion: add tests for 'git config' completion","fromName":"SZEDER Gábor","fromEmail":"szeder.dev@gmail.com","sentAt":"2019-08-13T12:26:44Z","receivedAt":"2019-08-13T12:27:12Z","isPatch":true,"sender":{"key":"szeder.dev@gmail.com","avatar":"https://avatars.githubusercontent.com/u/116324?v=4"},"body":"The next patches will change/refactor the way we complete\nconfiguration variable names and values, so add a few tests to cover\nthe basics, namely the completion of matching configuration sections,\nfull variable names, and their values.\n\nNote that the test checking the completion of configuration sections\nis currently failing, though it's not a sign of an actual bug. If a\nsection contains multiple variables, then that section is currently\nrepeated as many times as the number of variables in there. This is\nnot a correctness issue in practice, because Bash's completion\nfacilities remove all repetitions anyway. Consequently, we could list\nall those repeated sections in the expected output of this test as\nwell, but then it would have to be updated whenever a new\nconfiguration variable is added to those sections. Instead, list each\nmatching configuration section only once, mark the test as failing for\nnow, and the next patch will update the completion script to avoid\nthose repetitions.\n\nSigned-off-by: SZEDER Gábor \n---\n t/t9902-completion.sh | 21 +++++++++++++++++++++\n 1 file changed, 21 insertions(+)\n\ndiff --git a/t/t9902-completion.sh b/t/t9902-completion.sh\nindex 75512c3403..e15be1164d 100755\n--- a/t/t9902-completion.sh\n+++ b/t/t9902-completion.sh\n@@ -1698,6 +1698,27 @@ do\n \t'\n done\n \n+test_expect_failure 'git config - section' '\n+\ttest_completion \"git config br\" <<-\\EOF\n+\tbranch.Z\n+\tbrowser.Z\n+\tEOF\n+'\n+\n+test_expect_success 'git config - variable name' '\n+\ttest_completion \"git config log.d\" <<-\\EOF\n+\tlog.date Z\n+\tlog.decorate Z\n+\tEOF\n+'\n+\n+test_expect_success 'git config - value' '\n+\ttest_completion \"git config color.pager \" <<-\\EOF\n+\tfalse Z\n+\ttrue Z\n+\tEOF\n+'\n+\n test_expect_success 'sourcing the completion script clears cached commands' '\n \t__git_compute_all_commands &&\n \tverbose test -n \"$__git_all_commands\" &&\n-- \n2.23.0.rc2.350.gf4fdc32db7\n\n"},{"id":"380371","messageId":"20190813122652.16468-6-szeder.dev@gmail.com","threadId":"51636","inReplyTo":"20190813122652.16468-1-szeder.dev@gmail.com","subject":"[PATCH 05/11] completion: use 'sort -u' to deduplicate config variable names","fromName":"SZEDER Gábor","fromEmail":"szeder.dev@gmail.com","sentAt":"2019-08-13T12:26:46Z","receivedAt":"2019-08-13T12:27:14Z","isPatch":true,"sender":{"key":"szeder.dev@gmail.com","avatar":"https://avatars.githubusercontent.com/u/116324?v=4"},"body":"The completion script runs the classic '| sort | uniq' pipeline to\ndeduplicate the output of 'git help --config-for-completion'. 'sort\n-u' does the same, but uses one less external process and pipeline\nstage. Not a bit win, as it's only run once as the list of supported\nconfiguration variables is initialized, but at least it sets a better\nexample for others to follow.\n\nSigned-off-by: SZEDER Gábor \n---\n contrib/completion/git-completion.bash | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash\nindex f89324d84f..b51cb31ea1 100644\n--- a/contrib/completion/git-completion.bash\n+++ b/contrib/completion/git-completion.bash\n@@ -2225,7 +2225,7 @@ __git_config_vars=\n __git_compute_config_vars ()\n {\n \ttest -n \"$__git_config_vars\" ||\n-\t__git_config_vars=\"$(git help --config-for-completion | sort | uniq)\"\n+\t__git_config_vars=\"$(git help --config-for-completion | sort -u)\"\n }\n \n _git_config ()\n-- \n2.23.0.rc2.350.gf4fdc32db7\n\n"},{"id":"380372","messageId":"20190813122652.16468-8-szeder.dev@gmail.com","threadId":"51636","inReplyTo":"20190813122652.16468-1-szeder.dev@gmail.com","subject":"[PATCH 07/11] completion: split _git_config()","fromName":"SZEDER Gábor","fromEmail":"szeder.dev@gmail.com","sentAt":"2019-08-13T12:26:48Z","receivedAt":"2019-08-13T12:27:17Z","isPatch":true,"sender":{"key":"szeder.dev@gmail.com","avatar":"https://avatars.githubusercontent.com/u/116324?v=4"},"body":"_git_config() contains two enormous case statements, one to complete\nconfiguration sections and variable names, and the other to complete\ntheir values.\n\nSplit these out into two separate helper functions, so in the next\npatches we can use them to implement completion for 'git -c '.\n\nSigned-off-by: SZEDER Gábor \n---\n contrib/completion/git-completion.bash | 39 ++++++++++++++++++++------\n 1 file changed, 30 insertions(+), 9 deletions(-)\n\ndiff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash\nindex fc437bf3eb..3e9c5b6b71 100644\n--- a/contrib/completion/git-completion.bash\n+++ b/contrib/completion/git-completion.bash\n@@ -2228,7 +2228,8 @@ __git_compute_config_vars ()\n \t__git_config_vars=\"$(git help --config-for-completion | sort -u)\"\n }\n \n-_git_config ()\n+# Completes possible values of various configuration variables.\n+__git_complete_config_variable_value ()\n {\n \tlocal varname\n \n@@ -2320,19 +2321,16 @@ _git_config ()\n \t\t__gitcomp \"7bit 8bit quoted-printable base64\"\n \t\treturn\n \t\t;;\n-\t--get|--get-all|--unset|--unset-all)\n-\t\t__gitcomp_nl \"$(__git_config_get_set_variables)\"\n-\t\treturn\n-\t\t;;\n \t*.*)\n \t\treturn\n \t\t;;\n \tesac\n+}\n+\n+# Completes configuration sections, subsections, variable names.\n+__git_complete_config_variable_name ()\n+{\n \tcase \"$cur\" in\n-\t--*)\n-\t\t__gitcomp_builtin config\n-\t\treturn\n-\t\t;;\n \tbranch.*.*)\n \t\tlocal pfx=\"${cur%.*}.\" cur_=\"${cur##*.}\"\n \t\t__gitcomp \"remote pushRemote merge mergeOptions rebase\" \"$pfx\" \"$cur_\"\n@@ -2407,6 +2405,29 @@ _git_config ()\n \t\t\t\t\t\tprint s \".\"\n \t\t\t\t}\n \t\t\t\t')\"\n+\t\t;;\n+\tesac\n+}\n+\n+_git_config ()\n+{\n+\tcase \"$prev\" in\n+\t--get|--get-all|--unset|--unset-all)\n+\t\t__gitcomp_nl \"$(__git_config_get_set_variables)\"\n+\t\treturn\n+\t\t;;\n+\t*.*)\n+\t\t__git_complete_config_variable_value\n+\t\treturn\n+\t\t;;\n+\tesac\n+\tcase \"$cur\" in\n+\t--*)\n+\t\t__gitcomp_builtin config\n+\t\t;;\n+\t*)\n+\t\t__git_complete_config_variable_name\n+\t\t;;\n \tesac\n }\n \n-- \n2.23.0.rc2.350.gf4fdc32db7\n\n"},{"id":"380373","messageId":"20190813122652.16468-7-szeder.dev@gmail.com","threadId":"51636","inReplyTo":"20190813122652.16468-1-szeder.dev@gmail.com","subject":"[PATCH 06/11] completion: simplify inner 'case' pattern in __gitcomp()","fromName":"SZEDER Gábor","fromEmail":"szeder.dev@gmail.com","sentAt":"2019-08-13T12:26:47Z","receivedAt":"2019-08-13T12:27:18Z","isPatch":true,"sender":{"key":"szeder.dev@gmail.com","avatar":"https://avatars.githubusercontent.com/u/116324?v=4"},"body":"The second '*' in the '--*=*' pattern of the inner 'case' statement of\nthe __gitcomp() helper function never matches anything, so let's use\n'--*=' instead.\n\nThe purpose of that inner case statement is to decide when to append a\ntrailing space to the listed options and when not. When an option\nrequires a stuck argument, i.e. '--option=', then the trailing space\nshould not be added, so the user can continue typing the required\nargument right away. That '--*=*' pattern is supposed to match these\noptions, but for this purpose that second '*' is unnecessary, a '--*='\npattern works just as well. That second '*' would only make a\ndifference in case of a possible completion word like\n'--option=value', but our completion script never passes such a word\nto __gitcomp(), because the '--option=' and its 'value' must be\ncompleted separately.\n\nSigned-off-by: SZEDER Gábor \n---\n contrib/completion/git-completion.bash | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash\nindex b51cb31ea1..fc437bf3eb 100644\n--- a/contrib/completion/git-completion.bash\n+++ b/contrib/completion/git-completion.bash\n@@ -340,7 +340,7 @@ __gitcomp ()\n \t\t\tc=\"$c${4-}\"\n \t\t\tif [[ $c == \"$cur_\"* ]]; then\n \t\t\t\tcase $c in\n-\t\t\t\t--*=*|*.) ;;\n+\t\t\t\t--*=|*.) ;;\n \t\t\t\t*) c=\"$c \" ;;\n \t\t\t\tesac\n \t\t\t\tCOMPREPLY[i++]=\"${2-}$c\"\n@@ -360,7 +360,7 @@ __gitcomp ()\n \t\t\tc=\"$c${4-}\"\n \t\t\tif [[ $c == \"$cur_\"* ]]; then\n \t\t\t\tcase $c in\n-\t\t\t\t--*=*|*.) ;;\n+\t\t\t\t--*=|*.) ;;\n \t\t\t\t*) c=\"$c \" ;;\n \t\t\t\tesac\n \t\t\t\tCOMPREPLY[i++]=\"${2-}$c\"\n-- \n2.23.0.rc2.350.gf4fdc32db7\n\n"},{"id":"380374","messageId":"20190813122652.16468-9-szeder.dev@gmail.com","threadId":"51636","inReplyTo":"20190813122652.16468-1-szeder.dev@gmail.com","subject":"[PATCH 08/11] completion: complete configuration sections and variable names for 'git -c'","fromName":"SZEDER Gábor","fromEmail":"szeder.dev@gmail.com","sentAt":"2019-08-13T12:26:49Z","receivedAt":"2019-08-13T12:27:18Z","isPatch":true,"sender":{"key":"szeder.dev@gmail.com","avatar":"https://avatars.githubusercontent.com/u/116324?v=4"},"body":"'git config' expects a configuration variable's name and value in\nseparate arguments, so we let the __gitcomp() helper append a space\ncharacter to each variable name by default, like we do for most other\nthings (--options, refs, paths, etc.). 'git -c', however, expects\nthem in a single option joined by a '=' character, i.e.\n'section.name=value', so we should append a '=' character to each\nfully completed variable name, but no space, so the user can continue\ntyping the value right away.\n\nAdd an option to the __git_complete_config_variable_name() function to\nallow callers to specify an alternate suffix to add, and use it to\nappend that '=' character to configuration variables. Update the\n__gitcomp() helper function to not append a trailing space to any\ncompletion words ending with a '=', not just to those option with a\nstuck argument.\n\nSigned-off-by: SZEDER Gábor \n---\n contrib/completion/git-completion.bash | 59 ++++++++++++++++++++------\n t/t9902-completion.sh | 14 ++++++\n 2 files changed, 60 insertions(+), 13 deletions(-)\n\ndiff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash\nindex 3e9c5b6b71..367b1c50f4 100644\n--- a/contrib/completion/git-completion.bash\n+++ b/contrib/completion/git-completion.bash\n@@ -360,7 +360,7 @@ __gitcomp ()\n \t\t\tc=\"$c${4-}\"\n \t\t\tif [[ $c == \"$cur_\"* ]]; then\n \t\t\t\tcase $c in\n-\t\t\t\t--*=|*.) ;;\n+\t\t\t\t*=|*.) ;;\n \t\t\t\t*) c=\"$c \" ;;\n \t\t\t\tesac\n \t\t\t\tCOMPREPLY[i++]=\"${2-}$c\"\n@@ -2328,18 +2328,33 @@ __git_complete_config_variable_value ()\n }\n \n # Completes configuration sections, subsections, variable names.\n+#\n+# Usage: __git_complete_config_variable_name [