Add file to pass to git blame --ignore-revs-file containing the black…

… commit
systemd · Dec 19, 2020 · 9670e96 · 9670e96
1 parent ea243a8
commit 9670e96
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1,3 @@
+# Migrate code style to Black
+9dfda52fffb564d99264c09e0f0182ab8540d7cd
+
diff --git a/README.md b/README.md
@@ -54,6 +54,11 @@ when not installed as a zipapp.
 Please note, that the the python module exists solely for the usage of the mkosi
 binary and is not to be considered a public API.
 
+## git blame
+
+When using git blame, be sure to add `--ignore-revs-file .git-blame-ignore-revs` to the arguments to ignore
+irrelevant code formatting commits. This can be set permanently via the `blame.ignoreRevsFile` git option.
+
 # References
 
 * [Primary mkosi git repository on GitHub](https://github.com/systemd/mkosi/)