summaryrefslogtreecommitdiff
path: root/Documentation/config
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2021-09-10 11:46:33 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2021-09-10 11:46:33 -0700
commit96ac07f4a93ae9c2012c7b13aa204d39e8cba6e1 (patch)
tree941ea0eaaa3ec68e587da7b959031a262789261e /Documentation/config
parentMerge branch 'cb/ci-build-pedantic' (diff)
parenthelp.c: help.autocorrect=prompt waits for user action (diff)
downloadtgif-96ac07f4a93ae9c2012c7b13aa204d39e8cba6e1.tar.xz
Merge branch 'ab/help-autocorrect-prompt'
The logic for auto-correction of misspelt subcommands learned to go interactive when the help.autocorrect configuration variable is set to 'prompt'. * ab/help-autocorrect-prompt: help.c: help.autocorrect=prompt waits for user action
Diffstat (limited to 'Documentation/config')
-rw-r--r--Documentation/config/help.txt16
1 files changed, 9 insertions, 7 deletions
diff --git a/Documentation/config/help.txt b/Documentation/config/help.txt
index 783a90a0f9..610701f9a3 100644
--- a/Documentation/config/help.txt
+++ b/Documentation/config/help.txt
@@ -9,13 +9,15 @@ help.format::
help.autoCorrect::
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.
+ to the error, git will try to suggest the correct command or even
+ run the suggestion automatically. Possible config values are:
+ - 0 (default): show the suggested command.
+ - positive number: run the suggested command after specified
+deciseconds (0.1 sec).
+ - "immediate": run the suggested command immediately.
+ - "prompt": show the suggestion and prompt for confirmation to run
+the command.
+ - "never": don't run or show any suggested command.
help.htmlPath::
Specify the path where the HTML documentation resides. File system paths