aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2016-10-28 09:01:16 -0700
committerJunio C Hamano <gitster@pobox.com>2016-10-28 09:01:16 -0700
commita42539f7de3f2516437fe4ee2d3bf769a27c89ab (patch)
tree3f494cfcd326e8c0e2d9b0556f326d13a6ab0990 /Documentation
parent42a9c6c0e2060327def808d9c4c2aa167d6d8934 (diff)
parent72710165c932edb2b8552aef7aef2f357dde4746 (diff)
downloadgit-a42539f7de3f2516437fe4ee2d3bf769a27c89ab.tar.gz
git-a42539f7de3f2516437fe4ee2d3bf769a27c89ab.tar.xz
Merge branch 'sb/submodule-config-doc-drop-path' into maint
The "submodule.<name>.path" stored in .gitmodules is never copied to .git/config and such a key in .git/config has no meaning, but the documentation described it and submodule.<name>.url next to each other as if both belong to .git/config. This has been fixed. * sb/submodule-config-doc-drop-path: documentation: improve submodule.<name>.{url, path} description
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/config.txt11
1 files changed, 6 insertions, 5 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt
index a077c64ef..21fdddf24 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -2805,12 +2805,13 @@ stash.showStat::
option will show diffstat of the stash. Defaults to true.
See description of 'show' command in linkgit:git-stash[1].
-submodule.<name>.path::
submodule.<name>.url::
- The path within this project and URL for a submodule. These
- variables are initially populated by 'git submodule init'. See
- linkgit:git-submodule[1] and linkgit:gitmodules[5] for
- details.
+ The URL for a submodule. This variable is copied from the .gitmodules
+ file to the git config via 'git submodule init'. The user can change
+ the configured URL before obtaining the submodule via 'git submodule
+ update'. After obtaining the submodule, the presence of this variable
+ is used as a sign whether the submodule is of interest to git commands.
+ See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
submodule.<name>.update::
The default update procedure for a submodule. This variable