Submodules: Add the new "ignore" config option for diff and status
[gitweb.git] / Documentation / git-status.txt
index 2fd054c1040ce43949382e4744a0d7a814a8d9bd..a7a5d79416aea3df31bfed22b1af52098aa79067 100644 (file)
@@ -55,7 +55,11 @@ specified.
 
 --ignore-submodules[=<when>]::
        Ignore changes to submodules when looking for changes. <when> can be
-       either "untracked", "dirty" or "all", which is the default. When
+       either "none", "untracked", "dirty" or "all", which is the default.
+       Using "none" will consider the submodule modified when it either contains
+       untracked or modified files or its HEAD differs from the commit recorded
+       in the superproject and can be used to override any settings of the
+       'ignore' option in linkgit:git-config[1]. When
        "untracked" is used submodules are not considered dirty when they only
        contain untracked content (but they are still scanned for modified
        content). Using "dirty" ignores all changes to the work tree of submodules,