diff options
Diffstat (limited to 'man5/githooks.5')
| -rw-r--r-- | man5/githooks.5 | 32 |
1 files changed, 28 insertions, 4 deletions
diff --git a/man5/githooks.5 b/man5/githooks.5 index a02022e8a..74b5f4fc7 100644 --- a/man5/githooks.5 +++ b/man5/githooks.5 @@ -2,12 +2,12 @@ .\" Title: githooks .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 2023-05-09 +.\" Date: 2023-05-10 .\" Manual: Git Manual -.\" Source: Git 2.40.1.515.g5597cfdf47 +.\" Source: Git 2.40.1.552.g91428f078b .\" Language: English .\" -.TH "GITHOOKS" "5" "2023\-05\-09" "Git 2\&.40\&.1\&.515\&.g5597cf" "Git Manual" +.TH "GITHOOKS" "5" "2023\-05\-10" "Git 2\&.40\&.1\&.552\&.g91428f" "Git Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -436,7 +436,31 @@ The commits are guaranteed to be listed in the order that they were processed by .RE .SS "sendemail\-validate" .sp -This hook is invoked by \fBgit-send-email\fR(1)\&. It takes a single parameter, the name of the file that holds the e\-mail to be sent\&. Exiting with a non\-zero status causes \fBgit send\-email\fR to abort before sending any e\-mails\&. +This hook is invoked by \fBgit-send-email\fR(1)\&. +.sp +It takes these command line arguments\&. They are, 1\&. the name of the file which holds the contents of the email to be sent\&. 2\&. The name of the file which holds the SMTP headers of the email\&. +.sp +The SMTP headers are passed in the exact same way as they are passed to the user\(cqs Mail Transport Agent (MTA)\&. In effect, the email given to the user\(cqs MTA, is the contents of $2 followed by the contents of $1\&. +.sp +An example of a few common headers is shown below\&. Take notice of the capitalization and multi\-line tab structure\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +From: Example <from@example\&.com> +To: to@example\&.com +Cc: cc@example\&.com, + A <author@example\&.com>, + One <one@example\&.com>, + two@example\&.com +Subject: PATCH\-STRING +.fi +.if n \{\ +.RE +.\} +.sp +Exiting with a non\-zero status causes \fBgit send\-email\fR to abort before sending any e\-mails\&. .sp The following environment variables are set when executing the hook\&. .PP |