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

[PATCH 6/7] format-patch: add preset for --commit-list-format

From
Mirko Faina <mroik@delayed.space>
Date
Mar 14, 2026, 23:20 UTC
Message-ID
<2a29c31fbb7143867b680ce488f97e9b51150b97.1773530191.git.mroik@delayed.space>
In-Reply-To
<cover.1773530191.git.mroik@delayed.space>

"git format-patch --commit-list-format" enables the user to make their own format for the commit list in the cover letter. It would be nice to have a ready to use format to replace shortlog.

Teach make_cover_letter() the "modern" format preset. This new format is the same as: "log:[%(count)/%(total)] %s".

Signed-off-by: Mirko Faina <mroik@delayed.space>
---
 Documentation/config/format.adoc    |  2 +-
 Documentation/git-format-patch.adoc |  4 ++--
 builtin/log.c                       |  3 +++
 t/t4014-format-patch.sh             | 20 +++++++++++++++-----
 4 files changed, 21 insertions(+), 8 deletions(-)
diff --git a/Documentation/config/format.adoc b/Documentation/config/format.adoc
index ea5ec5df7a..ef1ed1d250 100644
--- a/Documentation/config/format.adoc
+++ b/Documentation/config/format.adoc
@@ -104,7 +104,7 @@ format.coverLetter::
 format.commitListFormat::
 	When the `--cover-letter-format` option is not given, `format-patch`
 	uses the value of this variable to decide how to format the title of
-	each commit. Default to `shortlog`.
+	each commit. Defaults to `shortlog`.
 
 format.outputDirectory::
 	Set a custom directory to store the resulting files instead of the
diff --git a/Documentation/git-format-patch.adoc b/Documentation/git-format-patch.adoc
index 45ca72e670..55cc680685 100644
--- a/Documentation/git-format-patch.adoc
+++ b/Documentation/git-format-patch.adoc
@@ -325,8 +325,8 @@ feeding the result to `git send-email`.
 
 --commit-list-format=<format-spec>::
 	Specify the format in which to generate the commit list of the patch
-	series. The accepted values for format-spec are "shortlog" or a format
-	string prefixed with `log:`.
+	series. The accepted values for format-spec are `shortlog`, `modern` or a
+	format string prefixed with `log:`.
 	e.g. `log: %s (%an)`
 	If not given, defaults to the `format.commitListFormat` configuration
 	variable.
