diff options
| author | Junio C Hamano <gitster@pobox.com> | 2015-03-13 22:56:03 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2015-03-13 22:56:03 -0700 |
| commit | 30a52c1dcbb286214a0d59fb4b3df1d13d9d060d (patch) | |
| tree | c50c7c6212f91a6adc78dc1c102bdb26aad55944 /Documentation/gitmodules.txt | |
| parent | 5244a31039dbb3fe0d544fc56100d0ccbc653131 (diff) | |
| parent | 5c31acfbe22cebdf1a04723b58cdb358e377632a (diff) | |
| download | git-30a52c1dcbb286214a0d59fb4b3df1d13d9d060d.tar.xz | |
Merge branch 'ms/submodule-update-config-doc' into maint
The interaction between "git submodule update" and the
submodule.*.update configuration was not clearly documented.
* ms/submodule-update-config-doc:
submodule: improve documentation of update subcommand
Diffstat (limited to 'Documentation/gitmodules.txt')
| -rw-r--r-- | Documentation/gitmodules.txt | 21 |
1 files changed, 9 insertions, 12 deletions
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt index f6c0dfd029..ac70eca321 100644 --- a/Documentation/gitmodules.txt +++ b/Documentation/gitmodules.txt @@ -38,18 +38,15 @@ submodule.<name>.url:: In addition, there are a number of optional keys: submodule.<name>.update:: - Defines what to do when the submodule is updated by the superproject. - If 'checkout' (the default), the new commit specified in the - superproject will be checked out in the submodule on a detached HEAD. - If 'rebase', the current branch of the submodule will be rebased onto - the commit specified in the superproject. If 'merge', the commit - specified in the superproject will be merged into the current branch - in the submodule. - If 'none', the submodule with name `$name` will not be updated - by default. - - This config option is overridden if 'git submodule update' is given - the '--merge', '--rebase' or '--checkout' options. + 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. submodule.<name>.branch:: A remote branch name for tracking updates in the upstream submodule. |