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 <manishsmail@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Manish Goregaokar committed
Nov 23, 2019 at 05:54 UTC
8d483c840836ef2508741cf1592c285a2cba4552
1 file changed
+3
Documentation/git-submodule.txt
+3
@@ -80,6 +80,9 @@ status [--cached] [--recursive] [--] [<path>...]::
80
does not match the SHA-1 found in the index of the containing
81
repository and `U` if the submodule has merge conflicts.
82
+
83
+If `--cached` is specified, this command will instead print the SHA-1
84
+recorded in the superproject for each submodule.
85
++
86
If `--recursive` is specified, this command will recurse into nested
87
submodules, and show their status as well.
88
+