diff options
author | Edward Thomson <ethomson@edwardthomson.com> | 2018-03-12 09:50:00 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-03-12 09:50:00 +0100 |
commit | 358cc2e2ea2e0fffc0672870e4a99160c068ebde (patch) | |
tree | 1eaed7cfe69218abeebfc6a0d5b475d35f34a89f | |
parent | d11c4a1a464f10c69d5cc58824e980ea5045d439 (diff) | |
parent | 2f89bd90bcdcbd64f3b67e1d9ae6c22711244c43 (diff) | |
download | libgit2-358cc2e2ea2e0fffc0672870e4a99160c068ebde.tar.gz |
Merge pull request #4396 from libgit2/cmn/config-regex-is-normalised
config: specify how we match the regular expressions
-rw-r--r-- | include/git2/config.h | 28 |
1 files changed, 26 insertions, 2 deletions
diff --git a/include/git2/config.h b/include/git2/config.h index d812e16bd..d9da65b84 100644 --- a/include/git2/config.h +++ b/include/git2/config.h @@ -401,6 +401,10 @@ GIT_EXTERN(int) git_config_get_string_buf(git_buf *out, const git_config *cfg, c * * The callback will be called on each variable found * + * The regular expression is applied case-sensitively on the normalized form of + * the variable name: the section and variable parts are lower-cased. The + * subsection is left unchanged. + * * @param cfg where to look for the variable * @param name the variable's name * @param regexp regular expression to filter which variables we're @@ -413,6 +417,10 @@ GIT_EXTERN(int) git_config_get_multivar_foreach(const git_config *cfg, const cha /** * Get each value of a multivar * + * The regular expression is applied case-sensitively on the normalized form of + * the variable name: the section and variable parts are lower-cased. The + * subsection is left unchanged. + * * @param out pointer to store the iterator * @param cfg where to look for the variable * @param name the variable's name @@ -490,6 +498,8 @@ GIT_EXTERN(int) git_config_set_string(git_config *cfg, const char *name, const c /** * Set a multivar in the local config file. * + * The regular expression is applied case-sensitively on the value. + * * @param cfg where to look for the variable * @param name the variable's name * @param regexp a regular expression to indicate which values to replace @@ -509,6 +519,8 @@ GIT_EXTERN(int) git_config_delete_entry(git_config *cfg, const char *name); /** * Deletes one or several entries from a multivar in the local config file. * + * The regular expression is applied case-sensitively on the value. + * * @param cfg where to look for the variables * @param name the variable's name * @param regexp a regular expression to indicate which values to delete @@ -555,6 +567,10 @@ GIT_EXTERN(int) git_config_iterator_new(git_config_iterator **out, const git_con * Use `git_config_next` to advance the iteration and * `git_config_iterator_free` when done. * + * The regular expression is applied case-sensitively on the normalized form of + * the variable name: the section and variable parts are lower-cased. The + * subsection is left unchanged. + * * @param out pointer to store the iterator * @param cfg where to ge the variables from * @param regexp regular expression to match the names @@ -568,8 +584,12 @@ GIT_EXTERN(int) git_config_iterator_glob_new(git_config_iterator **out, const gi * regular expression that filters which config keys are passed to the * callback. * - * The pointers passed to the callback are only valid as long as the - * iteration is ongoing. + * The regular expression is applied case-sensitively on the normalized form of + * the variable name: the section and variable parts are lower-cased. The + * subsection is left unchanged. + * + * The regular expression is applied case-sensitively on the normalized form of + * the variable name: the case-insensitive parts are lower-case. * * @param cfg where to get the variables from * @param regexp regular expression to match against config names @@ -696,6 +716,10 @@ GIT_EXTERN(int) git_config_parse_path(git_buf *out, const char *value); * This behaviors like `git_config_foreach_match` except instead of all config * entries it just enumerates through the given backend entry. * + * The regular expression is applied case-sensitively on the normalized form of + * the variable name: the section and variable parts are lower-cased. The + * subsection is left unchanged. + * * @param backend where to get the variables from * @param regexp regular expression to match against config names (can be NULL) * @param callback the function to call on each variable |