aboutsummaryrefslogtreecommitdiff
path: root/Documentation/diff-config.txt
diff options
context:
space:
mode:
authorJens Lehmann <Jens.Lehmann@web.de>2013-09-11 21:07:15 +0200
committerJunio C Hamano <gitster@pobox.com>2013-09-11 12:20:41 -0700
commitbb58b696c6ad810560d361b640580715a90382cb (patch)
treebbd12e705f39ff3a9f8f34cada4b933616db8682 /Documentation/diff-config.txt
parent927b26f87a5654349b87d3217ed8e9360d9ff798 (diff)
downloadgit-bb58b696c6ad810560d361b640580715a90382cb.tar.gz
git-bb58b696c6ad810560d361b640580715a90382cb.tar.xz
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 <Matthieu.Moy@grenoble-inp.fr> Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/diff-config.txt')
-rw-r--r--Documentation/diff-config.txt6
1 files changed, 5 insertions, 1 deletions
diff --git a/Documentation/diff-config.txt b/Documentation/diff-config.txt
index ac7705025..223b9310d 100644
--- a/Documentation/diff-config.txt
+++ b/Documentation/diff-config.txt
@@ -73,7 +73,11 @@ diff.ignoreSubmodules::
Sets the default value of --ignore-submodules. Note that this
affects only 'git diff' Porcelain, and not lower level 'diff'
commands such as 'git diff-files'. 'git checkout' also honors
- this setting when reporting uncommitted changes.
+ this setting when reporting uncommitted changes. Setting it to
+ 'all' disables the submodule summary normally shown by 'git commit'
+ and 'git status' when 'status.submodulesummary' is set unless it is
+ overridden by using the --ignore-submodules command line option.
+ The 'git submodule' commands are not affected by this setting.
diff.mnemonicprefix::
If set, 'git diff' uses a prefix pair that is different from the