Skip to content

Commit 28fc3e5

Browse files
committed
Merge branch 'sb/submodule-config-doc-drop-path' into next
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
2 parents f0ae64b + 7271016 commit 28fc3e5

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

Documentation/config.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2825,12 +2825,13 @@ stash.showStat::
28252825
option will show diffstat of the stash. Defaults to true.
28262826
See description of 'show' command in linkgit:git-stash[1].
28272827

2828-
submodule.<name>.path::
28292828
submodule.<name>.url::
2830-
The path within this project and URL for a submodule. These
2831-
variables are initially populated by 'git submodule init'. See
2832-
linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2833-
details.
2829+
The URL for a submodule. This variable is copied from the .gitmodules
2830+
file to the git config via 'git submodule init'. The user can change
2831+
the configured URL before obtaining the submodule via 'git submodule
2832+
update'. After obtaining the submodule, the presence of this variable
2833+
is used as a sign whether the submodule is of interest to git commands.
2834+
See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
28342835

28352836
submodule.<name>.update::
28362837
The default update procedure for a submodule. This variable

0 commit comments

Comments
 (0)