diff options
| author |  Andreas Heiduk <asheiduk@gmail.com> | 2017-08-15 00:12:18 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2017-08-14 15:47:56 -0700 |
| commit | 7f0a02be2f2712f66daa730e389f45e3e96f1edd (patch) | |
| tree | 29283dc443852273f63c48f04bf8fa39f3ac1ca5 /Documentation | |
| parent | Git 2.11.3 (diff) | |
| download | tgif-7f0a02be2f2712f66daa730e389f45e3e96f1edd.tar.xz | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/config.txt | 10 | ||||
| -rw-r--r-- | Documentation/git.txt | 3 |
2 files changed, 7 insertions, 6 deletions
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:: diff --git a/Documentation/git.txt b/Documentation/git.txt index cc215361f1..d5ddb38e56 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -571,7 +571,8 @@ example the following invocations are equivalent: Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets `foo.bar` to the boolean true value (just like `[foo]bar` would in a config file). Including the equals but with an empty value (like `git -c -foo.bar= ...`) sets `foo.bar` to the empty string. +foo.bar= ...`) sets `foo.bar` to the empty string which ` git config +--bool` will convert to `false`. --exec-path[=<path>]:: Path to wherever your core Git programs are installed. |