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

[PATCH 3/7] submodule-config: add helper to get 'update-clone' config from .gitmodules

From
Antonio Ospite <ao2@ao2.it>
Date
Jun 22, 2018, 16:26 UTC
Message-ID
<20180622162656.19338-4-ao2@ao2.it>
In-Reply-To
<20180622162656.19338-1-ao2@ao2.it>

Add a helper function to make it clearer that retrieving 'update-clone' configuration from the .gitmodules file is a special case supported solely for backward compatibility purposes.

This change removes one direct use of 'config_from_gitmodules' for options not strictly related to submodules: "submodule.fetchobjs" does not describe a property of a submodule, but a behavior of other commands when dealing with submodules, so it does not really belong to the .gitmodules file.

This is in the effort to communicate better that .gitmodules is not to be used as a mechanism to store arbitrary configuration in the repository that any command can retrieve.

Signed-off-by: Antonio Ospite <ao2@ao2.it>
---
 builtin/submodule--helper.c |  8 ++++----
 submodule-config.c          | 14 ++++++++++++++
 submodule-config.h          |  1 +
 3 files changed, 19 insertions(+), 4 deletions(-)
diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c
index bd250ca21..d450b81da 100644
--- a/builtin/submodule--helper.c
+++ b/builtin/submodule--helper.c
@@ -1562,8 +1562,8 @@ static int update_clone_task_finished(int result,
 	return 0;
 }
 
-static int gitmodules_update_clone_config(const char *var, const char *value,
-					  void *cb)
+static int git_update_clone_config(const char *var, const char *value,
+				   void *cb)
 {
 	int *max_jobs = cb;
 	if (!strcmp(var, "submodule.fetchjobs"))
@@ -1613,8 +1613,8 @@ static int update_clone(int argc, const char **argv, const char *prefix)
 	};
 	suc.prefix = prefix;
 
-	config_from_gitmodules(gitmodules_update_clone_config, &max_jobs);
-	git_config(gitmodules_update_clone_config, &max_jobs);
+	update_clone_config_from_gitmodules(&max_jobs);
+	git_config(git_update_clone_config, &max_jobs);
 
 	argc = parse_options(argc, argv, prefix, module_update_clone_options,
 			     git_submodule_helper_usage, 0);
diff --git a/submodule-config.c b/submodule-config.c
index ef292eb7c..46fb454ae 100644
--- a/submodule-config.c
+++ b/submodule-config.c
@@ -716,3 +716,17 @@ void fetch_config_from_gitmodules(int *max_children, int *recurse_submodules)
 	};
 	config_from_gitmodules(gitmodules_fetch_config, &config);
 }
+
+static int gitmodules_update_clone_config(const char *var, const char *value,
+					  void *cb)
+{
+	int *max_jobs = cb;
+	if (!strcmp(var, "submodule.fetchjobs"))
+		*max_jobs = parse_submodule_fetchjobs(var, value);
+	return 0;
+}
+
+void update_clone_config_from_gitmodules(int *max_jobs)
+{
+	config_from_gitmodules(gitmodules_update_clone_config, &max_jobs);
+}
diff --git a/submodule-config.h b/submodule-config.h
index cff297a75..b6f19d0d4 100644
--- a/submodule-config.h
+++ b/submodule-config.h
@@ -67,5 +67,6 @@ int check_submodule_name(const char *name);
 extern void config_from_gitmodules(config_fn_t fn, void *data);
 
 extern void fetch_config_from_gitmodules(int *max_children, int *recurse_submodules);
+extern void update_clone_config_from_gitmodules(int *max_jobs);
 
 #endif /* SUBMODULE_CONFIG_H */
-- 
2.18.0
Previous: Antonio OspiteNext: Brandon Williams
Message 9 of 15 in “Restrict the usage of config_from_gitmodules()”
  1. 0/7 Restrict the usage of config_from_gitmodules()Antonio Ospite, Jun 22, 2018
  2. 5/7 submodule-config: pass repository as argument to config_from_gitmodulesAntonio Ospite, Jun 22, 2018
  3. 2/7 submodule-config: add helper function to get 'fetch' config from .gitmodulesAntonio Ospite, Jun 22, 2018
  4. Brandon WilliamsJun 22, 2018
  5. 1/7 config: move config_from_gitmodules to submodule-config.cAntonio Ospite, Jun 22, 2018
  6. 7/7 submodule-config: cleanup backward compatibility helpersAntonio Ospite, Jun 22, 2018
  7. Brandon WilliamsJun 22, 2018
  8. 4/7 submodule-config: make 'config_from_gitmodules' privateAntonio Ospite, Jun 22, 2018
  9. 3/7 submodule-config: add helper to get 'update-clone' config from .gitmodulesAntonio Ospite, Jun 22, 2018
  10. Brandon WilliamsJun 22, 2018
  11. 6/7 submodule-config: reuse config_from_gitmodules in repo_read_gitmodulesAntonio Ospite, Jun 22, 2018
  12. Brandon WilliamsJun 22, 2018
  13. Brandon WilliamsJun 22, 2018
  14. Antonio OspiteJun 22, 2018
  15. Brandon WilliamsJun 22, 2018

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.