From: Junio C Hamano <firstname.lastname@example.org> To: Shourya Shukla <email@example.com> Cc: firstname.lastname@example.org, email@example.com, firstname.lastname@example.org, email@example.com Subject: Re: [PATCH v2 1/1] gitfaq: append the 'Common Issues' section Date: Thu, 16 Apr 2020 12:05:38 -0700 [thread overview] Message-ID: <firstname.lastname@example.org> (raw) In-Reply-To: <email@example.com> (Shourya Shukla's message of "Mon, 13 Apr 2020 19:39:18 +0530") Shourya Shukla <firstname.lastname@example.org> writes: > +[[files-in-.gitignore-are-tracked]] > +I asked Git to ignore various files, yet they show up as changes in my staging area:: (again, I'll wrap overly long lines, as they were unreviewable otherwise) > + One uses '.gitignore' to ignore files from getting tracked > + in the working tree. This ignores the aforementioned files > + for the whole lifetime of the project unless they area > + removed from the '.gitignore'. At least "they area" -> "they are" is needed, but it is unclear where these two sentences one to go. "to ignore files from getting tracked in the working tree" is why you may want to use the '.gitignore' file. That is OK. But the connection to the next sentence, especially the subject "This ignores", is hard to grok. I am guessing that you want to tell the users something like Paths that match patterns listed in the `.gitignore` are not meant to be tracked. The act of adding a pattern in `.gitignore` that matches a set of paths that are not tracked is a declaration that you do not intend to track these paths and a request by you to Git to help you achieve that goal. but you are trying to state it in a more approachable manner. But I sense that you ended up being unclear. > + Consequently, `git add` does > + not list these files as 'modified' even if any change was > + made in them and `git status` does not bother to track the > + changes in these files either. This part is very much in line with the "you are declaring and requesting". The user does not want to track these paths, and these commands are helping the user to achieve that wish. However, "`git add` does not list ..." is questionable. by definition, Git does not care about contents of any untracked paths, so there is no way for us to say `modified` about them. The primary utility of `git add` is to add a path, which used to be untracked, to the set of the paths that are tracked. So perhaps To help you keep the paths untracked, `git add` does not add the paths that are not tracked and ignored without the `--force` option, and `git status` does not list them as untracked (i.e. possible candidate that you might want to add but forgot). > + But, '.gitignore' will only ignore the files which were not > + a part of the repository when they were mentioned in the > + it. > + Hence, addition of a file to '.gitignore' after it was > + added to the working tree will have no effect and Git will > + keep tracking them. I am not sure wat you mean by the first sentence (even after removing 'the' from "in the it."). It does not matter if you wrote the pattern '*.o' in the .gitignore file one year ago, or 7 seconds ago. As long as hello.o in the working tree is not tracked, it is ignored. Perhaps The `.gitignore` mechanism applies only to the files that are not already tracked. A path that is already tracked will stay to be tracked even if you add a pattern that happens to match it to .gitignore file. > + To amend this mistake, i.e., to untrack > + and completely ignore a tracked file, I'd omit "To amend this mistake, i.e.," from the above, if I were writing this. Also, I see no value in saying "completely" here. It is not like there are ways to half-ignore or fully-ignore ;-). > + one has to use `git rm > + --cached <file>` to remove the file from the staging > + area(i.e. the cache) and not from the repository(presuming > + the file has been added in the 'gitignore'). To untrack a tracked file, without removing it from the working tree, "git rm --cached <file>" can be used. To keep the file ignored after doing so, make sure that `.gitignore` knows that the file is to be ignored (e.g. by adding <file> to `.gitignore`, but you may already have a pattern that match <file> there). Having commented on this section, I am not sure why we need so much description here, instead of clarifying the existing documentation of the mechanism in the Documentation/gitignore.txt file. I think it is better to limit the FAQ list to two kinds of entries: * A topic that spans multiple mechanisms and features that is not easy to explain in a single documentation page may have to be described in place. * Other topics that already have authoritative description with adequate clarity in other pages should just have a summary paragraph that is less than 5 sentences, and a pointer to the authoritative page. The `.gitignore` topic should fall into the latter category. It is a separate issue if Documentation/gitignore.txt has rooms for improvement and if so, I think it is more productive to propose a patch to it there, not adding too much description on the topic here. Thanks.
next prev parent reply other threads:[~2020-04-16 19:05 UTC|newest] Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-04-13 14:09 [PATCH v2 0/1] update gitfaq Shourya Shukla 2020-04-13 14:09 ` [PATCH v2 1/1] gitfaq: append the 'Common Issues' section Shourya Shukla 2020-04-14 1:06 ` brian m. carlson 2020-04-14 7:33 ` Junio C Hamano 2020-04-16 19:05 ` Junio C Hamano [this message] 2020-04-21 6:58 ` Shourya Shukla 2020-04-16 19:36 ` Junio C Hamano 2020-04-21 0:57 ` Junio C Hamano 2020-04-21 8:38 ` Shourya Shukla 2020-04-21 18:00 ` Junio C Hamano -- strict thread matches above, loose matches on Subject: below -- 2020-04-13 10:55 [PATCH v2 0/1] update gitfaq Shourya Shukla 2020-04-13 10:55 ` [PATCH v2 1/1] gitfaq: append the 'Common Issues' section Shourya Shukla
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 List information: http://vger.kernel.org/majordomo-info.html * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --subject='Re: [PATCH v2 1/1] gitfaq: append the '\''Common Issues'\'' section' \ /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
Code repositories for project(s) associated with this inbox: https://80x24.org/mirrors/git.git 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).