]> git.ipfire.org Git - thirdparty/git.git/commit - submodule-config.h
submodule-config: move doc to submodule-config.h
authorHeba Waly <heba.waly@gmail.com>
Sun, 17 Nov 2019 21:04:58 +0000 (21:04 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 18 Nov 2019 06:21:29 +0000 (15:21 +0900)
commitd95a77d05988ed1682c3e2bf1b94523341ef58b7
tree6503ff052a8b02772f6a9267accd7a27ef1ad69a
parentbbcfa3002a6534613d8b74ecac0e19876dbfc2d3
submodule-config: move doc to submodule-config.h

Move the documentation from Documentation/technical/api-submodule-config.txt
to submodule-config.h as it's easier for the developers to find the usage
information beside the code instead of looking for it in another doc file.

Documentation/technical/api-submodule-config.txt is removed because the
information it has is now redundant and it'll be hard to keep it up to
date and synchronized with the documentation in the header file.

The documentation of parse_submodule_config_option() is discarded as the
function was removed 2 years ago.

Signed-off-by: Heba Waly <heba.waly@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-submodule-config.txt [deleted file]
submodule-config.h