git hyper-blame: Added automatically ignoring revs from a file.

man/man1/git-hyper-blame.1

 '\" t
 .\"     Title: git-hyper-blame
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 02/05/2016
+.\"      Date: 02/19/2016
 .\"    Manual: Chromium depot_tools Manual
-.\"    Source: depot_tools d2dbf32
+.\"    Source: depot_tools ba74a75
 .\"  Language: English
 .\"
-.TH "GIT\-HYPER\-BLAME" "1" "02/05/2016" "depot_tools d2dbf32" "Chromium depot_tools Manual"
+.TH "GIT\-HYPER\-BLAME" "1" "02/19/2016" "depot_tools ba74a75" "Chromium depot_tools Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .\" http://bugs.debian.org/507673
 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
 .SH "NAME"
 git-hyper-blame \- Like git blame, but with the ability to ignore or bypass certain commits\&.
 .SH "SYNOPSIS"
 .sp
 .nf
-\fIgit hyper\-blame\fR [\-i <rev> [\-i <rev> \&...]] [<rev>] [\-\-] <file>
+\fIgit hyper\-blame\fR [\-i <rev> [\-i <rev> \&...]] [\-\-ignore\-file=<file>]
+                [\-\-no\-default\-ignores] [<rev>] [\-\-] <file>
 .fi
 .sp
 .SH "DESCRIPTION"
 .sp
 git hyper\-blame is like git blame but it can ignore or "look through" a given set of commits, to find the real culprit\&.
 .sp
 This is useful if you have a commit that makes sweeping changes that are unlikely to be what you are looking for in a blame, such as mass reformatting or renaming\&. By adding these commits to the hyper\-blame ignore list, git hyper\-blame will look past these commits to find the previous commit that touched a given line\&.
 .sp
 Follows the normal blame syntax: annotates <file> with the revision that last modified each line\&. Optional <rev> specifies the revision of <file> to start from\&.
+.sp
+Automatically looks for a file called \&.git\-blame\-ignore\-revs in the repository root directory\&. This file has the same syntax as the \-\-ignore\-file argument, and any commits mentioned in this file are added to the ignore list\&.
 .SH "OPTIONS"
 .PP
 \-i <rev>
 .RS 4
 A revision to ignore\&. Can be specified as many times as needed\&.
 .RE
+.PP
+\-\-ignore\-file=<file>
+.RS 4
+A file containing a list of revisions to ignore\&. Can have comments beginning with
+#\&.
+.RE
+.PP
+\-\-no\-default\-ignores
+.RS 4
+Do not ignore commits from the
+\&.git\-blame\-ignore\-revs
+file\&.
+.RE
 .SH "EXAMPLE"
 .sp
 Let\(cqs run git blame on a file:
 .sp
 
 .sp
 .if n \{\
 .RS 4
 .\}
 .nf
@@ skipping 30 matching lines @@
 .RE
 .\}
 .sp
 .sp
 hyper\-blame places a * next to any line where it has skipped over an ignored commit, so you know that the line in question has been changed (by an ignored commit) since the given person wrote it\&.
 .SH "CAVEATS"
 .sp
 When a line skips over an ignored commit, a guess is made as to which commit previously modified that line, but it is not always clear where the line came from\&. If the ignored commit makes lots of changes in close proximity, in particular adding/removing/reordering lines, then the wrong authors may be blamed for nearby edits\&.
 .sp
 For this reason, hyper\-blame works best when the ignored commits are be limited to minor changes such as formatting and renaming, not refactoring or other more invasive changes\&.
-.SH "BUGS"
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-There is currently no way to pass the ignore list as a file\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-It should be possible for a git repository to configure an automatic list of commits to ignore (like
-\&.gitignore), so that project owners can maintain a list of "big change" commits that are ignored by hyper\-blame by default\&.
-.RE
 .SH "SEE ALSO"
 .sp
 \fBgit-blame\fR(1)
 .SH "CHROMIUM DEPOT_TOOLS"
 .sp
 Part of the chromium \fBdepot_tools\fR(7) suite\&. These tools are meant to assist with the development of chromium and related projects\&. Download the tools from \m[blue]\fBhere\fR\m[]\&\s-2\u[1]\d\s+2\&.
 .SH "NOTES"
 .IP " 1." 4
 here
 .RS 4
 \%https://chromium.googlesource.com/chromium/tools/depot_tools.git
 .RE