aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-format-patch.adoc
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2026-03-26 14:03:57 -0700
committerJunio C Hamano <gitster@pobox.com>2026-03-26 14:03:57 -0700
commitf54477a8053716221ccbdfbbcb9cef4e9d26fe28 (patch)
tree098ab742e268c4bf60b2a572f247b65667cdecff /Documentation/git-format-patch.adoc
parent67006b9db8b772423ad0706029286096307d2567 (diff)
parent36c16a5b7fff7806b475b5fa07eca3a5179d7fa6 (diff)
downloadgit-f54477a8053716221ccbdfbbcb9cef4e9d26fe28.tar.xz
Merge branch 'mf/format-patch-commit-list-format' into mf/format-patch-commit-list-format-doc
* mf/format-patch-commit-list-format: format-patch: --commit-list-format without prefix format-patch: add preset for --commit-list-format format-patch: wrap generate_commit_list_cover() format.commitListFormat: strip meaning from empty docs/pretty-formats: add %(count) and %(total) format-patch: rename --cover-letter-format option format-patch: refactor generate_commit_list_cover pretty.c: better die message %(count) and %(total) docs: add usage for the cover-letter fmt feature format-patch: add commitListFormat config format-patch: add ability to use alt cover format format-patch: move cover letter summary generation pretty.c: add %(count) and %(total) placeholders
Diffstat (limited to 'Documentation/git-format-patch.adoc')
-rw-r--r--Documentation/git-format-patch.adoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/git-format-patch.adoc b/Documentation/git-format-patch.adoc
index 36146006fa..c52dbcc170 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]
+ [--commit-list-format=<format-spec>]
[--[no-]encode-email-headers]
[--no-notes | --notes[=<ref>]]
[--interdiff=<previous>]
@@ -322,6 +323,18 @@ 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.
+--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:`.
+ 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
+ `--no-cover-letter` is given.
+
--encode-email-headers::
--no-encode-email-headers::
Encode email headers that have non-ASCII characters with
@@ -453,6 +466,7 @@ with configuration variables.
signOff = true
outputDirectory = <directory>
coverLetter = auto
+ commitListFormat = shortlog
coverFromDescription = auto
------------