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

Re: Re* Re* [PATCH v4 0/3] advice: add "all" option to disable all hints

From
DSDragan Simic <dsimic@manjaro.org>
Date
May 7, 2024, 00:11 UTC
Message-ID
<5665eef37193e8a6894f100a554bce4d@manjaro.org>
In-Reply-To
<xmqqbk5i3ncw.fsf_-_@gitster.g>
Hello Junio,
On 2024-05-06 18:40, Junio C Hamano wrote:
Show 14 quoted lines
> So what's the conclusion of this discussion (have we reached one
> yet)?
> 
> to me it sounds like everybody is on board to raise the default used
> for format-patch.  In the old thread I said "I use something
> unreasonably high like 9999", but my "unreasonably high" number
> these days is 999, which was used in the earlier weatherbaloon
> patch.  The old thread ended with an academic "we know different
> defaults are appropriate, but what is the right number then?" but
> anything higher (like 999 or even 9999) is better than the default
> for range-diff which is 60, I would think.
> 
> Here is the patch, this time with a bit of documentation stolen from
> the old weather-balloon by Ævar.

After going through all the linked discussions, I think that introducing the new default value for the creation factor in "git format-patch" is the way to go. However, I still have one remaining concern.

See, the creation factor is described in the documentation as some fudge factor, specified as a percentage. Without going through the actual source code in detail, a question that pops up in my mind is why do we need to use 999 or 9999 as the new default value? Shouldn't 99 or 100 be good enough instead, if it's a percentage? I'd assume that the same question might be asked by other Git users.

Admittedly, I haven't produced numerous range diffs, but for what I did, 90 worked very well as the creation factor value. I even created some aliases that specify 90 as the creation factor value.

