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

[PATCH v3 8/8] format-patch: --commit-list-format without prefix

From
Mirko Faina <mroik@delayed.space>
Date
Mar 23, 2026, 16:57 UTC
Message-ID
<d125458e3351e6007831dcf84c70e91924b8883d.1774284699.git.mroik@delayed.space>
In-Reply-To
<cover.1774284699.git.mroik@delayed.space>

Having to prefix a custom format-string with "log:" when passed from the CLI can be annoying. It would be great if this prefix wasn't required.

Teach make_cover_letter() to accept custom format-strings without the "log:" prefix if a placeholder is detected.

Note that both here and in "git log --format" the check is done naively by just checking for the presence of a '%'.

Signed-off-by: Mirko Faina <mroik@delayed.space>
---
 Documentation/git-format-patch.adoc |  4 +++-
 builtin/log.c                       |  2 ++
 t/t4014-format-patch.sh             | 24 ++++++++++++++++++++++++
 3 files changed, 29 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-format-patch.adoc b/Documentation/git-format-patch.adoc
index 55cc680685..c52dbcc170 100644
--- a/Documentation/git-format-patch.adoc
+++ b/Documentation/git-format-patch.adoc
@@ -326,8 +326,10 @@ 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`, `modern` or a
-	format string prefixed with `log:`.
+	format-string prefixed with `log:`.
 	e.g. `log: %s (%an)`
+	The user is allowed to drop the prefix if the format-string contains a
+	`%<placeholder>`.
 	If not given, defaults to the `format.commitListFormat` configuration
 	variable.
 	This option implies the use of `--cover-letter` unless
diff --git a/builtin/log.c b/builtin/log.c
index c6cf04350a..ad7b7215fe 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -1448,6 +1448,8 @@ static void make_cover_letter(struct rev_info *rev, int use_separate_file,
 	else if (!strcmp(format, "modern"))
 		generate_commit_list_cover(rev->diffopt.file, "[%(count)/%(total)] %s",
 					   list, nr);
+	else if (strchr(format, '%'))
+		generate_commit_list_cover(rev->diffopt.file, format, 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 7571cc582b..7517094bd6 100755
--- a/t/t4014-format-patch.sh
+++ b/t/t4014-format-patch.sh
@@ -392,6 +392,30 @@ 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 custom format no prefix' '
+	rm -rf patches &&
+	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="[%(count)/%(total)] %s (%an)" \
+	-o patches HEAD~1 &&
+	test_grep "^\[1/1\] This is a subject (A U Thor)$" patches/0000-cover-letter.patch
+'
+
+test_expect_success 'cover letter fail when no prefix and no placeholder' '
+	rm -rf patches &&
+	test_when_finished "git reset --hard HEAD~1" &&
+	test_when_finished "rm -rf patches test_file err" &&
+	touch test_file &&
+	git add test_file &&
+	git commit -m "This is a subject" &&
+	test_must_fail git format-patch --commit-list-format="this should fail" \
+	-o patches HEAD~1 2>err &&
+	test_grep "is not a valid format string" err
+'
+
 test_expect_success 'cover letter modern format' '
 	test_when_finished "git reset --hard HEAD~1" &&
 	test_when_finished "rm -rf patches test_file" &&
-- 
2.53.0.1118.gaef5881109
Previous: Mirko FainaNext: Mirko Faina
Message 31 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.