From: Sohom <sohom.datta@xxxxxxxxxxxxxxxxxxx>
Added text explaining that the git rm --cached command
isn't analogous to the gitignore file and that the file
will need to be added to gitignore to prevent later
commits from adding the file back.
Signed-off-by: Sohom Datta <sohom.datta@xxxxxxxxxxxxxxxxxxx>
---
docs: Clarify git rm --cached function in gitignore note
Added text explaining that the git rm --cached command isn't analogous
to the gitignore file and that the file will need to be added to
gitignore to prevent later commits from adding the file back.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-862%2Fsohomdatta1%2Fgitignore-note-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-862/sohomdatta1/gitignore-note-v1
Pull-Request: https://github.com/git/git/pull/862
Documentation/gitignore.txt | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
index d47b1ae296..22d58df805 100644
--- a/Documentation/gitignore.txt
+++ b/Documentation/gitignore.txt
@@ -147,7 +147,9 @@ The purpose of gitignore files is to ensure that certain files
not tracked by Git remain untracked.
To stop tracking a file that is currently tracked, use
-'git rm --cached'.
+'git rm --cached' to remove the file from the index. The filename
+can then be added to the `gitignore` file to stop the file from
+being reintroduced in later commits.
EXAMPLES
--------
base-commit: ab4691b67bc1a2cd8d9068fb03e3fbd6979247d6
--
gitgitgadget
