From f2627d9b19f91455a3f8b3c150da601cb72e4085 Mon Sep 17 00:00:00 2001 From: Stefan Beller Date: Tue, 22 Nov 2016 12:14:38 -0800 Subject: 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 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. -- cgit v0.10.2-6-g49f6