path: root/Documentation/git-submodule.txt
diff options
authorManish Goregaokar <>2019-11-23 05:54:28 (GMT)
committerJunio C Hamano <>2019-11-24 04:52:29 (GMT)
commit8d483c840836ef2508741cf1592c285a2cba4552 (patch)
tree557dba3fc0413c3175b6f8aae00144148b076dba /Documentation/git-submodule.txt
parent5fa0f5238b0cd46cfe7f6fa76c3f526ea98148d9 (diff)
doc: document 'git submodule status --cached'
'git submodule status --cached' reports the SHAs recorded in the index of the superproject, instead of the SHAs that are checked out in the submodule. Signed-off-by: Manish Goregaokar <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-submodule.txt')
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 0ed5c24..f05c2b9 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -80,6 +80,9 @@ status [--cached] [--recursive] [--] [<path>...]::
does not match the SHA-1 found in the index of the containing
repository and `U` if the submodule has merge conflicts.
+If `--cached` is specified, this command will instead print the SHA-1
+recorded in the superproject for each submodule.
If `--recursive` is specified, this command will recurse into nested
submodules, and show their status as well.