]> git.ipfire.org Git - thirdparty/git.git/commitdiff
config: document includeIf conditions consistently
authorJunio C Hamano <gitster@pobox.com>
Thu, 21 Aug 2025 15:06:52 +0000 (08:06 -0700)
committerJunio C Hamano <gitster@pobox.com>
Thu, 21 Aug 2025 15:48:43 +0000 (08:48 -0700)
When 399b1984 (config: include file if remote URL matches a glob,
2022-01-18) added the 'hasconfig:remote.*.url:<URL>' condition to be
used in the "includeIf.<condition>.path" configuration, the keyword
was added with an extra colon in the documentation.

The section that documents these condition begins with this preamble:

    The condition starts with a keyword followed by a colon and some data
    whose format and meaning depends on the keyword. Supported keywords
    are:

which makes it clear that the colon that comes between the condition
keyword (e.g. "gitdir") and the parameter (aka "some data") is not
a part of the keyword.

Lose the extra colon.  Also rewrite description of all keywords to
clarify that "some data" does not directly follow "keyword", and the
colon is not a part of keyword.

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

index 8c0b3ed807521490429dec119124cf236332968e..ee1f80cad6191f5baac9648ac61863160e962938 100644 (file)
@@ -114,8 +114,7 @@ whose format and meaning depends on the keyword. Supported keywords
 are:
 
 `gitdir`::
-
-       The data that follows the keyword `gitdir:` is used as a glob
+       The data that follows the keyword `gitdir` and a colon is used as a glob
        pattern. If the location of the .git directory matches the
        pattern, the include condition is met.
 +
@@ -148,7 +147,7 @@ refer to linkgit:gitignore[5] for details. For convenience:
        case-insensitively (e.g. on case-insensitive file systems)
 
 `onbranch`::
-       The data that follows the keyword `onbranch:` is taken to be a
+       The data that follows the keyword `onbranch` and a colon is taken to be a
        pattern with standard globbing wildcards and two additional
        ones, `**/` and `/**`, that can match multiple path components.
        If we are in a worktree where the name of the branch that is
@@ -161,8 +160,8 @@ all branches that begin with `foo/`. This is useful if your branches are
 organized hierarchically and you would like to apply a configuration to
 all the branches in that hierarchy.
 
-`hasconfig:remote.*.url:`::
-       The data that follows this keyword is taken to
+`hasconfig:remote.*.url`::
+       The data that follows this keyword and a colon is taken to
        be a pattern with standard globbing wildcards and two
        additional ones, `**/` and `/**`, that can match multiple
        components. The first time this keyword is seen, the rest of