Subject: [PATCH 1/1] Documentation: Correct man page for the SHAs reported by 'submodule status'

From: "Manish Goregaokar via GitGitGadget" <[email-masked]>
Date: Fri, 22 Nov 2019 23:11:25 +0000

From: Manish Goregaokar <[email-masked]>

'git submodule status' reports the SHAs expected by the parent project,
not the SHAs that are actually checked out in the submodule. Checking
out a new SHA in a submodule will not change the output of 'git
submodule status' until you 'git add' the submodule.

Signed-off-by: Manish Goregaokar <[email-masked]>
---
 Documentation/git-submodule.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 0ed5c24dc1..31e089454a 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -72,8 +72,8 @@ git-submodule will correctly locate the submodule using the relative
 URL in `.gitmodules`.
 
 status [--cached] [--recursive] [--] [<path>...]::
-	Show the status of the submodules. This will print the SHA-1 of the
-	currently checked out commit for each submodule, along with the
+	Show the status of the submodules. This will print the SHA-1
+	recorded in the superproject for each submodule, along with the
 	submodule path and the output of 'git describe' for the
 	SHA-1. Each SHA-1 will possibly be prefixed with `-` if the submodule is
 	not initialized, `+` if the currently checked out submodule commit
-- 
gitgitgadget