Submodule status and sync in Git - Step-by-Step Execution

Process Flow - Submodule status and sync

Check submodule status

↓

Identify changes or updates

↓

Run sync to update URLs

↓

Update submodules to correct commit

↓

Confirm submodules are up-to-date

↓

END

This flow shows checking submodule status, syncing URLs, updating submodules, and confirming they are current.

Execution Sample

Git

git submodule status
# Shows current commit and state of submodules

git submodule sync
# Updates submodule URLs from .gitmodules

git submodule update --init --recursive
# Updates submodules to correct commits

This sequence checks submodule status, syncs URLs, and updates submodules to the right commits.

Process Table

Step	Command Run	Action	Output / Result
1	git submodule status	Check current submodule commits and states	3f4e2a1 submoduleA (heads/main) -9f8e7d6 submoduleB (detached HEAD)
2	git submodule sync	Update submodule URLs from .gitmodules	Synchronizing submodule url for 'submoduleA' Synchronizing submodule url for 'submoduleB'
3	git submodule update --init --recursive	Update submodules to correct commits	Submodule path 'submoduleA': checked out '3f4e2a1' Submodule path 'submoduleB': checked out '1a2b3c4'
4	git submodule status	Verify submodules are up-to-date	3f4e2a1 submoduleA (heads/main) 1a2b3c4 submoduleB (heads/main)
5	END	All submodules synced and updated	No further action needed

💡 All submodules are now synchronized and updated to the correct commits.

Status Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	After Step 4	Final
submoduleA commit	unknown	3f4e2a1	3f4e2a1	3f4e2a1	3f4e2a1	3f4e2a1
submoduleB commit	unknown	-9f8e7d6 (detached)	-9f8e7d6 (detached)	1a2b3c4 (updated)	1a2b3c4	1a2b3c4
submodule URLs	from .gitmodules	from .gitmodules	synced	synced	synced	synced

Key Moments - 3 Insights

Why does 'git submodule status' show a commit with a '-' sign before it?

The '-' means the submodule is not at the commit recorded in the main repo. See Step 1 in execution_table where submoduleB shows '-9f8e7d6', indicating it is detached or out of sync.

What does 'git submodule sync' actually do?

It updates the URLs of submodules from the .gitmodules file to the local config. This is shown in Step 2 where URLs are synchronized before updating commits.

Why run 'git submodule update --init --recursive' after syncing?

Because syncing only updates URLs, but update fetches and checks out the correct commits for submodules. Step 3 shows submodules being checked out to the right commits.

Visual Quiz - 3 Questions

Look at the execution table, what is the submoduleB commit status after Step 1?

A -9f8e7d6 (detached HEAD)

B 3f4e2a1 (up-to-date)

C 1a2b3c4 (updated)

D unknown

💡 Hint

Check the 'After Step 1' column in variable_tracker for submoduleB commit.

At which step does the submoduleB commit get updated to the correct commit?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look at execution_table Step 3 where submoduleB is checked out to '1a2b3c4'.

If you skip 'git submodule sync', what problem might occur?

A Submodules will update correctly anyway

B Submodule URLs might be outdated causing fetch errors

C Main repo commit will change

D Nothing happens, sync is optional

💡 Hint

Refer to key_moments about what 'git submodule sync' does and Step 2 in execution_table.

Concept Snapshot

git submodule status
  # Shows current commit and state of each submodule

git submodule sync
  # Updates submodule URLs from .gitmodules to local config

git submodule update --init --recursive
  # Fetches and checks out submodules to correct commits

Use status to check, sync to fix URLs, update to apply commits.

Full Transcript

This visual execution shows how to manage git submodules by checking their status, syncing URLs, and updating them. First, 'git submodule status' lists each submodule's commit and state. If a submodule is out of sync, it shows a '-' sign. Next, 'git submodule sync' updates the URLs from the .gitmodules file to the local config, ensuring the submodules point to the right remote repositories. Then, 'git submodule update --init --recursive' fetches and checks out the submodules to the commits recorded in the main repository. Finally, running 'git submodule status' again confirms all submodules are up-to-date. This process helps keep submodules correctly linked and at the right versions.