diff mbox series

[v2,2/2] Update sendemail-validate hook docs to add header file parameter

Message ID 20221111193042.641898-3-michael.strawbridge@amd.com (mailing list archive)
State New, archived
Headers show
Series Update sendemail-validate hook docs to add header file parameter | expand

Commit Message

Michael Strawbridge Nov. 11, 2022, 7:31 p.m. UTC 
Add documentation for the new SMTP header file parameter used by the
sendemail-validate git-send-email hook.

sendemail-validate accepts the patch file as the first parameter (same as
before) and now also adds the SMTP header information as the second parameter.

Cc: Luben Tuikov <luben.tuikov@amd.com>
Cc: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Michael Strawbridge <michael.strawbridge@amd.com>
---
 Documentation/githooks.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index a16e62bc8c..346e536cbe 100644
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -583,10 +583,10 @@  processed by rebase.
 sendemail-validate
 ~~~~~~~~~~~~~~~~~~
 
-This hook is invoked by linkgit:git-send-email[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 `git send-email` to abort before sending any
-e-mails.
+This hook is invoked by linkgit:git-send-email[1].  It takes two parameters,
+the name of a file that holds the patch and the name of a file that holds the
+SMTP headers.  Exiting with a non-zero status causes `git send-email` to abort
+before sending any e-mails.
 
 fsmonitor-watchman
 ~~~~~~~~~~~~~~~~~~