• Jens Lehmann's avatar
    rm: delete .gitmodules entry of submodules removed from the work tree · 95c16418
    Jens Lehmann authored
    Currently using "git rm" on a submodule removes the submodule's work tree
    from that of the superproject and the gitlink from the index. But the
    submodule's section in .gitmodules is left untouched, which is a leftover
    of the now removed submodule and might irritate users (as opposed to the
    setting in .git/config, this must stay as a reminder that the user showed
    interest in this submodule so it will be repopulated later when an older
    commit is checked out).
    
    Let "git rm" help the user by not only removing the submodule from the
    work tree but by also removing the "submodule.<submodule name>" section
    from the .gitmodules file and stage both. This doesn't happen when the
    "--cached" option is used, as it would modify the work tree. This also
    silently does nothing when no .gitmodules file is found and only issues a
    warning when it doesn't have a section for this submodule. This is because
    the user might just use plain gitlinks without the .gitmodules file or has
    already removed the section by hand before issuing the "git rm" command
    (in which case the warning reminds him that rm would have done that for
    him). Only when .gitmodules is found and contains merge conflicts the rm
    command will fail and tell the user to resolve the conflict before trying
    again.
    
    Also extend the man page to inform the user about this new feature. While
    at it promote the submodule sub-section to a chapter as it made not much
    sense under "REMOVING FILES THAT HAVE DISAPPEARED FROM THE FILESYSTEM".
    
    In t7610 three uses of "git rm submod" had to be replaced with "git rm
    --cached submod" because that test expects .gitmodules and the work tree
    to stay untouched. Also in t7400 the tests for the remaining settings in
    the .gitmodules file had to be changed to assert that these settings are
    missing.
    Signed-off-by: default avatarJens Lehmann <Jens.Lehmann@web.de>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    95c16418
submodule.h 1.9 KB