]> git.ipfire.org Git - thirdparty/git.git/commit
doc: centrally document various ways tospell `true` and `false`
authorJunio C Hamano <gitster@pobox.com>
Tue, 11 Feb 2025 17:20:07 +0000 (09:20 -0800)
committerJunio C Hamano <gitster@pobox.com>
Tue, 11 Feb 2025 18:12:04 +0000 (10:12 -0800)
commit832f56f06a5910b2f41a2e0dd8b382b6c709de07
tree9d49593006b1592ed47b59e97c0060fcbfb8b077
parent5c21db3a0d5f4414b65e114ca21c5a1fe736f2bc
doc: centrally document various ways tospell `true` and `false`

We do not seem to centrally document exhaustively ways to spell
Boolean values.

The description in the Environment Variables of git(1) section
assumes that the reader is already familiar with how "Boolean valued
configuration variables" are specified, without referring to
anything, so there is no way for the readers to find out more.

The description of `bool` in the section on "--type
<type>" in "git config --help" might be the place to do so, but it
is not telling us all that much.

The description of Boolean valued placeholders in the pretty formats
section of "git log --help" enumerates the possible values with "etc."
implying there may be other synonyms; shrink the list of samples and
instead refer to the canonical and authoritative source of truth, which
now is git-config(1).

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-config.txt
Documentation/git.txt
Documentation/pretty-formats.txt