path: root/Documentation/gitmodules.txt
diff options
authorHeiko Voigt <>2012-05-10 18:59:04 (GMT)
committerJunio C Hamano <>2012-05-11 15:39:33 (GMT)
commite6a1c43aafa8b221e05e57132549dcb3cd7866cf (patch)
tree7155a2ea13e984a1b2ffb34635882cc16eba359a /Documentation/gitmodules.txt
parent5ad3e16a6f075deff3cddd6d12ae89fafb0c718d (diff)
document submdule.$name.update=none option for gitmodules
This option was not yet described in the gitmodules documentation. We only described it in the 'git submodule' command documentation but gitmodules is the more natural place to look. A short reference in the 'git submodule' documentation should be sufficient since the details can now be found in the documentation to gitmodules. Signed-off-by: Heiko Voigt <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/gitmodules.txt')
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index 4e1fd52..4effd78 100644
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -41,8 +41,11 @@ submodule.<name>.update::
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' or '--rebase' options.
+ the '--merge', '--rebase' or '--checkout' options.
This option can be used to control recursive fetching of this