{"thread":{"id":"62277","subject":"[PATCH 0/1] Remove value from positional args in config unset usage","startedAt":"2024-10-08T04:08:26Z","lastAt":"2024-10-09T03:37:27Z","messageCount":7,"participants":["Josh Heinrichs","Patrick Steinhardt","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":1},"messages":[{"id":"504388","messageId":"20241008040749.69801-1-joshiheinrichs@gmail.com","threadId":"62277","inReplyTo":null,"subject":"[PATCH 0/1] Remove value from positional args in config unset usage","fromName":"Josh Heinrichs","fromEmail":"joshiheinrichs@gmail.com","sentAt":"2024-10-08T04:07:48Z","receivedAt":"2024-10-08T04:08:26Z","isPatch":true,"sender":{"key":"joshiheinrichs@gmail.com","avatar":"https://avatars.githubusercontent.com/u/6166471?v=4"},"body":"I tripped over this while attempting to use `git config unset --fixed-value`.\nThe value is supposed to be provided via `--value`, but the usage makes it\nseem like it can be provided as a positional argument.\n\nWhile I was looking at the translations I noticed that po/bg.po was missing\n`` as a positional argument. From my reading of the docs it sounds like\ntranslation changes are made independently, so I have not changed them in this\nseries.\n\nJosh Heinrichs (1):\n git-config.1: remove value from positional args in unset usage\n\n Documentation/git-config.txt | 2 +-\n builtin/config.c | 4 ++--\n 2 files changed, 3 insertions(+), 3 deletions(-)\n\n-- \n2.25.1\n\n"},{"id":"504389","messageId":"20241008040749.69801-2-joshiheinrichs@gmail.com","threadId":"62277","inReplyTo":"20241008040749.69801-1-joshiheinrichs@gmail.com","subject":"[PATCH 1/1] git-config.1: remove value from positional args in unset usage","fromName":"Josh Heinrichs","fromEmail":"joshiheinrichs@gmail.com","sentAt":"2024-10-08T04:07:49Z","receivedAt":"2024-10-08T04:08:49Z","isPatch":true,"sender":{"key":"joshiheinrichs@gmail.com","avatar":"https://avatars.githubusercontent.com/u/6166471?v=4"},"body":"A single positional argument appears to be enforcecd at\nbuiltin/config.c:993. Values need to be provided via --value.\n---\n Documentation/git-config.txt | 2 +-\n builtin/config.c | 4 ++--\n 2 files changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\nindex 7f81fbbea8..3e420177c1 100644\n--- a/Documentation/git-config.txt\n+++ b/Documentation/git-config.txt\n@@ -12,7 +12,7 @@ SYNOPSIS\n 'git config list' [] [] [--includes]\n 'git config get' [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] \n 'git config set' [] [--type=] [--all] [--value=] [--fixed-value] \n-'git config unset' [] [--all] [--value=] [--fixed-value] \n+'git config unset' [] [--all] [--value=] [--fixed-value] \n 'git config rename-section' [] \n 'git config remove-section' [] \n 'git config edit' []\ndiff --git a/builtin/config.c b/builtin/config.c\nindex 97e4d5f57c..d60e106bd6 100644\n--- a/builtin/config.c\n+++ b/builtin/config.c\n@@ -19,7 +19,7 @@ static const char *const builtin_config_usage[] = {\n \tN_(\"git config list [] [] [--includes]\"),\n \tN_(\"git config get [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] \"),\n \tN_(\"git config set [] [--type=] [--all] [--value=] [--fixed-value] \"),\n-\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n+\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n \tN_(\"git config rename-section [] \"),\n \tN_(\"git config remove-section [] \"),\n \tN_(\"git config edit []\"),\n@@ -43,7 +43,7 @@ static const char *const builtin_config_set_usage[] = {\n };\n \n static const char *const builtin_config_unset_usage[] = {\n-\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n+\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n \tNULL\n };\n \n-- \n2.25.1\n\n"},{"id":"504419","messageId":"ZwUnhPbpwtA1MM34@pks.im","threadId":"62277","inReplyTo":"20241008040749.69801-2-joshiheinrichs@gmail.com","subject":"Re: [PATCH 1/1] git-config.1: remove value from positional args in unset usage","fromName":"Patrick Steinhardt","fromEmail":"ps@pks.im","sentAt":"2024-10-08T12:37:34Z","receivedAt":"2024-10-08T12:37:38Z","isPatch":true,"sender":{"key":"ps@pks.im","avatar":"https://avatars.githubusercontent.com/u/4056630?v=4"},"body":"On Mon, Oct 07, 2024 at 10:07:49PM -0600, Josh Heinrichs wrote:\n> A single positional argument appears to be enforcecd at\n> builtin/config.c:993. Values need to be provided via --value.\n\nGood catch!\n\nTwo comments regarding the commit message:\n\n - You are missing the Signed-off-by tag.\n\n - Our commit messages are typically structured such that they first\n give an observation of the issue and why it is an issue, followed by\n a proposed solution and imperative instructions for the code to\n become so.\n\nSo something like the following:\n\n The synopsis for the `git config unset` command mentions two\n positional arguments `` and ``. While the first\n positional argument is indeed correct, the second one is not. Instead,\n users are expected to pass in the value via the `--value=`\n option.\n\n Remove the positional argument. The `--value=` option is\n already documented correctly, so this is all we need to do to fix up\n the documentation.\n\nOther than that the change looks good to me, thanks!\n\nPatrick\n"},{"id":"504448","messageId":"20241008142920.570244-1-joshiheinrichs@gmail.com","threadId":"62277","inReplyTo":"20241008040749.69801-1-joshiheinrichs@gmail.com","subject":"[PATCH v2 0/1] Remove value from position args in config unset usage","fromName":"Josh Heinrichs","fromEmail":"joshiheinrichs@gmail.com","sentAt":"2024-10-08T14:29:19Z","receivedAt":"2024-10-08T14:29:46Z","isPatch":true,"sender":{"key":"joshiheinrichs@gmail.com","avatar":"https://avatars.githubusercontent.com/u/6166471?v=4"},"body":"Hello!\n\nThis version addresses the issues with my commit message that Patrick flagged\nin v1.\n\nJosh\n\nJosh Heinrichs (1):\n git-config.1: remove value from positional args in unset usage\n\n Documentation/git-config.txt | 2 +-\n builtin/config.c | 4 ++--\n 2 files changed, 3 insertions(+), 3 deletions(-)\n\nRange-diff against v1:\n1: 4bb9c65fb9 ! 1: e3b5f3c8b2 git-config.1: remove value from positional args in unset usage\n @@ Metadata\n ## Commit message ##\n git-config.1: remove value from positional args in unset usage\n \n - A single positional argument appears to be enforcecd at\n - builtin/config.c:993. Values need to be provided via --value.\n + The synopsis for `git config unset` mentions two positional arguments:\n + `` and ``. While the first argument is correct, the second\n + is not. Users are expected to provide the value via `--value=`.\n +\n + Remove the positional argument. The `--value=` option is already\n + documented correctly, so this is all we need to do to fix the\n + documentation.\n +\n + Signed-off-by: Josh Heinrichs \n \n ## Documentation/git-config.txt ##\n @@ Documentation/git-config.txt: SYNOPSIS\n-- \n2.25.1\n\n"},{"id":"504449","messageId":"20241008142920.570244-2-joshiheinrichs@gmail.com","threadId":"62277","inReplyTo":"20241008142920.570244-1-joshiheinrichs@gmail.com","subject":"[PATCH v2 1/1] git-config.1: remove value from positional args in unset usage","fromName":"Josh Heinrichs","fromEmail":"joshiheinrichs@gmail.com","sentAt":"2024-10-08T14:29:20Z","receivedAt":"2024-10-08T14:29:51Z","isPatch":true,"sender":{"key":"joshiheinrichs@gmail.com","avatar":"https://avatars.githubusercontent.com/u/6166471?v=4"},"body":"The synopsis for `git config unset` mentions two positional arguments:\n`` and ``. While the first argument is correct, the second\nis not. Users are expected to provide the value via `--value=`.\n\nRemove the positional argument. The `--value=` option is already\ndocumented correctly, so this is all we need to do to fix the\ndocumentation.\n\nSigned-off-by: Josh Heinrichs \n---\n Documentation/git-config.txt | 2 +-\n builtin/config.c | 4 ++--\n 2 files changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\nindex 7f81fbbea8..3e420177c1 100644\n--- a/Documentation/git-config.txt\n+++ b/Documentation/git-config.txt\n@@ -12,7 +12,7 @@ SYNOPSIS\n 'git config list' [] [] [--includes]\n 'git config get' [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] \n 'git config set' [] [--type=] [--all] [--value=] [--fixed-value] \n-'git config unset' [] [--all] [--value=] [--fixed-value] \n+'git config unset' [] [--all] [--value=] [--fixed-value] \n 'git config rename-section' [] \n 'git config remove-section' [] \n 'git config edit' []\ndiff --git a/builtin/config.c b/builtin/config.c\nindex 97e4d5f57c..d60e106bd6 100644\n--- a/builtin/config.c\n+++ b/builtin/config.c\n@@ -19,7 +19,7 @@ static const char *const builtin_config_usage[] = {\n \tN_(\"git config list [] [] [--includes]\"),\n \tN_(\"git config get [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] \"),\n \tN_(\"git config set [] [--type=] [--all] [--value=] [--fixed-value] \"),\n-\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n+\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n \tN_(\"git config rename-section [] \"),\n \tN_(\"git config remove-section [] \"),\n \tN_(\"git config edit []\"),\n@@ -43,7 +43,7 @@ static const char *const builtin_config_set_usage[] = {\n };\n \n static const char *const builtin_config_unset_usage[] = {\n-\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n+\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n \tNULL\n };\n \n-- \n2.25.1\n\n"},{"id":"504466","messageId":"xmqqfrp61mnz.fsf@gitster.g","threadId":"62277","inReplyTo":"20241008142920.570244-2-joshiheinrichs@gmail.com","subject":"Re: [PATCH v2 1/1] git-config.1: remove value from positional args in unset usage","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-10-08T18:20:48Z","receivedAt":"2024-10-08T18:20:51Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Josh Heinrichs writes:\n\n> The synopsis for `git config unset` mentions two positional arguments:\n> `` and ``. While the first argument is correct, the second\n> is not. Users are expected to provide the value via `--value=`.\n>\n> Remove the positional argument. The `--value=` option is already\n> documented correctly, so this is all we need to do to fix the\n> documentation.\n>\n> Signed-off-by: Josh Heinrichs \n> ---\n> Documentation/git-config.txt | 2 +-\n> builtin/config.c | 4 ++--\n> 2 files changed, 3 insertions(+), 3 deletions(-)\n\nPatrick, do you mind to forge your Reviewed-by for this one?\n\nWill queue. Thanks, both.\n\n> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\n> index 7f81fbbea8..3e420177c1 100644\n> --- a/Documentation/git-config.txt\n> +++ b/Documentation/git-config.txt\n> @@ -12,7 +12,7 @@ SYNOPSIS\n> 'git config list' [] [] [--includes]\n> 'git config get' [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] \n> 'git config set' [] [--type=] [--all] [--value=] [--fixed-value] \n> -'git config unset' [] [--all] [--value=] [--fixed-value] \n> +'git config unset' [] [--all] [--value=] [--fixed-value] \n> 'git config rename-section' [] \n> 'git config remove-section' [] \n> 'git config edit' []\n> diff --git a/builtin/config.c b/builtin/config.c\n> index 97e4d5f57c..d60e106bd6 100644\n> --- a/builtin/config.c\n> +++ b/builtin/config.c\n> @@ -19,7 +19,7 @@ static const char *const builtin_config_usage[] = {\n> \tN_(\"git config list [] [] [--includes]\"),\n> \tN_(\"git config get [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] \"),\n> \tN_(\"git config set [] [--type=] [--all] [--value=] [--fixed-value] \"),\n> -\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n> +\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n> \tN_(\"git config rename-section [] \"),\n> \tN_(\"git config remove-section [] \"),\n> \tN_(\"git config edit []\"),\n> @@ -43,7 +43,7 @@ static const char *const builtin_config_set_usage[] = {\n> };\n> \n> static const char *const builtin_config_unset_usage[] = {\n> -\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n> +\tN_(\"git config unset [] [--all] [--value=] [--fixed-value] \"),\n> \tNULL\n> };\n"},{"id":"504512","messageId":"ZwX6byY2IVFvKezP@pks.im","threadId":"62277","inReplyTo":"xmqqfrp61mnz.fsf@gitster.g","subject":"Re: [PATCH v2 1/1] git-config.1: remove value from positional args in unset usage","fromName":"Patrick Steinhardt","fromEmail":"ps@pks.im","sentAt":"2024-10-09T03:37:19Z","receivedAt":"2024-10-09T03:37:27Z","isPatch":true,"sender":{"key":"ps@pks.im","avatar":"https://avatars.githubusercontent.com/u/4056630?v=4"},"body":"On Tue, Oct 08, 2024 at 11:20:48AM -0700, Junio C Hamano wrote:\n> Josh Heinrichs writes:\n> \n> > The synopsis for `git config unset` mentions two positional arguments:\n> > `` and ``. While the first argument is correct, the second\n> > is not. Users are expected to provide the value via `--value=`.\n> >\n> > Remove the positional argument. The `--value=` option is already\n> > documented correctly, so this is all we need to do to fix the\n> > documentation.\n> >\n> > Signed-off-by: Josh Heinrichs \n> > ---\n> > Documentation/git-config.txt | 2 +-\n> > builtin/config.c | 4 ++--\n> > 2 files changed, 3 insertions(+), 3 deletions(-)\n> \n> Patrick, do you mind to forge your Reviewed-by for this one?\n> \n> Will queue. Thanks, both.\n\nNo, please feel free to add it.\n\n Reviewed-by: Patrick Steinhardt \n\nPatrick\n"}]}