path: root/Documentation/gitmodules.txt
diff options
authorJens Lehmann <>2013-09-11 19:07:15 (GMT)
committerJunio C Hamano <>2013-09-11 19:20:41 (GMT)
commitbb58b696c6ad810560d361b640580715a90382cb (patch)
treebbd12e705f39ff3a9f8f34cada4b933616db8682 /Documentation/gitmodules.txt
parent927b26f87a5654349b87d3217ed8e9360d9ff798 (diff)
Improve documentation concerning the status.submodulesummary setting
'git status' and 'git commit' can be told to also show the output of "git submodule summary" by setting the "status.submodulesummary" config option. But status and commit also honor the "diff.ignoreSubmodules" and the "submodule.<name>.ignore" settings, which then disable the summary partly or completely. This - and the fact that the last two settings do not affect the "git submodule" commands at all - is not well documented. Extend the documentation in those places where "status.submodulesummary", "diff.ignoreSubmodules" and "submodule.<name>.ignore" are described to better explain these dependencies. Thanks-to: Matthieu Moy <> Signed-off-by: Jens Lehmann <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/gitmodules.txt')
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index 6a1ca4a..f7be93f 100644
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -75,7 +75,8 @@ submodule.<name>.ignore::
the superproject, the setting there will override the one found in
Both settings can be overridden on the command line by using the
- "--ignore-submodule" option.
+ "--ignore-submodule" option. The 'git submodule' commands are not
+ affected by this setting.