Skip to content

Commit 2f89bd9

Browse files
committed
config: explicitly state that subsections are case-sensitive
1 parent 158a42a commit 2f89bd9

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

include/git2/config.h

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,8 @@ GIT_EXTERN(int) git_config_get_string_buf(git_buf *out, const git_config *cfg, c
399399
* The callback will be called on each variable found
400400
*
401401
* The regular expression is applied case-sensitively on the normalized form of
402-
* the variable name: the case-insensitive parts are lower-case.
402+
* the variable name: the section and variable parts are lower-cased. The
403+
* subsection is left unchanged.
403404
*
404405
* @param cfg where to look for the variable
405406
* @param name the variable's name
@@ -414,7 +415,8 @@ GIT_EXTERN(int) git_config_get_multivar_foreach(const git_config *cfg, const cha
414415
* Get each value of a multivar
415416
*
416417
* The regular expression is applied case-sensitively on the normalized form of
417-
* the variable name: the case-insensitive parts are lower-case.
418+
* the variable name: the section and variable parts are lower-cased. The
419+
* subsection is left unchanged.
418420
*
419421
* @param out pointer to store the iterator
420422
* @param cfg where to look for the variable
@@ -563,7 +565,8 @@ GIT_EXTERN(int) git_config_iterator_new(git_config_iterator **out, const git_con
563565
* `git_config_iterator_free` when done.
564566
*
565567
* The regular expression is applied case-sensitively on the normalized form of
566-
* the variable name: the case-insensitive parts are lower-case.
568+
* the variable name: the section and variable parts are lower-cased. The
569+
* subsection is left unchanged.
567570
*
568571
* @param out pointer to store the iterator
569572
* @param cfg where to ge the variables from
@@ -578,8 +581,9 @@ GIT_EXTERN(int) git_config_iterator_glob_new(git_config_iterator **out, const gi
578581
* regular expression that filters which config keys are passed to the
579582
* callback.
580583
*
581-
* The pointers passed to the callback are only valid as long as the
582-
* iteration is ongoing.
584+
* The regular expression is applied case-sensitively on the normalized form of
585+
* the variable name: the section and variable parts are lower-cased. The
586+
* subsection is left unchanged.
583587
*
584588
* The regular expression is applied case-sensitively on the normalized form of
585589
* the variable name: the case-insensitive parts are lower-case.
@@ -710,7 +714,8 @@ GIT_EXTERN(int) git_config_parse_path(git_buf *out, const char *value);
710714
* entries it just enumerates through the given backend entry.
711715
*
712716
* The regular expression is applied case-sensitively on the normalized form of
713-
* the variable name: the case-insensitive parts are lower-case.
717+
* the variable name: the section and variable parts are lower-cased. The
718+
* subsection is left unchanged.
714719
*
715720
* @param backend where to get the variables from
716721
* @param regexp regular expression to match against config names (can be NULL)

0 commit comments

Comments
 (0)