git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Andreas Heiduk <asheiduk@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Git Mailing List <git@vger.kernel.org>
Subject: Re: [PATCH] doc: clarify "config --bool" behaviour with empty values
Date: Tue, 15 Aug 2017 00:07:26 +0200	[thread overview]
Message-ID: <914098af-00a9-fbc8-cdfe-a65918b2951b@gmail.com> (raw)
In-Reply-To: <xmqq60dqvxw1.fsf@gitster.mtv.corp.google.com>

Am 14.08.2017 um 19:53 schrieb Junio C Hamano:
> Andreas Heiduk <asheiduk@gmail.com> writes:
> 
>> `git config --bool xxx.yyy` returns `true` for `[xxx]yyy` but
>> `false` for `[xxx]yyy=` or `[xxx]yyy=""`.  This is tested in
>> t1300-repo-config.sh since 09bc098c2.
>>
>> Signed-off-by: Andreas Heiduk <asheiduk@gmail.com>
>> ---
>>  Documentation/config.txt | 3 ++-
>>  Documentation/git.txt    | 3 ++-
>>  2 files changed, 4 insertions(+), 2 deletions(-)
>>
>> diff --git a/Documentation/config.txt b/Documentation/config.txt
>> index d5c9c4cab..d3261006b 100644
>> --- a/Documentation/config.txt
>> +++ b/Documentation/config.txt
>> @@ -221,7 +221,8 @@ boolean::
>>  		is taken as true.
>>  
>>         false;; Boolean false can be spelled as `no`, `off`,
>> -		`false`, or `0`.
>> +		`false`, `0`, no value (but still with `=`) or the
>> +		empty string.
> 
[...]
 
> However, I think this "no value (but still with '=')" is making it
> more confusing than necessary for two reasons.
[...]
 
> I notice that in this Values section (where the boolean:: is the
> first entry) there is no mention on how to spell a string value.

I assumed this is due to the pretext of the definition list:

	Values of many variables are treated as a simple string, but there
	are variables that take values of specific types and there are rules
	as to how to spell them.

After that I would NOT expect string values to be "specific". Also: If string 
values are explained here in the "Values" section, the line-breaking and escape 
sequences syntax should be here too.

So my (minimal) suggestion is:

       false;; Boolean false literals are `no`, `off`,
                `false`, `0` and the empty string.

I'll adapt `true` in the same style and resend a patch.

  reply	other threads:[~2017-08-14 22:07 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-08-13  9:48 [PATCH] doc: clarify "config --bool" behaviour with empty values Andreas Heiduk
2017-08-14 17:53 ` Junio C Hamano
2017-08-14 22:07   ` Andreas Heiduk [this message]
2017-08-14 22:12     ` [PATCH v2] " Andreas Heiduk
2017-08-14 22:24       ` Junio C Hamano
2017-08-14 22:21     ` [PATCH] " Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=914098af-00a9-fbc8-cdfe-a65918b2951b@gmail.com \
    --to=asheiduk@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).