git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v7 5/8] config: add `git_die_config()` to the config-set API

From
Tanay Abhra <tanayabh@gmail.com>
Date
Aug 1, 2014, 17:05 UTC
Message-ID
<1406912756-15517-6-git-send-email-tanayabh@gmail.com>
In-Reply-To
<1406912756-15517-1-git-send-email-tanayabh@gmail.com>

Add `git_die_config` that dies printing the line number and the file name of the highest priority value for the configuration variable `key`.

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)) {
		/* NULL values not allowed */
		if (!value)
			git_config_die(key);
		else
			/* do work */
	}
Signed-off-by: Tanay Abhra <tanayabh@gmail.com>
---
 Documentation/technical/api-config.txt | 12 ++++++++++++
 cache.h                                |  2 ++
 config.c                               | 34 ++++++++++++++++++++++++++++++++--
 3 files changed, 46 insertions(+), 2 deletions(-)
diff --git a/Documentation/technical/api-config.txt b/Documentation/technical/api-config.txt
index 815c1ee..d6a2c39 100644
--- a/Documentation/technical/api-config.txt
+++ b/Documentation/technical/api-config.txt
@@ -155,6 +155,18 @@ 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.
 
+`void git_die_config(const char *key)`::
+
+	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
diff --git a/cache.h b/cache.h
index c61919d..9ec2f4e 100644
--- a/cache.h
+++ b/cache.h
@@ -1382,6 +1382,8 @@ extern int git_config_get_bool(const char *key, int *dest);
 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
 extern int git_config_get_maybe_bool(const char *key, int *dest);
 extern int git_config_get_pathname(const char *key, const char **dest);
+extern void git_die_config(const char *key);
+extern void git_die_config_linenr(const char *key, const char *filename, int linenr);
 
 extern int committer_ident_sufficiently_given(void);
 extern int author_ident_sufficiently_given(void);
diff --git a/config.c b/config.c
index f923b1c..ddbfe4d 100644
--- a/config.c
+++ b/config.c
@@ -1474,8 +1474,12 @@ const struct string_list *git_config_get_value_multi(const char *key)
 
 int git_config_get_string_const(const char *key, const char **dest)
 {
+	int ret;
 	git_config_check_init();
-	return git_configset_get_string_const(&the_config_set, key, dest);
+	ret = git_configset_get_string_const(&the_config_set, key, dest);
+	if (ret < 0)
+		git_die_config(key);
+	return ret;
 }
 
 int git_config_get_string(const char *key, char **dest)
@@ -1516,8 +1520,34 @@ int git_config_get_maybe_bool(const char *key, int *dest)
 
 int git_config_get_pathname(const char *key, const char **dest)
 {
+	int ret;
 	git_config_check_init();
-	return git_configset_get_pathname(&the_config_set, key, dest);
+	ret = git_configset_get_pathname(&the_config_set, key, dest);
+	if (ret < 0)
+		git_die_config(key);
+	return ret;
+}
+
+NORETURN
+void git_die_config_linenr(const char *key, const char *filename, int linenr)
+{
+	if (!linenr)
+		die(_("unable to parse '%s' from command-line config"), key);
+	else
+		die(_("bad config variable '%s' at file line %d in %s"),
+			key,
+			linenr,
+			filename);
+}
+
+NORETURN
+void git_die_config(const char *key)
+{
+	const struct string_list *values;
+	struct key_value_info *kv_info;
+	values = git_config_get_value_multi(key);
+	kv_info = values->items[values->nr - 1].util;
+	git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
 }
 
 /*
-- 
1.9.0.GIT
Previous: Tanay AbhraNext: Junio C Hamano
Message 7 of 19 in “Rewrite `git_config()` using config-set API”
  1. 0/8 Rewrite `git_config()` using config-set APITanay Abhra, Aug 1, 2014
  2. 1/8 config.c: mark error and warnings strings for translationTanay Abhra, Aug 1, 2014
  3. 2/8 config.c: fix accuracy of line number in errorsTanay Abhra, Aug 1, 2014
  4. Matthieu MoyAug 4, 2014
  5. 3/8 add line number and file name info to `config_set`Tanay Abhra, Aug 1, 2014
  6. 4/8 change `git_config()` return value to voidTanay Abhra, Aug 1, 2014
  7. 5/8 config: add `git_die_config()` to the config-set APITanay Abhra, Aug 1, 2014
  8. Junio C HamanoAug 4, 2014
  9. Tanay AbhraAug 4, 2014
  10. Matthieu MoyAug 4, 2014
  11. Tanay AbhraAug 5, 2014
  12. Matthieu MoyAug 5, 2014
  13. Junio C HamanoAug 5, 2014
  14. Junio C HamanoAug 4, 2014
  15. 6/8 rewrite git_config() to use the config-set APITanay Abhra, Aug 1, 2014
  16. 7/8 add a test for semantic errors in config filesTanay Abhra, Aug 1, 2014
  17. Junio C HamanoAug 4, 2014
  18. 8/8 add tests for `git_config_get_string_const()`Tanay Abhra, Aug 1, 2014
  19. Matthieu MoyAug 4, 2014

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.