aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-format-patch.txt
diff options
context:
space:
mode:
authorOswald Buddenhagen <oswald.buddenhagen@gmx.de>2023-08-21 19:07:20 +0200
committerJunio C Hamano <gitster@pobox.com>2023-08-21 15:03:47 -0700
commit67f4b36e339d91c06ff9cdc254864c830158e10f (patch)
tree9669710eb67178297355fdacfa2b016e2309797a /Documentation/git-format-patch.txt
parentfac96dfbb1c24369ba7d37a5affd8adfe6c650fd (diff)
downloadgit-67f4b36e339d91c06ff9cdc254864c830158e10f.tar.gz
format-patch: add --description-file option
This patch makes it possible to directly feed a branch description to derive the cover letter from. The use case is formatting dynamically created temporary commits which are not referenced anywhere. The most obvious alternative would be creating a temporary branch and setting a description on it, but that doesn't seem particularly elegant. Signed-off-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-format-patch.txt')
-rw-r--r--Documentation/git-format-patch.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 373b46fc0d..8e515c7dbb 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -215,6 +215,10 @@ is greater than 100 bytes, then the mode will be `message`, otherwise
If `<mode>` is `none`, both the cover letter subject and body will be
populated with placeholder text.
+--description-file=<file>::
+ Use the contents of <file> instead of the branch's description
+ for generating the cover letter.
+
--subject-prefix=<subject prefix>::
Instead of the standard '[PATCH]' prefix in the subject
line, instead use '[<subject prefix>]'. This