git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 2/2] diff: teach diff to read gitattribute diff-algorithm

From
Elijah Newren <newren@gmail.com>
Date
Feb 10, 2023, 09:57 UTC
Message-ID
<CABPp-BHQDS+AzWXtk9WV4HY2QZ8UdXrWJJDr-y6VPoLB6HuAfw@mail.gmail.com>
In-Reply-To
<1ddac91b-7552-3e1e-9888-9e21e808104d@dunelm.org.uk>
Hi Phillip,
On Thu, Feb 9, 2023 at 6:44 AM Phillip Wood <phillip.wood123@gmail.com> wrote:
Show 36 quoted lines
>
> Hi Elijah
>
> On 09/02/2023 09:09, Elijah Newren wrote:
> > Hi John and Phillip,
> >
> > On Tue, Feb 7, 2023 at 9:05 AM John Cai <johncai86@gmail.com> wrote:
> >>
> > [...]
> >>> Perhaps I'm over simplifying but having read the issue you linked to I couldn't help feeling that the majority of users might be satisfied by just changing gitlab to use the patience algorithm when generating diffs.
> >>
> >> Right, I recognize this is a judgment call that may be best left up to the list.
> >>
> >> We don't have a way in GitLab to change the diff algorithm currently. Of course
> >> that can be implemented outside of Git,
> >
> > Well, the below doesn't allow users to make diffs better for
> > *individual* files of interest, but if you agree with me that we
> > should just make diffs better for all users automatically, it's a
> > two-line change in git.git that I'd love to eventually convince the
> > project to take (though obviously doing that would also require some
> > documentation changes and some good messaging in release notes and
> > whatnot).  I've used it for a good long while, and had a few dozen
> > users using this patch too, all without complaint:
>
> I'd support a change to either patience or histogram as the default
> algorithm. My personal preference would be for the patience algorithm as
> I think it generally gives nicer diffs in the cases that the two
> disagree (see below, I've tried changing diff.algorithm to histogram a
> few times and I always end up changing it back to patience pretty
> quickly). However I can see there is an advantage in having "diff" and
> "merge" use the same algorithm as users who diffing either side to the
> merge base will see the same diff that the merge is using. The histogram
> algorithm is known to produce sub-optimal diffs in certain cases[1] but
> I'm not sure how much worse it is in that respect than any of the other
> algorithms.
[...]
> [1]
> https://lore.kernel.org/git/CAGZ79kZYO6hHiAM8Sfp3J=VX11c=0-7YDSx3_EAKt5-uvvt-Ew@mail.gmail.com/

Thanks, I might have a fix, though I'm a bit worried my tweaks might trigger issues elsewhere or cost a bit of performance; I'll need to test. Are there any other good known testcases where histogram produces sub-optimal diffs?

Show 20 quoted lines
> To see the differences between the output of patience and histogram
> algorithms I diffed the output of "git log -p --no-merges
> --diff-algorithm=patience" and "git log -p --no-merges
> --diff-algorithm=histogram". The first three differences are
>
> - 6c065f72b8 (http: support CURLOPT_PROTOCOLS_STR, 2023-01-16)
>    In get_curl_allowed_protocols() the patience algorithm shows the
>    change in the return statement more clearly
>
> - 47cfc9bd7d (attr: add flag `--source` to work with tree-ish, 2023-01-14)
>     The histogram algorithm shows read_attr_from_index() being moved
>     whereas the patience algorithm does not making the diff easier to
>     follow.
>
> - b0226007f0 (fsmonitor: eliminate call to deprecated FSEventStream
> function, 2022-12-14)
>    In fsm_listen__stop_async() the histogram algorithm shows
>    data->shutdown_style = SHUTDOWN_EVENT;
>    being moved, which is not as clear as the patience output which
>    shows it as a context line.

If my current changes are "good", then they also remove the differences between patience and histogram for the second and third commits above. (And the differences between the two algorithms for the first commit look really minor.)

