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>
Junio C Hamano committed
May 6, 2024 at 09:40 UTC
c22d41d641711879c57299244ae13b6c4a215fee
3 files changed
+12
-1
Documentation/git-format-patch.txt
+5
@@ -346,6 +346,11 @@ material (this may change in the future).
346
between the previous and current series of patches by adjusting the
347
creation/deletion cost fudge factor. See linkgit:git-range-diff[1])
348
for details.
349
++
350
+Defaults to 999 (the linkgit:git-range-diff[1] uses 60), as the use
351
+case is to show comparison with an older iteration of the same
352
+topic and the tool should find more correspondence between the two
353
+sets of patches.
354
355
--notes[=<ref>]::
356
--no-notes::
builtin/log.c
+1
-1
@@ -2274,7 +2274,7 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
2274
}
2275
2276
if (creation_factor < 0)
2277
- creation_factor = RANGE_DIFF_CREATION_FACTOR_DEFAULT;
2277
+ creation_factor = CREATION_FACTOR_FOR_THE_SAME_SERIES;
2278
else if (!rdiff_prev)
2279
die(_("the option '%s' requires '%s'"), "--creation-factor", "--range-diff");
2280
range-diff.h
+6
@@ -6,6 +6,12 @@
6
7
#define RANGE_DIFF_CREATION_FACTOR_DEFAULT 60
8
9
+/*
10
+ * A much higher value than the default, when we KNOW we are comparing
11
+ * the same series (e.g., used when format-patch calls range-diff).
12
+ */
13
+#define CREATION_FACTOR_FOR_THE_SAME_SERIES 999
14
+
15
struct range_diff_options {
16
int creation_factor;
17
unsigned dual_color:1;