Merge branch 'ph/submodule-rebase' (early part)

[git.git] / Documentation / gitmodules.txt

diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index cc95b69f27c3d4b5437fa15e3d1e825a7ae8576e..1b67f0a9f12974afca2e8e6948d0fca564b9b17b 100644 (file)
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -7,7 +7,7 @@ gitmodules - defining submodule properties
 
 SYNOPSIS
 --------
-gitmodules
+$GIT_WORK_DIR/.gitmodules
 
 
 DESCRIPTION
@@ -30,6 +30,15 @@ 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.
+       This config option is overridden if 'git submodule update' is given
+       the '--rebase' option.
+
 
 EXAMPLES
 --------
@@ -59,4 +68,4 @@ Documentation by Lars Hjemli <hjemli@gmail.com>
 
 GIT
 ---
-Part of the linkgit:git[7] suite
+Part of the linkgit:git[1] suite