> I think there is a degree of personal preference when it comes to which
> out of patience or histogram is best and the user can easily select
> their preferred algorithm so I'd be happy with either.
:-)
Previous: Phillip WoodNext: Phillip Wood
Message 19 of 78 in “Teach diff to honor diff algorithms set through git attributes”
  1. 0/2 Teach diff to honor diff algorithms set through git attributesJohn Cai via GitGitGadget, Feb 5, 2023
  2. 1/2 diff: consolidate diff algorithm option parsingJohn Cai via GitGitGadget, Feb 5, 2023
  3. Phillip WoodFeb 6, 2023
  4. 2/2 diff: teach diff to read gitattribute diff-algorithmJohn Cai via GitGitGadget, Feb 5, 2023
  5. Eric SunshineFeb 5, 2023
  6. John CaiFeb 6, 2023
  7. Phillip WoodFeb 6, 2023
  8. Eric SunshineFeb 6, 2023
  9. John CaiFeb 6, 2023
  10. Elijah NewrenFeb 9, 2023
  11. "bad" diffs (was: [PATCH 2/2] diff: teach diff to read gitattribute diff-algorithm)Ævar Arnfjörð Bjarmason, Feb 9, 2023
  12. John CaiFeb 9, 2023
  13. Ævar Arnfjörð BjarmasonFeb 6, 2023
  14. John CaiFeb 6, 2023
  15. Phillip WoodFeb 7, 2023
  16. John CaiFeb 7, 2023
  17. Elijah NewrenFeb 9, 2023
  18. Phillip WoodFeb 9, 2023
  19. Elijah NewrenFeb 10, 2023
  20. Phillip WoodFeb 11, 2023
  21. Jeff KingFeb 11, 2023
  22. Elijah NewrenFeb 15, 2023
  23. Jeff KingFeb 15, 2023
  24. Junio C HamanoFeb 15, 2023
  25. Phillip WoodFeb 15, 2023
  26. Jeff KingFeb 15, 2023
  27. Ævar Arnfjörð BjarmasonFeb 7, 2023
  28. Phillip WoodFeb 15, 2023
  29. Elijah NewrenFeb 9, 2023
  30. John CaiFeb 14, 2023
  31. Elijah NewrenFeb 15, 2023
  32. Elijah NewrenFeb 9, 2023
  33. Ævar Arnfjörð BjarmasonFeb 9, 2023
  34. Jeff KingFeb 11, 2023
  35. Jeff KingFeb 7, 2023
  36. Ævar Arnfjörð BjarmasonFeb 7, 2023
  37. Junio C HamanoFeb 7, 2023
  38. Ævar Arnfjörð BjarmasonFeb 7, 2023
  39. Junio C HamanoFeb 7, 2023
  40. Ævar Arnfjörð BjarmasonFeb 7, 2023
  41. John CaiFeb 9, 2023
  42. Jeff KingFeb 11, 2023
  43. 0/2 Teach diff to honor diff algorithms set through git attributesJohn Cai via GitGitGadget, Feb 14, 2023
  44. 1/2 diff: consolidate diff algorithm option parsingJohn Cai via GitGitGadget, Feb 14, 2023
  45. Junio C HamanoFeb 15, 2023
  46. John CaiFeb 15, 2023
  47. Junio C HamanoFeb 15, 2023
  48. Jeff KingFeb 16, 2023
  49. Junio C HamanoFeb 16, 2023
  50. John CaiFeb 16, 2023
  51. 2/2 diff: teach diff to read gitattribute diff-algorithmJohn Cai via GitGitGadget, Feb 14, 2023
  52. Junio C HamanoFeb 15, 2023
  53. Junio C HamanoFeb 15, 2023
  54. John CaiFeb 16, 2023
  55. 0/2 Teach diff to honor diff algorithms set through git attributesJohn Cai via GitGitGadget, Feb 17, 2023
  56. 1/2 diff: consolidate diff algorithm option parsingJohn Cai via GitGitGadget, Feb 17, 2023
  57. Junio C HamanoFeb 17, 2023
  58. Elijah NewrenFeb 18, 2023
  59. 2/2 diff: teach diff to read algorithm from diff driverJohn Cai via GitGitGadget, Feb 17, 2023
  60. Junio C HamanoFeb 17, 2023
  61. Elijah NewrenFeb 18, 2023
  62. John CaiFeb 20, 2023
  63. Elijah NewrenFeb 20, 2023
  64. John CaiFeb 20, 2023
  65. Elijah NewrenFeb 20, 2023
  66. John CaiFeb 20, 2023
  67. Jeff KingFeb 22, 2023
  68. John CaiFeb 24, 2023
  69. Elijah NewrenFeb 18, 2023
  70. John CaiFeb 20, 2023
  71. 0/2 Teach diff to honor diff algorithms set through git attributesJohn Cai via GitGitGadget, Feb 20, 2023
  72. 1/2 diff: consolidate diff algorithm option parsingJohn Cai via GitGitGadget, Feb 20, 2023
  73. 2/2 diff: teach diff to read algorithm from diff driverJohn Cai via GitGitGadget, Feb 20, 2023
  74. Junio C HamanoFeb 21, 2023
  75. Elijah NewrenFeb 21, 2023
  76. Junio C HamanoFeb 21, 2023
  77. John CaiFeb 21, 2023
  78. Elijah NewrenFeb 21, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.