According to the git rm documentation,
--cached
Use this option to unstage and remove paths only from the index.
Working tree files, whether modified or not
With git rm --cached
you stage a file for removal, but you don't remove it from the working dir. The file will then be shown as untracked.
Take a test drive
git init test_repo
cd test_repo
touch test
git add test
git commit -m 'Added file test
git rm --cached test
git status
Changes to be committed:
(use "git reset HEAD <file>..." to unstage)
deleted: test <---- staged for removal
Untracked files:
(use "git add <file>..." to include in what will be committed)
test <-- still in the working dir
With git reset <file>
you can unstage a file. In the example above you might want to use git reset test
to unstage the removal.
git reset test
git status
On branch master
nothing to commit, working directory clean
git rm --cached removes the file from the index but leaves it in the working directory. This indicates to Git that you don't want to track the file any more.
git reset HEAD leaves the file as a tracked file in the index, but the modifications cached in the index are lost. This has the effect as if the file in cache had been over written by the file in HEAD (and the working tree file being untouched)