Why Removing submodules in Git? - Purpose & Use Cases

The Big Idea

Discover how a few simple commands can save you hours of frustrating cleanup when removing submodules!

The Scenario

Imagine you have a project with several submodules, and you want to remove one because it's no longer needed or causing issues.

You try deleting the submodule folder manually and commit, but the submodule still appears in your project history and configuration.

The Problem

Manually deleting submodule folders leaves behind hidden configuration files and references in your git settings.

This causes confusion, broken builds, and errors when others clone or update the project.

It's slow and error-prone to track all places where the submodule is registered.

The Solution

Using the proper git commands to remove submodules cleans all references and configuration automatically.

This ensures your project is tidy, consistent, and error-free after removal.

Before vs After

✗ Before

rm -rf path/to/submodule
rm -rf .git/modules/path/to/submodule
# but submodule still listed in .gitmodules and config

✓ After

git submodule deinit -f path/to/submodule
git rm -f path/to/submodule
rm -rf .git/modules/path/to/submodule
# submodule fully removed from config and history

What It Enables

You can cleanly remove unwanted submodules without breaking your project or confusing collaborators.

Real Life Example

A developer removes a deprecated library submodule from a shared project to reduce complexity and avoid build errors for the whole team.

Key Takeaways

Manual deletion leaves hidden references causing errors.

Proper git commands fully remove submodules and clean configs.

Clean removal keeps projects stable and easy to maintain.

Practice

1. What is the first step to remove a Git submodule from your project?

easy

A. Commit the changes immediately

B. Delete the submodule folder manually

C. Unregister the submodule using git submodule deinit

D. Run git rm --cached on the main repository

Solution

1. Step 1: Unregister the submodule

   Use git submodule deinit <path> to unregister the submodule from Git's configuration.

2. Step 2: Remove submodule files and commit

   After unregistering, delete the submodule folder and commit the changes to keep the project clean.

3. Final Answer:

   Unregister the submodule using git submodule deinit -> Option C

4. Quick Check:

   First step is unregistering submodule [OK]

Hint: Always unregister submodule before deleting files [OK]

Common Mistakes:

• Deleting folder before unregistering causes errors
• Committing before unregistering submodule
• Skipping unregister step

2. Which command correctly removes a submodule's cached entry from Git's index?

easy

A. git rm <submodule_path>

B. git delete submodule <submodule_path>

C. git submodule remove <submodule_path>

D. git rm --cached <submodule_path>

Solution

1. Step 1: Remove cached submodule entry

   Use git rm --cached <submodule_path> to remove the submodule from Git's index without deleting files immediately.

2. Step 2: Delete submodule folder and commit

   After removing cached entry, delete the folder manually and commit the changes.

3. Final Answer:

   git rm --cached <submodule_path> -> Option D

4. Quick Check:

   Remove cached entry with git rm --cached [OK]

Hint: Use --cached to remove from index but keep files temporarily [OK]

Common Mistakes:

• Using git rm without --cached deletes files immediately
• Using non-existent git submodule remove command
• Trying git delete submodule which is invalid

3. Given these commands run in order, what is the final state of the submodule folder?

git submodule deinit mysub
rm -rf .git/modules/mysub
git rm --cached mysub
rm -rf mysub
git commit -m "Remove submodule"

medium

A. The submodule folder and Git data are fully removed

B. The submodule folder remains but is untracked

C. Only Git data is removed, folder remains

D. Submodule is still registered and tracked

Solution

1. Step 1: Unregister and remove Git data

   git submodule deinit mysub unregisters the submodule, and rm -rf .git/modules/mysub deletes its Git data.

2. Step 2: Remove cached index and folder, then commit

   git rm --cached mysub removes it from Git index, rm -rf mysub deletes the folder, and commit saves changes.

3. Final Answer:

   The submodule folder and Git data are fully removed -> Option A

4. Quick Check:

   All steps done means full removal [OK]

Hint: Deinit, remove Git data, rm cached, delete folder, commit [OK]

Common Mistakes:

• Forgetting to delete .git/modules data
• Not committing after removal
• Deleting folder before unregistering

4. You ran rm -rf mysub before git submodule deinit mysub. What problem might occur?

medium

A. Git still tracks the submodule and shows errors on next fetch

B. The submodule folder is restored automatically

C. Git removes the submodule automatically without errors

D. No problem, this is the correct order

Solution

1. Step 1: Understand order importance

   Deleting the folder before unregistering leaves Git still tracking the submodule path.

2. Step 2: Resulting error state

   Git will show errors or warnings because the submodule is missing but still registered.

3. Final Answer:

   Git still tracks the submodule and shows errors on next fetch -> Option A

4. Quick Check:

   Delete folder before deinit causes tracking errors [OK]

Hint: Always deinit before deleting submodule folder [OK]

Common Mistakes:

• Deleting folder first then deinit
• Ignoring Git errors after removal
• Assuming folder deletion unregisters submodule

5. You want to completely remove a submodule named libs/toolkit from your project. Which sequence of commands correctly removes it and cleans all related data?

hard

A. git rm libs/toolkit; rm -rf libs/toolkit; git commit -m "Remove submodule"

B. git submodule deinit libs/toolkit; rm -rf .git/modules/libs/toolkit; git rm --cached libs/toolkit; rm -rf libs/toolkit; git commit -m "Remove submodule"

C. rm -rf libs/toolkit; git submodule deinit libs/toolkit; git commit -m "Remove submodule"

D. git submodule remove libs/toolkit; git commit -m "Remove submodule"

Solution

1. Step 1: Unregister and remove Git submodule data

   Run git submodule deinit libs/toolkit to unregister, then delete Git metadata with rm -rf .git/modules/libs/toolkit.

2. Step 2: Remove cached index and folder, then commit

   Use git rm --cached libs/toolkit to remove from index, delete the folder manually, and commit changes.

3. Final Answer:

   git submodule deinit libs/toolkit; rm -rf .git/modules/libs/toolkit; git rm --cached libs/toolkit; rm -rf libs/toolkit; git commit -m "Remove submodule" -> Option B

4. Quick Check:

   Full removal requires unregister, delete Git data, rm cached, delete folder, commit [OK]

Hint: Deinit, delete .git/modules, rm cached, delete folder, commit [OK]

Common Mistakes:

• Skipping removal of .git/modules data
• Using non-existent git submodule remove command
• Deleting folder before unregistering