From: "Sohom Datta via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Elijah Newren <newren@gmail.com>,
Sohom Datta <sohomdatta1@gmail.com>,
Sohom Datta <sohom.datta@learner.manipal.edu>
Subject: [PATCH v3] docs: clarify git rm --cached function in gitignore note
Date: Wed, 03 May 2023 21:46:40 +0000 [thread overview]
Message-ID: <pull.862.v3.git.git.1683150400953.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.862.v2.git.git.1683127916363.gitgitgadget@gmail.com>
From: Sohom Datta <sohom.datta@learner.manipal.edu>
Explain to users that the step to untrack a file will not also prevent them
from getting added in the future.
Signed-off-by: Sohom Datta <sohom.datta@learner.manipal.edu>
---
docs: Clarify git rm --cached function in gitignore note
I've fixed the Sign-Off v/s commit author issue and incorporated the
changes suggested :)
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-862%2Fsohomdatta1%2Fgitignore-note-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-862/sohomdatta1/gitignore-note-v3
Pull-Request: https://github.com/git/git/pull/862
Range-diff vs v2:
1: c3257398c8f ! 1: ae09ff2e70c docs: clarify git rm --cached function in gitignore note
@@
## Metadata ##
-Author: Sohom <sohom.datta@learner.manipal.edu>
+Author: Sohom Datta <sohom.datta@learner.manipal.edu>
## Commit message ##
docs: clarify git rm --cached function in gitignore note
- Explain to users that the step to untrack a file will not also keep it
- untracked in the future.
+ Explain to users that the step to untrack a file will not also prevent them
+ from getting added in the future.
Signed-off-by: Sohom Datta <sohom.datta@learner.manipal.edu>
@@ Documentation/gitignore.txt: The purpose of gitignore files is to ensure that ce
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
++can then be added to the `.gitignore` file to stop the file from
+being reintroduced in later commits.
Git does not follow symbolic links when accessing a `.gitignore` file in
Documentation/gitignore.txt | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
index f2738b10db6..4c17f2356c4 100644
--- a/Documentation/gitignore.txt
+++ b/Documentation/gitignore.txt
@@ -146,7 +146,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.
Git does not follow symbolic links when accessing a `.gitignore` file in
the working tree. This keeps behavior consistent when the file is
base-commit: 69c786637d7a7fe3b2b8f7d989af095f5f49c3a8
--
gitgitgadget
next prev parent reply other threads:[~2023-05-03 21:46 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-05 8:58 [PATCH] docs: clarify git rm --cached function in gitignore note Sohom Datta via GitGitGadget
2023-05-03 0:09 ` Sohom
2023-05-03 4:32 ` Elijah Newren
2023-05-03 15:31 ` [PATCH v2] " Sohom Datta via GitGitGadget
2023-05-03 17:06 ` Junio C Hamano
2023-05-03 21:46 ` Sohom Datta via GitGitGadget [this message]
2023-05-07 1:36 ` [PATCH v3] " Elijah Newren
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.862.v3.git.git.1683150400953.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=newren@gmail.com \
--cc=sohom.datta@learner.manipal.edu \
--cc=sohomdatta1@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).