{"thread":{"id":"61533","subject":"[PATCH v2] doc: imply that interactive.singleKey is disabled by default","startedAt":"2024-05-22T21:24:49Z","lastAt":"2024-06-08T09:59:40Z","messageCount":10,"participants":["Dragan Simic","Junio C Hamano"],"isPatch":true,"patchVersion":2,"patchTotal":null},"messages":[{"id":"495330","messageId":"7da73f15a018d858519eefa373001ccb3eaf32e2.1716412958.git.dsimic@manjaro.org","threadId":"61533","inReplyTo":null,"subject":"[PATCH v2] doc: imply that interactive.singleKey is disabled by default","fromName":"Dragan Simic","fromEmail":"dsimic@manjaro.org","sentAt":"2024-05-22T21:24:43Z","receivedAt":"2024-05-22T21:24:49Z","isPatch":true,"sender":{"key":"dsimic@manjaro.org","avatar":null},"body":"Make it clear that the interactive.singleKey configuration option is disabled\nby default, using rather subtle wording that avoids an emphasis on the actual\ndefault value. This should eliminate any associated doubts.\n\nWhile there, touch up the remaining wording of the description a bit.\n\nSigned-off-by: Dragan Simic \n---\n\nNotes:\n Changes in v2:\n - As agreed upon with Junio, [1] switched to more subtle wording that\n does not explicitly mention the default value.\n \n [1] https://lore.kernel.org/git/xmqqttip379x.fsf@gitster.g/\n \n Link to v1: https://lore.kernel.org/git/3141fe9f7328a97bf3818748421f6ae929120626.1716363167.git.dsimic@manjaro.org/T/#u\n\nRange-diff against v1:\n1: 3141fe9f7328 ! 1: 7da73f15a018 doc: note that interactive.singleKey is disabled by default\n @@ Metadata\n Author: Dragan Simic \n \n ## Commit message ##\n - doc: note that interactive.singleKey is disabled by default\n + doc: imply that interactive.singleKey is disabled by default\n \n Make it clear that the interactive.singleKey configuration option is disabled\n - by default. This should eliminate any associated doubts.\n + by default, using rather subtle wording that avoids an emphasis on the actual\n + default value. This should eliminate any associated doubts.\n +\n + While there, touch up the remaining wording of the description a bit.\n \n Signed-off-by: Dragan Simic \n \n +\n + ## Notes ##\n + Changes in v2:\n + - As agreed upon with Junio, [1] switched to more subtle wording that\n + does not explicitly mention the default value.\n +\n + [1] https://lore.kernel.org/git/xmqqttip379x.fsf@gitster.g/\n +\n + Link to v1: https://lore.kernel.org/git/3141fe9f7328a97bf3818748421f6ae929120626.1716363167.git.dsimic@manjaro.org/T/#u\n +\n ## Documentation/config/interactive.txt ##\n -@@ Documentation/config/interactive.txt: interactive.singleKey::\n - \tlinkgit:git-add[1], linkgit:git-checkout[1],\n +@@\n + interactive.singleKey::\n +-\tIn interactive commands, allow the user to provide one-letter\n +-\tinput with a single key (i.e., without hitting enter).\n +-\tCurrently this is used by the `--patch` mode of\n +-\tlinkgit:git-add[1], linkgit:git-checkout[1],\n ++\tWhen set to true, allow the user to provide one-letter input\n ++\twith a single key (i.e., without hitting the Enter key) in\n ++\tinteractive commands. This is currently used by the `--patch`\n ++\tmode of linkgit:git-add[1], linkgit:git-checkout[1],\n \tlinkgit:git-restore[1], linkgit:git-commit[1],\n \tlinkgit:git-reset[1], and linkgit:git-stash[1].\n -+\tThis is disabled by default.\n \n - interactive.diffFilter::\n - \tWhen an interactive command (such as `git add --patch`) shows\n\n Documentation/config/interactive.txt | 8 ++++----\n 1 file changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/config/interactive.txt b/Documentation/config/interactive.txt\nindex 5cc26555f19a..8b876cb4eb8e 100644\n--- a/Documentation/config/interactive.txt\n+++ b/Documentation/config/interactive.txt\n@@ -1,8 +1,8 @@\n interactive.singleKey::\n-\tIn interactive commands, allow the user to provide one-letter\n-\tinput with a single key (i.e., without hitting enter).\n-\tCurrently this is used by the `--patch` mode of\n-\tlinkgit:git-add[1], linkgit:git-checkout[1],\n+\tWhen set to true, allow the user to provide one-letter input\n+\twith a single key (i.e., without hitting the Enter key) in\n+\tinteractive commands. This is currently used by the `--patch`\n+\tmode of linkgit:git-add[1], linkgit:git-checkout[1],\n \tlinkgit:git-restore[1], linkgit:git-commit[1],\n \tlinkgit:git-reset[1], and linkgit:git-stash[1].\n \n"},{"id":"495332","messageId":"xmqqy1811qkx.fsf@gitster.g","threadId":"61533","inReplyTo":"7da73f15a018d858519eefa373001ccb3eaf32e2.1716412958.git.dsimic@manjaro.org","subject":"Re: [PATCH v2] doc: imply that interactive.singleKey is disabled by default","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-05-22T21:31:26Z","receivedAt":"2024-05-22T21:31:29Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Dragan Simic writes:\n\n> 1: 3141fe9f7328 ! 1: 7da73f15a018 doc: note that interactive.singleKey is disabled by default\n> @@ Metadata\n> Author: Dragan Simic \n> \n> ## Commit message ##\n> - doc: note that interactive.singleKey is disabled by default\n> + doc: imply that interactive.singleKey is disabled by default\n> \n> Make it clear that the interactive.singleKey configuration option is disabled\n\nHeh, \"note that\" would probably be better, as we are going to say\n\"Make it clear\" anyway, no? That is stronger than just to imply.\n\nKeeping the original version of the log message probably was\nsufficient.\n\n> +\tWhen set to true, allow the user to provide one-letter input\n> +\twith a single key (i.e., without hitting the Enter key) in\n> +\tinteractive commands. This is currently used by the `--patch`\n> +\tmode of linkgit:git-add[1], linkgit:git-checkout[1],\n> \tlinkgit:git-restore[1], linkgit:git-commit[1],\n> \tlinkgit:git-reset[1], and linkgit:git-stash[1].\n> \n\nThe resulting text reads well.\nNicely done.\n"},{"id":"495333","messageId":"673887a14c4f74deb4ef7771a331689b@manjaro.org","threadId":"61533","inReplyTo":"xmqqy1811qkx.fsf@gitster.g","subject":"Re: [PATCH v2] doc: imply that interactive.singleKey is disabled by default","fromName":"Dragan Simic","fromEmail":"dsimic@manjaro.org","sentAt":"2024-05-22T21:34:45Z","receivedAt":"2024-05-22T21:34:47Z","isPatch":true,"sender":{"key":"dsimic@manjaro.org","avatar":null},"body":"On 2024-05-22 23:31, Junio C Hamano wrote:\n> Dragan Simic writes:\n> \n>> 1: 3141fe9f7328 ! 1: 7da73f15a018 doc: note that \n>> interactive.singleKey is disabled by default\n>> @@ Metadata\n>> Author: Dragan Simic \n>> \n>> ## Commit message ##\n>> - doc: note that interactive.singleKey is disabled by default\n>> + doc: imply that interactive.singleKey is disabled by default\n>> \n>> Make it clear that the interactive.singleKey configuration \n>> option is disabled\n> \n> Heh, \"note that\" would probably be better, as we are going to say\n> \"Make it clear\" anyway, no? That is stronger than just to imply.\n> \n> Keeping the original version of the log message probably was\n> sufficient.\n\nYeah, but I felt like it needed some adjustments, because the patch\nitself was actually changed. I hope I won't have to send the v3\nbecause of that? :)\n\n>> +\tWhen set to true, allow the user to provide one-letter input\n>> +\twith a single key (i.e., without hitting the Enter key) in\n>> +\tinteractive commands. This is currently used by the `--patch`\n>> +\tmode of linkgit:git-add[1], linkgit:git-checkout[1],\n>> \tlinkgit:git-restore[1], linkgit:git-commit[1],\n>> \tlinkgit:git-reset[1], and linkgit:git-stash[1].\n>> \n> \n> The resulting text reads well.\n> Nicely done.\n\nThanks.\n"},{"id":"495973","messageId":"35f5633ebf263ec743d673770eb86487@manjaro.org","threadId":"61533","inReplyTo":"673887a14c4f74deb4ef7771a331689b@manjaro.org","subject":"Re: [PATCH v2] doc: imply that interactive.singleKey is disabled by default","fromName":"Dragan Simic","fromEmail":"dsimic@manjaro.org","sentAt":"2024-05-31T00:49:55Z","receivedAt":"2024-05-31T00:49:58Z","isPatch":true,"sender":{"key":"dsimic@manjaro.org","avatar":null},"body":"On 2024-05-22 23:34, Dragan Simic wrote:\n> On 2024-05-22 23:31, Junio C Hamano wrote:\n>> Dragan Simic writes:\n>> \n>>> 1: 3141fe9f7328 ! 1: 7da73f15a018 doc: note that \n>>> interactive.singleKey is disabled by default\n>>> @@ Metadata\n>>> Author: Dragan Simic \n>>> \n>>> ## Commit message ##\n>>> - doc: note that interactive.singleKey is disabled by default\n>>> + doc: imply that interactive.singleKey is disabled by default\n>>> \n>>> Make it clear that the interactive.singleKey configuration \n>>> option is disabled\n>> \n>> Heh, \"note that\" would probably be better, as we are going to say\n>> \"Make it clear\" anyway, no? That is stronger than just to imply.\n>> \n>> Keeping the original version of the log message probably was\n>> sufficient.\n> \n> Yeah, but I felt like it needed some adjustments, because the patch\n> itself was actually changed. I hope I won't have to send the v3\n> because of that? :)\n> \n>>> +\tWhen set to true, allow the user to provide one-letter input\n>>> +\twith a single key (i.e., without hitting the Enter key) in\n>>> +\tinteractive commands. This is currently used by the `--patch`\n>>> +\tmode of linkgit:git-add[1], linkgit:git-checkout[1],\n>>> \tlinkgit:git-restore[1], linkgit:git-commit[1],\n>>> \tlinkgit:git-reset[1], and linkgit:git-stash[1].\n>>> \n>> \n>> The resulting text reads well.\n>> Nicely done.\n> \n> Thanks.\n\nJust checking, is there something left to be addressed for this patch,\nbefore it can be considered to be pulled into the next branch?\n"},{"id":"496024","messageId":"xmqq5xutgajw.fsf@gitster.g","threadId":"61533","inReplyTo":"35f5633ebf263ec743d673770eb86487@manjaro.org","subject":"Re: [PATCH v2] doc: imply that interactive.singleKey is disabled by default","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-05-31T17:23:31Z","receivedAt":"2024-05-31T17:23:37Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Dragan Simic writes:\n\n> On 2024-05-22 23:34, Dragan Simic wrote:\n>> On 2024-05-22 23:31, Junio C Hamano wrote:\n>>> Dragan Simic writes:\n>>> \n>>>> 1: 3141fe9f7328 ! 1: 7da73f15a018 doc: note that\n>>>> interactive.singleKey is disabled by default\n>>>> @@ Metadata\n>>>> Author: Dragan Simic \n>>>> ## Commit message ##\n>>>> - doc: note that interactive.singleKey is disabled by default\n>>>> + doc: imply that interactive.singleKey is disabled by default\n>>>> Make it clear that the interactive.singleKey\n>>>> configuration option is disabled\n>>> Heh, \"note that\" would probably be better, as we are going to say\n>>> \"Make it clear\" anyway, no? That is stronger than just to imply.\n>>> Keeping the original version of the log message probably was\n>>> sufficient.\n>> Yeah, but I felt like it needed some adjustments, because the patch\n>> itself was actually changed. I hope I won't have to send the v3\n>> because of that? :)\n>> \n>>>> +\tWhen set to true, allow the user to provide one-letter input\n>>>> +\twith a single key (i.e., without hitting the Enter key) in\n>>>> +\tinteractive commands. This is currently used by the `--patch`\n>>>> +\tmode of linkgit:git-add[1], linkgit:git-checkout[1],\n>>>> \tlinkgit:git-restore[1], linkgit:git-commit[1],\n>>>> \tlinkgit:git-reset[1], and linkgit:git-stash[1].\n>>>> \n>>> The resulting text reads well.\n>>> Nicely done.\n>> Thanks.\n>\n> Just checking, is there something left to be addressed for this patch,\n> before it can be considered to be pulled into the next branch?\n\nThanks for pinging, as these small things were on the back burner\nwhile preparing for updates to maintenance tracks.\n\nApparently v2 cannot be pulled into the next branch, and I forgot if\nI saw v3 already. In general, unless I explicitly say there is no\nneed to resend (sometimes with conditions), I'd expect an updated\niteration sent to the list.\n\nThanks.\n\n"},{"id":"496030","messageId":"e5eb72eeb2f8e2de9400ed9373b72236@manjaro.org","threadId":"61533","inReplyTo":"xmqq5xutgajw.fsf@gitster.g","subject":"Re: [PATCH v2] doc: imply that interactive.singleKey is disabled by default","fromName":"Dragan Simic","fromEmail":"dsimic@manjaro.org","sentAt":"2024-05-31T22:21:18Z","receivedAt":"2024-05-31T22:21:20Z","isPatch":true,"sender":{"key":"dsimic@manjaro.org","avatar":null},"body":"Hello Junio,\n\nOn 2024-05-31 19:23, Junio C Hamano wrote:\n> Dragan Simic writes:\n> \n>> On 2024-05-22 23:34, Dragan Simic wrote:\n>>> On 2024-05-22 23:31, Junio C Hamano wrote:\n>>>> Dragan Simic writes:\n>>>> \n>>>>> 1: 3141fe9f7328 ! 1: 7da73f15a018 doc: note that\n>>>>> interactive.singleKey is disabled by default\n>>>>> @@ Metadata\n>>>>> Author: Dragan Simic \n>>>>> ## Commit message ##\n>>>>> - doc: note that interactive.singleKey is disabled by \n>>>>> default\n>>>>> + doc: imply that interactive.singleKey is disabled by \n>>>>> default\n>>>>> Make it clear that the interactive.singleKey\n>>>>> configuration option is disabled\n>>>> Heh, \"note that\" would probably be better, as we are going to say\n>>>> \"Make it clear\" anyway, no? That is stronger than just to imply.\n>>>> Keeping the original version of the log message probably was\n>>>> sufficient.\n>>> Yeah, but I felt like it needed some adjustments, because the patch\n>>> itself was actually changed. I hope I won't have to send the v3\n>>> because of that? :)\n>>> \n>>>>> +\tWhen set to true, allow the user to provide one-letter input\n>>>>> +\twith a single key (i.e., without hitting the Enter key) in\n>>>>> +\tinteractive commands. This is currently used by the `--patch`\n>>>>> +\tmode of linkgit:git-add[1], linkgit:git-checkout[1],\n>>>>> \tlinkgit:git-restore[1], linkgit:git-commit[1],\n>>>>> \tlinkgit:git-reset[1], and linkgit:git-stash[1].\n>>>>> \n>>>> The resulting text reads well.\n>>>> Nicely done.\n>>> Thanks.\n>> \n>> Just checking, is there something left to be addressed for this patch,\n>> before it can be considered to be pulled into the next branch?\n> \n> Thanks for pinging, as these small things were on the back burner\n> while preparing for updates to maintenance tracks.\n> \n> Apparently v2 cannot be pulled into the next branch, and I forgot if\n> I saw v3 already. In general, unless I explicitly say there is no\n> need to resend (sometimes with conditions), I'd expect an updated\n> iteration sent to the list.\n\nI see, but I'm not really sure is there need for the v3? Maybe the\npatch description could be tweaked a bit further, but I wasn't under\nimpression that you asked for that to be done? Am I wrong there?\n"},{"id":"496310","messageId":"61f46d925e89b6a574d84970089f3c50@manjaro.org","threadId":"61533","inReplyTo":"e5eb72eeb2f8e2de9400ed9373b72236@manjaro.org","subject":"Re: [PATCH v2] doc: imply that interactive.singleKey is disabled by default","fromName":"Dragan Simic","fromEmail":"dsimic@manjaro.org","sentAt":"2024-06-04T20:11:30Z","receivedAt":"2024-06-04T20:11:32Z","isPatch":true,"sender":{"key":"dsimic@manjaro.org","avatar":null},"body":"On 2024-06-01 00:21, Dragan Simic wrote:\n> On 2024-05-31 19:23, Junio C Hamano wrote:\n>> Dragan Simic writes:\n>>> Just checking, is there something left to be addressed for this \n>>> patch,\n>>> before it can be considered to be pulled into the next branch?\n>> \n>> Thanks for pinging, as these small things were on the back burner\n>> while preparing for updates to maintenance tracks.\n>> \n>> Apparently v2 cannot be pulled into the next branch, and I forgot if\n>> I saw v3 already. In general, unless I explicitly say there is no\n>> need to resend (sometimes with conditions), I'd expect an updated\n>> iteration sent to the list.\n> \n> I see, but I'm not really sure is there need for the v3? Maybe the\n> patch description could be tweaked a bit further, but I wasn't under\n> impression that you asked for that to be done? Am I wrong there?\n\nAny chances, please, to have a look at this?\n"},{"id":"496682","messageId":"xmqqbk4ce6w3.fsf@gitster.g","threadId":"61533","inReplyTo":"61f46d925e89b6a574d84970089f3c50@manjaro.org","subject":"Re: [PATCH v2] doc: imply that interactive.singleKey is disabled by default","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-06-07T22:15:56Z","receivedAt":"2024-06-07T22:15:58Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Dragan Simic writes:\n\n> On 2024-06-01 00:21, Dragan Simic wrote:\n>> On 2024-05-31 19:23, Junio C Hamano wrote:\n>>> Dragan Simic writes:\n>>>> Just checking, is there something left to be addressed for this\n>>>> patch,\n>>>> before it can be considered to be pulled into the next branch?\n>>> Thanks for pinging, as these small things were on the back burner\n>>> while preparing for updates to maintenance tracks.\n>>> Apparently v2 cannot be pulled into the next branch, and I forgot\n>>> if\n>>> I saw v3 already. In general, unless I explicitly say there is no\n>>> need to resend (sometimes with conditions), I'd expect an updated\n>>> iteration sent to the list.\n>> I see, but I'm not really sure is there need for the v3? Maybe the\n>> patch description could be tweaked a bit further, but I wasn't under\n>> impression that you asked for that to be done? Am I wrong there?\n>\n> Any chances, please, to have a look at this?\n\nI _have_ taken a look---as I said, \"I saw v3 already\".\n\nUnless you were asking other folks, that is, but the message was\naddressed to me with others CC'ed, so I am not sure what the true\nintention was.\n\n"},{"id":"496683","messageId":"xmqq4ja4e6d6.fsf@gitster.g","threadId":"61533","inReplyTo":"7da73f15a018d858519eefa373001ccb3eaf32e2.1716412958.git.dsimic@manjaro.org","subject":"[PATCH v3] doc: interactive.singleKey is disabled by default","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-06-07T22:27:17Z","receivedAt":"2024-06-07T22:27:22Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"From: Dragan Simic \n\nMake it clear that the interactive.singleKey configuration option is\ndisabled by default, using rather subtle wording that avoids an\nemphasis on the actual default value. This should eliminate any\nassociated doubts.\n\nWhile there, touch up the remaining wording of the description a bit.\n\nSigned-off-by: Dragan Simic \nSigned-off-by: Junio C Hamano \n---\n\n * While I think it is pointless to say an optional on/off switch\n defaults to off, the structure of the paragraph is better with\n the updated text overall, so let's take this version before we\n forget.\n\n Documentation/config/interactive.txt | 8 ++++----\n 1 file changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/config/interactive.txt b/Documentation/config/interactive.txt\nindex 5cc26555f1..8b876cb4eb 100644\n--- a/Documentation/config/interactive.txt\n+++ b/Documentation/config/interactive.txt\n@@ -1,8 +1,8 @@\n interactive.singleKey::\n-\tIn interactive commands, allow the user to provide one-letter\n-\tinput with a single key (i.e., without hitting enter).\n-\tCurrently this is used by the `--patch` mode of\n-\tlinkgit:git-add[1], linkgit:git-checkout[1],\n+\tWhen set to true, allow the user to provide one-letter input\n+\twith a single key (i.e., without hitting the Enter key) in\n+\tinteractive commands. This is currently used by the `--patch`\n+\tmode of linkgit:git-add[1], linkgit:git-checkout[1],\n \tlinkgit:git-restore[1], linkgit:git-commit[1],\n \tlinkgit:git-reset[1], and linkgit:git-stash[1].\n \n-- \n2.45.2-445-g1b76f06508\n\n"},{"id":"496700","messageId":"0a3e229942b314947b3a301a85cfef8c@manjaro.org","threadId":"61533","inReplyTo":"xmqqbk4ce6w3.fsf@gitster.g","subject":"Re: [PATCH v2] doc: imply that interactive.singleKey is disabled by default","fromName":"Dragan Simic","fromEmail":"dsimic@manjaro.org","sentAt":"2024-06-08T09:59:38Z","receivedAt":"2024-06-08T09:59:40Z","isPatch":true,"sender":{"key":"dsimic@manjaro.org","avatar":null},"body":"Hello Junio,\n\nOn 2024-06-08 00:15, Junio C Hamano wrote:\n> Dragan Simic writes:\n> \n>> On 2024-06-01 00:21, Dragan Simic wrote:\n>>> On 2024-05-31 19:23, Junio C Hamano wrote:\n>>>> Dragan Simic writes:\n>>>>> Just checking, is there something left to be addressed for this\n>>>>> patch,\n>>>>> before it can be considered to be pulled into the next branch?\n>>>> Thanks for pinging, as these small things were on the back burner\n>>>> while preparing for updates to maintenance tracks.\n>>>> Apparently v2 cannot be pulled into the next branch, and I forgot\n>>>> if\n>>>> I saw v3 already. In general, unless I explicitly say there is no\n>>>> need to resend (sometimes with conditions), I'd expect an updated\n>>>> iteration sent to the list.\n>>> I see, but I'm not really sure is there need for the v3? Maybe the\n>>> patch description could be tweaked a bit further, but I wasn't under\n>>> impression that you asked for that to be done? Am I wrong there?\n>> \n>> Any chances, please, to have a look at this?\n> \n> I _have_ taken a look---as I said, \"I saw v3 already\".\n> \n> Unless you were asking other folks, that is, but the message was\n> addressed to me with others CC'ed, so I am not sure what the true\n> intention was.\n\nAh, I see now [1] what you asked for, which was a slight rewording\nof the patch subject and description. That's what my intention was,\nto check was rewording the patch v2 subject and description necessary.\nSorry for the confusion, and thanks for putting the v3 [1] together.\n\n[1] https://lore.kernel.org/git/xmqq4ja4e6d6.fsf@gitster.g/\n"}]}