Make it clear that the interactive.singleKey configuration option is disabled
by default, using rather subtle wording that avoids an emphasis on the actual
default value. This should eliminate any associated doubts.
While there, touch up the remaining wording of the description a bit.
Signed-off-by: Dragan Simic <dsimic@xxxxxxxxxxx>
---
Notes:
Changes in v2:
- As agreed upon with Junio, [1] switched to more subtle wording that
does not explicitly mention the default value.
[1] https://lore.kernel.org/git/xmqqttip379x.fsf@gitster.g/
Link to v1: https://lore.kernel.org/git/3141fe9f7328a97bf3818748421f6ae929120626.1716363167.git.dsimic@xxxxxxxxxxx/T/#u
Range-diff against v1:
1: 3141fe9f7328 ! 1: 7da73f15a018 doc: note that interactive.singleKey is disabled by default
@@ Metadata
Author: Dragan Simic <dsimic@xxxxxxxxxxx>
## Commit message ##
- doc: note that interactive.singleKey is disabled by default
+ doc: imply that interactive.singleKey is disabled by default
Make it clear that the interactive.singleKey configuration option is disabled
- by default. This should eliminate any associated doubts.
+ by default, using rather subtle wording that avoids an emphasis on the actual
+ default value. This should eliminate any associated doubts.
+
+ While there, touch up the remaining wording of the description a bit.
Signed-off-by: Dragan Simic <dsimic@xxxxxxxxxxx>
+
+ ## Notes ##
+ Changes in v2:
+ - As agreed upon with Junio, [1] switched to more subtle wording that
+ does not explicitly mention the default value.
+
+ [1] https://lore.kernel.org/git/xmqqttip379x.fsf@gitster.g/
+
+ Link to v1: https://lore.kernel.org/git/3141fe9f7328a97bf3818748421f6ae929120626.1716363167.git.dsimic@xxxxxxxxxxx/T/#u
+
## Documentation/config/interactive.txt ##
-@@ Documentation/config/interactive.txt: interactive.singleKey::
- linkgit:git-add[1], linkgit:git-checkout[1],
+@@
+ interactive.singleKey::
+- In interactive commands, allow the user to provide one-letter
+- input with a single key (i.e., without hitting enter).
+- Currently this is used by the `--patch` mode of
+- linkgit:git-add[1], linkgit:git-checkout[1],
++ When set to true, allow the user to provide one-letter input
++ with a single key (i.e., without hitting the Enter key) in
++ interactive commands. This is currently used by the `--patch`
++ mode of linkgit:git-add[1], linkgit:git-checkout[1],
linkgit:git-restore[1], linkgit:git-commit[1],
linkgit:git-reset[1], and linkgit:git-stash[1].
-+ This is disabled by default.
- interactive.diffFilter::
- When an interactive command (such as `git add --patch`) shows
Documentation/config/interactive.txt | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/config/interactive.txt b/Documentation/config/interactive.txt
index 5cc26555f19a..8b876cb4eb8e 100644
--- a/Documentation/config/interactive.txt
+++ b/Documentation/config/interactive.txt
@@ -1,8 +1,8 @@
interactive.singleKey::
- In interactive commands, allow the user to provide one-letter
- input with a single key (i.e., without hitting enter).
- Currently this is used by the `--patch` mode of
- linkgit:git-add[1], linkgit:git-checkout[1],
+ When set to true, allow the user to provide one-letter input
+ with a single key (i.e., without hitting the Enter key) in
+ interactive commands. This is currently used by the `--patch`
+ mode of linkgit:git-add[1], linkgit:git-checkout[1],
linkgit:git-restore[1], linkgit:git-commit[1],
linkgit:git-reset[1], and linkgit:git-stash[1].
