Git Submodules. Pulling into a new clone of the super-project

Question

OK. So I thought I had this licked ... but now ....

I have a project which includes one small library from GitHub as a submodule. In the original version of that super-project the submodule is working as expected.

However, I just cloned the superproject, did what I thought I should : "git submodule init", got the directory of the submodule to appear, but it's empty.

If I now try to do

git submodule update

I get

fatal: Needed a single revision 
Unable to find current revision in submodule path 'external_libraries/BEACHhtml'

If I try

git submodule foreach git pull

I get

Entering 'external_libraries/BEACHhtml'
fatal: Where do you want to fetch from today?
Stopping at 'external_libraries/BEACHhtml'; script returned non-zero status.

In my .git/config, I have this :

[submodule "external_libraries/BEACHhtml"]
    url = [email protected]:interstar/BEACHhtml.git

In my .gitmodules I have this :

[submodule "external_libraries/BEACHhtml"]
path = external_libraries/BEACHhtml
url = [email protected]:interstar/BEACHhtml.git

Anyone got an idea what's missing?

Scutum

Answer 1

It seems that now (in 2019) installing latest GIT client could solve the problem according to comments below. This should be the best solution for now.

---

I have the same problem as you. This is a bug in git: http://git.661346.n2.nabble.com/BUG-git-submodule-update-is-not-fail-safe-td7574168.html

In short, for your problem, try:

# rm -rf external_libraries/BEACHhtml
# git submodule update

It seems there is something wrong with the previous checkout folder, remove it, and update again solves the problem.

Barye

for me it was a hanged git-fetch that was keeping the folder locked – Diathermic

I had to remove both the submodule worktree (ext/blah) and the matching folder below the GIT_DIR (.git/modules/ext/blah). – Scutch

This looks like a sad thing to do. Fortunately the devs are aware of the problem and hopeful it will be fixed: lists-archives.com/git/… – Readability

solved for me too. My problem was the there weren't enough permissions to lock the config file, and it stopped too late, fetching an empty library. – Freeliving

The failure to clone the submodule caused the clone of the top-level repo to not complete, i.e. I had the README.md but not a subdirectory that was part of the repo. After I re-updated the submodule, I then had to run git reset --hard in the top level to get everything. – Manamanacle

That link is broken - @tokland's link in the comments seems relatively informative - that is an unsuccessful git submodule update junks the directory and must be removed before trying again. – Uke

In my particular case git submodule update kept failing on my CI server because it wanted somebody to accept the RSA keys (ci server normally uses https connection and this was the first time a submodule had pulled in ssh connection). Hope it saves somebody an hour of head scratching! – Namhoi

In 2016 this bug still goes on :( – Prorogue

2017 checking in, still present. – Susysuter

Found the reason this happens for me, if you use git submodule update --init and get your authentication details wrong – Clarinda

Nope, guys, in 2019 you need to INSTALL FRESH GIT. Incrementing year is not enough. – Worshipful

The URL for the mailing list reference is broken. lists-archives.com server not found. – Surgeonfish

Answer 2

Solved by deleting 2 directories and refetching submodule:

1. Go to external_libraries/BEACHhtml and look into .git file. It's content should be something like gitdir: ../../.git/modules/external_libraries/BEACHhtml
2. Delete both external_libraries/BEACHhtml and .git/modules/external_libraries/BEACHhtml directories.

From now on git submodule update runs without errors.

Lynnette

you may need to run git submodule init before git submodule update so that the submodule is re-initialized, then this will work. – Adherent

Answer 3

I had this problem (flaky network so I got dropped submodule checkout like this) and I solved it by making this script (named it git-submodule-fix so I could run it as git submodule-fix)

#!/bin/bash 

for arg 
do 
  echo $arg 
  find . -name "`basename $arg`" | grep "$arg\$" | xargs rm -fr
done

If you get this i.e. from a git submodule update

fatal: Needed a single revision
Unable to find current revision in submodule path 'some/submodule/path'

do

git submodule-fix some/submodule/path
git submodule update

Darondarooge

Answer 4

If you are reading in 2019 or later, just update the git client. Worked for me.

Worshipful

Answer 5

I ran into this in 2021 when I got into a detached HEAD state between commits from the sub-module repo's source and it's version in the 'calling' main repo.

this answer helped --> How do I fix a Git detached head?

And I verified this strategy with new changes to the sub-module repo

1. $ cd <into the sub-module dir within the calling/main repo>
2. $ git pull --> the sub-module repo brings in any changes from it's source
3. $ cd <back into the calling/main repo>
4. $ git status --> should show new changes to be committed for the sub-module repo

Emerald

Answer 6

use a diff tool to compare the original clone that's working and this one. Also, what does git submodule output. Ensure you are pointing to the same branch in each repo before you do.

I'm suspecting that you've switched to a branch or older revision where the submodule was not defined.

hope this helps

Introrse

Answer 7

I had the same issue with a submodule on a project. When I tried to clone the submodule separately it worked well.

I've tried all of the answers above, but without success (git submodule update, ..., removing the submodule folders, ...).

The issue disappeared after update of git (from Git-1.7.11-preview20120710) to latest version (to Git-1.8.1.2-preview20130201) at the time. Strangely my colleagues had even older version, worked without any issues, but they were on Mac. I'm on Win7 64bit.

Adey