Add the 'fetch.recurseSubmodules' config setting
[gitweb.git] / Documentation / gitmodules.txt
index 1b67f0a9f12974afca2e8e6948d0fca564b9b17b..bcffd95ada574a8fb3c6e62e539e736a17170414 100644 (file)
@@ -29,15 +29,35 @@ submodule.<name>.path::
 
 submodule.<name>.url::
        Defines an url from where the submodule repository can be cloned.
+       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.
+       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 '--rebase' option.
+       the '--merge' or '--rebase' options.
+
+submodule.<name>.ignore::
+       Defines under what circumstances "git status" and the diff family show
+       a submodule as modified. When set to "all", it will never be considered
+       modified, "dirty" will ignore all changes to the submodules work tree and
+       takes only differences between the HEAD of the submodule and the commit
+       recorded in the superproject into account. "untracked" will additionally
+       let submodules with modified tracked files in their work tree show up.
+       Using "none" (the default when this option is not set) also shows
+       submodules that have untracked files in their work tree as changed.
+       If this option is also present in the submodules entry in .git/config of
+       the superproject, the setting there will override the one found in
+       .gitmodules.
+       Both settings can be overridden on the command line by using the
+       "--ignore-submodule" option.
 
 
 EXAMPLES