submodule-config: clarify parsing of null_sha1 element
Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> Reviewed-by: Brandon Williams <bmwill@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Stefan Beller committed
Nov 22, 2016 at 12:14 UTC
f2627d9b19f91455a3f8b3c150da601cb72e4085
1 file changed
+5
-2
Documentation/technical/api-submodule-config.txt
+5
-2
@@ -56,8 +56,11 @@ Functions
56
57
The same as above but lookup by name.
58
59
-If given the null_sha1 as treeish_name the local configuration of a
60
-submodule will be returned (e.g. consolidated values from local git
59
+Whenever a submodule configuration is parsed in `parse_submodule_config_option`
60
+via e.g. `gitmodules_config()`, it will overwrite the null_sha1 entry.
61
+So in the normal case, when HEAD:.gitmodules is parsed first and then overlayed
62
+with the repository configuration, the null_sha1 entry contains the local
63
+configuration of a submodule (e.g. consolidated values from local git
64
configuration and the .gitmodules file in the worktree).
65
66
For an example usage see test-submodule-config.c.