path: root/Documentation/technical/api-submodule-config.txt
diff options
authorStefan Beller <>2016-11-22 20:14:38 (GMT)
committerJunio C Hamano <>2016-11-22 22:43:04 (GMT)
commitf2627d9b19f91455a3f8b3c150da601cb72e4085 (patch)
tree508adca3036b2d0937882a97eb5cea8ed9bf7624 /Documentation/technical/api-submodule-config.txt
parent73c293bb6c15992690b16c90bcac243a76d86400 (diff)
submodule-config: clarify parsing of null_sha1 element
Signed-off-by: Stefan Beller <> Signed-off-by: Junio C Hamano <> Reviewed-by: Brandon Williams <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/technical/api-submodule-config.txt')
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/technical/api-submodule-config.txt b/Documentation/technical/api-submodule-config.txt
index 8285bcc..3dce003 100644
--- a/Documentation/technical/api-submodule-config.txt
+++ b/Documentation/technical/api-submodule-config.txt
@@ -56,8 +56,11 @@ Functions
The same as above but lookup by name.
-If given the null_sha1 as treeish_name the local configuration of a
-submodule will be returned (e.g. consolidated values from local git
+Whenever a submodule configuration is parsed in `parse_submodule_config_option`
+via e.g. `gitmodules_config()`, it will overwrite the null_sha1 entry.
+So in the normal case, when HEAD:.gitmodules is parsed first and then overlayed
+with the repository configuration, the null_sha1 entry contains the local
+configuration of a submodule (e.g. consolidated values from local git
configuration and the .gitmodules file in the worktree).
For an example usage see test-submodule-config.c.