public inbox for git@vger.kernel.org
 help / color / mirror / Atom feed
From: Mirko Faina <mroik@delayed.space>
To: git@vger.kernel.org
Cc: Mirko Faina <mroik@delayed.space>,
	Junio C Hamano <gitster@pobox.com>, Jeff King <peff@peff.net>
Subject: [PATCH v4 5/4] docs: add usage for the cover-letter fmt feature
Date: Fri, 27 Feb 2026 17:42:33 +0100	[thread overview]
Message-ID: <20260227164234.11632-1-mroik@delayed.space> (raw)
In-Reply-To: <f9ee8e24001aa16e5df3dc0bbfccd1b381e37d85.1772196510.git.mroik@delayed.space>

Document the new "--cover-letter-format" feature in format-patch and its
related config variable "format.commitListFormat".

Signed-off-by: Mirko Faina <mroik@delayed.space>
---
Sorry, forgot to update the docs. This patch is to be applied on top of
patch #4 of the series.

 Documentation/config/format.adoc    |  6 ++++++
 Documentation/git-format-patch.adoc | 11 +++++++++++
 2 files changed, 17 insertions(+)

diff --git a/Documentation/config/format.adoc b/Documentation/config/format.adoc
index ab0710e86a..b91e59321c 100644
--- a/Documentation/config/format.adoc
+++ b/Documentation/config/format.adoc
@@ -101,6 +101,12 @@ format.coverLetter::
 	generate a cover-letter only when there's more than one patch.
 	Default is false.
 
+format.commitListFormat::
+	A format string that specifies how to generate the commit list of a
+	cover-letter when format-patch is invoked. This is the config coupled
+	with `--cover-letter-format` in the format-patch command.
+	Default is "shortlog".
+
 format.outputDirectory::
 	Set a custom directory to store the resulting files instead of the
 	current working directory. All directory components will be created.
diff --git a/Documentation/git-format-patch.adoc b/Documentation/git-format-patch.adoc
index 9a7807ca71..bdcb5f989c 100644
--- a/Documentation/git-format-patch.adoc
+++ b/Documentation/git-format-patch.adoc
@@ -24,6 +24,7 @@ SYNOPSIS
 		   [(--reroll-count|-v) <n>]
 		   [--to=<email>] [--cc=<email>]
 		   [--[no-]cover-letter] [--quiet]
+		   [--cover-letter-format=<format-spec>]
 		   [--[no-]encode-email-headers]
 		   [--no-notes | --notes[=<ref>]]
 		   [--interdiff=<previous>]
@@ -321,6 +322,15 @@ feeding the result to `git send-email`.
 	containing the branch description, shortlog and the overall diffstat.  You can
 	fill in a description in the file before sending it out.
 
+--cover-letter-format=<format-spec>::
+	Specify the format in which to generate the commit list of the
+	patch series. This option is available if the user wants to use
+	an alternative to the default shortlog format. The accepted
+	values for format-spec are "shortlog" or a format string
+	prefixed with `log:`.  
+	e.g. `log: %s (%an)`  
+	This option is relevant only if a cover letter is generated.
+
 --encode-email-headers::
 --no-encode-email-headers::
 	Encode email headers that have non-ASCII characters with
@@ -452,6 +462,7 @@ with configuration variables.
 	signOff = true
 	outputDirectory = <directory>
 	coverLetter = auto
+	commitListFormat = shortlog
 	coverFromDescription = auto
 ------------
 
-- 
2.53.0


  reply	other threads:[~2026-02-27 16:42 UTC|newest]

