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

[PATCH v9 4/8] change `git_config()` return value to void

From
Tanay Abhra <tanayabh@gmail.com>
Date
Aug 7, 2014, 11:59 UTC
Message-ID
<1407412759-13833-5-git-send-email-tanayabh@gmail.com>
In-Reply-To
<1407412759-13833-1-git-send-email-tanayabh@gmail.com>

Currently `git_config()` returns an integer signifying an error code. During rewrites of the function most of the code was shifted to `git_config_with_options()`. `git_config_with_options()` normally returns positive values if its `config_source` parameter is set as NULL, as most errors are fatal, and non-fatal potential errors are guarded by "if" statements that are entered only when no error is possible.

Still a negative value can be returned in case of race condition between `access_or_die()` & `git_config_from_file()`. Also, all callers of `git_config()` ignore the return value except for one case in branch.c.

Change `git_config()` return value to void and make it die if it receives a negative value from `git_config_with_options()`.

Original-patch-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Tanay Abhra <tanayabh@gmail.com>
---
 branch.c |  5 +----
 cache.h  |  2 +-
 config.c | 16 ++++++++++++++--
 3 files changed, 16 insertions(+), 7 deletions(-)
diff --git a/branch.c b/branch.c
index 46e8aa8..735767d 100644
--- a/branch.c
+++ b/branch.c
@@ -161,10 +161,7 @@ int read_branch_desc(struct strbuf *buf, const char *branch_name)
 	strbuf_addf(&name, "branch.%s.description", branch_name);
 	cb.config_name = name.buf;
 	cb.value = NULL;
-	if (git_config(read_branch_desc_cb, &cb) < 0) {
-		strbuf_release(&name);
-		return -1;
-	}
+	git_config(read_branch_desc_cb, &cb);
 	if (cb.value)
 		strbuf_addstr(buf, cb.value);
 	strbuf_release(&name);
diff --git a/cache.h b/cache.h
index 0b1bdfd..f11ce41 100644
--- a/cache.h
+++ b/cache.h
@@ -1294,7 +1294,7 @@ extern int git_config_from_buf(config_fn_t fn, const char *name,
 			       const char *buf, size_t len, void *data);
 extern void git_config_push_parameter(const char *text);
 extern int git_config_from_parameters(config_fn_t fn, void *data);
-extern int git_config(config_fn_t fn, void *);
+extern void git_config(config_fn_t fn, void *);
 extern int git_config_with_options(config_fn_t fn, void *,
 				   struct git_config_source *config_source,
 				   int respect_includes);
diff --git a/config.c b/config.c
index e4d745e..4cefa25 100644
--- a/config.c
+++ b/config.c
@@ -1230,9 +1230,21 @@ int git_config_with_options(config_fn_t fn, void *data,
 	return ret;
 }
 
-int git_config(config_fn_t fn, void *data)
+void git_config(config_fn_t fn, void *data)
 {
-	return git_config_with_options(fn, data, NULL, 1);
+	if (git_config_with_options(fn, data, NULL, 1) < 0)
+		/*
+		 * git_config_with_options() normally returns only
+		 * positive values, as most errors are fatal, and
+		 * non-fatal potential errors are guarded by "if"
+		 * statements that are entered only when no error is
+		 * possible.
+		 *
+		 * If we ever encounter a non-fatal error, it means
+		 * something went really wrong and we should stop
+		 * immediately.
+		 */
+		die(_("unknown error occured while reading the configuration files"));
 }
 
 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
-- 
1.9.0.GIT
Previous: Matthieu MoyNext: Tanay Abhra
Message 9 of 16 in “Rewrite `git_config()` using config-set API”
  1. 0/8 Rewrite `git_config()` using config-set APITanay Abhra, Aug 7, 2014
  2. 1/8 config.c: mark error and warnings strings for translationTanay Abhra, Aug 7, 2014
  3. 2/8 config.c: fix accuracy of line number in errorsTanay Abhra, Aug 7, 2014
  4. 3/8 add line number and file name info to `config_set`Tanay Abhra, Aug 7, 2014
  5. Ramsay JonesAug 7, 2014
  6. Matthieu MoyAug 7, 2014
  7. Junio C HamanoAug 7, 2014
  8. Matthieu MoyAug 7, 2014
  9. 4/8 change `git_config()` return value to voidTanay Abhra, Aug 7, 2014
  10. 5/8 config: add `git_die_config()` to the config-set APITanay Abhra, Aug 7, 2014
  11. Junio C HamanoAug 7, 2014
  12. Tanay AbhraAug 8, 2014
  13. 6/8 rewrite git_config() to use the config-set APITanay Abhra, Aug 7, 2014
  14. 7/8 add a test for semantic errors in config filesTanay Abhra, Aug 7, 2014
  15. 8/8 add tests for `git_config_get_string_const()`Tanay Abhra, Aug 7, 2014
  16. Matthieu MoyAug 7, 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.