Differences

This shows you the differences between two versions of the page.

--- git:git-full-remove-submodules [2024/05/28 13:49] – created admin
+++ git:git-full-remove-submodules [2025/03/25 17:10] (current) – admin
@@ Line 1: / Line 1: @@
 Back to [[git:main-git|git main page]]
-If you want to fully remove a submodule,
+If you want to fully remove a submodule, the following things have to done :
+  * remove the submodule entry from the .gitmodules file in the root of the main git repo
+  * remove the variables associated to the submodule
+  * remove the description in ./git/modules folder
+  * remove the folder containing the submodule
+Assume that the submodule is called **submod** and that it's path relative to the root of the git repo is ** external/gits**
+Open a terminal in the root of the git repo, and edit the **.gitmodules** file to remove the entry
+<code>
+[submodule "external/gits/submod"]
+path = external/gits/submod
+url = https://github.com/user/submod.git
+</code>
+Remove git tracking of the submodule folder, but keep the files :
+<code bash>
+git rm --cached -r external/gits/submod
+</code>
+Remove the submodule from git config (all variables are remove using section) :
+<code bash>
+git config --remove-section submodule.external/gits/submod
+</code>
+stage and commit the changes in .gitmodules
+<code bash>
+git add .gitmodules
+git commit -m "Remove submodule submod"
+</code>
+Remove the submodules from .git/modules
+<code bash>
+rm -rf .git/modules/external/gits/submod
+</code>
+Finally, push the changes to the remote repo
+<code bash>
+git push
+</code>
+Note that the files are still on the host, to remove them just use rm :
+<code bash>
+rm -rf external/gits/submod
+</code>