gitmodules: clarify the ignore option values
Add more structure and describe each possible option in a self-contained way, not referring to any of the previously described options. Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Sebastian Schuberth committed
Apr 19, 2017 at 09:15 UTC
61e282425abd78605524322f05a49866b2c9e70e
1 file changed
+20
-11
Documentation/gitmodules.txt
+20
-11
@@ -66,17 +66,26 @@ submodule.<name>.fetchRecurseSubmodules::
66
67
submodule.<name>.ignore::
68
Defines under what circumstances "git status" and the diff family show
69
- a submodule as modified. When set to "all", it will never be considered
70
- modified (but will nonetheless show up in the output of status and
71
- commit when it has been staged), "dirty" will ignore all changes
72
- to the submodules work tree and
73
- takes only differences between the HEAD of the submodule and the commit
74
- recorded in the superproject into account. "untracked" will additionally
75
- let submodules with modified tracked files in their work tree show up.
76
- Using "none" (the default when this option is not set) also shows
77
- submodules that have untracked files in their work tree as changed.
78
- If this option is also present in the submodules entry in .git/config of
79
- the superproject, the setting there will override the one found in
69
+ a submodule as modified. The following values are supported:
70
+
71
+ all;; The submodule will never be considered modified (but will
72
+ nonetheless show up in the output of status and commit when it has
73
+ been staged).
74
+
75
+ dirty;; All changes to the submodule's work tree will be ignored, only
76
+ committed differences between the HEAD of the submodule and its
77
+ recorded state in the superproject are taken into account.
78
+
79
+ untracked;; Only untracked files in submodules will be ignored.
80
+ Committed differences and modifications to tracked files will show
81
+ up.
82
+
83
+ none;; No modifiations to submodules are ignored, all of committed
84
+ differences, and modifications to tracked and untracked files are
85
+ shown. This is the default option.
86
+
87
+ If this option is also present in the submodules entry in .git/config
88
+ of the superproject, the setting there will override the one found in
89
.gitmodules.
90
Both settings can be overridden on the command line by using the
91
"--ignore-submodule" option. The 'git submodule' commands are not