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.

Practice

1. What does the command git clone --recurse-submodules <repo_url> do?

easy

A. Clones the main repository and all its submodules in one step

B. Clones only the main repository without any submodules

C. Updates submodules after cloning the main repository

D. Removes submodules from the cloned repository

Solution

1. Step 1: Understand the purpose of --recurse-submodules

   The option tells Git to clone the main repo and all submodules recursively in one command.

2. Step 2: Compare with cloning without this option

   Without it, only the main repo is cloned; submodules need separate commands to fetch.

3. Final Answer:

   Clones the main repository and all its submodules in one step -> Option A

4. Quick Check:

   --recurse-submodules = clone main + submodules [OK]

Hint: Use --recurse-submodules to clone all at once [OK]

Common Mistakes:

• Thinking it clones only the main repo
• Confusing update with clone
• Assuming it removes submodules

2. Which of the following is the correct command to clone a repository along with its submodules?

easy

A. git clone --update-submodules https://example.com/repo.git

B. git clone --init-submodules https://example.com/repo.git

C. git clone --recurse-submodules https://example.com/repo.git

D. git clone --submodule-update https://example.com/repo.git

Solution

1. Step 1: Identify the correct flag for cloning with submodules

   The correct flag is --recurse-submodules to clone main repo and submodules together.

2. Step 2: Check other options for validity

   Options --init-submodules, --update-submodules, and --submodule-update are not valid git clone flags.

3. Final Answer:

   git clone --recurse-submodules https://example.com/repo.git -> Option C

4. Quick Check:

   --recurse-submodules is the correct clone flag [OK]

Hint: Remember: clone with --recurse-submodules for submodules [OK]

Common Mistakes:

• Using non-existent flags like --init-submodules
• Mixing update commands with clone
• Misspelling the flag

3. After cloning a repository without --recurse-submodules, you run git submodule update --init --recursive. What is the expected result?

medium

A. Submodules are initialized and updated to the correct commit

B. The main repository is recloned

C. Submodules are deleted from the repository

D. Nothing happens because submodules are not cloned

Solution

1. Step 1: Understand the command purpose

   The command initializes submodules and updates them recursively to the commit recorded in the main repo.

2. Step 2: Clarify what happens after cloning without submodules

   Submodules are present as empty folders; this command fetches their content properly.

3. Final Answer:

   Submodules are initialized and updated to the correct commit -> Option A

4. Quick Check:

   git submodule update --init --recursive = fetch submodules [OK]

Hint: Use update --init --recursive to fetch missing submodules [OK]

Common Mistakes:

• Thinking it reclones the main repo
• Assuming submodules get deleted
• Believing nothing happens without --recurse-submodules

4. You cloned a repository with submodules but forgot to use --recurse-submodules. Running git submodule update --init gives an error. What is the most likely cause?

medium

A. The main repository was cloned with --recurse-submodules

B. The submodule URLs are missing or incorrect in .gitmodules

C. You need to delete the main repository and reclone

D. Submodules cannot be initialized after cloning

Solution

1. Step 1: Analyze the error cause

   If submodule URLs in .gitmodules are missing or wrong, update --init fails to fetch them.

2. Step 2: Check other options for correctness

   The main repository was cloned with --recurse-submodules is false because main repo was cloned without --recurse-submodules; C and D are incorrect as recloning or inability to init is not required.

3. Final Answer:

   The submodule URLs are missing or incorrect in .gitmodules -> Option B

4. Quick Check:

   Missing or wrong URLs cause submodule init errors [OK]

Hint: Check .gitmodules URLs if submodule update fails [OK]

Common Mistakes:

• Assuming recloning is always needed
• Thinking submodules can't be initialized later
• Ignoring .gitmodules configuration

5. You cloned a repository with nested submodules but only ran git submodule update --init. What is the best command to ensure all nested submodules are also initialized and updated?

hard

A. git submodule update --recursive

B. git submodule init --recursive

C. git clone --recurse-submodules

D. git submodule update --init --recursive

Solution

1. Step 1: Understand nested submodules

   Nested submodules require recursive initialization and update to fetch all levels.

2. Step 2: Identify the correct command

   The command with both --init and --recursive flags initializes and updates all nested submodules properly.

3. Step 3: Check other options

   git submodule update --recursive misses --init, C is for cloning not updating, D is invalid syntax.

4. Final Answer:

   git submodule update --init --recursive -> Option D

5. Quick Check:

   Use --init --recursive to update nested submodules [OK]

Hint: Add --init --recursive to update all nested submodules [OK]

Common Mistakes:

• Forgetting --init when updating submodules
• Using clone commands after cloning
• Using invalid flags like --recursive with init only