Skip to content

Commit da5a114

Browse files
committed
Merge branch 'mf/format-patch-commit-list-format-doc' into seen
Doc updates. * mf/format-patch-commit-list-format-doc: docs: fix --commit-list-format related entries
2 parents 0e2229c + 99410ea commit da5a114

2 files changed

Lines changed: 16 additions & 13 deletions

File tree

Documentation/config/format.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ format.coverLetter::
103103

104104
format.commitListFormat::
105105
When the `--cover-letter-format` option is not given, `format-patch`
106-
uses the value of this variable to decide how to format the title of
106+
uses the value of this variable to decide how to format the entry of
107107
each commit. Defaults to `shortlog`.
108108

109109
format.outputDirectory::

Documentation/git-format-patch.adoc

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -319,21 +319,24 @@ feeding the result to `git send-email`.
319319
320320
--cover-letter::
321321
--no-cover-letter::
322-
In addition to the patches, generate a cover letter file
323-
containing the branch description, shortlog and the overall diffstat. You can
324-
fill in a description in the file before sending it out.
322+
In addition to the patches, generate a cover letter file containing the
323+
branch description, commit list and the overall diffstat. You can fill
324+
in a description in the file before sending it out.
325325
326326
--commit-list-format=<format-spec>::
327327
Specify the format in which to generate the commit list of the patch
328-
series. The accepted values for format-spec are `shortlog`, `modern` or a
329-
format-string prefixed with `log:`.
330-
e.g. `log: %s (%an)`
331-
The user is allowed to drop the prefix if the format-string contains a
332-
`%<placeholder>`.
333-
If not given, defaults to the `format.commitListFormat` configuration
334-
variable.
335-
This option implies the use of `--cover-letter` unless
336-
`--no-cover-letter` is given.
328+
series. The accepted values for format-spec are `shortlog`, `modern` or
329+
a format-string prefixed with `log:`. E.g. `log: %s (%an)`.
330+
Modern is the same as `log:[%(count)/%(total)] %s`.
331+
The user is allowed to drop the `log:` prefix if the format-string
332+
contains a '%' character. The '%' is expected as part of a placeholder
333+
but this is not validated by git.
334+
If not given, defaults to `shortlog` unless the
335+
`format.commitListFormat` configuration variable is set.
336+
This option given from the command-line implies the use of
337+
`--cover-letter` unless `--no-cover-letter` is given. Note that
338+
`format.commitListFormat` being set does not imply the use of
339+
`--cover-letter`.
337340
338341
--encode-email-headers::
339342
--no-encode-email-headers::

0 commit comments

Comments
 (0)