# [PATCH 0/1] Remove value from positional args in config unset usage 7 messages from 2024-10-08 to 2024-10-09. Participants: Josh Heinrichs, Patrick Steinhardt, Junio C Hamano. Thread: https://gitlist.dev/t/62277 ## Josh Heinrichs, 2024-10-08 04:07 Subject: [PATCH 0/1] Remove value from positional args in config unset usage Message-ID: <20241008040749.69801-1-joshiheinrichs@gmail.com> URL: https://gitlist.dev/e/20241008040749.69801-1-joshiheinrichs%40gmail.com ``` I tripped over this while attempting to use `git config unset --fixed-value`. The value is supposed to be provided via `--value`, but the usage makes it seem like it can be provided as a positional argument. While I was looking at the translations I noticed that po/bg.po was missing `` as a positional argument. From my reading of the docs it sounds like translation changes are made independently, so I have not changed them in this series. Josh Heinrichs (1): git-config.1: remove value from positional args in unset usage Documentation/git-config.txt | 2 +- builtin/config.c | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) -- 2.25.1 ``` ## Josh Heinrichs, 2024-10-08 04:07 Subject: [PATCH 1/1] git-config.1: remove value from positional args in unset usage Message-ID: <20241008040749.69801-2-joshiheinrichs@gmail.com> URL: https://gitlist.dev/e/20241008040749.69801-2-joshiheinrichs%40gmail.com In-Reply-To: <20241008040749.69801-1-joshiheinrichs@gmail.com> ``` A single positional argument appears to be enforcecd at builtin/config.c:993. Values need to be provided via --value. --- Documentation/git-config.txt | 2 +- builtin/config.c | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index 7f81fbbea8..3e420177c1 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -12,7 +12,7 @@ SYNOPSIS 'git config list' [] [] [--includes] 'git config get' [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] 'git config set' [] [--type=] [--all] [--value=] [--fixed-value] -'git config unset' [] [--all] [--value=] [--fixed-value] +'git config unset' [] [--all] [--value=] [--fixed-value] 'git config rename-section' []

