summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-06-24 15:29:32 -0700
committerJunio C Hamano <gitster@pobox.com>2017-06-24 15:29:32 -0700
commit4f7132a9bed66d62a27f3ee9e01022d05e3ea2e5 (patch)
treed5f8738cb9b0943c6207ace5d8e355e3bbbc3a1d /Documentation
parentb960cd37c6ec11b35802216c38c9d02886f4fce8 (diff)
parent68602c01fde24d3b5cbcc4817bb85ab309684def (diff)
downloadgit-4f7132a9bed66d62a27f3ee9e01022d05e3ea2e5.tar.gz
Merge branch 'sb/submodule-rm-absorb' into maint
Doc update to a recently graduated topic. * sb/submodule-rm-absorb: Documentation/git-rm: correct submodule description
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-rm.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt
index f1efc116eb..8c87e8cdd7 100644
--- a/Documentation/git-rm.txt
+++ b/Documentation/git-rm.txt
@@ -140,10 +140,11 @@ Only submodules using a gitfile (which means they were cloned
with a Git version 1.7.8 or newer) will be removed from the work
tree, as their repository lives inside the .git directory of the
superproject. If a submodule (or one of those nested inside it)
-still uses a .git directory, `git rm` will fail - no matter if forced
-or not - to protect the submodule's history. If it exists the
-submodule.<name> section in the linkgit:gitmodules[5] file will also
-be removed and that file will be staged (unless --cached or -n are used).
+still uses a .git directory, `git rm` will move the submodules
+git directory into the superprojects git directory to protect
+the submodule's history. If it exists the submodule.<name> section
+in the linkgit:gitmodules[5] file will also be removed and that file
+will be staged (unless --cached or -n are used).
A submodule is considered up-to-date when the HEAD is the same as
recorded in the index, no tracked files are modified and no untracked