summaryrefslogtreecommitdiff
path: root/Documentation/config
diff options
context:
space:
mode:
authorLibravatar Denton Liu <liu.denton@gmail.com>2019-10-15 02:06:40 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2019-10-16 10:26:45 +0900
commitbf8e65b30b77308710f14d523782f99a4a23eb55 (patch)
tree48aeeadc9e382244c08ecb286f1b56b6c302c64d /Documentation/config
parentformat-patch: use enum variables (diff)
downloadtgif-bf8e65b30b77308710f14d523782f99a4a23eb55.tar.xz
format-patch: teach --cover-from-description option
Before, when format-patch generated a cover letter, only the body would be populated with a branch's description while the subject would be populated with placeholder text. However, users may want to have the subject of their cover letter automatically populated in the same way. Teach format-patch to accept the `--cover-from-description` option and corresponding `format.coverFromDescription` config, allowing users to populate different parts of the cover letter (including the subject now). Signed-off-by: Denton Liu <liu.denton@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config')
-rw-r--r--Documentation/config/format.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt
index cb629fa769..735dfcf827 100644
--- a/Documentation/config/format.txt
+++ b/Documentation/config/format.txt
@@ -36,6 +36,12 @@ format.subjectPrefix::
The default for format-patch is to output files with the '[PATCH]'
subject prefix. Use this variable to change that prefix.
+format.coverFromDescription::
+ The default mode for format-patch to determine which parts of
+ the cover letter will be populated using the branch's
+ description. See the `--cover-from-description` option in
+ linkgit:git-format-patch[1].
+
format.signature::
The default for format-patch is to output a signature containing
the Git version number. Use this variable to change that default.