diff options
| author | Junio C Hamano <gitster@pobox.com> | 2026-03-16 12:42:54 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2026-03-16 12:42:54 -0700 |
| commit | b3c222ed9103db7947b432a99d460e22bdc873ca (patch) | |
| tree | b8edc42f69bfb0da8b690501a7826e3845107696 /Documentation | |
| parent | 67006b9db8b772423ad0706029286096307d2567 (diff) | |
| parent | 51ed9f7e724468b8e44a7c33946dda38a335acca (diff) | |
| download | git-b3c222ed9103db7947b432a99d460e22bdc873ca.tar.xz | |
Merge branch 'mf/format-patch-cover-letter-format' into mf/format-patch-commit-list-format
* mf/format-patch-cover-letter-format:
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')
| -rw-r--r-- | Documentation/config/format.adoc | 5 | ||||
| -rw-r--r-- | Documentation/git-format-patch.adoc | 13 |
2 files changed, 18 insertions, 0 deletions
diff --git a/Documentation/config/format.adoc b/Documentation/config/format.adoc index ab0710e86a..ea5ec5df7a 100644 --- a/Documentation/config/format.adoc +++ b/Documentation/config/format.adoc @@ -101,6 +101,11 @@ format.coverLetter:: generate a cover-letter only when there's more than one patch. Default is false. +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`. + 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 36146006fa..31fa492335 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>] @@ -322,6 +323,17 @@ 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)` + If defined, defaults to the `format.commitListFormat` configuration + variable. + 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 @@ -453,6 +465,7 @@ with configuration variables. signOff = true outputDirectory = <directory> coverLetter = auto + commitListFormat = shortlog coverFromDescription = auto ------------ |