diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2016-10-17 13:25:23 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2016-10-17 13:25:24 -0700 |
| commit | 14944826855a26ce1f0e058008f9b2baa11e5cb7 (patch) | |
| tree | 391dc732397f1d133353f40f02af49b41da578a5 | |
| parent | Merge branch 'rs/pretty-format-color-doc-fix' (diff) | |
| parent | documentation: improve submodule.<name>.{url, path} description (diff) | |
| download | tgif-14944826855a26ce1f0e058008f9b2baa11e5cb7.tar.xz | |
Merge branch 'sb/submodule-config-doc-drop-path'
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
| -rw-r--r-- | Documentation/config.txt | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index a17947462a..27069ac032 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -2825,12 +2825,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 |