diff mbox series

[v2,1/1] doc: Document 'git submodule status --cached'

Message ID 3168924c3c6f12a293b25a00f333a55d4b8fa3a9.1574488468.git.gitgitgadget@gmail.com (mailing list archive)
State New, archived
Headers show
Series doc: Document 'git submodule status --cached' | expand

Commit Message

Koji Nakamaru via GitGitGadget Nov. 23, 2019, 5:54 a.m. UTC 
From: Manish Goregaokar <manishsmail@gmail.com>

'git submodule status --cached' reports the SHAs expected by the parent project,
instead of the SHAs that are actually checked out in the submodule.

Signed-off-by: Manish Goregaokar <manishsmail@gmail.com>
---
 Documentation/git-submodule.txt | 3 +++
 1 file changed, 3 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 0ed5c24dc1..f05c2b92fb 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.
 +