Re: [PATCH] doc: note that interactive.singleKey is disabled by default

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]


On 2024-05-22 20:28, Junio C Hamano wrote:
Dragan Simic <dsimic@xxxxxxxxxxx> writes:

diff --git a/Documentation/config/interactive.txt b/Documentation/config/interactive.txt
index 5cc26555f19a..067496d77cea 100644
--- a/Documentation/config/interactive.txt
+++ b/Documentation/config/interactive.txt
@@ -5,6 +5,7 @@ interactive.singleKey::
 	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.

Hmph, an optional configuration is optional because the lack of it
means the feature behind it does not trigger.

While it makes tons of sense to mention what the default is when
there are more than true or false choices (e.g. "defaults to never,
among possible choices never/local/remote/always"), or if it
defaults to true and the knob is to opt out of it, it feels like it
adds unnecesary noise to say "defaults to off" for a configuration
that is clearly a Boolean.

So I dunno.

Let's have a look at a rather suitable (and to me, a bit inspiring)
excerpt from the git-config(1) man page:

     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 git-add(1),
     git-checkout(1), git-restore(1), git-commit(1), git-reset(1),
     and git-stash(1). Note that this setting is silently ignored
     if portable keystroke input is not available; requires the
     Perl module Term::ReadKey.


     If true, makes git-log(1), git-show(1), and git-whatchanged(1)
     assume --abbrev-commit. You may override this option with

With this in mind, I think that rewording the opening sentence for
the description of interactive.singleKey like this would make sense:

     If true, allow the user to provide one-letter input with a
     single key (i.e., without hitting Enter key) in interactive

Thoughts?  It would be more consistent and a bit more clear, without
putting too much stress on the actual default value.

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux