[v7,0/8] blame: add the ability to ignore commits

Message

Barret Rhoden May 15, 2019, 9:44 p.m. UTC

This patch set adds the ability to ignore a set of commits and their
changes when blaming.  This can be used to ignore a commit deemed 'not
interesting,' such as reformatting.

The main change to this patchset from previous versions is the addition of
Michael's fuzzy fingerprinting logic.  It's added in its own commit, and
integrated into the more generic blame-ignore logic in the final commit of the
patch set.

v6 -> v7
v6: https://public-inbox.org/git/[e-mail]
- Split the init_skiplist commit into two commits: "change variable names" then
  "move the function".
- Fixed the test's usage of grep, from grep "\+" to grep -E "+".
- Fixed comments related to fsck.skipList, added them to config/blame.txt
- A line in the blame output is either "ignored" or "unblamable", not both.
- Changed the way we mark lines.  In particular, we don't zero-out the hash
  anymore for unblamables, since all zeros already had a meaning.  We also
  distinguish between ignored and unblamable.  Here's the new style:
	? for ignored
	* for unblamable
  Both of those markings are controlled by config vars; the discussion on the
  list shows that no default style works for everyone:
        if blame.markIgnoredLines
	    Line was attributed to a commit that was not the most recent to
	    change it (i.e. the ignored commit) and will be marked with '?'.
	    Lines touched by an ignored commit that we could not blame on
	    another are unmarked.
        if blame.markUnblamableLines
	    Lines touched by an ignored commit that we could not blame on
	    another are marked with *.  I wanted to differentiate between
	    Ignored and Unblamable, so a single ? isn't enough.
- Added Michael's fuzzy fingerprinting code.
- We guess_line_blames() for an entire chunk, instead of per-blame entry.  A diff
  chunk can be made up of more than one blame_entry, which made the job of the
  heuristic unnecessarily difficult.
- Rebased onto master.

v5 -> v6
v5: https://public-inbox.org/git/[e-mail]/
- The "guess" heuristic can now look anywhere in the parent file for a
  matching line, instead of just looking in the parent chunk.  The
  chunks passed to blame_chunk() are smaller than you'd expect: they are
  just adjacent '-' and '+' sections.  Any diff 'context' is a chunk
  boundary.
- Fixed the parent_len calculation.  I had been basing it off of
  e->num_lines, and treating the blame entry as if it was the target
  chunk, but the individual blame entries are subsets of the chunk.  I
  just pass the parent chunk info all the way through now.
- Use Michael's newest fingerprinting code, which is a large speedup.
- Made a config option to zero the hash for an ignored line when the
  heuristic could not find a line in the parent to blame.  Previously,
  this was always 'on'.
- Moved the for loop variable declarations out of the for ().
- Rebased on master.

v4 -> v5
v4: https://public-inbox.org/git/[e-mail]/
- Changed the handling of blame_entries from ignored commits so that you
  can use any algorithm you want to map lines from the diff chunk to
  different parts of the parent commit.
- fill_origin_blob() optionally can track the offsets of the start of
  every line, similar to what we do in the scoreboard for the final
  file.  This can be used by the matching algorithm.  It has no effect
  if you are not ignoring commits.
- RFC of a fuzzy/fingerprinting heuristic, based on Michael Platings RFC
  at https://public-inbox.org/git/[e-mail]/
- Made the tests that detect unblamable entries more resilient to
  different heuristics.
- Fixed a few bugs:
	- tests were not grepping the line number from --line-porcelain
	  correctly.
	- In the old version, when I passed the "upper" part of the
	  blame entry to the target and marked unblamable, the suspect
	  was incorrectly marked as the parent.  The s_lno was also in
	  the parent's address space.

v3 -> v4
v3: https://public-inbox.org/git/[e-mail]/
- Cleaned up the tests, especially removing usage of sed -i.
- Squashed the 'tests' commit into the other blame commits.  Let me know
  if you'd like further squashing.

v2 -> v3
v2: https://public-inbox.org/git/[e-mail]/
- SHA-1 -> "object name", and fixed other comments
- Changed error string for oidset_parse_file()
- Adjusted existing fsck tests to handle those string changes
- Return hash of all zeros for lines we know we cannot identify
- Allow repeated options for blame.ignoreRevsFile and
  --ignore-revs-file.  An empty file name resets the list.  Config
  options are parsed before the command line options.
- Rebased to master
- Added regression tests

v1 -> v2
v1: https://public-inbox.org/git/[e-mail]/
- extracted the skiplist from fsck to avoid duplicating code
- overhauled the interface and options
- split out markIgnoredFiles
- handled merges

Barret Rhoden (7):
  fsck: rename and touch up init_skiplist()
  Move oidset_parse_file() to oidset.c
  blame: use a helper function in blame_chunk()
  blame: add the ability to ignore commits and their changes
  blame: add config options for the output of ignored or unblamable
    lines
  blame: optionally track line fingerprints during fill_blame_origin()
  blame: use the fingerprint heuristic to match ignored lines

Michael Platings (1):
  blame: add a fingerprint heuristic to match ignored lines

 Documentation/blame-options.txt |   19 +
 Documentation/config/blame.txt  |   16 +
 Documentation/git-blame.txt     |    1 +
 blame.c                         | 1024 +++++++++++++++++++++++++++++--
 blame.h                         |    6 +
 builtin/blame.c                 |   56 ++
 fsck.c                          |   37 +-
 oidset.c                        |   35 ++
 oidset.h                        |    8 +
 t/t5504-fetch-receive-strict.sh |   14 +-
 t/t8013-blame-ignore-revs.sh    |  274 +++++++++
 t/t8014-blame-ignore-fuzzy.sh   |  432 +++++++++++++
 12 files changed, 1823 insertions(+), 99 deletions(-)
 create mode 100755 t/t8013-blame-ignore-revs.sh
 create mode 100755 t/t8014-blame-ignore-fuzzy.sh