Removing submodules in Git - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Git submodule?

A Git submodule is a repository embedded inside another repository. It allows you to keep a separate project within your main project, tracking its own history.

beginner

What is the first step to remove a Git submodule?

The first step is to remove the submodule entry from the .gitmodules file and stage the change with git add .gitmodules.

intermediate

Why do you need to remove the submodule directory from the Git index?

Because the submodule is tracked as a separate repository, you must remove it from the Git index with git rm --cached <path> to stop tracking it.

beginner

What command removes the submodule directory from your working directory after untracking it?

You manually delete the submodule directory using a command like rm -rf <path> to remove the files from your working directory.

beginner

What is the final step to complete submodule removal?

Commit the changes to .gitmodules and the removal of the submodule from the index and working directory to finalize the removal.

Which file must you edit to remove a Git submodule?

A README.md

B .gitmodules

C .gitignore

D .git/config

The .gitmodules file contains the configuration for submodules and must be updated to remove a submodule.

What does the command 'git rm --cached <submodule_path>' do?

A Removes the submodule from the Git index but keeps files locally

B Deletes the submodule files from disk

C Adds the submodule to the index

D Updates the submodule to the latest commit

The --cached option removes the submodule from Git tracking but leaves the files in your working directory.

After removing a submodule from .gitmodules and the index, what should you do next?

A Create a new submodule

B Run git submodule update

C Delete the submodule directory manually

D Push to remote without committing

You must manually delete the submodule directory to remove its files from your working directory.

Why is it important to commit changes after removing a submodule?

A To save the removal changes in the repository history

B To create a new submodule

C To update the remote submodule

D To reset the repository

Committing saves the removal steps so others see the submodule is no longer part of the project.

Which command sequence correctly removes a submodule named 'lib'?

A git add lib; git commit -m 'Remove submodule'; rm -rf lib

B rm -rf lib; git commit -m 'Remove submodule'

C git submodule update; git rm lib; git commit

D git rm --cached lib; rm -rf lib; git add .gitmodules; git commit -m 'Remove submodule'

This sequence removes the submodule from Git tracking, deletes its files, updates .gitmodules, and commits the changes.

Explain the step-by-step process to remove a Git submodule from a project.

Think about editing config, untracking, deleting files, and saving changes.

Why is it necessary to manually delete the submodule directory after removing it from Git tracking?

Consider what happens to files when you remove only from Git index.

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