Updating submodules in Git - Commands & Configuration

Introduction

Sometimes a project uses other projects inside it, called submodules. Updating submodules means getting the latest changes from those smaller projects so your main project stays current.

When you clone a project that contains submodules and want to get their content.

When the submodule projects have new updates and you want to include them in your main project.

When you switch branches and the submodules need to update to match the branch.

When you want to check if submodules are out of date compared to their remote repositories.

Commands

This command initializes and fetches all submodules for the first time, including nested ones, so you have their files locally.

Terminal

git submodule update --init --recursive

Expected Output

Submodule 'libs/example-lib' (https://github.com/example/example-lib.git) registered for path 'libs/example-lib'

Cloning into 'libs/example-lib'...

Submodule path 'libs/example-lib': checked out 'a1b2c3d4e5f6g7h8i9j0'

→

--init - Initializes submodules that are not yet initialized

→

--recursive - Also updates nested submodules inside submodules

This command fetches the latest commits from the remote repositories of all submodules and updates them to those commits.

Terminal

git submodule update --remote

Expected Output

Fetching submodule libs/example-lib

Submodule path 'libs/example-lib': checked out 'f1e2d3c4b5a697887766'

→

--remote - Updates submodules to the latest commit on their remote tracking branch

Check if the submodule update changed anything in your main project, so you can commit the updated submodule references.

Terminal

git status

Expected Output

On branch main

Changes not staged for commit:

  modified:   libs/example-lib (new commits)



no changes added to commit (use "git add" and/or "git commit -a")

Stage the updated submodule so you can commit the new submodule version in your main project.

Terminal

git add libs/example-lib

Expected Output

No output (command runs silently)

Commit the updated submodule reference to your main project repository.

Terminal

git commit -m "Update submodule libs/example-lib to latest"

Expected Output

[main abcdef1] Update submodule libs/example-lib to latest

 1 file changed, 1 insertion(+), 1 deletion(-)

Key Concept

If you remember nothing else from this pattern, remember: submodules are separate projects inside your project and need their own update commands to stay current.

Common Mistakes

Running 'git pull' only on the main project without updating submodules

This does not update the submodules to their latest commits, so your submodules stay outdated.

After pulling, run 'git submodule update --remote' to fetch and update submodules.

Forgetting to initialize submodules after cloning

The submodule folders will be empty or missing, causing build errors or missing code.

Run 'git submodule update --init --recursive' right after cloning to get all submodule content.

Not committing the updated submodule references after updating

Your main project will not record the new submodule versions, causing confusion for others or on other machines.

Stage and commit the submodule changes with 'git add' and 'git commit' after updating.

Summary

Use 'git submodule update --init --recursive' to get submodules after cloning.

Use 'git submodule update --remote' to fetch and update submodules to their latest commits.

Always check 'git status' and commit updated submodule references to keep your main project consistent.

Practice

1. What does the command git submodule update --init --recursive do in a Git project?

easy

A. It deletes all submodules from the project.

B. It commits changes in all submodules automatically.

C. It initializes and updates all submodules recursively after cloning the main project.

D. It creates new submodules inside the main project.

Solution

1. Step 1: Understand submodule initialization

   The --init option initializes submodules that are not yet initialized in the cloned project.

2. Step 2: Understand recursive update

   The --recursive option ensures that nested submodules inside submodules are also initialized and updated.

3. Final Answer:

   It initializes and updates all submodules recursively after cloning the main project. -> Option C

4. Quick Check:

   Initialize + recursive update = It initializes and updates all submodules recursively after cloning the main project. [OK]

Hint: Init and recursive flags together set up all submodules after clone [OK]

Common Mistakes:

• Thinking it deletes submodules
• Assuming it commits changes automatically
• Confusing initialization with creation of submodules

2. Which of the following is the correct syntax to update submodules to their latest remote commits?

easy

A. git submodule update --remote

B. git submodule update --fetch --all

C. git submodule update --recursive --commit

D. git submodule update --init

Solution

1. Step 1: Identify the command for updating to latest remote commits

   The --remote option tells Git to fetch and update submodules to the latest commit on their remote branches.

2. Step 2: Check other options for correctness

   --init only initializes, --recursive --commit is invalid syntax, and --fetch --all is not a valid submodule update option.

3. Final Answer:

   git submodule update --remote -> Option A

4. Quick Check:

   Update submodules to latest remote = --remote [OK]

Hint: Use --remote to pull latest submodule commits [OK]

Common Mistakes:

• Using --init instead of --remote
• Adding invalid flags like --commit
• Confusing fetch with update options

3. After cloning a repository with submodules, you run these commands:

git submodule update --init
cd submodule_dir
git log -1 --oneline

What will the git log -1 --oneline inside the submodule show?

medium

A. The latest commit from the submodule's remote repository.

B. The commit that the main project references for the submodule.

C. An error because the submodule is not initialized.

D. The commit history of the main project.

Solution

1. Step 1: Understand what git submodule update --init does

   This command initializes the submodule and checks out the commit that the main project references, not necessarily the latest remote commit.

2. Step 2: Analyze the git log -1 --oneline output inside submodule

   This shows the latest commit checked out in the submodule directory, which matches the main project's recorded commit, not the remote HEAD.

3. Final Answer:

   The commit that the main project references for the submodule. -> Option B

4. Quick Check:

   Submodule update checks out main project commit, not latest remote [OK]

Hint: Submodule update checks out recorded commit, not latest remote [OK]

Common Mistakes:

• Assuming submodule auto-updates to latest remote commit
• Expecting error after init command
• Confusing main project and submodule commit logs

4. You ran git submodule update --remote but the submodule did not update to the latest commit. What is a likely cause?

medium

A. The submodule directory is empty.

B. You forgot to clone the main repository first.

C. The main project has no submodules configured.

D. The submodule's remote branch is not set or tracking is missing.

Solution

1. Step 1: Understand the role of remote tracking in submodules

   The --remote option updates submodules by fetching from their configured remote branch. If this branch is not set, update won't move the commit.

2. Step 2: Check other options for relevance

   Cloning the main repo is prerequisite but unrelated to this issue; no submodules means no update; empty directory usually means uninitialized submodule.

3. Final Answer:

   The submodule's remote branch is not set or tracking is missing. -> Option D

4. Quick Check:

   Remote branch missing = no update with --remote [OK]

Hint: Ensure submodule remote branch is set for --remote updates [OK]

Common Mistakes:

• Ignoring remote branch configuration
• Assuming cloning main repo fixes submodule update
• Confusing empty directory with update failure

5. You want to clone a repository with multiple nested submodules and ensure all submodules and their nested submodules are initialized and updated to the commits recorded in the main project. Which command should you run immediately after cloning?

hard

A. git submodule update --init --recursive

B. git submodule update --remote --recursive

C. git clone --recurse-submodules --remote

D. git submodule init && git submodule update

Solution

1. Step 1: Understand cloning with submodules

   After cloning, submodules are not initialized or updated by default. The --init flag initializes them.

2. Step 2: Ensure nested submodules are handled

   The --recursive flag ensures all nested submodules are also initialized and updated to the recorded commits.

3. Step 3: Differentiate from --remote option

   --remote updates submodules to latest remote commits, not the commits recorded in the main project, so it's not suitable here.

4. Final Answer:

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

5. Quick Check:

   Init + recursive updates recorded commits after clone [OK]

Hint: Use --init and --recursive to set all submodules after clone [OK]

Common Mistakes:

• Using --remote instead of --init for recorded commits
• Forgetting recursive flag for nested submodules
• Trying to combine clone and remote flags incorrectly