'git config remove-section' [] 'git config edit' [] diff --git a/builtin/config.c b/builtin/config.c index 97e4d5f57c..d60e106bd6 100644 --- a/builtin/config.c +++ b/builtin/config.c @@ -19,7 +19,7 @@ static const char *const builtin_config_usage[] = { 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 []"), @@ -43,7 +43,7 @@ static const char *const builtin_config_set_usage[] = { }; static const char *const builtin_config_unset_usage[] = { - N_("git config unset [] [--all] [--value=] [--fixed-value] "), + N_("git config unset [] [--all] [--value=] [--fixed-value] "), NULL }; -- 2.25.1 ``` ## Patrick Steinhardt, 2024-10-08 12:37 Subject: Re: [PATCH 1/1] git-config.1: remove value from positional args in unset usage Message-ID: URL: https://gitlist.dev/e/ZwUnhPbpwtA1MM34%40pks.im In-Reply-To: <20241008040749.69801-2-joshiheinrichs@gmail.com> ``` On Mon, Oct 07, 2024 at 10:07:49PM -0600, Josh Heinrichs wrote: > A single positional argument appears to be enforcecd at > builtin/config.c:993. Values need to be provided via --value. Good catch! Two comments regarding the commit message: - You are missing the Signed-off-by tag. - Our commit messages are typically structured such that they first give an observation of the issue and why it is an issue, followed by a proposed solution and imperative instructions for the code to become so. So something like the following: The synopsis for the `git config unset` command mentions two positional arguments `` and ``. While the first positional argument is indeed correct, the second one is not. Instead, users are expected to pass in the value via the `--value=` option. Remove the positional argument. The `--value=` option is already documented correctly, so this is all we need to do to fix up the documentation. Other than that the change looks good to me, thanks! Patrick ``` ## Josh Heinrichs, 2024-10-08 14:29 Subject: [PATCH v2 0/1] Remove value from position args in config unset usage Message-ID: <20241008142920.570244-1-joshiheinrichs@gmail.com> URL: https://gitlist.dev/e/20241008142920.570244-1-joshiheinrichs%40gmail.com In-Reply-To: <20241008040749.69801-1-joshiheinrichs@gmail.com> ``` Hello! This version addresses the issues with my commit message that Patrick flagged in v1. Josh Josh Heinrichs (1): git-config.1: remove value from positional args in unset usage Documentation/git-config.txt | 2 +- builtin/config.c | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) Range-diff against v1: 1: 4bb9c65fb9 ! 1: e3b5f3c8b2 git-config.1: remove value from positional args in unset usage @@ Metadata ## Commit message ## git-config.1: remove value from positional args in unset usage - A single positional argument appears to be enforcecd at - builtin/config.c:993. Values need to be provided via --value. + The synopsis for `git config unset` mentions two positional arguments: + `` and ``. While the first argument is correct, the second + is not. Users are expected to provide the value via `--value=`. + + Remove the positional argument. The `--value=` option is already + documented correctly, so this is all we need to do to fix the + documentation. + + Signed-off-by: Josh Heinrichs ## Documentation/git-config.txt ## @@ Documentation/git-config.txt: SYNOPSIS -- 2.25.1 ``` ## Josh Heinrichs, 2024-10-08 14:29 Subject: [PATCH v2 1/1] git-config.1: remove value from positional args in unset usage Message-ID: <20241008142920.570244-2-joshiheinrichs@gmail.com> URL: https://gitlist.dev/e/20241008142920.570244-2-joshiheinrichs%40gmail.com In-Reply-To: <20241008142920.570244-1-joshiheinrichs@gmail.com> ``` The synopsis for `git config unset` mentions two positional arguments: `` and ``. While the first argument is correct, the second is not. Users are expected to provide the value via `--value=`. Remove the positional argument. The `--value=` option is already documented correctly, so this is all we need to do to fix the documentation. Signed-off-by: Josh Heinrichs --- Documentation/git-config.txt | 2 +- builtin/config.c | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index 7f81fbbea8..3e420177c1 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -12,7 +12,7 @@ SYNOPSIS 'git config list' [] [] [--includes] 'git config get' [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] 'git config set' [] [--type=] [--all] [--value=] [--fixed-value] -'git config unset' [] [--all] [--value=] [--fixed-value] +'git config unset' [] [--all] [--value=] [--fixed-value] 'git config rename-section' []

> 'git config remove-section' [] > 'git config edit' [] > diff --git a/builtin/config.c b/builtin/config.c > index 97e4d5f57c..d60e106bd6 100644 > --- a/builtin/config.c > +++ b/builtin/config.c > @@ -19,7 +19,7 @@ static const char *const builtin_config_usage[] = { > 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 []"), > @@ -43,7 +43,7 @@ static const char *const builtin_config_set_usage[] = { > }; > > static const char *const builtin_config_unset_usage[] = { > - N_("git config unset [] [--all] [--value=] [--fixed-value] "), > + N_("git config unset [] [--all] [--value=] [--fixed-value] "), > NULL > }; ``` ## Patrick Steinhardt, 2024-10-09 03:37 Subject: Re: [PATCH v2 1/1] git-config.1: remove value from positional args in unset usage Message-ID: URL: https://gitlist.dev/e/ZwX6byY2IVFvKezP%40pks.im In-Reply-To: ``` On Tue, Oct 08, 2024 at 11:20:48AM -0700, Junio C Hamano wrote: > Josh Heinrichs writes: > > > The synopsis for `git config unset` mentions two positional arguments: > > `` and ``. While the first argument is correct, the second > > is not. Users are expected to provide the value via `--value=`. > > > > Remove the positional argument. The `--value=` option is already > > documented correctly, so this is all we need to do to fix the > > documentation. > > > > Signed-off-by: Josh Heinrichs > > --- > > Documentation/git-config.txt | 2 +- > > builtin/config.c | 4 ++-- > > 2 files changed, 3 insertions(+), 3 deletions(-) > > Patrick, do you mind to forge your Reviewed-by for this one? > > Will queue. Thanks, both. No, please feel free to add it. Reviewed-by: Patrick Steinhardt Patrick ```