Cloning with submodules in Git - Step-by-Step Execution

Process Flow - Cloning with submodules

Start: git clone main repo

↓

Clone main repo files

↓

Detect .gitmodules file

↓

Initialize submodules

↓

Clone each submodule repo

↓

Checkout submodule commits

↓

Finish: main repo + submodules ready

This flow shows how git clones a main repository and then initializes and clones its submodules step-by-step.

Execution Sample

Git

git clone --recurse-submodules https://github.com/example/project.git

Clones the main repository and all its submodules in one command.

Process Table

Step	Action	Result	Details
1	Start cloning main repo	Main repo files start downloading	git connects to remote and downloads main repo data
2	Main repo cloned	Main repo files present locally	Working directory has main repo files including empty submodule directories
3	Detect .gitmodules file	Found submodule config	File lists submodule URLs and paths
4	Initialize submodules	Submodules initialized	Submodule configurations initialized from .gitmodules
5	Clone submodule repos	Submodule repos cloned inside main repo	Each submodule repo is cloned into its folder
6	Checkout submodule commits	Submodules at correct commit	Submodules checked out to commit recorded by main repo
7	Finish	Main repo and submodules ready	Full project with submodules is ready to use

💡 All submodules cloned and checked out to correct commits, cloning process complete

Status Tracker

Variable	Start	After Step 2	After Step 5	Final
main_repo_files	empty	present	present	present
submodule_dirs	none	created	populated	populated
submodule_repos	none	none	cloned	checked out

Key Moments - 3 Insights

Why do submodule directories appear empty right after cloning the main repo?

Because submodules are separate repositories, they are not cloned with the main repo initially (see execution_table step 2 and 4). They are initialized and cloned in later steps.

What does the --recurse-submodules option do?

It tells git to clone the main repo and automatically initialize and clone all submodules in one command (see execution_table steps 3 to 6).

Why must submodules be checked out to specific commits?

Because the main repo records exact commits for submodules to ensure compatibility. Git checks out those commits after cloning (see execution_table step 6).

Visual Quiz - 3 Questions

Look at the execution table, at which step are submodule repositories cloned?

A Step 2

B Step 3

C Step 5

D Step 7

💡 Hint

Check the 'Action' column for cloning submodules in the execution_table.

According to the variable tracker, when do submodule directories get created?

A At Start

B After Step 2

C After Step 4

D After Step 5

💡 Hint

Look at 'submodule_dirs' row and see when it changes from 'none' to 'created'.

If you omit --recurse-submodules, what will happen after cloning?

A Submodule directories will be empty

B Submodules will be cloned automatically

C Main repo will not clone

D Submodules will be checked out to wrong commits

💡 Hint

Refer to the explanation in key_moments about submodule directories after cloning main repo.

Concept Snapshot

git clone --recurse-submodules <repo_url>
- Clones main repo and all submodules
- Detects .gitmodules file
- Initializes and clones submodules
- Checks out submodules to recorded commits
- Ensures full project with dependencies ready

Full Transcript

Cloning a git repository with submodules involves first cloning the main repository files. Then git detects the .gitmodules file which lists submodules. It initializes empty directories for submodules and clones each submodule repository inside the main repo. Finally, git checks out each submodule to the commit recorded by the main repo. Using the --recurse-submodules option automates this entire process in one command, ensuring the full project including submodules is ready to use after cloning.