diff options
| author | Tanay Abhra <tanayabh@gmail.com> | 2014-08-07 04:59:16 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-08-07 11:40:25 -0700 |
| commit | 5a80e97c827e9d73884dbe4119bf97f6dd84b237 (patch) | |
| tree | 46564b16273d2524672680afd0a1dc61e561595e /Documentation | |
| parent | aace4385027b0366f43961a94c8ed95ac9b3bd53 (diff) | |
| download | git-5a80e97c827e9d73884dbe4119bf97f6dd84b237.tar.gz git-5a80e97c827e9d73884dbe4119bf97f6dd84b237.tar.xz | |
config: add `git_die_config()` to the config-set API
Add `git_die_config` that dies printing the line number and the file name
of the highest priority value for the configuration variable `key`. A custom
error message is also printed before dying, specified by the caller, which can
be skipped if `err` argument is set to NULL.
It has usage in non-callback based config value retrieval where we can
raise an error and die if there is a semantic error.
For example,
if (!git_config_get_value(key, &value)){
if (!strcmp(value, "foo"))
git_config_die(key, "value: `%s` is illegal", value);
else
/* do work */
}
Signed-off-by: Tanay Abhra <tanayabh@gmail.com>
Reviewed-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/technical/api-config.txt | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/Documentation/technical/api-config.txt b/Documentation/technical/api-config.txt index 815c1eecc..7108888b8 100644 --- a/Documentation/technical/api-config.txt +++ b/Documentation/technical/api-config.txt @@ -155,6 +155,19 @@ as well as retrieval for the queried variable, including: Similar to `git_config_get_string`, but expands `~` or `~user` into the user's home directory when found at the beginning of the path. +`git_die_config(const char *key, const char *err, ...)`:: + + First prints the error message specified by the caller in `err` and then + dies printing the line number and the file name of the highest priority + value for the configuration variable `key`. + +`void git_die_config_linenr(const char *key, const char *filename, int linenr)`:: + + Helper function which formats the die error message according to the + parameters entered. Used by `git_die_config()`. It can be used by callers + handling `git_config_get_value_multi()` to print the correct error message + for the desired value. + See test-config.c for usage examples. Value Parsing Helpers |