threads / patch / 18362

patchgit config: clarify bool types

Subject: [PATCH] git config: clarify bool types

## tl;dr

3 messages between Mar 17, 2009 and May 6, 2009. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Felipe Contreras· Mar 17, 2009, 23:13 UTC · lore

The value is what it is, the --bool and --bool-or-int options don't specify the value type, just how it is interpreted. For example: a value of '1' can be interpreted as 'true'.

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---

This applies on top of the 'next' branch.

 builtin-config.c |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

Show changes to builtin-config.c +2 −2

diff --git a/builtin-config.c b/builtin-config.c
index 1a3baa1..c3a0176 100644
--- a/builtin-config.c
+++ b/builtin-config.c
@@ -66,9 +66,9 @@ static struct option builtin_config_options[] = {
 	OPT_STRING(0, "get-color", &get_color_slot, "slot", "find the color configured: [default]"),
 	OPT_STRING(0, "get-colorbool", &get_colorbool_slot, "slot", "find the color setting: [stdout-is-tty]"),
 	OPT_GROUP("Type"),
-	OPT_BIT(0, "bool", &types, "value is \"true\" or \"false\"", TYPE_BOOL),
+	OPT_BIT(0, "bool", &types, "value is intepreted as bool (\"true\" or \"false\")", TYPE_BOOL),
 	OPT_BIT(0, "int", &types, "value is decimal number", TYPE_INT),
-	OPT_BIT(0, "bool-or-int", &types, "value is --bool or --int", TYPE_BOOL_OR_INT),
+	OPT_BIT(0, "bool-or-int", &types, "value is interpreted either as bool or int", TYPE_BOOL_OR_INT),
 	OPT_GROUP("Other"),
 	OPT_BOOLEAN('z', "null", &end_null, "terminate values with NUL byte"),
 	OPT_END(),

-- 
1.6.2.313.g33352

Junio C Hamano· Mar 18, 2009, 01:13 UTC · re: Felipe Contreras · lore

Re: [PATCH] git config: clarify bool types

Felipe Contreras <felipe.contreras@gmail.com> writes:

Show 22 quoted lines

> The value is what it is, the --bool and --bool-or-int options don't
> specify the value type, just how it is interpreted. For example: a value
> of '1' can be interpreted as 'true'.
>
> Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
> ---
>
> This applies on top of the 'next' branch.
>
>  builtin-config.c |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/builtin-config.c b/builtin-config.c
> index 1a3baa1..c3a0176 100644
> --- a/builtin-config.c
> +++ b/builtin-config.c
> @@ -66,9 +66,9 @@ static struct option builtin_config_options[] = {
>  	OPT_STRING(0, "get-color", &get_color_slot, "slot", "find the color configured: [default]"),
>  	OPT_STRING(0, "get-colorbool", &get_colorbool_slot, "slot", "find the color setting: [stdout-is-tty]"),
>  	OPT_GROUP("Type"),
> -	OPT_BIT(0, "bool", &types, "value is \"true\" or \"false\"", TYPE_BOOL),
> +	OPT_BIT(0, "bool", &types, "value is intepreted as bool (\"true\" or \"false\")", TYPE_BOOL),

I'd rater see it say something like:

	Output the value as boolean (true or false)

so that it is consistent with others you can see in the context. E.g. get-color explains it to order the command to "find the color".

"Interpret" is fine too. The point is not about the choice of verb but use of imperative mood.

Felipe Contreras· May 6, 2009, 23:07 UTC · re: Junio C Hamano · lore

Re: [PATCH] git config: clarify bool types

On Wed, Mar 18, 2009 at 4:13 AM, Junio C Hamano <gitster@pobox.com> wrote:

Show 34 quoted lines

> Felipe Contreras <felipe.contreras@gmail.com> writes:
>
>> The value is what it is, the --bool and --bool-or-int options don't
>> specify the value type, just how it is interpreted. For example: a value
>> of '1' can be interpreted as 'true'.
>>
>> Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
>> ---
>>
>> This applies on top of the 'next' branch.
>>
>>  builtin-config.c |    4 ++--
>>  1 files changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/builtin-config.c b/builtin-config.c
>> index 1a3baa1..c3a0176 100644
>> --- a/builtin-config.c
>> +++ b/builtin-config.c
>> @@ -66,9 +66,9 @@ static struct option builtin_config_options[] = {
>>       OPT_STRING(0, "get-color", &get_color_slot, "slot", "find the color configured: [default]"),
>>       OPT_STRING(0, "get-colorbool", &get_colorbool_slot, "slot", "find the color setting: [stdout-is-tty]"),
>>       OPT_GROUP("Type"),
>> -     OPT_BIT(0, "bool", &types, "value is \"true\" or \"false\"", TYPE_BOOL),
>> +     OPT_BIT(0, "bool", &types, "value is intepreted as bool (\"true\" or \"false\")", TYPE_BOOL),
>
> I'd rater see it say something like:
>
>        Output the value as boolean (true or false)
>
> so that it is consistent with others you can see in the context.
> E.g. get-color explains it to order the command to "find the color".
>
> "Interpret" is fine too.  The point is not about the choice of verb but
> use of imperative mood.

-bool is not only used to output values, it's also used to set them, so it's not related to an action, it's an action modifier, so I don't think it must be imperative.

I'm going to resend this patch as is.

-- 
Felipe Contreras