Thread overview: 113+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-20 23:06 [RFC PATCH] format-patch: better commit list for cover letter Mirko Faina
2026-02-20 23:55 ` [RFC PATCH v2] " Mirko Faina
2026-02-21  0:51   ` Mirko Faina
2026-02-21  4:54 ` [RFC PATCH] " Junio C Hamano
2026-02-21  5:18   ` Mirko Faina
2026-02-21  5:55     ` Junio C Hamano
2026-02-21  6:02       ` Junio C Hamano
2026-02-21 15:59         ` Mirko Faina
2026-02-21 17:33           ` Junio C Hamano
2026-02-21 19:16             ` Mirko Faina
2026-02-24  4:03 ` [PATCH 0/3] format-patch: add cover-letter-format option Mirko Faina
2026-02-24  4:06   ` Mirko Faina
2026-02-24  9:29   ` [PATCH v2 0/2] " Mirko Faina
2026-02-24  9:29     ` [PATCH v2 1/2] format-patch: add ability to use alt cover format Mirko Faina
2026-02-24 17:40       ` Junio C Hamano
2026-02-24 23:54         ` Mirko Faina
2026-02-25  0:29           ` Junio C Hamano
2026-02-25 13:47           ` Jeff King
2026-02-24 20:25       ` Junio C Hamano
2026-02-25 13:56       ` Jeff King
2026-02-25 22:55         ` Mirko Faina
2026-02-24  9:29     ` [PATCH v2 2/2] format-patch: add commitListFormat config Mirko Faina
2026-02-24 18:07       ` Junio C Hamano
2026-02-25  0:14         ` Mirko Faina
2026-02-25 17:25           ` Junio C Hamano
2026-02-26 21:40           ` Mirko Faina
2026-02-26 22:19             ` Junio C Hamano
2026-02-24 20:38     ` [PATCH v2 0/2] format-patch: add cover-letter-format option Junio C Hamano
2026-02-24 21:39       ` Junio C Hamano
2026-02-25  0:19         ` Mirko Faina
2026-02-25  2:46           ` Junio C Hamano
2026-02-27  1:52     ` [PATCH v3 0/4] " Mirko Faina
2026-02-27  1:52       ` [PATCH v3 1/4] pretty.c: add %(count) and %(total) placeholders Mirko Faina
2026-02-27  1:52       ` [PATCH v3 2/4] format-patch: move cover letter summary generation Mirko Faina
2026-02-27  1:52       ` [PATCH v3 3/4] format-patch: add ability to use alt cover format Mirko Faina
2026-02-27  4:23         ` Junio C Hamano
2026-02-27 12:41           ` Mirko Faina
2026-02-27  1:52       ` [PATCH v3 4/4] format-patch: add commitListFormat config Mirko Faina
2026-02-27 13:18       ` [PATCH v4 0/4] format-patch: add cover-letter-format option Mirko Faina
2026-02-27 13:18         ` [PATCH v4 1/4] pretty.c: add %(count) and %(total) placeholders Mirko Faina
2026-02-27 13:18         ` [PATCH v4 2/4] format-patch: move cover letter summary generation Mirko Faina
2026-02-27 13:18         ` [PATCH v4 3/4] format-patch: add ability to use alt cover format Mirko Faina
2026-02-27 13:18         ` [PATCH v4 4/4] format-patch: add commitListFormat config Mirko Faina
2026-02-27 16:42           ` Mirko Faina [this message]
2026-02-27 17:51           ` Junio C Hamano
2026-02-27 21:51             ` Mirko Faina
2026-02-27 22:21               ` Junio C Hamano
2026-02-27 22:48         ` [PATCH v5 0/5] format-patch: add cover-letter-format option Mirko Faina
2026-02-27 22:48           ` [PATCH v5 1/5] pretty.c: add %(count) and %(total) placeholders Mirko Faina
2026-02-27 22:48           ` [PATCH v5 2/5] format-patch: move cover letter summary generation Mirko Faina
2026-02-27 22:48           ` [PATCH v5 3/5] format-patch: add ability to use alt cover format Mirko Faina
2026-02-27 22:48           ` [PATCH v5 4/5] format-patch: add commitListFormat config Mirko Faina
2026-02-27 22:48           ` [PATCH v5 5/5] docs: add usage for the cover-letter fmt feature Mirko Faina
2026-03-06 22:33           ` [PATCH v5 0/5] format-patch: add cover-letter-format option Junio C Hamano
2026-03-06 22:49             ` Mirko Faina
2026-03-06 22:58           ` [PATCH v6 " Mirko Faina
2026-03-06 22:58             ` [PATCH v6 1/5] pretty.c: add %(count) and %(total) placeholders Mirko Faina
2026-03-06 22:58             ` [PATCH v6 2/5] format-patch: move cover letter summary generation Mirko Faina
2026-03-06 22:58             ` [PATCH v6 3/5] format-patch: add ability to use alt cover format Mirko Faina
2026-03-10 22:14               ` Junio C Hamano
2026-03-10 22:32                 ` Mirko Faina
2026-03-06 22:58             ` [PATCH v6 4/5] format-patch: add commitListFormat config Mirko Faina
2026-03-06 22:58             ` [PATCH v6 5/5] docs: add usage for the cover-letter fmt feature Mirko Faina
2026-03-06 23:18               ` Junio C Hamano
2026-03-06 23:34             ` [PATCH v7 0/5] format-patch: add cover-letter-format option Mirko Faina
2026-03-06 23:34               ` [PATCH v7 1/5] pretty.c: add %(count) and %(total) placeholders Mirko Faina
2026-03-10 14:32                 ` Phillip Wood
2026-03-10 20:55                   ` Mirko Faina
2026-03-06 23:34               ` [PATCH v7 2/5] format-patch: move cover letter summary generation Mirko Faina
2026-03-06 23:34               ` [PATCH v7 3/5] format-patch: add ability to use alt cover format Mirko Faina
2026-03-10 14:33                 ` Phillip Wood
2026-03-10 21:05                   ` Mroik
2026-03-06 23:34               ` [PATCH v7 4/5] format-patch: add commitListFormat config Mirko Faina
2026-03-10 14:34                 ` Phillip Wood
2026-03-10 16:45                   ` Junio C Hamano
2026-03-10 21:23                     ` Mirko Faina
2026-03-11 10:38                       ` Phillip Wood
2026-03-11 17:13                         ` Junio C Hamano
2026-03-11 10:32                     ` Phillip Wood
2026-03-11 17:18                       ` Junio C Hamano
2026-03-10 21:19                   ` Mirko Faina
2026-03-06 23:34               ` [PATCH v7 5/5] docs: add usage for the cover-letter fmt feature Mirko Faina
2026-03-10  9:51                 ` Bert Wesarg
2026-03-10 14:34                 ` Phillip Wood
2026-03-12 16:20               ` [PATCH v8 0/4] format-patch: add cover-letter-format option Mirko Faina
2026-03-12 16:20                 ` [PATCH v8 1/4] format-patch: move cover letter summary generation Mirko Faina
2026-03-12 16:28                   ` Junio C Hamano
2026-03-12 16:20                 ` [PATCH v8 2/4] format-patch: add ability to use alt cover format Mirko Faina
2026-03-12 16:52                   ` Junio C Hamano
2026-03-12 17:18                     ` Mirko Faina
2026-03-12 17:25                       ` Junio C Hamano
2026-03-12 17:27                         ` Junio C Hamano
2026-03-13 10:38                         ` Phillip Wood
2026-03-13 17:20                           ` Junio C Hamano
2026-03-13 19:17                             ` Mirko Faina
2026-03-13 20:22                               ` Junio C Hamano
2026-03-12 16:20                 ` [PATCH v8 3/4] format-patch: add "chronological" format for cover Mirko Faina
2026-03-12 16:55                   ` Junio C Hamano
2026-03-12 16:20                 ` [PATCH v8 4/4] format-patch: add commitListFormat config Mirko Faina
2026-03-12 17:00                   ` Junio C Hamano
2026-03-12 17:20                 ` [PATCH v8 0/4] format-patch: add cover-letter-format option Junio C Hamano
2026-03-12 17:45                   ` Mirko Faina
2026-03-12 18:12                     ` Junio C Hamano
2026-02-24  4:03 ` [PATCH 1/3] pretty.c: fix null pointer dereference Mirko Faina
2026-02-24  6:25   ` Junio C Hamano
2026-02-24  7:08     ` Mirko Faina
2026-02-24  7:43       ` Mirko Faina
2026-02-24  8:41       ` Jeff King
2026-02-24  4:03 ` [PATCH 2/3] format-patch: add ability to use alt cover format Mirko Faina
2026-02-24  9:02   ` Jeff King
2026-02-24  9:09     ` Mirko Faina
2026-02-24  9:18       ` Jeff King
2026-02-24  4:03 ` [PATCH 3/3] format-patch: add commitListFormat config Mirko Faina

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260227164234.11632-1-mroik@delayed.space \
    --to=mroik@delayed.space \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox