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

[PATCH 6/7] config: add `git_die_config()` to the config-set API

From
Tanay Abhra <tanayabh@gmail.com>
Date
Jul 23, 2014, 18:42 UTC
Message-ID
<1406140978-9472-7-git-send-email-tanayabh@gmail.com>
In-Reply-To
<1406140978-9472-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 |  5 +++++
 cache.h                                |  1 +
 config.c                               | 24 ++++++++++++++++++++++--
 3 files changed, 28 insertions(+), 2 deletions(-)
diff --git a/Documentation/technical/api-config.txt b/Documentation/technical/api-config.txt
index 8a86e45..14571e7 100644
--- a/Documentation/technical/api-config.txt
+++ b/Documentation/technical/api-config.txt
@@ -150,6 +150,11 @@ 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`.
+
 See test-config.c for usage examples.
 
 Value Parsing Helpers
diff --git a/cache.h b/cache.h
index 2f63fd1..fc886c3 100644
--- a/cache.h
+++ b/cache.h
@@ -1380,6 +1380,7 @@ 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 int committer_ident_sufficiently_given(void);
 extern int author_ident_sufficiently_given(void);
diff --git a/config.c b/config.c
index 43a951f..f0c9805 100644
--- a/config.c
+++ b/config.c
@@ -1491,8 +1491,12 @@ const struct string_list *git_config_get_value_multi(const char *key)
 
 int git_config_get_string(const char *key, const char **dest)
 {
+	int ret;
 	git_config_check_init();
-	return git_configset_get_string(&the_config_set, key, dest);
+	ret = git_configset_get_string(&the_config_set, key, dest);
+	if (ret < 0)
+		git_die_config(key);
+	return ret;
 }
 
 int git_config_get_int(const char *key, int *dest)
@@ -1527,8 +1531,24 @@ 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;
+}
+
+void git_die_config(const char *key)
+{
+	const struct string_list *strptr;
+	struct key_value_info *kv_info;
+	strptr = git_config_get_value_multi(key);
+	kv_info = strptr->items[strptr->nr - 1].util;
+	if (!kv_info->linenr)
+		die("unable to parse command-line config");
+	else
+		die("bad config file line %d in %s",kv_info->linenr, kv_info->filename);
 }
 
 /*
-- 
1.9.0.GIT
Previous: Junio C HamanoNext: Tanay Abhra
Message 39 of 51 in “Rewrite `git_config()` using config-set API”
  1. 0/7 Rewrite `git_config()` using config-set APITanay Abhra, Jul 23, 2014
  2. 1/7 config.c: fix accuracy of line number in errorsTanay Abhra, Jul 23, 2014
  3. Junio C HamanoJul 23, 2014
  4. Tanay AbhraJul 24, 2014
  5. Junio C HamanoJul 24, 2014
  6. Tanay AbhraJul 24, 2014
  7. Matthieu MoyJul 24, 2014
  8. 2/7 rewrite git_config() to use the config-set APITanay Abhra, Jul 23, 2014
  9. Matthieu MoyJul 23, 2014
  10. Matthieu MoyJul 23, 2014
  11. Junio C HamanoJul 23, 2014
  12. Matthieu MoyJul 24, 2014
  13. 3/7 add a test for semantic errors in config filesTanay Abhra, Jul 23, 2014
  14. Matthieu MoyJul 23, 2014
  15. Junio C HamanoJul 23, 2014
  16. Tanay AbhraJul 24, 2014
  17. Matthieu MoyJul 24, 2014
  18. Junio C HamanoJul 24, 2014
  19. 4/7 add line number and file name info to `config_set`Tanay Abhra, Jul 23, 2014
  20. Junio C HamanoJul 23, 2014
  21. 5/7 enforce `xfuncname` precedence over `funcname`Tanay Abhra, Jul 23, 2014
  22. Matthieu MoyJul 23, 2014
  23. Eric SunshineJul 23, 2014
  24. Junio C HamanoJul 23, 2014
  25. Matthieu MoyJul 24, 2014
  26. Junio C HamanoJul 24, 2014
  27. Tanay AbhraJul 24, 2014
  28. Matthieu MoyJul 24, 2014
  29. John KeepingJul 24, 2014
  30. Junio C HamanoJul 24, 2014
  31. Tanay AbhraJul 24, 2014
  32. Junio C HamanoJul 24, 2014
  33. Ramsay JonesJul 24, 2014
  34. Tanay AbhraJul 25, 2014
  35. Matthieu MoyJul 25, 2014
  36. Junio C HamanoJul 25, 2014
  37. Matthieu MoyJul 25, 2014
  38. Junio C HamanoJul 25, 2014
  39. 6/7 config: add `git_die_config()` to the config-set APITanay Abhra, Jul 23, 2014
  40. 7/7 Add tests for `git_config_get_string()`Tanay Abhra, Jul 23, 2014
  41. Matthieu MoyJul 23, 2014
  42. Matthieu MoyJul 23, 2014
  43. Junio C HamanoJul 23, 2014
  44. Tanay AbhraJul 24, 2014
  45. Matthieu MoyJul 24, 2014
  46. Tanay AbhraJul 24, 2014
  47. Matthieu MoyJul 24, 2014
  48. Junio C HamanoJul 24, 2014
  49. 1/2 add `config_set` API for caching config-like filesTanay Abhra, Jul 24, 2014
  50. Junio C HamanoJul 24, 2014
  51. 2/2 test-config: add tests for the config_set APITanay Abhra, Jul 24, 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.