Skip to content

Commit ac70967

Browse files
committed
config: document includeIf conditions consistently
When 399b198 (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 <[email protected]>
1 parent a1cf0cf commit ac70967

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

Documentation/config.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,7 @@ whose format and meaning depends on the keyword. Supported keywords
114114
are:
115115

116116
`gitdir`::
117-
118-
The data that follows the keyword `gitdir:` is used as a glob
117+
The data that follows the keyword `gitdir` and a colon is used as a glob
119118
pattern. If the location of the .git directory matches the
120119
pattern, the include condition is met.
121120
+
@@ -148,7 +147,7 @@ refer to linkgit:gitignore[5] for details. For convenience:
148147
case-insensitively (e.g. on case-insensitive file systems)
149148

150149
`onbranch`::
151-
The data that follows the keyword `onbranch:` is taken to be a
150+
The data that follows the keyword `onbranch` and a colon is taken to be a
152151
pattern with standard globbing wildcards and two additional
153152
ones, `**/` and `/**`, that can match multiple path components.
154153
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
161160
organized hierarchically and you would like to apply a configuration to
162161
all the branches in that hierarchy.
163162

164-
`hasconfig:remote.*.url:`::
165-
The data that follows this keyword is taken to
163+
`hasconfig:remote.*.url`::
164+
The data that follows this keyword and a colon is taken to
166165
be a pattern with standard globbing wildcards and two
167166
additional ones, `**/` and `/**`, that can match multiple
168167
components. The first time this keyword is seen, the rest of

0 commit comments

Comments
 (0)