summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Stefan Beller <sbeller@google.com>2016-11-22 12:14:38 -0800
committerLibravatar Junio C Hamano <gitster@pobox.com>2016-11-22 14:43:04 -0800
commitf2627d9b19f91455a3f8b3c150da601cb72e4085 (patch)
tree508adca3036b2d0937882a97eb5cea8ed9bf7624 /Documentation
parentsubmodule-config: rename commit_sha1 to treeish_name (diff)
downloadtgif-f2627d9b19f91455a3f8b3c150da601cb72e4085.tar.xz
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>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/technical/api-submodule-config.txt7
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/technical/api-submodule-config.txt b/Documentation/technical/api-submodule-config.txt
index 8285bcc605..3dce003fda 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.