summaryrefslogtreecommitdiff
path: root/Documentation/git-status.txt
diff options
context:
space:
mode:
authorPing Yin <pkufranky@gmail.com>2008-04-12 23:05:32 +0800
committerJunio C Hamano <gitster@pobox.com>2008-04-12 20:00:45 -0700
commitac8d5afca6931aa005aff873e4f490ff5050fc76 (patch)
treebb892b0ccc125a5912e6910b0bc31c3caa63f933 /Documentation/git-status.txt
parentd0f64dd44d5f708f77380998b2c16bffe1e94050 (diff)
downloadgit-ac8d5afca6931aa005aff873e4f490ff5050fc76.tar.gz
builtin-status: submodule summary support
This commit teaches 'git commit/status' show a new 'Modified submodules' section, which is an output from: git submodule summary --cached --for-status --summary-limit <limit> just before the 'Untracked files' section. The <limit> is given by the config variable status.submodulesummary to limit the submodule summary size. status.submodulesummary is a bool/int variable with value: - false or 0 by default to disable the summary, or - positive number to limit the summary size, or - true or negative number to unlimit the summary size. Also mention status.submodulesummary in the documentation. Signed-off-by: Ping Yin <pkufranky@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-status.txt')
-rw-r--r--Documentation/git-status.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 3ea269aa7a..ea4376a17f 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -52,6 +52,11 @@ If the config variable `status.relativePaths` is set to false, then all
paths shown are relative to the repository root, not to the current
directory.
+If `status.submodulesummary` is set to a non zero number or true (identical
+to -1 or an unlimited number), the submodule summary will be enabled and a
+summary of commits for modified submodules will be shown (see --summary-limit
+option of linkgit:git-submodule[1]).
+
See Also
--------
linkgit:gitignore[5]