[PATCH v5 5/5] docs: add usage for the cover-letter fmt feature
- From
Mirko Faina <mroik@delayed.space>
- Date
- Feb 27, 2026, 22:48 UTC
- Message-ID
- <a2160693709ff6867ea5db9a944d13091f03bc5d.1772232373.git.mroik@delayed.space>
- In-Reply-To
- <cover.1772232373.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> --- Documentation/config/format.adoc | 7 +++++++ Documentation/git-format-patch.adoc | 11 +++++++++++ 2 files changed, 18 insertions(+)
diff --git a/Documentation/config/format.adoc b/Documentation/config/format.adoc index ab0710e86a..771e84af98 100644 --- a/Documentation/config/format.adoc +++ b/Documentation/config/format.adoc @@ -101,6 +101,13 @@ 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 and they both accept the same values. + 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.5.ga216069370