diff options
| author |  Andreas Heiduk <asheiduk@gmail.com> | 2017-06-14 08:51:39 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2017-06-15 10:55:47 -0700 |
| commit | 773a88914f7b951cb33b27b12b4b715b66451a07 (patch) | |
| tree | 22531820f65dc6df0231477bc8799d745f675e5b | |
| parent | Prepare for 2.13.2 (diff) | |
| download | tgif-773a88914f7b951cb33b27b12b4b715b66451a07.tar.xz | |
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>
| -rw-r--r-- | Documentation/gitattributes.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt index 4736483865..2a2d7e2a4d 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -229,7 +229,7 @@ From a clean working directory: ------------------------------------------------- $ echo "* text=auto" >.gitattributes -$ rm .git/index # Remove the index to re-scan the working directory +$ git read-tree --empty # Clean index, force re-scan of working directory $ git add . $ git status # Show files that will be normalized $ git commit -m "Introduce end-of-line normalization" |