LUCENE-9570: add parial reformatting commit reference to .git-blame-i…

…gnore-revs [thanks rmuir] and add a note to git.txt aiding in making this a persistent local option.
shatejas · Dec 18, 2020 · a827aaa · a827aaa
1 parent 6faa4f9
commit a827aaa
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1,2 @@
+# LUCENE-9570 [google java formatter applied]
+6faa4f98e04
diff --git a/help/git.txt b/help/git.txt
@@ -1,3 +1,6 @@
+git
+===
+
 A list of resources that may be helpful for those learning git:
 
  - Dawid's task-oriented help:
@@ -12,3 +15,13 @@ A list of resources that may be helpful for those learning git:
 
  - git workflows, their pros and cons:
    https://help.github.com/articles/what-is-a-good-git-workflow/
+
+
+git blame
+=========
+
+Git blame shows the last revision that touched a line in a given file. Certain
+reformatting commits may stand in the way here. Please issue the following
+command so that git ignores those irrelevant commits:
+
+git config blame.ignoreRevsFile .git-blame-ignore-revs
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# LUCENE-9570 [google java formatter applied]
		6faa4f98e04