git submodule sync command - what is it for?

git git-submodules
Narek picture Narek · Nov 16, 2015 · Viewed 13.7k times · Source

I don't understand from the documentation what does git submodule sync do. Please explain.

Answer

db48x picture db48x · Nov 16, 2015

Git stores information about submodules in two places. The first is in a file called .gitmodules, which is checked in to the git repository. Changes to this file are what get propagated to other repositories.

The other location is in .git/config, and it's where git actually looks when performing most commands.

So imagine you've worked on a project for a while, and there's a submodule called foo. Files for this submodule are checked out from some url, it doesn't really matter where. At some point, however, this url changes. Perhaps it changes so that the submodule is checked out from a different server, or a different path or whatever. When you update your repository your copy of the .gitmodules file will be updated, but not your .git/config file; you would still be checking out from the old url. When you want to start checking out from the new url, you would run git submodule sync to copy the new configuration from .gitmodules to .git/config. Git doesn't do this automatically because you might have made your own changes to your configuration, and it wouldn't want to overwrite them.

Related questions

Easy way to pull latest of all git submodules

We're using git submodules to manage a couple of large projects that have dependencies on many other libraries we've developed. Each library is a separate repo brought into the dependent project as a submodule. During development, we often want to …

Read More
How to "git clone" including submodules?

I'm trying to put a submodule into a repo. The problem is that when I clone the parent repo, the submodule folder is entirely empty. Is there any way to make it so that git clone parent_repo actually puts …

Read More
How do I remove a submodule?

How do I remove a Git submodule? By the way, is there a reason I can't simply do git submodule rm whatever ?

Read More