| Message ID | 0eabb27ba0c7a07bbf24f13f1766c0ff63995348.1574464285.git.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | doc: Correct man page for the SHAs reported by 'submodule status' | expand |
"Manish Goregaokar via GitGitGadget" <gitgitgadget@gmail.com> writes: > From: Manish Goregaokar <manishsmail@gmail.com> > > '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 <manishsmail@gmail.com> > --- > 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 Am I mistaken to say that neither the old or the new description is correct, depending on the use (or non-use) of the --cached option? ... print the object name of the commit that is currently checked out, or the commit that is recorded in the superproject if `--cached` option is given, for each submodule, ... perhaps?
Turns out that I've found a bug! I was getting this behavior because it wasn't detecting that submodules were modified. I'll submit a patch shortly, but first fix this one since the documentation should be fixed regardless. Thanks, -Manish Goregaokar -Manish Goregaokar On Fri, Nov 22, 2019 at 5:21 PM Junio C Hamano <gitster@pobox.com> wrote: > > "Manish Goregaokar via GitGitGadget" <gitgitgadget@gmail.com> > writes: > > > From: Manish Goregaokar <manishsmail@gmail.com> > > > > '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 <manishsmail@gmail.com> > > --- > > 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 > > Am I mistaken to say that neither the old or the new description is > correct, depending on the use (or non-use) of the --cached option? > > ... print the object name of the commit that is currently > checked out, or the commit that is recorded in the > superproject if `--cached` option is given, for each > submodule, ... > > perhaps?
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