parse-options: clarify PARSE_OPT_NOARG description
[gitweb.git] / Documentation / gitmodules.txt
index 7c22c409497cbfa403d108e6009ca000acaf771f..72a13d18e019ef00de0e8a79bbe5fe4651ab8dba 100644 (file)
@@ -29,9 +29,20 @@ submodule.<name>.path::
 
 submodule.<name>.url::
        Defines an url from where the submodule repository can be cloned.
-
-submodule.<name>.rebase::
-       Defines that the submodule should be rebased by default.
+       This may be either an absolute URL ready to be passed to
+       linkgit:git-clone[1] or (if it begins with ./ or ../) a location
+       relative to the superproject's origin repository.
+
+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