Merge branch 'mg/reset-doc' into maint
[gitweb.git] / Documentation / gitmodules.txt
index 72a13d18e019ef00de0e8a79bbe5fe4651ab8dba..bcffd95ada574a8fb3c6e62e539e736a17170414 100644 (file)
@@ -44,6 +44,21 @@ submodule.<name>.update::
        This config option is overridden if 'git submodule update' is given
        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
 --------