Removing submodules in Git - Step-by-Step Execution

Process Flow - Removing submodules

Identify submodule to remove

↓

Remove submodule entry from .gitmodules

↓

Remove submodule directory from git index

↓

Delete submodule physical directory

↓

Commit changes to main repo

↓

Remove submodule config from .git/config

↓

Submodule fully removed

This flow shows the step-by-step process to cleanly remove a git submodule from a repository.

Execution Sample

Git

git submodule deinit -f path/to/submodule
rm -rf .git/modules/path/to/submodule
git rm -f path/to/submodule
rm -rf path/to/submodule
git commit -m "Remove submodule"

Commands to deinitialize, remove, and commit removal of a git submodule.

Process Table

Step	Command	Action	Result
1	git submodule deinit -f path/to/submodule	Unregister submodule from git config	Submodule deinitialized, no longer tracked in config
2	rm -rf .git/modules/path/to/submodule	Delete submodule's git data directory	Submodule git data removed from .git/modules
3	git rm -f path/to/submodule	Remove submodule directory from git index	Submodule directory staged for removal
4	rm -rf path/to/submodule	Delete submodule physical directory	Submodule files deleted from working directory
5	git commit -m "Remove submodule"	Commit removal changes	Commit created removing submodule from repo

💡 Submodule fully removed after commit; no traces remain in config or working directory.

Status Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	After Step 4	Final
.gitmodules	Contains submodule entry	Unchanged	Unchanged	Submodule entry removed	Submodule entry removed	Submodule entry removed
.git/config	Contains submodule config	Submodule config removed	Submodule config removed	Submodule config removed	Submodule config removed	Submodule config removed
Submodule directory	Exists with files	Exists	Exists	Removed from index	Deleted	Deleted
.git/modules/path/to/submodule	Exists	Exists	Deleted	Deleted	Deleted	Deleted

Key Moments - 3 Insights

Why do we run 'git submodule deinit' before removing files?

Because 'git submodule deinit' unregisters the submodule from git's config, preventing git from tracking it before we delete files. See execution_table step 1.

Why must we delete the .git/modules/path/to/submodule directory?

This directory holds the submodule's git data. If not deleted, git still keeps submodule info internally. See execution_table step 2.

Why do we run 'git rm' instead of just deleting the submodule folder?

'git rm' removes the submodule from git's index so git knows it's deleted. Just deleting files won't update git's tracking. See execution_table step 3.

Visual Quiz - 3 Questions

Look at the execution table, what happens at step 2?

A Submodule directory is deleted from working folder

B Submodule is committed as removed

C Submodule git data directory is deleted

D Submodule is deinitialized in config

💡 Hint

Check the 'Action' and 'Result' columns for step 2 in the execution_table.

According to variable_tracker, when is the submodule directory removed from git index?

A After Step 3

B After Step 2

C After Step 1

D After Step 4

💡 Hint

Look at the 'Submodule directory' row and see when it changes to 'Removed from index'.

If you skip deleting .git/modules/path/to/submodule, what remains?

A Submodule entry remains in .gitmodules

B Submodule git data remains internally

C Submodule files remain in working directory

D Submodule is fully removed

💡 Hint

Refer to variable_tracker row for '.git/modules/path/to/submodule' after Step 2.

Concept Snapshot

Removing git submodules:
1. Run 'git submodule deinit -f <path>' to unregister.
2. Delete submodule git data: 'rm -rf .git/modules/<path>'.
3. Remove submodule from index: 'git rm -f <path>'.
4. Delete submodule files: 'rm -rf <path>'.
5. Commit changes to finalize removal.

Full Transcript

To remove a git submodule, first deinitialize it with 'git submodule deinit -f' to unregister it from git config. Then delete the submodule's git data directory inside .git/modules. Next, remove the submodule directory from git's index using 'git rm -f'. After that, delete the physical submodule folder from your working directory. Finally, commit these changes to your repository. This process ensures the submodule is fully removed from tracking and files.