doc: do not use `rm .git/index` when normalizing line endings

When illustrating how to normalize the line endings, the documentation in gitattributes tells the user to `rm .git/index`. This is incorrect for two reasons: - Users shouldn't be instructed to mess around with the internal implementation of Git using raw file system tools like `rm`. - Within a submodule or an additional working tree `.git` is just a file containing a `gitdir: <path>` pointer into the real `.git` directory. Therefore `rm .git/index` does not work. The purpose of the `rm .git/index` instruction is to remove all entries from the index without touching the working tree. The way to do this with Git is to use `read-tree --empty`. Signed-off-by: Andreas Heiduk <asheiduk@gmail.com> Helped-by: Junio C Hamano <gitster@pobox.com> Helped-by: Torsten Bögershausen <tboegi@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Andreas Heiduk committed Jun 14, 2017 at 08:51 UTC 773a88914f7b951cb33b27b12b4b715b66451a07
1 file changed +1 -1
Documentation/gitattributes.txt
+1 -1
@@ -229,7 +229,7 @@ From a clean working directory:
229
230 -------------------------------------------------
231 $ echo "* text=auto" >.gitattributes
232 -$ rm .git/index # Remove the index to re-scan the working directory
232 +$ git read-tree --empty # Clean index, force re-scan of working directory
233 $ git add .
234 $ git status # Show files that will be normalized
235 $ git commit -m "Introduce end-of-line normalization"