rm: better document side effects when removing a submodule
commitbbad9f9314f658b5c0f302148fc9780f5788dcd8
authorJens Lehmann <Jens.Lehmann@web.de>
Tue, 7 Jan 2014 21:32:37 +0000 (7 22:32 +0100)
committerJunio C Hamano <gitster@pobox.com>
Tue, 7 Jan 2014 22:34:06 +0000 (7 14:34 -0800)
tree9c1c6f25614f987ddeb45bba0e748035e888fbd7
parent1cbd18300a8755ba46791b2aa6249fa537a1d651
rm: better document side effects when removing a submodule

The "Submodules" section of the "git rm" documentation mentions what will
happen when a submodule with a gitfile gets removed with newer git. But it
doesn't talk about what happens when the user changes between commits
before and after the removal, which does not remove the submodule from the
work tree like using the rm command did the first time.

Explain what happens and what the user has to do manually to fix that in
the new BUGS section. Also document this behavior in a new test.

Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-rm.txt
t/t3600-rm.sh