help.c: expand options for help.autocorrect
PATCH v5 1/1 help.c: expand options for help.autocorrect
While help.autocorrect can be set to 0 to decline auto-execution of possibly mistyped commands, it still spends cycles to compute the suggestions, and it wastes screen real estate.
Update help.autocorrect to accept the string "never" to just exit with error upon mistyped commands to help users who prefer to never see suggested corrections at all.
While at it, introduce "immediate" as a more readable way to immediately execute the auto-corrected command, which can be done with negative value.
---
v5 incorporates Junio's suggested commit message and test.
Documentation/config/help.txt | 16 +++++++++------- help.c | 25 ++++++++++++++++++++++--- t/t9003-help-autocorrect.sh | 13 +++++++++++++ 3 files changed, 44 insertions(+), 10 deletions(-)
Documentation/config/help.txt +9 -7
@@ -8,13 +8,15 @@ help.format:: the default. 'web' and 'html' are the same. help.autoCorrect:: - Automatically correct and execute mistyped commands after - waiting for the given number of deciseconds (0.1 sec). If more - than one command can be deduced from the entered text, nothing - will be executed. If the value of this option is negative, - the corrected command will be executed immediately. If the - value is 0 - the command will be just shown but not executed. - This is the default. + If git detects typos and can identify exactly one valid command similar + to the error, git will automatically run the intended command after + waiting a duration of time defined by this configuration value in + deciseconds (0.1 sec). If this value is 0, the suggested corrections + will be shown, but not executed. If "immediate", the suggested command + is run immediately. If "never", suggestions are not shown at all. The + default value is zero. ++ +Negative integers are interpreted as "immediately" for historical reasons. help.htmlPath:: Specify the path where the HTML documentation resides. File system paths
help.c +22 -3
@@ -472,12 +472,26 @@ int is_in_cmdlist(struct cmdnames *c, const char *s)static int autocorrect;static struct cmdnames aliases; +#define AUTOCORRECT_NEVER (-2) +#define AUTOCORRECT_IMMEDIATELY (-1) +static int git_unknown_cmd_config (const char *var,const char *value,void *cb) {const char *p; -if (!strcmp (var,"help.autocorrect" )) - autocorrect =git_config_int (var,value); +if (!strcmp (var,"help.autocorrect" )) { +if (!value) +return config_error_nonbool (var); +if (!strcmp (value,"never" )) { + autocorrect =AUTOCORRECT_NEVER ; + }else if (!strcmp (value,"immediate" )) { + autocorrect =AUTOCORRECT_IMMEDIATELY ; + }else { +int v =git_config_int (var, value); + autocorrect = (v <0 ) + ?AUTOCORRECT_IMMEDIATELY : v; + } + }/* Also use aliases for command lookup */ if (skip_prefix (var,"alias." , &p))add_cmdname (&aliases, p,strlen (p));
@@ -525,6 +539,11 @@ const char *help_unknown_cmd(const char *cmd)read_early_config (git_unknown_cmd_config,NULL ); +if (autocorrect ==AUTOCORRECT_NEVER ) { +fprintf_ln (stderr,_ ("git: '%s' is not a git command. See 'git --help'." ), cmd); +exit (1 ); + } +load_command_list ("git-" , &main_cmds, &other_cmds);add_cmd_list (&main_cmds, &aliases);
@@ -594,7 +613,7 @@ const char *help_unknown_cmd(const char *cmd)_ ("WARNING: You called a Git command named '%s', " "which does not exist." ), cmd); -if (autocorrect <0 ) +if (autocorrect ==AUTOCORRECT_IMMEDIATELY ) fprintf_ln(stderr, _("Continuing under the assumption that " "you meant '%s'."),
t/t9003-help-autocorrect.sh +13 -0
@@ -49,4 +49,17 @@ test_expect_success 'autocorrect running commands' ' test_cmp expect actual ' +test_expect_success 'autocorrect can be declined altogether' ' + git config help.autocorrect never && + + test_must_fail git lfg 2>actual && + if test_have_prereq C_LOCALE_OUTPUT + then + : cannot test with poisoned i18n + else + grep "is not a git command" actual && + test_line_count = 1 actual + fi +' + test_done
Signature · 1 line
2.29.2
Quoted 8 lines · Drew DeVault
While help.autocorrect can be set to 0 to decline auto-execution of possibly mistyped commands, it still spends cycles to compute the suggestions, and it wastes screen real estate.
Update help.autocorrect to accept the string "never" to just exit with error upon mistyped commands to help users who prefer to never see suggested corrections at all.
Quoted 8 lines
While at it, introduce "immediate" as a more readable way to immediately execute the auto-corrected command, which can be done with negative value.
Signed-off-by Drew DeVault <[email protected]>Signed-off-by Junio C Hamano <[email protected]>---
v5 incorporates Junio's suggested commit message and test.
Hmph,...
Review
Quoted 9 lines
(quoted diff) +9
-0+ If git detects typos and can identify exactly one valid command similar + to the error, git will automatically run the intended command after + waiting a duration of time defined by this configuration value in + deciseconds (0.1 sec). If this value is 0, the suggested corrections + will be shown, but not executed. If "immediate", the suggested command + is run immediately. If "never", suggestions are not shown at all. The + default value is zero. ++ +Negative integers are interpreted as "immediately" for historical reasons.
I do not think we should place too much stress on things that are there for "historical reasons"---they do not deserve their own paragraph. That is why the version I queued with tweak said:
... If this value is 0, the suggested corrections will be shown, but not executed. If it is a negative integer, or "immediate", the suggested command is run immediately. If "never", suggestions are not shown at all. The default value is zero.
Review
Quoted 12 lines
(quoted diff) +12
-0+test_expect_success 'autocorrect can be declined altogether' ' + git config help.autocorrect never && + + test_must_fail git lfg 2>actual && + if test_have_prereq C_LOCALE_OUTPUT + then + : cannot test with poisoned i18n + else + grep "is not a git command" actual && + test_line_count = 1 actual + fi +'
This test for 'never' is good. We'd probably want to also add a test for immediate.
Taking them together, perhaps like the attached patch.
Thanks.
--- >8 ------ >8 ------ >8 ------ >8 ------ >8 ------ >8 ------ From 59c61bb206242f750a3b63d9b5e16f4e1cf343e7 Mon Sep 17 00:00:00 2001
From: Drew DeVault <[email protected]>
Date: Tue, 24 Nov 2020 11:37:52 -0500
Subject: [PATCH] help.c: help.autocorrect=never means "do not even compute
suggestions"
While help.autocorrect can be set to 0 to decline auto-execution of possibly mistyped commands, it still spends cycles to compute the suggestions, and it wastes screen real estate.
Update help.autocorrect to accept the string "never" to just exit with error upon mistyped commands to help users who prefer to never see suggested corrections at all.
While at it, introduce "immediate" as a more readable way to immediately execute the auto-corrected command, which can be done with negative value.
---
Range-diff:
1: 4ea4744d46 ! 1: 59c61bb206 help.c: expand options for help.autocorrect
@@ Metadata
Author: Drew DeVault <[email protected]>
## Commit message ##
- help.c: expand options for help.autocorrect
+ help.c: help.autocorrect=never means "do not even compute suggestions"
While help.autocorrect can be set to 0 to decline auto-execution of possibly mistyped commands, it still spends cycles to compute the
@@ Documentation/config/help.txt: help.format::
+ to the error, git will automatically run the intended command after
+ waiting a duration of time defined by this configuration value in
+ deciseconds (0.1 sec). If this value is 0, the suggested corrections
-+ will be shown, but not executed. If "immediate", the suggested command
++ will be shown, but not executed. If it is a negative integer, or
++ "immediate", the suggested command
+ is run immediately. If "never", suggestions are not shown at all. The
+ default value is zero.
-++
-+Negative integers are interpreted as "immediately" for historical reasons.
help.htmlPath::
Specify the path where the HTML documentation resides. File system paths
@@ help.c: const char *help_unknown_cmd(const char *cmd)
"you meant '%s'."),
## t/t9003-help-autocorrect.sh ##
-@@ t/t9003-help-autocorrect.sh: test_expect_success 'autocorrect running commands' '
- test_cmp expect actual
+@@ t/t9003-help-autocorrect.sh: test_expect_success 'autocorrect showing candidates' '
+ grep "^ distimdistim" actual
'
+-test_expect_success 'autocorrect running commands' '
+- git config help.autocorrect -1 &&
++for immediate in -1 immediate
++do
++ test_expect_success 'autocorrect running commands' '
++ git config help.autocorrect $immediate &&
+
+- git lfg >actual &&
+- echo "a single log entry" >expect &&
+- test_cmp expect actual &&
++ git lfg >actual &&
++ echo "a single log entry" >expect &&
++ test_cmp expect actual &&
+
+- git distimdist >actual &&
+- echo "distimdistim was called" >expect &&
+- test_cmp expect actual
++ git distimdist >actual &&
++ echo "distimdistim was called" >expect &&
++ test_cmp expect actual
++ '
++done
++
+test_expect_success 'autocorrect can be declined altogether' '
+ git config help.autocorrect never &&
+
@@ t/t9003-help-autocorrect.sh: test_expect_success 'autocorrect running commands'
+ grep "is not a git command" actual &&
+ test_line_count = 1 actual
+ fi
-+'
-+
+ '
+
test_done
Documentation/config/help.txt | 15 ++++++++------- help.c | 25 ++++++++++++++++++++++--- t/t9003-help-autocorrect.sh | 32 ++++++++++++++++++++++++-------- 3 files changed, 54 insertions(+), 18 deletions(-)
Documentation/config/help.txt +8 -7
@@ -8,13 +8,14 @@ help.format:: the default. 'web' and 'html' are the same. help.autoCorrect:: - Automatically correct and execute mistyped commands after - waiting for the given number of deciseconds (0.1 sec). If more - than one command can be deduced from the entered text, nothing - will be executed. If the value of this option is negative, - the corrected command will be executed immediately. If the - value is 0 - the command will be just shown but not executed. - This is the default. + If git detects typos and can identify exactly one valid command similar + to the error, git will automatically run the intended command after + waiting a duration of time defined by this configuration value in + deciseconds (0.1 sec). If this value is 0, the suggested corrections + will be shown, but not executed. If it is a negative integer, or + "immediate", the suggested command + is run immediately. If "never", suggestions are not shown at all. The + default value is zero. help.htmlPath:: Specify the path where the HTML documentation resides. File system paths
help.c +22 -3
@@ -472,12 +472,26 @@ int is_in_cmdlist(struct cmdnames *c, const char *s)static int autocorrect;static struct cmdnames aliases; +#define AUTOCORRECT_NEVER (-2) +#define AUTOCORRECT_IMMEDIATELY (-1) +static int git_unknown_cmd_config (const char *var,const char *value,void *cb) {const char *p; -if (!strcmp (var,"help.autocorrect" )) - autocorrect =git_config_int (var,value); +if (!strcmp (var,"help.autocorrect" )) { +if (!value) +return config_error_nonbool (var); +if (!strcmp (value,"never" )) { + autocorrect =AUTOCORRECT_NEVER ; + }else if (!strcmp (value,"immediate" )) { + autocorrect =AUTOCORRECT_IMMEDIATELY ; + }else { +int v =git_config_int (var, value); + autocorrect = (v <0 ) + ?AUTOCORRECT_IMMEDIATELY : v; + } + }/* Also use aliases for command lookup */ if (skip_prefix (var,"alias." , &p))add_cmdname (&aliases, p,strlen (p));
@@ -525,6 +539,11 @@ const char *help_unknown_cmd(const char *cmd)read_early_config (git_unknown_cmd_config,NULL ); +if (autocorrect ==AUTOCORRECT_NEVER ) { +fprintf_ln (stderr,_ ("git: '%s' is not a git command. See 'git --help'." ), cmd); +exit (1 ); + } +load_command_list ("git-" , &main_cmds, &other_cmds);add_cmd_list (&main_cmds, &aliases);
@@ -594,7 +613,7 @@ const char *help_unknown_cmd(const char *cmd)_ ("WARNING: You called a Git command named '%s', " "which does not exist." ), cmd); -if (autocorrect <0 ) +if (autocorrect ==AUTOCORRECT_IMMEDIATELY ) fprintf_ln(stderr, _("Continuing under the assumption that " "you meant '%s'."),
t/t9003-help-autocorrect.sh +24 -8
@@ -37,16 +37,32 @@ test_expect_success 'autocorrect showing candidates' ' grep "^ distimdistim" actual ' -test_expect_success 'autocorrect running commands' ' - git config help.autocorrect -1 && +for immediate in -1 immediate +do + test_expect_success 'autocorrect running commands' ' + git config help.autocorrect $immediate && - git lfg >actual && - echo "a single log entry" >expect && - test_cmp expect actual && + git lfg >actual && + echo "a single log entry" >expect && + test_cmp expect actual && - git distimdist >actual && - echo "distimdistim was called" >expect && - test_cmp expect actual + git distimdist >actual && + echo "distimdistim was called" >expect && + test_cmp expect actual + ' +done + +test_expect_success 'autocorrect can be declined altogether' ' + git config help.autocorrect never && + + test_must_fail git lfg 2>actual && + if test_have_prereq C_LOCALE_OUTPUT + then + : cannot test with poisoned i18n + else + grep "is not a git command" actual && + test_line_count = 1 actual + fi ' test_done
Signature · 1 line
2.29.2-520-gf7cd35e8a7
PATCH v6 1/1 help.c: help.autocorrect=never means "do not compute suggestions"
From: Drew DeVault <[email protected]>
While help.autocorrect can be set to 0 to decline auto-execution of possibly mistyped commands, it still spends cycles to compute the suggestions, and it wastes screen real estate.
Update help.autocorrect to accept the string "never" to just exit with error upon mistyped commands to help users who prefer to never see suggested corrections at all.
While at it, introduce "immediate" as a more readable way to immediately execute the auto-corrected command, which can be done with negative value.
---
* Took bugfix for the new test from SZEDER's review.
Range-diff against v5:
1: 59c61bb206 ! 1: c4b6b18b2e help.c: help.autocorrect=never means "do not even compute suggestions"
@@ t/t9003-help-autocorrect.sh: test_expect_success 'autocorrect showing candidates
+ test_must_fail git lfg 2>actual &&
+ if test_have_prereq C_LOCALE_OUTPUT
+ then
-+ : cannot test with poisoned i18n
-+ else
+ grep "is not a git command" actual &&
+ test_line_count = 1 actual
+ fiDocumentation/config/help.txt | 15 ++++++++------- help.c | 25 ++++++++++++++++++++++--- t/t9003-help-autocorrect.sh | 30 ++++++++++++++++++++++-------- 3 files changed, 52 insertions(+), 18 deletions(-)
Documentation/config/help.txt +8 -7
@@ -8,13 +8,14 @@ help.format:: the default. 'web' and 'html' are the same. help.autoCorrect:: - Automatically correct and execute mistyped commands after - waiting for the given number of deciseconds (0.1 sec). If more - than one command can be deduced from the entered text, nothing - will be executed. If the value of this option is negative, - the corrected command will be executed immediately. If the - value is 0 - the command will be just shown but not executed. - This is the default. + If git detects typos and can identify exactly one valid command similar + to the error, git will automatically run the intended command after + waiting a duration of time defined by this configuration value in + deciseconds (0.1 sec). If this value is 0, the suggested corrections + will be shown, but not executed. If it is a negative integer, or + "immediate", the suggested command + is run immediately. If "never", suggestions are not shown at all. The + default value is zero. help.htmlPath:: Specify the path where the HTML documentation resides. File system paths
help.c +22 -3
@@ -472,12 +472,26 @@ int is_in_cmdlist(struct cmdnames *c, const char *s)static int autocorrect;static struct cmdnames aliases; +#define AUTOCORRECT_NEVER (-2) +#define AUTOCORRECT_IMMEDIATELY (-1) +static int git_unknown_cmd_config (const char *var,const char *value,void *cb) {const char *p; -if (!strcmp (var,"help.autocorrect" )) - autocorrect =git_config_int (var,value); +if (!strcmp (var,"help.autocorrect" )) { +if (!value) +return config_error_nonbool (var); +if (!strcmp (value,"never" )) { + autocorrect =AUTOCORRECT_NEVER ; + }else if (!strcmp (value,"immediate" )) { + autocorrect =AUTOCORRECT_IMMEDIATELY ; + }else { +int v =git_config_int (var, value); + autocorrect = (v <0 ) + ?AUTOCORRECT_IMMEDIATELY : v; + } + }/* Also use aliases for command lookup */ if (skip_prefix (var,"alias." , &p))add_cmdname (&aliases, p,strlen (p));
@@ -525,6 +539,11 @@ const char *help_unknown_cmd(const char *cmd)read_early_config (git_unknown_cmd_config,NULL ); +if (autocorrect ==AUTOCORRECT_NEVER ) { +fprintf_ln (stderr,_ ("git: '%s' is not a git command. See 'git --help'." ), cmd); +exit (1 ); + } +load_command_list ("git-" , &main_cmds, &other_cmds);add_cmd_list (&main_cmds, &aliases);
@@ -594,7 +613,7 @@ const char *help_unknown_cmd(const char *cmd)_ ("WARNING: You called a Git command named '%s', " "which does not exist." ), cmd); -if (autocorrect <0 ) +if (autocorrect ==AUTOCORRECT_IMMEDIATELY ) fprintf_ln(stderr, _("Continuing under the assumption that " "you meant '%s'."),
t/t9003-help-autocorrect.sh +22 -8
@@ -37,16 +37,30 @@ test_expect_success 'autocorrect showing candidates' ' grep "^ distimdistim" actual ' -test_expect_success 'autocorrect running commands' ' - git config help.autocorrect -1 && +for immediate in -1 immediate +do + test_expect_success 'autocorrect running commands' ' + git config help.autocorrect $immediate && - git lfg >actual && - echo "a single log entry" >expect && - test_cmp expect actual && + git lfg >actual && + echo "a single log entry" >expect && + test_cmp expect actual && - git distimdist >actual && - echo "distimdistim was called" >expect && - test_cmp expect actual + git distimdist >actual && + echo "distimdistim was called" >expect && + test_cmp expect actual + ' +done + +test_expect_success 'autocorrect can be declined altogether' ' + git config help.autocorrect never && + + test_must_fail git lfg 2>actual && + if test_have_prereq C_LOCALE_OUTPUT + then + grep "is not a git command" actual && + test_line_count = 1 actual + fi ' test_done
Signature · 1 line
2.29.2-533-ge2694b469b