From 7f0a02be2f2712f66daa730e389f45e3e96f1edd Mon Sep 17 00:00:00 2001
From: Andreas Heiduk <asheiduk@gmail.com>
Date: Tue, 15 Aug 2017 00:12:18 +0200
Subject: doc: clarify "config --bool" behaviour with empty string
`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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
Documentation/config.txt | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
(limited to 'Documentation/config.txt')
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 1fee83ca42..8886b1fcfb 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -133,15 +133,15 @@ boolean::
synonyms are accepted for 'true' and 'false'; these are all
case-insensitive.
- true;; Boolean true can be spelled as `yes`, `on`, `true`,
- or `1`. Also, a variable defined without `= <value>`
+ true;; Boolean true literals are `yes`, `on`, `true`,
+ and `1`. Also, a variable defined without `= <value>`
is taken as true.
- false;; Boolean false can be spelled as `no`, `off`,
- `false`, or `0`.
+ false;; Boolean false literals are `no`, `off`, `false`,
+ `0` and the empty string.
+
When converting value to the canonical form using `--bool` type
-specifier; 'git config' will ensure that the output is "true" or
+specifier, 'git config' will ensure that the output is "true" or
"false" (spelled in lowercase).
integer::
--
cgit v1.2.1