[PATCHv2] documentation: improve submodule.<name>.{url, path} description
- From
Stefan Beller <sbeller@google.com>
- Date
- Oct 10, 2016, 19:36 UTC
- Message-ID
- <20161010193641.16489-1-sbeller@google.com>
- In-Reply-To
- <xmqqshs4dnq1.fsf@gitster.mtv.corp.google.com>
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> ---
I think the gitmodules[5] is enough for .path, so let's just do this one instead.
Thanks, Stefan
Documentation/config.txt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt index e78293b..fd775b4 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -2811,12 +2811,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
-- 2.10.1.382.ga23ca1b.dirty