diff --git a/builtin/log.c b/builtin/log.c
index d1765ce4ad..c6cf04350a 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -1445,6 +1445,9 @@ static void make_cover_letter(struct rev_info *rev, int use_separate_file,
 		generate_commit_list_cover(rev->diffopt.file, format, list, nr);
 	else if (!strcmp(format, "shortlog"))
 		generate_shortlog_cover_letter(&log, rev, list, nr);
+	else if (!strcmp(format, "modern"))
+		generate_commit_list_cover(rev->diffopt.file, "[%(count)/%(total)] %s",
+					   list, nr);
 	else
 		die(_("'%s' is not a valid format string"), format);
 
diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
index ca37f40a6a..7571cc582b 100755
--- a/t/t4014-format-patch.sh
+++ b/t/t4014-format-patch.sh
@@ -392,18 +392,17 @@ test_expect_success 'cover letter with subject, author and count' '
 	test_grep "^\[1/1\] This is a subject (A U Thor)$" patches/0000-cover-letter.patch
 '
 
-test_expect_success 'cover letter with author and count' '
+test_expect_success 'cover letter modern format' '
 	test_when_finished "git reset --hard HEAD~1" &&
 	test_when_finished "rm -rf patches test_file" &&
 	touch test_file &&
 	git add test_file &&
 	git commit -m "This is a subject" &&
-	git format-patch --commit-list-format="log:[%(count)/%(total)] %an" \
-	-o patches HEAD~1 &&
-	test_grep "^\[1/1\] A U Thor$" patches/0000-cover-letter.patch
+	git format-patch --commit-list-format="modern" -o patches HEAD~1 &&
+	test_grep "^\[1/1\] This is a subject$" patches/0000-cover-letter.patch
 '
 
-test_expect_success 'cover letter shortlog' '
+test_expect_success 'cover letter shortlog format' '
 	test_when_finished "git reset --hard HEAD~1" &&
 	test_when_finished "rm -rf expect patches result test_file" &&
 	cat >expect <<-"EOF" &&
@@ -451,6 +450,17 @@ test_expect_success 'cover letter config with count and author' '
 	test_line_count = 2 result
 '
 
+test_expect_success 'cover letter config commitlistformat set to modern' '
+	test_when_finished "rm -rf patches result" &&
+	test_when_finished "git config unset format.coverletter" &&
+	test_when_finished "git config unset format.commitlistformat" &&
+	git config set format.coverletter true &&
+	git config set format.commitlistformat modern &&
+	git format-patch -o patches HEAD~2 &&
+	grep -E "^[[[:digit:]]+/[[:digit:]]+] .*$" patches/0000-cover-letter.patch >result &&
+	test_line_count = 2 result
+'
+
 test_expect_success 'cover letter config commitlistformat set to shortlog' '
 	test_when_finished "rm -rf patches result" &&
 	test_when_finished "git config unset format.coverletter" &&
-- 
2.53.0.959.g497ff81fa9
Previous: Mirko FainaNext: Mirko Faina
Message 9 of 42 in “improve "git format-patch --commit-list-format"”
  1. 0/7 improve "git format-patch --commit-list-format"Mirko Faina, Mar 14, 2026
  2. 1/7 pretty.c: better die message %(count) and %(total)Mirko Faina, Mar 14, 2026
  3. 3/7 format-patch: rename --cover-letter-format optionMirko Faina, Mar 14, 2026
  4. 2/7 format-patch: refactor generate_commit_list_coverMirko Faina, Mar 14, 2026
  5. 4/7 format.commitListFormat: strip meaning from emptyMirko Faina, Mar 14, 2026
  6. 5/7 format-patch: wrap generate_commit_list_cover()Mirko Faina, Mar 14, 2026
  7. Kristoffer HaugsbakkMar 17, 2026
  8. Mirko FainaMar 17, 2026
  9. 6/7 format-patch: add preset for --commit-list-formatMirko Faina, Mar 14, 2026
  10. 7/7 format-patch: --commit-list-format without prefixMirko Faina, Mar 14, 2026
  11. Kristoffer HaugsbakkMar 17, 2026
  12. Mirko FainaMar 17, 2026
  13. 0/8 improve "git format-patch --commit-list-format"Mirko Faina, Mar 19, 2026
  14. 1/8 pretty.c: better die message %(count) and %(total)Mirko Faina, Mar 19, 2026
  15. 2/8 format-patch: refactor generate_commit_list_coverMirko Faina, Mar 19, 2026
  16. 4/8 docs/pretty-formats: add %(count) and %(total)Mirko Faina, Mar 19, 2026
  17. Kristoffer HaugsbakkMar 23, 2026
  18. Mirko FainaMar 23, 2026
  19. 3/8 format-patch: rename --cover-letter-format optionMirko Faina, Mar 19, 2026
  20. 5/8 format.commitListFormat: strip meaning from emptyMirko Faina, Mar 19, 2026
  21. 6/8 format-patch: wrap generate_commit_list_cover()Mirko Faina, Mar 19, 2026
  22. 8/8 format-patch: --commit-list-format without prefixMirko Faina, Mar 19, 2026
  23. 7/8 format-patch: add preset for --commit-list-formatMirko Faina, Mar 19, 2026
  24. 0/8 improve "git format-patch --commit-list-format"Mirko Faina, Mar 23, 2026
  25. 1/8 pretty.c: better die message %(count) and %(total)Mirko Faina, Mar 23, 2026
  26. 2/8 format-patch: refactor generate_commit_list_coverMirko Faina, Mar 23, 2026
  27. 4/8 docs/pretty-formats: add %(count) and %(total)Mirko Faina, Mar 23, 2026
  28. 3/8 format-patch: rename --cover-letter-format optionMirko Faina, Mar 23, 2026
  29. 5/8 format.commitListFormat: strip meaning from emptyMirko Faina, Mar 23, 2026
  30. 6/8 format-patch: wrap generate_commit_list_cover()Mirko Faina, Mar 23, 2026
  31. 8/8 format-patch: --commit-list-format without prefixMirko Faina, Mar 23, 2026
  32. 7/8 format-patch: add preset for --commit-list-formatMirko Faina, Mar 23, 2026
  33. Junio C HamanoMar 23, 2026
  34. Kristoffer HaugsbakkMar 24, 2026
  35. Phillip WoodMar 26, 2026
  36. Junio C HamanoMar 26, 2026
  37. Mirko FainaMar 27, 2026
  38. Junio C HamanoMar 27, 2026
  39. Mirko FainaMar 27, 2026
  40. Junio C HamanoMar 27, 2026
  41. D. Ben KnobleMar 26, 2026
  42. Mirko FainaMar 26, 2026

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.