Document git's ignore-revs-file feature #1419
Conversation
A long-standing counterargument against moving to automated code formatters like Black is that the migration will clutter up the output of git blame. This used to be a valid argument, but not anymore. Since git version 2.23, git natively supports ignoring revisions in blame with the --ignore-rev and --ignore-revs-file options. This isn't documented in the Black documentation. It should be as it would put old projects wanting to migrate to Black at ease since blame won't be ruined.
README.md
Outdated
| **The one caveat is that GitHub and GitLab do not yet support ignoring revisions using | ||
| in their native UI of blame.** So blame information will be cluttered with a reformating | ||
| commit on those platforms. |
There was a problem hiding this comment.
Is there a public issue or request anywhere we can link to for people to +1?
If not, maybe we should kick it off someway or at least via my own paid personal account.
There was a problem hiding this comment.
Found an issue for GitLab.. still looking for GitHub
https://gitlab.com/gitlab-org/gitlab/-/issues/31423
There was a problem hiding this comment.
Probably doesn't count, but here's something.
https://github.community/t5/How-to-use-Git-and-GitHub/Support-ignore-revs-file-in-Github-s-blame-view/m-p/57020
There was a problem hiding this comment.
It appears that the only ways to submit feature requests regarding github.com is either via https://support.github.com/contact/feedback which isn't public, or on the GitHub Community Forum.
Quoted from this answer for a question about submitting feature questions regarding GitHub Community Forum:
That said, I do want to share that we are working on a new tool and process for submitting these sorts of things for the Community Forum (and for github.com). This is still in the investigative stage, and I don't have a timeline to share, but we are planning on improving this process.
We also recognize the desire for feature requests to be visible to other users, commented on, and even voted on. These are all things that we are taking into consideration when looking at implementing a new process.
There was a problem hiding this comment.
@cooperlees, do you think those two links work? If they do, I'll add them in the docs.
There was a problem hiding this comment.
Yeah sounds good - Lets just add the link for GitLab + say if you'd like this feature please let GitHub know!
Re being confusing ... no ... I just copy pasted - I should have used --ignore-revs-file to refer to the feature.
There was a problem hiding this comment.
https://github.com/isaacs/github is an unofficial place to post GitHub requests to +1. Wanna make one there?
There was a problem hiding this comment.
While I like the idea of posting an issue there, for personal reasons, I don't want to post the issue myself... It's not something I'd want to lead, by being the issue author. I hope I am not being ridiculous.
Edit: I didn't mention having one of you author the feature request since that seems too much to ask for. If you'd like to, go for it, but I personally won't and there's no pressure to do so for me.
Edit two: Thanks for the suggestion though :)
Make my documentation less wordy. Co-authored-by: Cooper Lees <me@cooperlees.com>
This comment has been minimized.
This comment has been minimized.
'Counterargument' was the wrong word since it means an objection to an objection. 'Argument' is the proper word I was looking for.
ichard26
force-pushed
the
ignore_rev_docnote
branch
from
fc14594
to
68f7022
Compare
Resolves #1408.
Commit message
A long-standing counterargument against moving to automated code formatters
like Black is that the migration will clutter up the output of git blame.
This used to be a valid argument, but not anymore. Since git version 2.23,
git natively supports ignoring revisions in blame with the --ignore-rev
and --ignore-revs-file options.
This isn't documented in the Black documentation. It should be as it would
put old projects wanting to migrate to Black at ease since blame won't
be ruined.
I personally don't like where the section is currently located. The
Installation and usagehas enough information already, but I frankly don't know where it should go. Suggestions are more than welcomed!