doc: imply that interactive.singleKey is disabled by default
PATCH v2 1/1 doc: imply that interactive.singleKey is disabled by default
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.
---
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/[email protected]/
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 <[email protected]>
## 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.
+
+ ## 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/[email protected]/
+
+ 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(-)
Documentation/config/interactive.txt +4 -4
@@ -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].
Quoted 9 lines · Dragan Simic
1:
3141fe9f7328! 1:7da73f15a018doc: note that interactive.singleKey is disabled by default
@@ Metadata
Author: Dragan Simic <[email protected]>## Commit message ##
- doc: note that interactive.singleKey is disabled by default
+ doc: imply that interactive.singleKey is disabled by defaultMake it clear that the interactive.singleKey configuration option is disabled
Heh, "note that" would probably be better, as we are going to say "Make it clear" anyway, no? That is stronger than just to imply.
Keeping the original version of the log message probably was sufficient.
Documentation/config/interactive.txt line 7
Quoted 7 lines
Documentation/config/interactive.txt +4
-0+ 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].
The resulting text reads well.
Nicely done.
Quoted 10 lines · Junio C Hamano
Quoted 8 lines · Dragan Simic
1:
3141fe9f7328! 1:7da73f15a018doc: note that interactive.singleKey is disabled by default
@@ Metadata
Author: Dragan Simic <[email protected]>## Commit message ##
- doc: note that interactive.singleKey is disabled by default
+ doc: imply that interactive.singleKey is disabled by default
Quoted 8 lines
Quoted 2 lines
Make it clear that the interactive.singleKey configuration
option is disabledHeh, "note that" would probably be better, as we are going to say "Make it clear" anyway, no? That is stronger than just to imply.
Keeping the original version of the log message probably was sufficient.
Yeah, but I felt like it needed some adjustments, because the patch itself was actually changed. I hope I won't have to send the v3 because of that? :)
Quoted 10 lines
Documentation/config/interactive.txt line 7
Quoted 7 lines
Documentation/config/interactive.txt +4
-0+ 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].The resulting text reads well.
Nicely done.
Thanks.
Quoted 35 lines · Dragan Simic
Quoted 10 lines · Junio C Hamano
Quoted 8 lines · Dragan Simic
1:
3141fe9f7328! 1:7da73f15a018doc: note that interactive.singleKey is disabled by default
@@ Metadata
Author: Dragan Simic <[email protected]>## Commit message ##
- doc: note that interactive.singleKey is disabled by default
+ doc: imply that interactive.singleKey is disabled by defaultQuoted 8 lines
Quoted 2 lines
Make it clear that the interactive.singleKey configuration
option is disabledHeh, "note that" would probably be better, as we are going to say "Make it clear" anyway, no? That is stronger than just to imply.
Keeping the original version of the log message probably was sufficient.
Yeah, but I felt like it needed some adjustments, because the patch itself was actually changed. I hope I won't have to send the v3 because of that? :)
Quoted 10 lines
Documentation/config/interactive.txt line 7
Quoted 7 lines
Documentation/config/interactive.txt +4
-0+ 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].The resulting text reads well.
Nicely done.
Quoted 1 line
Thanks.
Just checking, is there something left to be addressed for this patch, before it can be considered to be pulled into the next branch?
Quoted 30 lines · Dragan Simic
Quoted 29 lines · Dragan Simic
Quoted 11 lines · Junio C Hamano
Quoted 9 lines · Dragan Simic
1:
3141fe9f7328! 1:7da73f15a018doc: note that interactive.singleKey is disabled by default
@@ Metadata
Author: Dragan Simic <[email protected]>
## 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 disabledQuoted 4 lines
Heh, "note that" would probably be better, as we are going to say "Make it clear" anyway, no? That is stronger than just to imply. Keeping the original version of the log message probably was sufficient.
Yeah, but I felt like it needed some adjustments, because the patch itself was actually changed. I hope I won't have to send the v3 because of that? :)
Quoted 9 lines
Documentation/config/interactive.txt line 7
Quoted 7 lines
Documentation/config/interactive.txt +4
-0+ 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].The resulting text reads well.
Nicely done.
Quoted 4 lines
Quoted 1 line
Thanks.
Just checking, is there something left to be addressed for this patch, before it can be considered to be pulled into the next branch?
Thanks for pinging, as these small things were on the back burner while preparing for updates to maintenance tracks.
Apparently v2 cannot be pulled into the next branch, and I forgot if I saw v3 already. In general, unless I explicitly say there is no need to resend (sometimes with conditions), I'd expect an updated iteration sent to the list.
Thanks.
Hello Junio,
Quoted 39 lines · Junio C Hamano
Quoted 32 lines · Dragan Simic
Quoted 31 lines · Dragan Simic
Quoted 13 lines · Junio C Hamano
Quoted 11 lines · Dragan Simic
1:
3141fe9f7328! 1:7da73f15a018doc: note that interactive.singleKey is disabled by default
@@ Metadata
Author: Dragan Simic <[email protected]>
## 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 disabledQuoted 4 lines
Heh, "note that" would probably be better, as we are going to say "Make it clear" anyway, no? That is stronger than just to imply. Keeping the original version of the log message probably was sufficient.
Yeah, but I felt like it needed some adjustments, because the patch itself was actually changed. I hope I won't have to send the v3 because of that? :)
Quoted 9 lines
Documentation/config/interactive.txt line 7
Quoted 7 lines
Documentation/config/interactive.txt +4
-0+ 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].The resulting text reads well.
Nicely done.Quoted 4 lines
Quoted 1 line
Thanks.
Just checking, is there something left to be addressed for this patch, before it can be considered to be pulled into the next branch?
Quoted 7 lines
Thanks for pinging, as these small things were on the back burner while preparing for updates to maintenance tracks.
Apparently v2 cannot be pulled into the next branch, and I forgot if I saw v3 already. In general, unless I explicitly say there is no need to resend (sometimes with conditions), I'd expect an updated iteration sent to the list.
I see, but I'm not really sure is there need for the v3? Maybe the patch description could be tweaked a bit further, but I wasn't under impression that you asked for that to be done? Am I wrong there?
Quoted 8 lines · Dragan Simic
Quoted 7 lines · Junio C Hamano
Quoted 2 lines · Dragan Simic
Just checking, is there something left to be addressed for this patch, before it can be considered to be pulled into the next branch?
Thanks for pinging, as these small things were on the back burner while preparing for updates to maintenance tracks.
Quoted 8 lines
Quoted 4 lines
Apparently v2 cannot be pulled into the next branch, and I forgot if I saw v3 already. In general, unless I explicitly say there is no need to resend (sometimes with conditions), I'd expect an updated iteration sent to the list.
I see, but I'm not really sure is there need for the v3? Maybe the patch description could be tweaked a bit further, but I wasn't under impression that you asked for that to be done? Am I wrong there?
Any chances, please, to have a look at this?
Quoted 13 lines · Dragan Simic
Quoted 12 lines · Dragan Simic
Quoted 11 lines · Junio C Hamano
Quoted 3 lines · Dragan Simic
Just checking, is there something left to be addressed for this patch,
before it can be considered to be pulled into the next branch?Thanks for pinging, as these small things were on the back burner while preparing for updates to maintenance tracks. Apparently v2 cannot be pulled into the next branch, and I forgot if
I saw v3 already. In general, unless I explicitly say there is no need to resend (sometimes with conditions), I'd expect an updated iteration sent to the list.
Quoted 5 lines
Quoted 3 lines
I see, but I'm not really sure is there need for the v3? Maybe the patch description could be tweaked a bit further, but I wasn't under impression that you asked for that to be done? Am I wrong there?
Any chances, please, to have a look at this?
I _have_ taken a look---as I said, "I saw v3 already".
Unless you were asking other folks, that is, but the message was addressed to me with others CC'ed, so I am not sure what the true intention was.
Hello Junio,
Quoted 19 lines · Junio C Hamano
Quoted 17 lines · Dragan Simic
Quoted 15 lines · Dragan Simic
Quoted 11 lines · Junio C Hamano
Quoted 3 lines · Dragan Simic
Just checking, is there something left to be addressed for this patch,
before it can be considered to be pulled into the next branch?Thanks for pinging, as these small things were on the back burner while preparing for updates to maintenance tracks. Apparently v2 cannot be pulled into the next branch, and I forgot if
I saw v3 already. In general, unless I explicitly say there is no need to resend (sometimes with conditions), I'd expect an updated iteration sent to the list.I see, but I'm not really sure is there need for the v3? Maybe the patch description could be tweaked a bit further, but I wasn't under impression that you asked for that to be done? Am I wrong there?
Quoted 7 lines
Quoted 1 line
Any chances, please, to have a look at this?
I _have_ taken a look---as I said, "I saw v3 already".
Unless you were asking other folks, that is, but the message was addressed to me with others CC'ed, so I am not sure what the true intention was.
Ah, I see now [1] what you asked for, which was a slight rewording of the patch subject and description. That's what my intention was, to check was rewording the patch v2 subject and description necessary. Sorry for the confusion, and thanks for putting the v3 [1] together.
PATCH v3 1/1 doc: interactive.singleKey is disabled by default
In reply to Dragan SimicFrom: Dragan Simic <[email protected]>
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.
---
* While I think it is pointless to say an optional on/off switch defaults to off, the structure of the paragraph is better with the updated text overall, so let's take this version before we forget.
Documentation/config/interactive.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/config/interactive.txt +4 -4
@@ -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].
Signature · 1 line
2.45.2-445-g1b76f06508