diff mbox series

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

Message ID 20221111021502.449662-3-michael.strawbridge@amd.com (mailing list archive)
State Superseded
Headers show
Series Expose header information to git-send-email's sendemail-validate hook | expand

Commit Message

Michael Strawbridge Nov. 11, 2022, 2:15 a.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(-)

Comments

Ævar Arnfjörð Bjarmason Nov. 11, 2022, 3:10 p.m. UTC | #1
On Fri, Nov 11 2022, Strawbridge, Michael wrote:

> 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 --git a/Documentation/githooks.txt b/Documentation/githooks.txt
> index a16e62bc8c..c1baf34454 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
>  ~~~~~~~~~~~~~~~~~~

As this is just documenting the change in 1/2 after-the-fact, we really
should squash it into that.

If you are doing another commit, the better thing to do would be to
first change the docs to say e.g.:
	
	This hook is invoked by linkgit:git-send-email[1]. It's provided with
	these parameters, in order:
	
	* A file that holds the....
	
Then instead of your "actual" change being a reword change etc. you can
just add another bullet-point.

Or you could just squash this as-is...
Luben Tuikov Nov. 11, 2022, 7:12 p.m. UTC | #2
On 2022-11-10 21:15, Strawbridge, Michael wrote:
> 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 --git a/Documentation/githooks.txt b/Documentation/githooks.txt
> index a16e62bc8c..c1baf34454 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.

Fix this: smtp --> SMTP

Regards,
Luben

>  
>  fsmonitor-watchman
>  ~~~~~~~~~~~~~~~~~~
diff mbox series

Patch

diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index a16e62bc8c..c1baf34454 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
 ~~~~~~~~~~~~~~~~~~