[PATCH] Documentation: consolidate submodule.<name>.update
- From
Stefan Beller <sbeller@google.com>
- Date
- Sep 25, 2017, 19:10 UTC
- Message-ID
- <20170925191011.29863-1-sbeller@google.com>
- In-Reply-To
- <xmqq1smxj7md.fsf@gitster.mtv.corp.google.com>
Have one place to explain the effects of setting submodule.<name>.update instead of two.
Signed-off-by: Stefan Beller <sbeller@google.com> ---
Show 5 quoted lines
>> I disagree. Actually, I think the git-config(1) blurb could just >> point here, and that the text here ought to be clear about what >> commands it affects and how an end user would use it. > > I tend to agree with the consolidation.
Something like this?
Documentation/config.txt | 9 +-------- Documentation/gitmodules.txt | 20 +++++++++++--------- 2 files changed, 12 insertions(+), 17 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt index 1ac0ae6adb..0d5a296b6c 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -3085,14 +3085,7 @@ submodule.<name>.url:: See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details. submodule.<name>.update:: - The method by which a submodule is updated by 'git submodule update', - which is the only affected command, others such as - 'git checkout --recurse-submodules' are unaffected. It exists for - historical reasons, when 'git submodule' was the only command to - interact with submodules; settings like `submodule.active` - and `pull.rebase` are more specific. It is populated by - `git submodule init` from the linkgit:gitmodules[5] file. - See description of 'update' command in linkgit:git-submodule[1]. + See `submodule.<name>.update` in linkgit:gitmodules[5]. submodule.<name>.branch:: The remote branch name for a submodule, used by `git submodule diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt index db5d47eb19..d156dee387 100644 --- a/Documentation/gitmodules.txt +++ b/Documentation/gitmodules.txt @@ -38,15 +38,17 @@ submodule.<name>.url:: In addition, there are a number of optional keys: submodule.<name>.update:: - Defines the default update procedure for the named submodule, - i.e. how the submodule is updated by "git submodule update" - command in the superproject. This is only used by `git - submodule init` to initialize the configuration variable of - the same name. Allowed values here are 'checkout', 'rebase', - 'merge' or 'none'. See description of 'update' command in - linkgit:git-submodule[1] for their meaning. Note that the - '!command' form is intentionally ignored here for security - reasons. + The method by which a submodule is updated by 'git submodule update', + which is the only affected command, others such as + 'git checkout --recurse-submodules' are unaffected. It exists for + historical reasons, when 'git submodule' was the only command to + interact with submodules; settings like `submodule.active` + and `pull.rebase` are more specific. It is copied to the config + by `git submodule init` from the .gitmodules file. + Allowed values here are 'checkout', 'rebase', 'merge' or 'none'. + See description of 'update' command in linkgit:git-submodule[1] + for their meaning. Note that the '!command' form is intentionally + ignored here for security reasons. submodule.<name>.branch:: A remote branch name for tracking updates in the upstream submodule.
-- 2.14.0.rc0.3.g6c2e499285