submodule: Fix documentation of update subcommand

[git.git] / Documentation / gitmodules.txt

diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index f6c0dfd0290a9b2174c645630998d2a62cdb9f5e..59efbfe8ae1d76a24e2f81f26cbee97738e124ce 100644 (file)
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -38,18 +38,12 @@ 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 what to do when the submodule is updated by the
+       superproject. This is only used by `git submodule init` to
+       initialize the variable of the same name in .git/config.
+       Allowed values here are 'checkout', 'rebase', 'merge' or
+       'none'. See linkgit:git-config[1] for their meaning and other
+       values that can be configured manually by users.
 
 submodule.<name>.branch::
        A remote branch name for tracking updates in the upstream submodule.