Merge pull request #12091 from terrdavis/support-git-ignore-revs

Support git blame ignore revs

.git-blame-ignore-revs

@@ -0,0 +1,8 b''
+# When making commits that are strictly formatting/style changes, add the
+# commit hash here, so git blame can ignore the change.
+# See docs for more details:
+# https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile
+
+# Example entries:
+# <full commit hash>  # initial black-format
+# <full commit hash>  # rename something internal

tools/configure-git-blame-ignore-revs.bat

@@ -0,0 +1,10 b''
+rem Other config options for blame are markUnblamables and markIgnoredLines.
+rem See docs for more details:
+rem https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile
+
+rem Uncomment below and rerun script to enable an option.
+rem git config blame.markIgnoredLines
+rem git config blame.markUnblamables
+
+git config blame.ignoreRevsFile .git-blame-ignore-revs
+git config --get blame.ignoreRevsFile

tools/configure-git-blame-ignore-revs.sh

@@ -0,0 +1,10 b''
+# Other config options for blame are markUnblamables and markIgnoredLines.
+# See docs for more details:
+# https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile
+
+# Uncomment below and rerun script to enable an option.
+# git config blame.markIgnoredLines
+# git config blame.markUnblamables
+
+git config blame.ignoreRevsFile .git-blame-ignore-revs
+git config --get blame.ignoreRevsFile

MANIFEST.in

@@ -24,6 +24,8 b' graft docs'
 exclude docs/\#*
 exclude docs/man/*.1.gz
 
+exclude .git-blame-ignore-revs
+
 # Examples
 graft examples
 

README.rst

@@ -129,3 +129,18 b' project that you might want to use:'
 - `mypython <https://www.asmeurer.com/mypython/>`_
 - `ptpython and ptipython <https://pypi.org/project/ptpython/>`
 - `xonsh <https://xon.sh/>`
+
+Ignoring commits with git blame.ignoreRevsFile
+==============================================
+
+As of git 2.23, it is possible to make formatting changes without breaking
+``git blame``. See the `git documentation
+<https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile>`_
+for more details.
+
+To use this feature you must:
+
+- Install git >= 2.23
+- Configure your local git repo by running:
+   - POSIX: ``tools\configure-git-blame-ignore-revs.sh``
+   - Windows:  ``tools\configure-git-blame-ignore-revs.bat``