diff --git a/README.rst b/README.rst index 3e13610..9c0c89e 100644 --- a/README.rst +++ b/README.rst @@ -129,3 +129,18 @@ project that you might want to use: - `mypython `_ - `ptpython and ptipython ` - `xonsh ` + +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 +`_ +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``