remote: fix set-branches usage and documentation

[git.git] / Documentation / gitmodules.txt

diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index d1a17e2625890245341a2099cc2b058e63564da2..5daf750d1942f3b97844b4ef378daf9346cb46d4 100644 (file)
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -30,6 +30,17 @@ submodule.<name>.path::
 submodule.<name>.url::
        Defines an url from where the submodule repository can be cloned.
 
+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.
+       This config option is overridden if 'git submodule update' is given
+       the '--merge' or '--rebase' options.
+
 
 EXAMPLES
 --------