Documentation/git-rm: correct submodule description
Since 3ccd681c2a (Merge branch 'sb/submodule-rm-absorb', 2017-01-18) git-rm tries to absorb any submodules git dir before deleting the submodule. Correct the documentation to say so. Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Stefan Beller committed
Jun 2, 2017 at 12:28 UTC
68602c01fde24d3b5cbcc4817bb85ab309684def
1 file changed
+5
-4
Documentation/git-rm.txt
+5
-4
@@ -140,10 +140,11 @@ Only submodules using a gitfile (which means they were cloned
140
with a Git version 1.7.8 or newer) will be removed from the work
141
tree, as their repository lives inside the .git directory of the
142
superproject. If a submodule (or one of those nested inside it)
143
-still uses a .git directory, `git rm` will fail - no matter if forced
144
-or not - to protect the submodule's history. If it exists the
145
-submodule.<name> section in the linkgit:gitmodules[5] file will also
146
-be removed and that file will be staged (unless --cached or -n are used).
143
+still uses a .git directory, `git rm` will move the submodules
144
+git directory into the superprojects git directory to protect
145
+the submodule's history. If it exists the submodule.<name> section
146
+in the linkgit:gitmodules[5] file will also be removed and that file
147
+will be staged (unless --cached or -n are used).
148
149
A submodule is considered up-to-date when the HEAD is the same as
150
recorded in the index, no tracked files are modified and no untracked