]> git.ipfire.org Git - thirdparty/git.git/commit
Documentation/git-config.txt: add SCOPES section
authorGlen Choo <chooglen@google.com>
Thu, 14 Jul 2022 21:27:57 +0000 (21:27 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 14 Jul 2022 22:08:29 +0000 (15:08 -0700)
commit5f5af3735dede73d6714311e20f17c7f77b1d907
tree9a14e000d00302bc01003b1061fdfbc5fd6e76df
parent4e2a4d1dd44367d7783f33b169698f2930ff13c0
Documentation/git-config.txt: add SCOPES section

In a subsequent commit, we will introduce "protected configuration",
which is easiest to describe in terms of configuration scopes (i.e. it's
the union of the 'system', 'global', and 'command' scopes). This
description is fine for ML discussions, but it's inadequate for end
users because we don't provide a good description of "configuration
scopes" in the public docs.

145d59f482 (config: add '--show-scope' to print the scope of a config
value, 2020-02-10) introduced the word "scope" to our public docs, but
that only enumerates the scopes and assumes the user can figure out
what those values mean.

Add a SCOPES section to Documentation/git-config.txt that describes the
configuration scopes, their corresponding CLI options, and mentions that
some configuration options are only respected in certain scopes. Then,
use the word "scope" to simplify the FILES section and change some
confusing wording.

Signed-off-by: Glen Choo <chooglen@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-config.txt