git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2] doc: imply that interactive.singleKey is disabled by default

From
DSDragan Simic <dsimic@manjaro.org>
Date
May 22, 2024, 21:24 UTC
Message-ID
<7da73f15a018d858519eefa373001ccb3eaf32e2.1716412958.git.dsimic@manjaro.org>

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@manjaro.org>
---
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@manjaro.org/T/#u
Range-diff against v1:
1:  3141fe9f7328 ! 1:  7da73f15a018 doc: note that interactive.singleKey is disabled by default
    @@ Metadata
     Author: Dragan Simic <dsimic@manjaro.org>
     
      ## 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@manjaro.org>
     
    +
    + ## 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@manjaro.org/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].
 
Next: Junio C Hamano
Message 1 of 10 in “doc: imply that interactive.singleKey is disabled by default”
  1. doc: imply that interactive.singleKey is disabled by defaultDragan Simic, May 22, 2024
  2. Junio C HamanoMay 22, 2024
  3. Dragan SimicMay 22, 2024
  4. Dragan SimicMay 31, 2024
  5. Junio C HamanoMay 31, 2024
  6. Dragan SimicMay 31, 2024
  7. Dragan SimicJun 4, 2024
  8. Junio C HamanoJun 7, 2024
  9. Dragan SimicJun 8, 2024
  10. doc: interactive.singleKey is disabled by defaultJunio C Hamano, Jun 7, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.