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

Re: [PATCH v2 3/3] diff: let external diffs report that changes are uninteresting

From
Junio C Hamano <gitster@pobox.com>
Date
Jun 6, 2024, 15:49 UTC
Message-ID
<xmqqsexqnkb7.fsf@gitster.g>
In-Reply-To
<55389f35-5762-4b86-81bf-b9fe956815d2@web.de>
René Scharfe <l.s.r@web.de> writes:
Show 30 quoted lines
>>> +diff.trustExitCode::
>>> +	If this boolean value is set to true then the `diff.external`
>>> +	command is expected to return exit code 1 if it finds
>>> +	significant changes and 0 if it doesn't, like diff(1).  If it's
>>> +	false then the `diff.external` command is expected to always
>>> +	return exit code 0.  Defaults to false.
>>
>> I find this somewhat unclear. What are the consequences when this value
>> is set to false, but the command exits with code other than 0? Is it
>>
>>     If it's false then any exit code other than 0 of the `diff.external`
>>     command is treated as an error.
>
> Yes, unexpected exit codes are reported as errors.
>
> If trustExitCode is false and --quiet is given then the execution of
> external diffs is skipped, so in that situation there is no exit code to
> expect, though.  Not sure how to express it concisely, though.  This
> attempt looks a bit bloated:
>
> --quiet::
>         Disable all output of the program. Implies `--exit-code`.
>         Disables execution of external diff helpers whose exit code
>         is not trusted, i.e. their respective configuration option
> 	`diff.trustExitCode` or `diff.<driver>.trustExitCode` or
> 	environment variable `GIT_EXTERNAL_DIFF_TRUST_EXIT_CODE` is
> 	false.
>
> Might be worth documenting this original behavior somehow, anyway.  It
> makes sense in hindsight, but surprised me a bit when I wrote the tests.

Yes. The explanation of trustExitCode makes sense as an explanation of what the variable means (i.e. if set, we pay attention to the exit code of the external diff driver, otherwise a non-zero exit is an error), but I suspect that readers are _more_ interested in how the external diff driver contributes to the answer to the "has this path been changed?" question when the variable is on and off. And the above description of "--quiet" does help answer that question somewhat.

Previous: René ScharfeNext: Phillip Wood
Message 23 of 32 in “Possible git-diff bug when using exit-code with diff filters”
  1. German LashevichApr 20, 2024
  2. René ScharfeApr 21, 2024
  3. Junio C HamanoApr 21, 2024
  4. rsbecker@nexbridge.comApr 21, 2024
  5. Junio C HamanoApr 21, 2024
  6. rsbecker@nexbridge.comApr 21, 2024
  7. René ScharfeMay 5, 2024
  8. Junio C HamanoMay 6, 2024
  9. 1/2 diff: report unmerged paths as changes in run_diff_cmd()René Scharfe, May 5, 2024
  10. 2/2 diff: fix --exit-code with external diffRené Scharfe, May 5, 2024
  11. Phillip WoodMay 5, 2024
  12. Junio C HamanoMay 6, 2024
  13. René ScharfeMay 6, 2024
  14. phillip.wood123@gmail.comMay 8, 2024
  15. René ScharfeMay 11, 2024
  16. René ScharfeMay 12, 2024
  17. 0/3 diff: fix --exit-code with external diffRené Scharfe, Jun 5, 2024
  18. 1/3 t4020: test exit code with external diffsRené Scharfe, Jun 5, 2024
  19. 2/3 userdiff: add and use struct external_diffRené Scharfe, Jun 5, 2024
  20. 3/3 diff: let external diffs report that changes are uninterestingRené Scharfe, Jun 5, 2024
  21. Johannes SixtJun 6, 2024
  22. René ScharfeJun 6, 2024
  23. Junio C HamanoJun 6, 2024
  24. Phillip WoodJun 6, 2024
  25. René ScharfeJun 7, 2024
  26. Junio C HamanoJun 5, 2024
  27. 0/3 diff: fix --exit-code with external diffRené Scharfe, Jun 9, 2024
  28. 1/3 t4020: test exit code with external diffsRené Scharfe, Jun 9, 2024
  29. Junio C HamanoJun 10, 2024
  30. 2/3 userdiff: add and use struct external_diffRené Scharfe, Jun 9, 2024
  31. 3/3 diff: let external diffs report that changes are uninterestingRené Scharfe, Jun 9, 2024
  32. phillip.wood123@gmail.comJun 10, 2024

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.