documentation: improve submodule.<name>.{url, path} description
Unlike the url variable a user cannot override the the path variable, as it is part of the content together with the gitlink at the given path. To avoid confusion do not mention the .path variable in the config section and rely on the documentation provided in gitmodules[5]. Enhance the description of submodule.<name>.url and mention its two use cases separately. Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Stefan Beller committed
Oct 10, 2016 at 12:36 UTC
72710165c932edb2b8552aef7aef2f357dde4746
1 file changed
+6
-5
Documentation/config.txt
+6
-5
@@ -2706,12 +2706,13 @@ stash.showStat::
2706
option will show diffstat of the stash. Defaults to true.
2707
See description of 'show' command in linkgit:git-stash[1].
2708
2709
-submodule.<name>.path::
2709
submodule.<name>.url::
2711
- The path within this project and URL for a submodule. These
2712
- variables are initially populated by 'git submodule init'. See
2713
- linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2714
- details.
2710
+ The URL for a submodule. This variable is copied from the .gitmodules
2711
+ file to the git config via 'git submodule init'. The user can change
2712
+ the configured URL before obtaining the submodule via 'git submodule
2713
+ update'. After obtaining the submodule, the presence of this variable
2714
+ is used as a sign whether the submodule is of interest to git commands.
2715
+ See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2716
2717
submodule.<name>.update::
2718
The default update procedure for a submodule. This variable