Show 73 quoted lines
> ----- >8 --------- >8 --------- >8 --------- >8 -----
> Subject: [PATCH] format-patch: run range-diff with larger 
> creation-factor
> 
> We see too often that a range-diff added to format-patch output
> shows too many "unmatched" patches.  This is because the default
> value for creation-factor is set to a relatively low value.
> 
> It may be justified for other uses (like you have a yet-to-be-sent
> new iteration of your series, and compare it against the 'seen'
> branch that has an older iteration, probably with the '--left-only'
> option, to pick out only your patches while ignoring the others) of
> "range-diff" command, but when the command is run as part of the
> format-patch, the user _knows_ and expects that the patches in the
> old and the new iterations roughly correspond to each other, so we
> can and should use a much higher default.
> 
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  Documentation/git-format-patch.txt | 5 +++++
>  builtin/log.c                      | 2 +-
>  range-diff.h                       | 6 ++++++
>  3 files changed, 12 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/git-format-patch.txt
> b/Documentation/git-format-patch.txt
> index 728bb3821c..b72f87b114 100644
> --- a/Documentation/git-format-patch.txt
> +++ b/Documentation/git-format-patch.txt
> @@ -346,6 +346,11 @@ material (this may change in the future).
>  	between the previous and current series of patches by adjusting the
>  	creation/deletion cost fudge factor. See linkgit:git-range-diff[1])
>  	for details.
> ++
> +Defaults to 999 (the linkgit:git-range-diff[1] uses 60), as the use
> +case is to show comparison with an older iteration of the same
> +topic and the tool should find more correspondence between the two
> +sets of patches.
> 
>  --notes[=<ref>]::
>  --no-notes::
> diff --git a/builtin/log.c b/builtin/log.c
> index c0a8bb95e9..73608ffef9 100644
> --- a/builtin/log.c
> +++ b/builtin/log.c
> @@ -2274,7 +2274,7 @@ int cmd_format_patch(int argc, const char
> **argv, const char *prefix)
>  	}
> 
>  	if (creation_factor < 0)
> -		creation_factor = RANGE_DIFF_CREATION_FACTOR_DEFAULT;
> +		creation_factor = CREATION_FACTOR_FOR_THE_SAME_SERIES;
>  	else if (!rdiff_prev)
>  		die(_("the option '%s' requires '%s'"), "--creation-factor", 
> "--range-diff");
> 
> diff --git a/range-diff.h b/range-diff.h
> index 04ffe217be..2f69f6a434 100644
> --- a/range-diff.h
> +++ b/range-diff.h
> @@ -6,6 +6,12 @@
> 
>  #define RANGE_DIFF_CREATION_FACTOR_DEFAULT 60
> 
> +/*
> + * A much higher value than the default, when we KNOW we are comparing
> + * the same series (e.g., used when format-patch calls range-diff).
> + */
> +#define CREATION_FACTOR_FOR_THE_SAME_SERIES 999
> +
>  struct range_diff_options {
>  	int creation_factor;
>  	unsigned dual_color:1;
Previous: Junio C HamanoNext: Junio C Hamano
Message 55 of 67 in “advice: add "all" option to disable all hints”
  1. 0/2 advice: add "all" option to disable all hintsJames Liu, Apr 24, 2024
  2. 1/2 advice: allow advice type to be provided in testsJames Liu, Apr 24, 2024
  3. Patrick SteinhardtApr 24, 2024
  4. 2/2 advice: add "all" option to disable all hintsJames Liu, Apr 24, 2024
  5. Patrick SteinhardtApr 24, 2024
  6. Junio C HamanoApr 24, 2024
  7. Patrick SteinhardtApr 24, 2024
  8. Phillip WoodApr 24, 2024
  9. Patrick SteinhardtApr 24, 2024
  10. Junio C HamanoApr 24, 2024
  11. Patrick SteinhardtApr 25, 2024
  12. Junio C HamanoApr 25, 2024
  13. Dragan SimicApr 24, 2024
  14. Dragan SimicApr 24, 2024
  15. Junio C HamanoApr 24, 2024
  16. Patrick SteinhardtApr 25, 2024
  17. Dragan SimicApr 24, 2024
  18. 0/1 advice: add --no-advice global optionJames Liu, Apr 29, 2024
  19. 1/1 advice: add --no-advice global optionJames Liu, Apr 29, 2024
  20. Dragan SimicApr 29, 2024
  21. James LiuApr 29, 2024
  22. Dragan SimicApr 29, 2024
  23. Dragan SimicApr 29, 2024
  24. Eric SunshineApr 29, 2024
  25. Dragan SimicApr 29, 2024
  26. Jeff KingApr 29, 2024
  27. Dragan SimicApr 29, 2024
  28. Junio C HamanoApr 29, 2024
  29. James LiuApr 30, 2024
  30. Junio C HamanoApr 29, 2024
  31. Rubén JustoApr 29, 2024
  32. Dragan SimicApr 29, 2024
  33. 0/1 advice: add --no-advice global optionJames Liu, Apr 30, 2024
  34. 1/1 advice: add --no-advice global optionJames Liu, Apr 30, 2024
  35. Patrick SteinhardtApr 30, 2024
  36. Dragan SimicApr 30, 2024
  37. Junio C HamanoApr 30, 2024
  38. 0/3 advice: add "all" option to disable all hintsJames Liu, May 3, 2024
  39. 1/3 doc: clean up usage documentation for --no-* optsJames Liu, May 3, 2024
  40. Junio C HamanoMay 3, 2024
  41. James LiuMay 6, 2024
  42. 2/3 doc: add spacing around paginate optionsJames Liu, May 3, 2024
  43. Karthik NayakMay 3, 2024
  44. Junio C HamanoMay 3, 2024
  45. 3/3 advice: add --no-advice global optionJames Liu, May 3, 2024
  46. 4/3 t0018: two small fixesJunio C Hamano, May 8, 2024
  47. Dragan SimicMay 3, 2024
  48. Re* [PATCH v4 0/3] advice: add "all" option to disable all hintsJunio C Hamano, May 3, 2024
  49. Eric SunshineMay 3, 2024
  50. Junio C HamanoMay 3, 2024
  51. Junio C HamanoMay 3, 2024
  52. Eric SunshineMay 3, 2024
  53. Johannes SchindelinMay 5, 2024
  54. Re* Re* [PATCH v4 0/3] advice: add "all" option to disable all hintsJunio C Hamano, May 6, 2024
  55. Dragan SimicMay 7, 2024
  56. Junio C HamanoMay 7, 2024
  57. Dragan SimicMay 7, 2024
  58. Dragan SimicMay 7, 2024
  59. Karthik NayakMay 3, 2024
  60. James LiuMay 5, 2024
  61. Junio C HamanoMay 3, 2024
  62. James LiuMay 5, 2024
  63. James LiuMay 6, 2024
  64. Junio C HamanoMay 6, 2024
  65. James LiuMay 6, 2024
  66. Karthik NayakMay 7, 2024
  67. Junio C HamanoMay 6, 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.