git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] docs: add instructions to use Yahoo with send-mail
@ 2025-05-13 18:28 Aditya Garg
  2025-05-13 18:33 ` Aditya Garg
                   ` (6 more replies)
  0 siblings, 7 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-13 18:28 UTC (permalink / raw)
  To: Junio C Hamano, git
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals

Just like Gmail and Outlook, Yahoo is another popular email service
provider. This commit adds instructions for Yahoo users to be able
to use it with `git send-email`. It also adds instructions for
OAauth2.0 authentication for the same, and adds a link for a
credential helper.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/git-send-email.adoc | 32 +++++++++++++++++++++++++++++++
 Documentation/gitcredentials.adoc |  2 ++
 2 files changed, 34 insertions(+)

diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 26fda63c2f..61a2d03546 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -561,6 +561,35 @@ SMTP server with `git send-email`:
 	smtpAuth = XOAUTH2
 ----
 
+Use Yahoo as the SMTP Server
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Just like Gmail, you can use an app-specific password for Yahoo as well. Visit
+https://help.yahoo.com/kb/SLN15241.html to get instructions for generating
+them. After generating, edit `~/.gitconfig` to specify your account settings
+for Yahoo and use its SMTP server with `git send-email`:
+
+----
+[sendemail]
+	smtpEncryption = tls
+	smtpServer = smtp.mail.yahoo.com
+	smtpUser = yourname@yahoo.com
+	smtpServerPort = 587
+----
+
+If you wish to use OAuth2.0 rather than an app-specific password, you can use
+either `OAUTHBEARER` or `XOAUTH2` as the authentication method. As an example,
+if you want to use `OAUTHBEARER`, edit your `~/.gitconfig` file and add
+`smtpAuth = OAUTHBEARER` to your account settings:
+
+----
+[sendemail]
+	smtpEncryption = tls
+	smtpServer = smtp.mail.yahoo.com
+	smtpUser = yourname@yahoo.com
+	smtpServerPort = 587
+	smtpAuth = OAUTHBEARER
+----
+
 SENDING PATCHES
 ---------------
 Once your commits are ready to be sent to the mailing list, run the
@@ -588,6 +617,9 @@ are also available:
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook]
 	  (cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
 
+	- https://github.com/AdityaGarg8/git-credential-email[git-credential-yahoo]
+	  (cross platform, dedicated helper for authenticating Yahoo accounts)
+
 You can also see linkgit:gitcredentials[7] for more OAuth based authentication
 helpers.
 
diff --git a/Documentation/gitcredentials.adoc b/Documentation/gitcredentials.adoc
index b49923db02..0c4fd0e8e7 100644
--- a/Documentation/gitcredentials.adoc
+++ b/Documentation/gitcredentials.adoc
@@ -137,6 +137,8 @@ Popular helpers with OAuth support include:
 
     - https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook] (cross platform, dedicated helper to authenticate Microsoft Outlook accounts for linkgit:git-send-email[1])
 
+    - https://github.com/AdityaGarg8/git-credential-email[git-credential-yahoo] (cross platform, dedicated helper to authenticate Yahoo accounts for linkgit:git-send-email[1])
+
 CREDENTIAL CONTEXTS
 -------------------
 
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* Re: [PATCH] docs: add instructions to use Yahoo with send-mail
  2025-05-13 18:28 [PATCH] docs: add instructions to use Yahoo with send-mail Aditya Garg
@ 2025-05-13 18:33 ` Aditya Garg
  2025-05-13 18:42   ` Junio C Hamano
  2025-05-14 12:58 ` Junio C Hamano
                   ` (5 subsequent siblings)
  6 siblings, 1 reply; 52+ messages in thread
From: Aditya Garg @ 2025-05-13 18:33 UTC (permalink / raw)
  To: Junio C Hamano, git
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals



On 13/05/25 11:58 pm, Aditya Garg wrote:
> Just like Gmail and Outlook, Yahoo is another popular email service
> provider. This commit adds instructions for Yahoo users to be able
> to use it with `git send-email`. It also adds instructions for
> OAauth2.0 authentication for the same, and adds a link for a
> credential helper.
> 
> Signed-off-by: Aditya Garg <gargaditya08@live.com>
> ---
>  Documentation/git-send-email.adoc | 32 +++++++++++++++++++++++++++++++
>  Documentation/gitcredentials.adoc |  2 ++
>  2 files changed, 34 insertions(+)
> 
> diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
> index 26fda63c2f..61a2d03546 100644
> --- a/Documentation/git-send-email.adoc
> +++ b/Documentation/git-send-email.adoc
> @@ -561,6 +561,35 @@ SMTP server with `git send-email`:
>  	smtpAuth = XOAUTH2
>  ----
>  
> +Use Yahoo as the SMTP Server
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +Just like Gmail, you can use an app-specific password for Yahoo as well. Visit
> +https://help.yahoo.com/kb/SLN15241.html to get instructions for generating
> +them. After generating, edit `~/.gitconfig` to specify your account settings
> +for Yahoo and use its SMTP server with `git send-email`:
> +
> +----
> +[sendemail]
> +	smtpEncryption = tls
> +	smtpServer = smtp.mail.yahoo.com
> +	smtpUser = yourname@yahoo.com
> +	smtpServerPort = 587
> +----
> +
> +If you wish to use OAuth2.0 rather than an app-specific password, you can use
> +either `OAUTHBEARER` or `XOAUTH2` as the authentication method. As an example,
> +if you want to use `OAUTHBEARER`, edit your `~/.gitconfig` file and add
> +`smtpAuth = OAUTHBEARER` to your account settings:
> +
> +----
> +[sendemail]
> +	smtpEncryption = tls
> +	smtpServer = smtp.mail.yahoo.com
> +	smtpUser = yourname@yahoo.com
> +	smtpServerPort = 587
> +	smtpAuth = OAUTHBEARER
> +----
> +
>  SENDING PATCHES
>  ---------------
>  Once your commits are ready to be sent to the mailing list, run the
> @@ -588,6 +617,9 @@ are also available:
>  	- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook]
>  	  (cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
>  
> +	- https://github.com/AdityaGarg8/git-credential-email[git-credential-yahoo]
> +	  (cross platform, dedicated helper for authenticating Yahoo accounts)
> +

BTW, I could not get the source code for https://git-scm.com/doc/credential-helpers. It
seems to be a page for all credential helpers.

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH] docs: add instructions to use Yahoo with send-mail
  2025-05-13 18:33 ` Aditya Garg
@ 2025-05-13 18:42   ` Junio C Hamano
  2025-05-13 18:51     ` Aditya Garg
  0 siblings, 1 reply; 52+ messages in thread
From: Junio C Hamano @ 2025-05-13 18:42 UTC (permalink / raw)
  To: Aditya Garg
  Cc: git, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals

Aditya Garg <gargaditya08@live.com> writes:

> BTW, I could not get the source code for https://git-scm.com/doc/credential-helpers. It
> seems to be a page for all credential helpers.

Probably

https://github.com/git/git-scm.com/blob/gh-pages/content/doc/credential-helpers.html

See https://github.com/git/git-scm.com?tab=readme-ov-file#git-homepage--
for the general notes to get changes to that repository.

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH] docs: add instructions to use Yahoo with send-mail
  2025-05-13 18:42   ` Junio C Hamano
@ 2025-05-13 18:51     ` Aditya Garg
  2025-05-13 19:36       ` Aditya Garg
  0 siblings, 1 reply; 52+ messages in thread
From: Aditya Garg @ 2025-05-13 18:51 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: git, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals



On 14/05/25 12:12 am, Junio C Hamano wrote:
> Aditya Garg <gargaditya08@live.com> writes:
> 
>> BTW, I could not get the source code for https://git-scm.com/doc/credential-helpers. It
>> seems to be a page for all credential helpers.
> 
> Probably
> 
> https://github.com/git/git-scm.com/blob/gh-pages/content/doc/credential-helpers.html
> 
> See https://github.com/git/git-scm.com?tab=readme-ov-file#git-homepage--
> for the general notes to get changes to that repository.

Thanks!


^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH] docs: add instructions to use Yahoo with send-mail
  2025-05-13 18:51     ` Aditya Garg
@ 2025-05-13 19:36       ` Aditya Garg
  0 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-13 19:36 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: git, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals



On 14/05/25 12:21 am, Aditya Garg wrote:
> 
> 
> On 14/05/25 12:12 am, Junio C Hamano wrote:
>> Aditya Garg <gargaditya08@live.com> writes:
>>
>>> BTW, I could not get the source code for https://git-scm.com/doc/credential-helpers. It
>>> seems to be a page for all credential helpers.
>>
>> Probably
>>
>> https://github.com/git/git-scm.com/blob/gh-pages/content/doc/credential-helpers.html
>>

Ok so I'll just get the Yahoo docs merged before opening a PR in this repo.

>> See https://github.com/git/git-scm.com?tab=readme-ov-file#git-homepage--
>> for the general notes to get changes to that repository.
> 
> Thanks!
> 

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH] docs: add instructions to use Yahoo with send-mail
  2025-05-13 18:28 [PATCH] docs: add instructions to use Yahoo with send-mail Aditya Garg
  2025-05-13 18:33 ` Aditya Garg
@ 2025-05-14 12:58 ` Junio C Hamano
  2025-05-14 13:05   ` Aditya Garg
  2025-05-15 10:29 ` [PATCH v2 0/2] docs: update email credential helpers Aditya Garg
                   ` (4 subsequent siblings)
  6 siblings, 1 reply; 52+ messages in thread
From: Junio C Hamano @ 2025-05-14 12:58 UTC (permalink / raw)
  To: Aditya Garg
  Cc: git, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals

Aditya Garg <gargaditya08@live.com> writes:

> Just like Gmail and Outlook, Yahoo is another popular email service
> provider. This commit adds instructions for Yahoo users to be able
> to use it with `git send-email`. It also adds instructions for
> OAauth2.0 authentication for the same, and adds a link for a
> credential helper.

Heh, I didn't know they are still around ;-)

    $ git checkout master
    $ for p in yahoo.com outlook.com gmail.com
      do
        echo "@$p"
        git log --oneline --since=5.years --no-merges --author=@$p |
        wc -l
      done
    @yahoo.com
    12
    @outlook.com
    16
    @gmail.com
    4765

> diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
> index 26fda63c2f..61a2d03546 100644
> --- a/Documentation/git-send-email.adoc
> +++ b/Documentation/git-send-email.adoc
> @@ -561,6 +561,35 @@ SMTP server with `git send-email`:
>  	smtpAuth = XOAUTH2
>  ----
>  
> +Use Yahoo as the SMTP Server
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +Just like Gmail, you can use an app-specific password for Yahoo as well. Visit
> +https://help.yahoo.com/kb/SLN15241.html to get instructions for generating
> +them. After generating, edit `~/.gitconfig` to specify your account settings
> +for Yahoo and use its SMTP server with `git send-email`:

I am starting to doubt the wisdom of giving one section per
provider, especially since the delta between the section is so small
(essentially, the server address, the smtpAuth supported, and their
official documentation URL).  Would it make more sense to just have
a template example with placeholders, and a table of placeholder
values that has one row per provider?

> +
> +----
> +[sendemail]
> +	smtpEncryption = tls
> +	smtpServer = smtp.mail.yahoo.com
> +	smtpUser = yourname@yahoo.com
> +	smtpServerPort = 587
> +----
> +
> +If you wish to use OAuth2.0 rather than an app-specific password, you can use
> +either `OAUTHBEARER` or `XOAUTH2` as the authentication method. As an example,
> +if you want to use `OAUTHBEARER`, edit your `~/.gitconfig` file and add
> +`smtpAuth = OAUTHBEARER` to your account settings:

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH] docs: add instructions to use Yahoo with send-mail
  2025-05-14 12:58 ` Junio C Hamano
@ 2025-05-14 13:05   ` Aditya Garg
  0 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-14 13:05 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: git, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals



On 14/05/25 6:28 pm, Junio C Hamano wrote:
> Aditya Garg <gargaditya08@live.com> writes:
> 
>> Just like Gmail and Outlook, Yahoo is another popular email service
>> provider. This commit adds instructions for Yahoo users to be able
>> to use it with `git send-email`. It also adds instructions for
>> OAauth2.0 authentication for the same, and adds a link for a
>> credential helper.
> 
> Heh, I didn't know they are still around ;-)
> 
>     $ git checkout master
>     $ for p in yahoo.com outlook.com gmail.com

You may want to check for hotmail.com and live.com as well :)

>       do
>         echo "@$p"
>         git log --oneline --since=5.years --no-merges --author=@$p |
>         wc -l
>       done
>     @yahoo.com
>     12
>     @outlook.com
>     16
>     @gmail.com
>     4765
> 
>> diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
>> index 26fda63c2f..61a2d03546 100644
>> --- a/Documentation/git-send-email.adoc
>> +++ b/Documentation/git-send-email.adoc
>> @@ -561,6 +561,35 @@ SMTP server with `git send-email`:
>>  	smtpAuth = XOAUTH2
>>  ----
>>  
>> +Use Yahoo as the SMTP Server
>> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>> +Just like Gmail, you can use an app-specific password for Yahoo as well. Visit
>> +https://help.yahoo.com/kb/SLN15241.html to get instructions for generating
>> +them. After generating, edit `~/.gitconfig` to specify your account settings
>> +for Yahoo and use its SMTP server with `git send-email`:
> 
> I am starting to doubt the wisdom of giving one section per
> provider, especially since the delta between the section is so small
> (essentially, the server address, the smtpAuth supported, and their
> official documentation URL).  Would it make more sense to just have
> a template example with placeholders, and a table of placeholder
> values that has one row per provider?

Umm, not sure how to get that done. Don't have much experience in these docs yk.

Also, I don't intend to support more email providers.

You also might want to hold off this for a while since I opened a PR here:

https://github.com/git/git-scm.com/pull/2005#issuecomment-2880140423

And as per this, we might have to remove the email helper links, from
gitcredentials, or move them to a separate section.

> 
>> +
>> +----
>> +[sendemail]
>> +	smtpEncryption = tls
>> +	smtpServer = smtp.mail.yahoo.com
>> +	smtpUser = yourname@yahoo.com
>> +	smtpServerPort = 587
>> +----
>> +
>> +If you wish to use OAuth2.0 rather than an app-specific password, you can use
>> +either `OAUTHBEARER` or `XOAUTH2` as the authentication method. As an example,
>> +if you want to use `OAUTHBEARER`, edit your `~/.gitconfig` file and add
>> +`smtpAuth = OAUTHBEARER` to your account settings:


^ permalink raw reply	[flat|nested] 52+ messages in thread

* [PATCH v2 0/2] docs: update email credential helpers
  2025-05-13 18:28 [PATCH] docs: add instructions to use Yahoo with send-mail Aditya Garg
  2025-05-13 18:33 ` Aditya Garg
  2025-05-14 12:58 ` Junio C Hamano
@ 2025-05-15 10:29 ` Aditya Garg
  2025-05-15 10:29   ` [PATCH v2 1/2] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
                     ` (2 more replies)
  2025-05-19 12:51 ` [PATCH v4 0/3] docs: update email credential helpers and improve formatting Aditya Garg
                   ` (3 subsequent siblings)
  6 siblings, 3 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-15 10:29 UTC (permalink / raw)
  To: Junio C Hamano, git; +Cc: Eric Sunshine, Zi Yao, Kristoffer Haugsbakk, sandals

Hi all,

This patch series included two patches:

1. The first patch adds a link to the `git-credential-yahoo` helper for
   Yahoo accounts and links Google's `sendgmail` tool as an alternative
   method for sending emails through Gmail.

2. The second patch removed the email credential helper links from the
   `gitcredentials` page. The links are still available in the
   `git-send-email` documentation, which is the right place for them.

Detailed explanation of the changes has been done in individual patch.

v2: Removed instructions for Yahoo SMTP server since I've realised that
    Yahoo *was* a popular email service. Also, the instructions were
    just making the docs more crowded. I've also added a link to
    Google's `sendgmail` tool in the first patch. The second patch has been
    added to address the issues that came up here:
    https://github.com/git/git-scm.com/pull/2005

Aditya Garg (2):
  docs: add credential helper for yahoo and link Google's sendgmail tool
  docs: remove credential helper links for emails from gitcredentials

 Documentation/git-send-email.adoc | 10 ++++++++--
 Documentation/gitcredentials.adoc |  4 ----
 2 files changed, 8 insertions(+), 6 deletions(-)

-- 
2.49.0


^ permalink raw reply	[flat|nested] 52+ messages in thread

* [PATCH v2 1/2] docs: add credential helper for yahoo and link Google's sendgmail tool
  2025-05-15 10:29 ` [PATCH v2 0/2] docs: update email credential helpers Aditya Garg
@ 2025-05-15 10:29   ` Aditya Garg
  2025-05-15 10:29   ` [PATCH v2 2/2] docs: remove credential helper links for emails from gitcredentials Aditya Garg
  2025-05-18  7:34   ` [PATCH v3 0/3] docs: update email credential helpers and improve formatting Aditya Garg
  2 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-15 10:29 UTC (permalink / raw)
  To: Junio C Hamano, git; +Cc: Eric Sunshine, Zi Yao, Kristoffer Haugsbakk, sandals

This commit links `git-credential-yahoo` as a credential helper for
Yahoo accounts. Also, Google's `sendgmail` tool has been linked as an
alternative method for sending emails through Gmail.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/git-send-email.adoc | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 26fda63c2f..81f8cbc6f3 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -543,6 +543,10 @@ settings:
 	smtpAuth = OAUTHBEARER
 ----
 
+Alternatively, you can use a tool developed by Google known as
+https://github.com/google/gmail-oauth2-tools/tree/master/go/sendgmail[sendgmail]
+to send emails using `git send-email`.
+
 Use Microsoft Outlook as the SMTP Server
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
@@ -579,8 +583,7 @@ next time.
 
 If you are using OAuth2.0 authentication, you need to use an access token in
 place of a password when prompted. Various OAuth2.0 token generators are
-available online. Community maintained credential helpers for Gmail and Outlook
-are also available:
+available online. Community maintained credential helpers are also available:
 
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail]
 	  (cross platform, dedicated helper for authenticating Gmail accounts)
@@ -588,6 +591,9 @@ are also available:
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook]
 	  (cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
 
+	- https://github.com/AdityaGarg8/git-credential-email[git-credential-yahoo]
+	  (cross platform, dedicated helper for authenticating Yahoo accounts)
+
 You can also see linkgit:gitcredentials[7] for more OAuth based authentication
 helpers.
 
-- 
2.49.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v2 2/2] docs: remove credential helper links for emails from gitcredentials
  2025-05-15 10:29 ` [PATCH v2 0/2] docs: update email credential helpers Aditya Garg
  2025-05-15 10:29   ` [PATCH v2 1/2] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
@ 2025-05-15 10:29   ` Aditya Garg
  2025-05-18  7:34   ` [PATCH v3 0/3] docs: update email credential helpers and improve formatting Aditya Garg
  2 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-15 10:29 UTC (permalink / raw)
  To: Junio C Hamano, git; +Cc: Eric Sunshine, Zi Yao, Kristoffer Haugsbakk, sandals

In a recent attempt to add links of email helpers to git-scm.com [1], I
came to a conclusion that the links in the gitcredentials page are meant
for people needing credential helpers for cloning, fetching and pushing
repositories to remote hosts, and not sending emails. gitcredentials
docs don't even talk about send emails, thus confirming this view.

So, lets remove these links from the gitcredentials page. The links are
still available in the git-send-email documentation, which is the right
place for them.

[1]: https://github.com/git/git-scm.com/pull/2005

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/gitcredentials.adoc | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/Documentation/gitcredentials.adoc b/Documentation/gitcredentials.adoc
index b49923db02..3337bb475d 100644
--- a/Documentation/gitcredentials.adoc
+++ b/Documentation/gitcredentials.adoc
@@ -133,10 +133,6 @@ Popular helpers with OAuth support include:
 
     - https://github.com/hickford/git-credential-oauth[git-credential-oauth] (cross platform, included in many Linux distributions)
 
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail] (cross platform, dedicated helper to authenticate Gmail accounts for linkgit:git-send-email[1])
-
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook] (cross platform, dedicated helper to authenticate Microsoft Outlook accounts for linkgit:git-send-email[1])
-
 CREDENTIAL CONTEXTS
 -------------------
 
-- 
2.49.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v3 0/3] docs: update email credential helpers and improve formatting
  2025-05-15 10:29 ` [PATCH v2 0/2] docs: update email credential helpers Aditya Garg
  2025-05-15 10:29   ` [PATCH v2 1/2] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
  2025-05-15 10:29   ` [PATCH v2 2/2] docs: remove credential helper links for emails from gitcredentials Aditya Garg
@ 2025-05-18  7:34   ` Aditya Garg
  2025-05-18  7:35     ` [PATCH v3 1/3] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
                       ` (2 more replies)
  2 siblings, 3 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-18  7:34 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net

Hi all,

This patch series included three patches:

1. The first patch adds a link to the `git-credential-yahoo` helper for
   Yahoo accounts and links Google's `sendgmail` tool as an alternative
   method for sending emails through Gmail.

2. The second patch improves the formatting of the `git-send-email`
   documentation, making it more readable and consistent.

3. The third patch removed the email credential helper links from the
   `gitcredentials` page. The links are still available in the
   `git-send-email` documentation, which is the right place for them.

Detailed explanation of the changes has been done in individual patch.

v2: Removed instructions for Yahoo SMTP server since I've realised that
    Yahoo *was* a popular email service. Also, the instructions were
    just making the docs more crowded. I've also added a link to
    Google's `sendgmail` tool in the first patch. The second patch has been
    added to address the issues that came up here:
    https://github.com/git/git-scm.com/pull/2005

v3: Added a patch to improve the formatting of the `git-send-email`
    documentation.

Aditya Garg (3):
  docs: add credential helper for yahoo and link Google's sendgmail tool
  docs: improve formatting in git-send-email documentation
  docs: remove credential helper links for emails from gitcredentials

 Documentation/config/sendemail.adoc |   8 +-
 Documentation/git-send-email.adoc   | 187 +++++++++++++++-------------
 Documentation/gitcredentials.adoc   |   4 -
 3 files changed, 102 insertions(+), 97 deletions(-)

-- 
2.49.0


^ permalink raw reply	[flat|nested] 52+ messages in thread

* [PATCH v3 1/3] docs: add credential helper for yahoo and link Google's sendgmail tool
  2025-05-18  7:34   ` [PATCH v3 0/3] docs: update email credential helpers and improve formatting Aditya Garg
@ 2025-05-18  7:35     ` Aditya Garg
  2025-05-18  7:36     ` [PATCH v3 2/3] docs: improve formatting in git-send-email documentation Aditya Garg
  2025-05-18  7:36     ` [PATCH v3 3/3] docs: remove credential helper links for emails from gitcredentials Aditya Garg
  2 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-18  7:35 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net

This commit links `git-credential-yahoo` as a credential helper for
Yahoo accounts. Also, Google's `sendgmail` tool has been linked as an
alternative method for sending emails through Gmail.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/git-send-email.adoc | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 26fda63c2f..81f8cbc6f3 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -543,6 +543,10 @@ settings:
 	smtpAuth = OAUTHBEARER
 ----
 
+Alternatively, you can use a tool developed by Google known as
+https://github.com/google/gmail-oauth2-tools/tree/master/go/sendgmail[sendgmail]
+to send emails using `git send-email`.
+
 Use Microsoft Outlook as the SMTP Server
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
@@ -579,8 +583,7 @@ next time.
 
 If you are using OAuth2.0 authentication, you need to use an access token in
 place of a password when prompted. Various OAuth2.0 token generators are
-available online. Community maintained credential helpers for Gmail and Outlook
-are also available:
+available online. Community maintained credential helpers are also available:
 
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail]
 	  (cross platform, dedicated helper for authenticating Gmail accounts)
@@ -588,6 +591,9 @@ are also available:
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook]
 	  (cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
 
+	- https://github.com/AdityaGarg8/git-credential-email[git-credential-yahoo]
+	  (cross platform, dedicated helper for authenticating Yahoo accounts)
+
 You can also see linkgit:gitcredentials[7] for more OAuth based authentication
 helpers.
 
-- 
2.49.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v3 2/3] docs: improve formatting in git-send-email documentation
  2025-05-18  7:34   ` [PATCH v3 0/3] docs: update email credential helpers and improve formatting Aditya Garg
  2025-05-18  7:35     ` [PATCH v3 1/3] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
@ 2025-05-18  7:36     ` Aditya Garg
  2025-05-18  7:36     ` [PATCH v3 3/3] docs: remove credential helper links for emails from gitcredentials Aditya Garg
  2 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-18  7:36 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net

The current documentation for git-send-email had an inconsistent use of
"", ``, and '' for quoting. This commit improves the formatting by
using the same style throughout the documentation.

Also, at some places, minor grammatical errors were fixed, and some
non existent links were removed.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/config/sendemail.adoc |   8 +-
 Documentation/git-send-email.adoc   | 177 ++++++++++++++--------------
 2 files changed, 94 insertions(+), 91 deletions(-)

diff --git a/Documentation/config/sendemail.adoc b/Documentation/config/sendemail.adoc
index 5ffcfc9f2a..0b1b2766f5 100644
--- a/Documentation/config/sendemail.adoc
+++ b/Documentation/config/sendemail.adoc
@@ -19,9 +19,9 @@ sendemail.<identity>.*::
 	`sendemail.identity`.
 
 sendemail.multiEdit::
-	If true (default), a single editor instance will be spawned to edit
+	If `true` (default), a single editor instance will be spawned to edit
 	files you have to edit (patches when `--annotate` is used, and the
-	summary when `--compose` is used). If false, files will be edited one
+	summary when `--compose` is used). If `false`, files will be edited one
 	after the other, spawning a new editor each time.
 
 sendemail.confirm::
@@ -101,7 +101,7 @@ sendemail.signedOffCc (deprecated)::
 
 sendemail.smtpBatchSize::
 	Number of messages to be sent per connection, after that a relogin
-	will happen.  If the value is 0 or undefined, send all messages in
+	will happen.  If the value is `0` or undefined, send all messages in
 	one connection.
 	See also the `--batch-size` option of linkgit:git-send-email[1].
 
@@ -111,5 +111,5 @@ sendemail.smtpReloginDelay::
 
 sendemail.forbidSendmailVariables::
 	To avoid common misconfiguration mistakes, linkgit:git-send-email[1]
-	will abort with a warning if any configuration options for "sendmail"
+	will abort with a warning if any configuration options for `sendmail`
 	exist. Set this variable to bypass the check.
diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 81f8cbc6f3..cd52150afd 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -21,7 +21,7 @@ Takes the patches given on the command line and emails them out.
 Patches can be specified as files, directories (which will send all
 files in the directory), or directly as a revision list.  In the
 last case, any format accepted by linkgit:git-format-patch[1] can
-be passed to git send-email, as well as options understood by
+be passed to `git send-email`, as well as options understood by
 linkgit:git-format-patch[1].
 
 The header of the email is configurable via command-line options.  If not
@@ -35,11 +35,11 @@ There are two formats accepted for patch files:
 This is what linkgit:git-format-patch[1] generates.  Most headers and MIME
 formatting are ignored.
 
-2. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl'
+2. The original format used by Greg Kroah-Hartman's `send_lots_of_email.pl`
    script
 +
-This format expects the first line of the file to contain the "Cc:" value
-and the "Subject:" of the message as the second line.
+This format expects the first line of the file to contain the 'Cc:' value
+and the 'Subject:' of the message as the second line.
 
 
 OPTIONS
@@ -54,13 +54,13 @@ Composing
 	`sendemail.multiEdit`.
 
 --bcc=<address>,...::
-	Specify a "Bcc:" value for each email. Default is the value of
+	Specify a 'Bcc:' value for each email. Default is the value of
 	`sendemail.bcc`.
 +
 This option may be specified multiple times.
 
 --cc=<address>,...::
-	Specify a starting "Cc:" value for each email.
+	Specify a starting 'Cc:' value for each email.
 	Default is the value of `sendemail.cc`.
 +
 This option may be specified multiple times.
@@ -69,14 +69,14 @@ This option may be specified multiple times.
 	Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
 	to edit an introductory message for the patch series.
 +
-When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
-Subject, Reply-To, and In-Reply-To headers specified in the message. If
-the body of the message (what you type after the headers and a blank
-line) only contains blank (or Git: prefixed) lines, the summary won't be
+When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
+'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
+message. If the body of the message (what you type after the headers and a
+blank line) only contains blank (or Git: prefixed) lines, the summary won't be
 sent, but the headers mentioned above will be used unless they are
 removed.
 +
-Missing From or In-Reply-To headers will be prompted for.
+Missing 'From' or 'In-Reply-To' headers will be prompted for.
 +
 See the CONFIGURATION section for `sendemail.multiEdit`.
 
@@ -85,13 +85,13 @@ See the CONFIGURATION section for `sendemail.multiEdit`.
 	the value of the `sendemail.from` configuration option is used.  If
 	neither the command-line option nor `sendemail.from` are set, then the
 	user will be prompted for the value.  The default for the prompt will be
-	the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
-	set, as returned by "git var -l".
+	the value of `GIT_AUTHOR_IDENT`, or `GIT_COMMITTER_IDENT` if that is not
+	set, as returned by `git var -l`.
 
 --reply-to=<address>::
 	Specify the address where replies from recipients should go to.
 	Use this if replies to messages should go to another address than what
-	is specified with the --from parameter.
+	is specified with the `--from` parameter.
 
 --in-reply-to=<identifier>::
 	Make the first mail (or all the mails with `--no-thread`) appear as a
@@ -112,14 +112,14 @@ illustration below where `[PATCH v2 0/3]` is in reply to `[PATCH 0/2]`:
       [PATCH v2 2/3] New tests
       [PATCH v2 3/3] Implementation
 +
-Only necessary if --compose is also set.  If --compose
+Only necessary if `--compose` is also set.  If `--compose`
 is not set, this will be prompted for.
 
 --[no-]outlook-id-fix::
 	Microsoft Outlook SMTP servers discard the Message-ID sent via email and
 	assign a new random Message-ID, thus breaking threads.
 +
-With `--outlook-id-fix`, 'git send-email' uses a mechanism specific to
+With `--outlook-id-fix`, `git send-email` uses a mechanism specific to
 Outlook servers to learn the Message-ID the server assigned to fix the
 threading. Use it only when you know that the server reports the
 rewritten Message-ID the same way as Outlook servers do.
@@ -130,14 +130,14 @@ to 'smtp.office365.com' or 'smtp-mail.outlook.com'. Use
 
 --subject=<string>::
 	Specify the initial subject of the email thread.
-	Only necessary if --compose is also set.  If --compose
+	Only necessary if `--compose` is also set.  If `--compose`
 	is not set, this will be prompted for.
 
 --to=<address>,...::
 	Specify the primary recipient of the emails generated. Generally, this
 	will be the upstream maintainer of the project involved. Default is the
 	value of the `sendemail.to` configuration value; if that is unspecified,
-	and --to-cmd is not specified, this will be prompted for.
+	and `--to-cmd` is not specified, this will be prompted for.
 +
 This option may be specified multiple times.
 
@@ -145,30 +145,30 @@ This option may be specified multiple times.
 	When encountering a non-ASCII message or subject that does not
 	declare its encoding, add headers/quoting to indicate it is
 	encoded in <encoding>.  Default is the value of the
-	'sendemail.assume8bitEncoding'; if that is unspecified, this
+	`sendemail.assume8bitEncoding`; if that is unspecified, this
 	will be prompted for if any non-ASCII files are encountered.
 +
 Note that no attempts whatsoever are made to validate the encoding.
 
 --compose-encoding=<encoding>::
 	Specify encoding of compose message. Default is the value of the
-	'sendemail.composeEncoding'; if that is unspecified, UTF-8 is assumed.
+	`sendemail.composeEncoding`; if that is unspecified, UTF-8 is assumed.
 
 --transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)::
 	Specify the transfer encoding to be used to send the message over SMTP.
-	7bit will fail upon encountering a non-ASCII message.  quoted-printable
+	'7bit' will fail upon encountering a non-ASCII message. 'quoted-printable'
 	can be useful when the repository contains files that contain carriage
-	returns, but makes the raw patch email file (as saved from a MUA) much
-	harder to inspect manually.  base64 is even more fool proof, but also
-	even more opaque.  auto will use 8bit when possible, and quoted-printable
-	otherwise.
+	returns, but makes the raw patch email file (as saved from an MUA) much
+	harder to inspect manually. 'base64' is even more fool proof, but also
+	even more opaque. 'auto' will use '8bit' when possible, and
+	'quoted-printable' otherwise.
 +
 Default is the value of the `sendemail.transferEncoding` configuration
-value; if that is unspecified, default to `auto`.
+value; if that is unspecified, default to 'auto'.
 
 --xmailer::
 --no-xmailer::
-	Add (or prevent adding) the "X-Mailer:" header.  By default,
+	Add (or prevent adding) the 'X-Mailer:' header.  By default,
 	the header is added, but it can be turned off by setting the
 	`sendemail.xmailer` configuration variable to `false`.
 
@@ -179,8 +179,8 @@ Sending
 	Specify the envelope sender used to send the emails.
 	This is useful if your default address is not the address that is
 	subscribed to a list. In order to use the 'From' address, set the
-	value to "auto". If you use the sendmail binary, you must have
-	suitable privileges for the -f parameter.  Default is the value of the
+	value to `auto`. If you use the `sendmail` binary, you must have
+	suitable privileges for the `-f` parameter.  Default is the value of the
 	`sendemail.envelopeSender` configuration variable; if that is
 	unspecified, choosing the envelope sender is left to your MTA.
 
@@ -189,8 +189,8 @@ Sending
 	be sendmail-like; specifically, it must support the `-i` option.
 	The command will be executed in the shell if necessary.  Default
 	is the value of `sendemail.sendmailCmd`.  If unspecified, and if
-	--smtp-server is also unspecified, git-send-email will search
-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH.
+	`--smtp-server` is also unspecified, `git send-email` will search
+	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH`.
 
 --smtp-encryption=<encryption>::
 	Specify in what way encrypting begins for the SMTP connection.
@@ -209,7 +209,7 @@ Sending
 --smtp-domain=<FQDN>::
 	Specifies the Fully Qualified Domain Name (FQDN) used in the
 	HELO/EHLO command to the SMTP server.  Some servers require the
-	FQDN to match your IP address.  If not set, git send-email attempts
+	FQDN to match your IP address.  If not set, `git send-email` attempts
 	to determine your FQDN automatically.  Default is the value of
 	`sendemail.smtpDomain`.
 
@@ -223,10 +223,10 @@ $ git send-email --smtp-auth="PLAIN LOGIN GSSAPI" ...
 +
 If at least one of the specified mechanisms matches the ones advertised by the
 SMTP server and if it is supported by the utilized SASL library, the mechanism
-is used for authentication. If neither 'sendemail.smtpAuth' nor `--smtp-auth`
+is used for authentication. If neither `sendemail.smtpAuth` nor `--smtp-auth`
 is specified, all mechanisms supported by the SASL library can be used. The
-special value 'none' maybe specified to completely disable authentication
-independently of `--smtp-user`
+special value `none` maybe specified to completely disable authentication
+independently of `--smtp-user`.
 
 --smtp-pass[=<password>]::
 	Password for SMTP-AUTH. The argument is optional: If no
@@ -238,16 +238,16 @@ Furthermore, passwords need not be specified in configuration files
 or on the command line. If a username has been specified (with
 `--smtp-user` or a `sendemail.smtpUser`), but no password has been
 specified (with `--smtp-pass` or `sendemail.smtpPass`), then
-a password is obtained using 'git-credential'.
+a password is obtained using linkgit:git-credential[1].
 
 --no-smtp-auth::
-	Disable SMTP authentication. Short hand for `--smtp-auth=none`
+	Disable SMTP authentication. Short hand for `--smtp-auth=none`.
 
 --smtp-server=<host>::
 	If set, specifies the outgoing SMTP server to use (e.g.
 	`smtp.example.com` or a raw IP address).  If unspecified, and if
 	`--sendmail-cmd` is also unspecified, the default is to search
-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH if such a
+	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH` if such a
 	program is available, falling back to `localhost` otherwise.
 +
 For backward compatibility, this option can also specify a full pathname
@@ -260,7 +260,7 @@ instead.
 	Specifies a port different from the default port (SMTP
 	servers typically listen to smtp port 25, but may also listen to
 	submission port 587, or the common SSL smtp port 465);
-	symbolic port names (e.g. "submission" instead of 587)
+	symbolic port names (e.g. `submission` instead of 587)
 	are also accepted. The port can also be set with the
 	`sendemail.smtpServerPort` configuration variable.
 
@@ -269,7 +269,7 @@ instead.
 	Default value can be specified by the `sendemail.smtpServerOption`
 	configuration option.
 +
-The --smtp-server-option option must be repeated for each option you want
+The `--smtp-server-option` option must be repeated for each option you want
 to pass to the server. Likewise, different lines in the configuration files
 must be used for each option.
 
@@ -279,9 +279,8 @@ must be used for each option.
 --smtp-ssl-cert-path::
 	Path to a store of trusted CA certificates for SMTP SSL/TLS
 	certificate validation (either a directory that has been processed
-	by 'c_rehash', or a single file containing one or more PEM format
-	certificates concatenated together: see verify(1) -CAfile and
-	-CApath for more information on these). Set it to an empty string
+	by `c_rehash`, or a single file containing one or more PEM format
+	certificates concatenated together). Set it to an empty string
 	to disable certificate verification. Defaults to the value of the
 	`sendemail.smtpSSLCertPath` configuration variable, if set, or the
 	backing SSL library's compiled-in default otherwise (which should
@@ -298,18 +297,18 @@ must be used for each option.
 	connection and authentication problems.
 
 --batch-size=<num>::
-	Some email servers (e.g. smtp.163.com) limit the number emails to be
+	Some email servers (e.g. 'smtp.163.com') limit the number of emails to be
 	sent per session (connection) and this will lead to a failure when
 	sending many messages.  With this option, send-email will disconnect after
-	sending $<num> messages and wait for a few seconds (see --relogin-delay)
-	and reconnect, to work around such a limit.  You may want to
-	use some form of credential helper to avoid having to retype
-	your password every time this happens.  Defaults to the
+	sending `$<num>` messages and wait for a few seconds
+	(see `--relogin-delay`) and reconnect, to work around such a limit.
+	You may want to use some form of credential helper to avoid having to
+	retype your password every time this happens.  Defaults to the
 	`sendemail.smtpBatchSize` configuration variable.
 
 --relogin-delay=<int>::
-	Waiting $<int> seconds before reconnecting to SMTP server. Used together
-	with --batch-size option.  Defaults to the `sendemail.smtpReloginDelay`
+	Waiting `$<int>` seconds before reconnecting to SMTP server. Used together
+	with `--batch-size` option.  Defaults to the `sendemail.smtpReloginDelay`
 	configuration variable.
 
 Automating
@@ -318,7 +317,7 @@ Automating
 --no-to::
 --no-cc::
 --no-bcc::
-	Clears any list of "To:", "Cc:", "Bcc:" addresses previously
+	Clears any list of 'To:', 'Cc:', 'Bcc:' addresses previously
 	set via config.
 
 --no-identity::
@@ -327,13 +326,13 @@ Automating
 
 --to-cmd=<command>::
 	Specify a command to execute once per patch file which
-	should generate patch file specific "To:" entries.
+	should generate patch file specific 'To:' entries.
 	Output of this command must be single email address per line.
-	Default is the value of 'sendemail.toCmd' configuration value.
+	Default is the value of `sendemail.toCmd` configuration value.
 
 --cc-cmd=<command>::
 	Specify a command to execute once per patch file which
-	should generate patch file specific "Cc:" entries.
+	should generate patch file specific 'Cc:' entries.
 	Output of this command must be single email address per line.
 	Default is the value of `sendemail.ccCmd` configuration value.
 
@@ -341,7 +340,7 @@ Automating
 	Specify a command that is executed once per outgoing message
 	and output RFC 2822 style header lines to be inserted into
 	them. When the `sendemail.headerCmd` configuration variable is
-	set, its value is always used. When --header-cmd is provided
+	set, its value is always used. When `--header-cmd` is provided
 	at the command line, its value takes precedence over the
 	`sendemail.headerCmd` configuration variable.
 
@@ -350,7 +349,7 @@ Automating
 
 --[no-]chain-reply-to::
 	If this is set, each email will be sent as a reply to the previous
-	email sent.  If disabled with "--no-chain-reply-to", all emails after
+	email sent.  If disabled with `--no-chain-reply-to`, all emails after
 	the first will be sent as replies to the first email sent.  When using
 	this, it is recommended that the first file given be an overview of the
 	entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
@@ -363,21 +362,22 @@ Automating
 	the value of `sendemail.identity`.
 
 --[no-]signed-off-by-cc::
-	If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
-	cc list. Default is the value of `sendemail.signedOffByCc` configuration
-	value; if that is unspecified, default to --signed-off-by-cc.
+	If this is set, add emails found in the `Signed-off-by` trailer or 'Cc:'
+	lines to the cc list. Default is the value of `sendemail.signedOffByCc`
+	configuration value; if that is unspecified, default to
+	`--signed-off-by-cc`.
 
 --[no-]cc-cover::
-	If this is set, emails found in Cc: headers in the first patch of
+	If this is set, emails found in 'Cc:' headers in the first patch of
 	the series (typically the cover letter) are added to the cc list
-	for each email set. Default is the value of 'sendemail.ccCover'
-	configuration value; if that is unspecified, default to --no-cc-cover.
+	for each email set. Default is the value of `sendemail.ccCover`
+	configuration value; if that is unspecified, default to `--no-cc-cover`.
 
 --[no-]to-cover::
-	If this is set, emails found in To: headers in the first patch of
+	If this is set, emails found in 'To:' headers in the first patch of
 	the series (typically the cover letter) are added to the to list
-	for each email set. Default is the value of 'sendemail.toCover'
-	configuration value; if that is unspecified, default to --no-to-cover.
+	for each email set. Default is the value of `sendemail.toCover`
+	configuration value; if that is unspecified, default to `--no-to-cover`.
 
 --suppress-cc=<category>::
 	Specify an additional category of recipients to suppress the
@@ -401,36 +401,36 @@ Automating
 --
 +
 Default is the value of `sendemail.suppressCc` configuration value; if
-that is unspecified, default to 'self' if --suppress-from is
-specified, as well as 'body' if --no-signed-off-cc is specified.
+that is unspecified, default to 'self' if `--suppress-from` is
+specified, as well as 'body' if `--no-signed-off-cc` is specified.
 
 --[no-]suppress-from::
-	If this is set, do not add the From: address to the cc: list.
+	If this is set, do not add the 'From:' address to the 'Cc:' list.
 	Default is the value of `sendemail.suppressFrom` configuration
-	value; if that is unspecified, default to --no-suppress-from.
+	value; if that is unspecified, default to `--no-suppress-from`.
 
 --[no-]thread::
-	If this is set, the In-Reply-To and References headers will be
+	If this is set, the 'In-Reply-To' and 'References' headers will be
 	added to each email sent.  Whether each mail refers to the
-	previous email (`deep` threading per 'git format-patch'
+	previous email (`deep` threading per `git format-patch`
 	wording) or to the first email (`shallow` threading) is
-	governed by "--[no-]chain-reply-to".
+	governed by `--[no-]chain-reply-to`.
 +
-If disabled with "--no-thread", those headers will not be added
-(unless specified with --in-reply-to).  Default is the value of the
+If disabled with `--no-thread`, those headers will not be added
+(unless specified with `--in-reply-to`).  Default is the value of the
 `sendemail.thread` configuration value; if that is unspecified,
-default to --thread.
+default to `--thread`.
 +
 It is up to the user to ensure that no In-Reply-To header already
-exists when 'git send-email' is asked to add it (especially note that
-'git format-patch' can be configured to do the threading itself).
+exists when `git send-email` is asked to add it (especially note that
+`git format-patch` can be configured to do the threading itself).
 Failure to do so may not produce the expected result in the
 recipient's MUA.
 
 --[no-]mailmap::
 	Use the mailmap file (see linkgit:gitmailmap[5]) to map all
 	addresses to their canonical real name and email address. Additional
-	mailmap data specific to git-send-email may be provided using the
+	mailmap data specific to `git send-email` may be provided using the
 	`sendemail.mailmap.file` or `sendemail.mailmap.blob` configuration
 	values. Defaults to `sendemail.mailmap`.
 
@@ -441,12 +441,12 @@ Administering
 	Confirm just before sending:
 +
 --
-- 'always' will always confirm before sending
-- 'never' will never confirm before sending
+- 'always' will always confirm before sending.
+- 'never' will never confirm before sending.
 - 'cc' will confirm before sending when send-email has automatically
-  added addresses from the patch to the Cc list
+  added addresses from the patch to the Cc list.
 - 'compose' will confirm before sending the first message when using --compose.
-- 'auto' is equivalent to 'cc' + 'compose'
+- 'auto' is equivalent to 'cc' + 'compose'.
 --
 +
 Default is the value of `sendemail.confirm` configuration value; if that
@@ -460,10 +460,10 @@ have been specified, in which case default to 'compose'.
 	When an argument may be understood either as a reference or as a file name,
 	choose to understand it as a format-patch argument (`--format-patch`)
 	or as a file name (`--no-format-patch`). By default, when such a conflict
-	occurs, git send-email will fail.
+	occurs, `git send-email` will fail.
 
 --quiet::
-	Make git-send-email less verbose.  One line per email should be
+	Make `git send-email` less verbose.  One line per email should be
 	all that is output.
 
 --[no-]validate::
@@ -525,7 +525,7 @@ edit `~/.gitconfig` to specify your account settings:
 ----
 
 If you have multi-factor authentication set up on your Gmail account, you can
-generate an app-specific password for use with 'git send-email'. Visit
+generate an app-specific password for use with `git send-email`. Visit
 https://security.google.com/settings/security/apppasswords to create it.
 
 You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
@@ -599,9 +599,12 @@ helpers.
 
 Note: the following core Perl modules that may be installed with your
 distribution of Perl are required:
-MIME::Base64, MIME::QuotedPrint, Net::Domain and Net::SMTP.
+
+'MIME::Base64', 'MIME::QuotedPrint', 'Net::Domain' and 'Net::SMTP'.
+
 These additional Perl modules are also required:
-Authen::SASL and Mail::Address.
+
+'Authen::SASL' and 'Mail::Address'.
 
 
 SEE ALSO
-- 
2.49.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v3 3/3] docs: remove credential helper links for emails from gitcredentials
  2025-05-18  7:34   ` [PATCH v3 0/3] docs: update email credential helpers and improve formatting Aditya Garg
  2025-05-18  7:35     ` [PATCH v3 1/3] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
  2025-05-18  7:36     ` [PATCH v3 2/3] docs: improve formatting in git-send-email documentation Aditya Garg
@ 2025-05-18  7:36     ` Aditya Garg
  2 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-18  7:36 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net

In a recent attempt to add links of email helpers to git-scm.com [1], I
came to a conclusion that the links in the gitcredentials page are meant
for people needing credential helpers for cloning, fetching and pushing
repositories to remote hosts, and not sending emails. gitcredentials
docs don't even talk about send emails, thus confirming this view.

So, lets remove these links from the gitcredentials page. The links are
still available in the git-send-email documentation, which is the right
place for them.

[1]: https://github.com/git/git-scm.com/pull/2005

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/gitcredentials.adoc | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/Documentation/gitcredentials.adoc b/Documentation/gitcredentials.adoc
index b49923db02..3337bb475d 100644
--- a/Documentation/gitcredentials.adoc
+++ b/Documentation/gitcredentials.adoc
@@ -133,10 +133,6 @@ Popular helpers with OAuth support include:
 
     - https://github.com/hickford/git-credential-oauth[git-credential-oauth] (cross platform, included in many Linux distributions)
 
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail] (cross platform, dedicated helper to authenticate Gmail accounts for linkgit:git-send-email[1])
-
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook] (cross platform, dedicated helper to authenticate Microsoft Outlook accounts for linkgit:git-send-email[1])
-
 CREDENTIAL CONTEXTS
 -------------------
 
-- 
2.49.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v4 0/3] docs: update email credential helpers and improve formatting
  2025-05-13 18:28 [PATCH] docs: add instructions to use Yahoo with send-mail Aditya Garg
                   ` (2 preceding siblings ...)
  2025-05-15 10:29 ` [PATCH v2 0/2] docs: update email credential helpers Aditya Garg
@ 2025-05-19 12:51 ` Aditya Garg
  2025-05-19 12:52   ` [PATCH v4 1/3] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
                     ` (3 more replies)
  2025-05-28  7:05 ` [PATCH v5 0/4] " Aditya Garg
                   ` (2 subsequent siblings)
  6 siblings, 4 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-19 12:51 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Shengyu Qu

Hi all,

This patch series included three patches:

1. The first patch adds a link to the `git-credential-yahoo` helper for
   Yahoo accounts and links Google's `sendgmail` tool as an alternative
   method for sending emails through Gmail.

2. The second patch improves the formatting of the `git-send-email`
   documentation, making it more readable and consistent.

3. The third patch removed the email credential helper links from the
   `gitcredentials` page. The links are still available in the
   `git-send-email` documentation, which is the right place for them.

Detailed explanation of the changes has been done in individual patch.

v2: Removed instructions for Yahoo SMTP server since I've realised that
    Yahoo *was* a popular email service. Also, the instructions were
    just making the docs more crowded. I've also added a link to
    Google's `sendgmail` tool in the first patch. The second patch has been
    added to address the issues that came up here:
    https://github.com/git/git-scm.com/pull/2005

v3: Added a patch to improve the formatting of the `git-send-email`
    documentation.

v4: Added cpan links of the perl modules requires for `git-send-email`
    to work.

Aditya Garg (3):
  docs: add credential helper for yahoo and link Google's sendgmail tool
  docs: improve formatting in git-send-email documentation
  docs: remove credential helper links for emails from gitcredentials

 Documentation/config/sendemail.adoc |   8 +-
 Documentation/git-send-email.adoc   | 191 +++++++++++++++-------------
 Documentation/gitcredentials.adoc   |   4 -
 3 files changed, 106 insertions(+), 97 deletions(-)

-- 
2.49.0


^ permalink raw reply	[flat|nested] 52+ messages in thread

* [PATCH v4 1/3] docs: add credential helper for yahoo and link Google's sendgmail tool
  2025-05-19 12:51 ` [PATCH v4 0/3] docs: update email credential helpers and improve formatting Aditya Garg
@ 2025-05-19 12:52   ` Aditya Garg
  2025-05-19 12:52   ` [PATCH v4 2/3] docs: improve formatting in git-send-email documentation Aditya Garg
                     ` (2 subsequent siblings)
  3 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-19 12:52 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Shengyu Qu

This commit links `git-credential-yahoo` as a credential helper for
Yahoo accounts. Also, Google's `sendgmail` tool has been linked as an
alternative method for sending emails through Gmail.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/git-send-email.adoc | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 26fda63c2f..81f8cbc6f3 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -543,6 +543,10 @@ settings:
 	smtpAuth = OAUTHBEARER
 ----
 
+Alternatively, you can use a tool developed by Google known as
+https://github.com/google/gmail-oauth2-tools/tree/master/go/sendgmail[sendgmail]
+to send emails using `git send-email`.
+
 Use Microsoft Outlook as the SMTP Server
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
@@ -579,8 +583,7 @@ next time.
 
 If you are using OAuth2.0 authentication, you need to use an access token in
 place of a password when prompted. Various OAuth2.0 token generators are
-available online. Community maintained credential helpers for Gmail and Outlook
-are also available:
+available online. Community maintained credential helpers are also available:
 
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail]
 	  (cross platform, dedicated helper for authenticating Gmail accounts)
@@ -588,6 +591,9 @@ are also available:
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook]
 	  (cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
 
+	- https://github.com/AdityaGarg8/git-credential-email[git-credential-yahoo]
+	  (cross platform, dedicated helper for authenticating Yahoo accounts)
+
 You can also see linkgit:gitcredentials[7] for more OAuth based authentication
 helpers.
 
-- 
2.49.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v4 2/3] docs: improve formatting in git-send-email documentation
  2025-05-19 12:51 ` [PATCH v4 0/3] docs: update email credential helpers and improve formatting Aditya Garg
  2025-05-19 12:52   ` [PATCH v4 1/3] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
@ 2025-05-19 12:52   ` Aditya Garg
  2025-05-19 12:53   ` [PATCH v4 3/3] docs: remove credential helper links for emails from gitcredentials Aditya Garg
  2025-05-19 18:26   ` [PATCH v4 0/3] docs: update email credential helpers and improve formatting Junio C Hamano
  3 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-19 12:52 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Shengyu Qu

The current documentation for git-send-email had an inconsistent use of
"", ``, and '' for quoting. This commit improves the formatting by
using the same style throughout the documentation.

Also, at some places, minor grammatical errors were fixed, and some
non existent links were removed.

Finally, the cpan links of necessary perl modules have been added to
make their installation easier.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/config/sendemail.adoc |   8 +-
 Documentation/git-send-email.adoc   | 181 +++++++++++++++-------------
 2 files changed, 98 insertions(+), 91 deletions(-)

diff --git a/Documentation/config/sendemail.adoc b/Documentation/config/sendemail.adoc
index 5ffcfc9f2a..0b1b2766f5 100644
--- a/Documentation/config/sendemail.adoc
+++ b/Documentation/config/sendemail.adoc
@@ -19,9 +19,9 @@ sendemail.<identity>.*::
 	`sendemail.identity`.
 
 sendemail.multiEdit::
-	If true (default), a single editor instance will be spawned to edit
+	If `true` (default), a single editor instance will be spawned to edit
 	files you have to edit (patches when `--annotate` is used, and the
-	summary when `--compose` is used). If false, files will be edited one
+	summary when `--compose` is used). If `false`, files will be edited one
 	after the other, spawning a new editor each time.
 
 sendemail.confirm::
@@ -101,7 +101,7 @@ sendemail.signedOffCc (deprecated)::
 
 sendemail.smtpBatchSize::
 	Number of messages to be sent per connection, after that a relogin
-	will happen.  If the value is 0 or undefined, send all messages in
+	will happen.  If the value is `0` or undefined, send all messages in
 	one connection.
 	See also the `--batch-size` option of linkgit:git-send-email[1].
 
@@ -111,5 +111,5 @@ sendemail.smtpReloginDelay::
 
 sendemail.forbidSendmailVariables::
 	To avoid common misconfiguration mistakes, linkgit:git-send-email[1]
-	will abort with a warning if any configuration options for "sendmail"
+	will abort with a warning if any configuration options for `sendmail`
 	exist. Set this variable to bypass the check.
diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 81f8cbc6f3..aff0861d29 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -21,7 +21,7 @@ Takes the patches given on the command line and emails them out.
 Patches can be specified as files, directories (which will send all
 files in the directory), or directly as a revision list.  In the
 last case, any format accepted by linkgit:git-format-patch[1] can
-be passed to git send-email, as well as options understood by
+be passed to `git send-email`, as well as options understood by
 linkgit:git-format-patch[1].
 
 The header of the email is configurable via command-line options.  If not
@@ -35,11 +35,11 @@ There are two formats accepted for patch files:
 This is what linkgit:git-format-patch[1] generates.  Most headers and MIME
 formatting are ignored.
 
-2. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl'
+2. The original format used by Greg Kroah-Hartman's `send_lots_of_email.pl`
    script
 +
-This format expects the first line of the file to contain the "Cc:" value
-and the "Subject:" of the message as the second line.
+This format expects the first line of the file to contain the 'Cc:' value
+and the 'Subject:' of the message as the second line.
 
 
 OPTIONS
@@ -54,13 +54,13 @@ Composing
 	`sendemail.multiEdit`.
 
 --bcc=<address>,...::
-	Specify a "Bcc:" value for each email. Default is the value of
+	Specify a 'Bcc:' value for each email. Default is the value of
 	`sendemail.bcc`.
 +
 This option may be specified multiple times.
 
 --cc=<address>,...::
-	Specify a starting "Cc:" value for each email.
+	Specify a starting 'Cc:' value for each email.
 	Default is the value of `sendemail.cc`.
 +
 This option may be specified multiple times.
@@ -69,14 +69,14 @@ This option may be specified multiple times.
 	Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
 	to edit an introductory message for the patch series.
 +
-When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
-Subject, Reply-To, and In-Reply-To headers specified in the message. If
-the body of the message (what you type after the headers and a blank
-line) only contains blank (or Git: prefixed) lines, the summary won't be
+When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
+'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
+message. If the body of the message (what you type after the headers and a
+blank line) only contains blank (or Git: prefixed) lines, the summary won't be
 sent, but the headers mentioned above will be used unless they are
 removed.
 +
-Missing From or In-Reply-To headers will be prompted for.
+Missing 'From' or 'In-Reply-To' headers will be prompted for.
 +
 See the CONFIGURATION section for `sendemail.multiEdit`.
 
@@ -85,13 +85,13 @@ See the CONFIGURATION section for `sendemail.multiEdit`.
 	the value of the `sendemail.from` configuration option is used.  If
 	neither the command-line option nor `sendemail.from` are set, then the
 	user will be prompted for the value.  The default for the prompt will be
-	the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
-	set, as returned by "git var -l".
+	the value of `GIT_AUTHOR_IDENT`, or `GIT_COMMITTER_IDENT` if that is not
+	set, as returned by `git var -l`.
 
 --reply-to=<address>::
 	Specify the address where replies from recipients should go to.
 	Use this if replies to messages should go to another address than what
-	is specified with the --from parameter.
+	is specified with the `--from` parameter.
 
 --in-reply-to=<identifier>::
 	Make the first mail (or all the mails with `--no-thread`) appear as a
@@ -112,14 +112,14 @@ illustration below where `[PATCH v2 0/3]` is in reply to `[PATCH 0/2]`:
       [PATCH v2 2/3] New tests
       [PATCH v2 3/3] Implementation
 +
-Only necessary if --compose is also set.  If --compose
+Only necessary if `--compose` is also set.  If `--compose`
 is not set, this will be prompted for.
 
 --[no-]outlook-id-fix::
 	Microsoft Outlook SMTP servers discard the Message-ID sent via email and
 	assign a new random Message-ID, thus breaking threads.
 +
-With `--outlook-id-fix`, 'git send-email' uses a mechanism specific to
+With `--outlook-id-fix`, `git send-email` uses a mechanism specific to
 Outlook servers to learn the Message-ID the server assigned to fix the
 threading. Use it only when you know that the server reports the
 rewritten Message-ID the same way as Outlook servers do.
@@ -130,14 +130,14 @@ to 'smtp.office365.com' or 'smtp-mail.outlook.com'. Use
 
 --subject=<string>::
 	Specify the initial subject of the email thread.
-	Only necessary if --compose is also set.  If --compose
+	Only necessary if `--compose` is also set.  If `--compose`
 	is not set, this will be prompted for.
 
 --to=<address>,...::
 	Specify the primary recipient of the emails generated. Generally, this
 	will be the upstream maintainer of the project involved. Default is the
 	value of the `sendemail.to` configuration value; if that is unspecified,
-	and --to-cmd is not specified, this will be prompted for.
+	and `--to-cmd` is not specified, this will be prompted for.
 +
 This option may be specified multiple times.
 
@@ -145,30 +145,30 @@ This option may be specified multiple times.
 	When encountering a non-ASCII message or subject that does not
 	declare its encoding, add headers/quoting to indicate it is
 	encoded in <encoding>.  Default is the value of the
-	'sendemail.assume8bitEncoding'; if that is unspecified, this
+	`sendemail.assume8bitEncoding`; if that is unspecified, this
 	will be prompted for if any non-ASCII files are encountered.
 +
 Note that no attempts whatsoever are made to validate the encoding.
 
 --compose-encoding=<encoding>::
 	Specify encoding of compose message. Default is the value of the
-	'sendemail.composeEncoding'; if that is unspecified, UTF-8 is assumed.
+	`sendemail.composeEncoding`; if that is unspecified, UTF-8 is assumed.
 
 --transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)::
 	Specify the transfer encoding to be used to send the message over SMTP.
-	7bit will fail upon encountering a non-ASCII message.  quoted-printable
+	'7bit' will fail upon encountering a non-ASCII message. 'quoted-printable'
 	can be useful when the repository contains files that contain carriage
-	returns, but makes the raw patch email file (as saved from a MUA) much
-	harder to inspect manually.  base64 is even more fool proof, but also
-	even more opaque.  auto will use 8bit when possible, and quoted-printable
-	otherwise.
+	returns, but makes the raw patch email file (as saved from an MUA) much
+	harder to inspect manually. 'base64' is even more fool proof, but also
+	even more opaque. 'auto' will use '8bit' when possible, and
+	'quoted-printable' otherwise.
 +
 Default is the value of the `sendemail.transferEncoding` configuration
-value; if that is unspecified, default to `auto`.
+value; if that is unspecified, default to 'auto'.
 
 --xmailer::
 --no-xmailer::
-	Add (or prevent adding) the "X-Mailer:" header.  By default,
+	Add (or prevent adding) the 'X-Mailer:' header.  By default,
 	the header is added, but it can be turned off by setting the
 	`sendemail.xmailer` configuration variable to `false`.
 
@@ -179,8 +179,8 @@ Sending
 	Specify the envelope sender used to send the emails.
 	This is useful if your default address is not the address that is
 	subscribed to a list. In order to use the 'From' address, set the
-	value to "auto". If you use the sendmail binary, you must have
-	suitable privileges for the -f parameter.  Default is the value of the
+	value to `auto`. If you use the `sendmail` binary, you must have
+	suitable privileges for the `-f` parameter.  Default is the value of the
 	`sendemail.envelopeSender` configuration variable; if that is
 	unspecified, choosing the envelope sender is left to your MTA.
 
@@ -189,8 +189,8 @@ Sending
 	be sendmail-like; specifically, it must support the `-i` option.
 	The command will be executed in the shell if necessary.  Default
 	is the value of `sendemail.sendmailCmd`.  If unspecified, and if
-	--smtp-server is also unspecified, git-send-email will search
-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH.
+	`--smtp-server` is also unspecified, `git send-email` will search
+	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH`.
 
 --smtp-encryption=<encryption>::
 	Specify in what way encrypting begins for the SMTP connection.
@@ -209,7 +209,7 @@ Sending
 --smtp-domain=<FQDN>::
 	Specifies the Fully Qualified Domain Name (FQDN) used in the
 	HELO/EHLO command to the SMTP server.  Some servers require the
-	FQDN to match your IP address.  If not set, git send-email attempts
+	FQDN to match your IP address.  If not set, `git send-email` attempts
 	to determine your FQDN automatically.  Default is the value of
 	`sendemail.smtpDomain`.
 
@@ -223,10 +223,10 @@ $ git send-email --smtp-auth="PLAIN LOGIN GSSAPI" ...
 +
 If at least one of the specified mechanisms matches the ones advertised by the
 SMTP server and if it is supported by the utilized SASL library, the mechanism
-is used for authentication. If neither 'sendemail.smtpAuth' nor `--smtp-auth`
+is used for authentication. If neither `sendemail.smtpAuth` nor `--smtp-auth`
 is specified, all mechanisms supported by the SASL library can be used. The
-special value 'none' maybe specified to completely disable authentication
-independently of `--smtp-user`
+special value `none` maybe specified to completely disable authentication
+independently of `--smtp-user`.
 
 --smtp-pass[=<password>]::
 	Password for SMTP-AUTH. The argument is optional: If no
@@ -238,16 +238,16 @@ Furthermore, passwords need not be specified in configuration files
 or on the command line. If a username has been specified (with
 `--smtp-user` or a `sendemail.smtpUser`), but no password has been
 specified (with `--smtp-pass` or `sendemail.smtpPass`), then
-a password is obtained using 'git-credential'.
+a password is obtained using linkgit:git-credential[1].
 
 --no-smtp-auth::
-	Disable SMTP authentication. Short hand for `--smtp-auth=none`
+	Disable SMTP authentication. Short hand for `--smtp-auth=none`.
 
 --smtp-server=<host>::
 	If set, specifies the outgoing SMTP server to use (e.g.
 	`smtp.example.com` or a raw IP address).  If unspecified, and if
 	`--sendmail-cmd` is also unspecified, the default is to search
-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH if such a
+	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH` if such a
 	program is available, falling back to `localhost` otherwise.
 +
 For backward compatibility, this option can also specify a full pathname
@@ -260,7 +260,7 @@ instead.
 	Specifies a port different from the default port (SMTP
 	servers typically listen to smtp port 25, but may also listen to
 	submission port 587, or the common SSL smtp port 465);
-	symbolic port names (e.g. "submission" instead of 587)
+	symbolic port names (e.g. `submission` instead of 587)
 	are also accepted. The port can also be set with the
 	`sendemail.smtpServerPort` configuration variable.
 
@@ -269,7 +269,7 @@ instead.
 	Default value can be specified by the `sendemail.smtpServerOption`
 	configuration option.
 +
-The --smtp-server-option option must be repeated for each option you want
+The `--smtp-server-option` option must be repeated for each option you want
 to pass to the server. Likewise, different lines in the configuration files
 must be used for each option.
 
@@ -279,9 +279,8 @@ must be used for each option.
 --smtp-ssl-cert-path::
 	Path to a store of trusted CA certificates for SMTP SSL/TLS
 	certificate validation (either a directory that has been processed
-	by 'c_rehash', or a single file containing one or more PEM format
-	certificates concatenated together: see verify(1) -CAfile and
-	-CApath for more information on these). Set it to an empty string
+	by `c_rehash`, or a single file containing one or more PEM format
+	certificates concatenated together). Set it to an empty string
 	to disable certificate verification. Defaults to the value of the
 	`sendemail.smtpSSLCertPath` configuration variable, if set, or the
 	backing SSL library's compiled-in default otherwise (which should
@@ -298,18 +297,18 @@ must be used for each option.
 	connection and authentication problems.
 
 --batch-size=<num>::
-	Some email servers (e.g. smtp.163.com) limit the number emails to be
+	Some email servers (e.g. 'smtp.163.com') limit the number of emails to be
 	sent per session (connection) and this will lead to a failure when
 	sending many messages.  With this option, send-email will disconnect after
-	sending $<num> messages and wait for a few seconds (see --relogin-delay)
-	and reconnect, to work around such a limit.  You may want to
-	use some form of credential helper to avoid having to retype
-	your password every time this happens.  Defaults to the
+	sending `$<num>` messages and wait for a few seconds
+	(see `--relogin-delay`) and reconnect, to work around such a limit.
+	You may want to use some form of credential helper to avoid having to
+	retype your password every time this happens.  Defaults to the
 	`sendemail.smtpBatchSize` configuration variable.
 
 --relogin-delay=<int>::
-	Waiting $<int> seconds before reconnecting to SMTP server. Used together
-	with --batch-size option.  Defaults to the `sendemail.smtpReloginDelay`
+	Waiting `$<int>` seconds before reconnecting to SMTP server. Used together
+	with `--batch-size` option.  Defaults to the `sendemail.smtpReloginDelay`
 	configuration variable.
 
 Automating
@@ -318,7 +317,7 @@ Automating
 --no-to::
 --no-cc::
 --no-bcc::
-	Clears any list of "To:", "Cc:", "Bcc:" addresses previously
+	Clears any list of 'To:', 'Cc:', 'Bcc:' addresses previously
 	set via config.
 
 --no-identity::
@@ -327,13 +326,13 @@ Automating
 
 --to-cmd=<command>::
 	Specify a command to execute once per patch file which
-	should generate patch file specific "To:" entries.
+	should generate patch file specific 'To:' entries.
 	Output of this command must be single email address per line.
-	Default is the value of 'sendemail.toCmd' configuration value.
+	Default is the value of `sendemail.toCmd` configuration value.
 
 --cc-cmd=<command>::
 	Specify a command to execute once per patch file which
-	should generate patch file specific "Cc:" entries.
+	should generate patch file specific 'Cc:' entries.
 	Output of this command must be single email address per line.
 	Default is the value of `sendemail.ccCmd` configuration value.
 
@@ -341,7 +340,7 @@ Automating
 	Specify a command that is executed once per outgoing message
 	and output RFC 2822 style header lines to be inserted into
 	them. When the `sendemail.headerCmd` configuration variable is
-	set, its value is always used. When --header-cmd is provided
+	set, its value is always used. When `--header-cmd` is provided
 	at the command line, its value takes precedence over the
 	`sendemail.headerCmd` configuration variable.
 
@@ -350,7 +349,7 @@ Automating
 
 --[no-]chain-reply-to::
 	If this is set, each email will be sent as a reply to the previous
-	email sent.  If disabled with "--no-chain-reply-to", all emails after
+	email sent.  If disabled with `--no-chain-reply-to`, all emails after
 	the first will be sent as replies to the first email sent.  When using
 	this, it is recommended that the first file given be an overview of the
 	entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
@@ -363,21 +362,22 @@ Automating
 	the value of `sendemail.identity`.
 
 --[no-]signed-off-by-cc::
-	If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
-	cc list. Default is the value of `sendemail.signedOffByCc` configuration
-	value; if that is unspecified, default to --signed-off-by-cc.
+	If this is set, add emails found in the `Signed-off-by` trailer or 'Cc:'
+	lines to the cc list. Default is the value of `sendemail.signedOffByCc`
+	configuration value; if that is unspecified, default to
+	`--signed-off-by-cc`.
 
 --[no-]cc-cover::
-	If this is set, emails found in Cc: headers in the first patch of
+	If this is set, emails found in 'Cc:' headers in the first patch of
 	the series (typically the cover letter) are added to the cc list
-	for each email set. Default is the value of 'sendemail.ccCover'
-	configuration value; if that is unspecified, default to --no-cc-cover.
+	for each email set. Default is the value of `sendemail.ccCover`
+	configuration value; if that is unspecified, default to `--no-cc-cover`.
 
 --[no-]to-cover::
-	If this is set, emails found in To: headers in the first patch of
+	If this is set, emails found in 'To:' headers in the first patch of
 	the series (typically the cover letter) are added to the to list
-	for each email set. Default is the value of 'sendemail.toCover'
-	configuration value; if that is unspecified, default to --no-to-cover.
+	for each email set. Default is the value of `sendemail.toCover`
+	configuration value; if that is unspecified, default to `--no-to-cover`.
 
 --suppress-cc=<category>::
 	Specify an additional category of recipients to suppress the
@@ -401,36 +401,36 @@ Automating
 --
 +
 Default is the value of `sendemail.suppressCc` configuration value; if
-that is unspecified, default to 'self' if --suppress-from is
-specified, as well as 'body' if --no-signed-off-cc is specified.
+that is unspecified, default to 'self' if `--suppress-from` is
+specified, as well as 'body' if `--no-signed-off-cc` is specified.
 
 --[no-]suppress-from::
-	If this is set, do not add the From: address to the cc: list.
+	If this is set, do not add the 'From:' address to the 'Cc:' list.
 	Default is the value of `sendemail.suppressFrom` configuration
-	value; if that is unspecified, default to --no-suppress-from.
+	value; if that is unspecified, default to `--no-suppress-from`.
 
 --[no-]thread::
-	If this is set, the In-Reply-To and References headers will be
+	If this is set, the 'In-Reply-To' and 'References' headers will be
 	added to each email sent.  Whether each mail refers to the
-	previous email (`deep` threading per 'git format-patch'
+	previous email (`deep` threading per `git format-patch`
 	wording) or to the first email (`shallow` threading) is
-	governed by "--[no-]chain-reply-to".
+	governed by `--[no-]chain-reply-to`.
 +
-If disabled with "--no-thread", those headers will not be added
-(unless specified with --in-reply-to).  Default is the value of the
+If disabled with `--no-thread`, those headers will not be added
+(unless specified with `--in-reply-to`).  Default is the value of the
 `sendemail.thread` configuration value; if that is unspecified,
-default to --thread.
+default to `--thread`.
 +
 It is up to the user to ensure that no In-Reply-To header already
-exists when 'git send-email' is asked to add it (especially note that
-'git format-patch' can be configured to do the threading itself).
+exists when `git send-email` is asked to add it (especially note that
+`git format-patch` can be configured to do the threading itself).
 Failure to do so may not produce the expected result in the
 recipient's MUA.
 
 --[no-]mailmap::
 	Use the mailmap file (see linkgit:gitmailmap[5]) to map all
 	addresses to their canonical real name and email address. Additional
-	mailmap data specific to git-send-email may be provided using the
+	mailmap data specific to `git send-email` may be provided using the
 	`sendemail.mailmap.file` or `sendemail.mailmap.blob` configuration
 	values. Defaults to `sendemail.mailmap`.
 
@@ -441,12 +441,12 @@ Administering
 	Confirm just before sending:
 +
 --
-- 'always' will always confirm before sending
-- 'never' will never confirm before sending
+- 'always' will always confirm before sending.
+- 'never' will never confirm before sending.
 - 'cc' will confirm before sending when send-email has automatically
-  added addresses from the patch to the Cc list
+  added addresses from the patch to the Cc list.
 - 'compose' will confirm before sending the first message when using --compose.
-- 'auto' is equivalent to 'cc' + 'compose'
+- 'auto' is equivalent to 'cc' + 'compose'.
 --
 +
 Default is the value of `sendemail.confirm` configuration value; if that
@@ -460,10 +460,10 @@ have been specified, in which case default to 'compose'.
 	When an argument may be understood either as a reference or as a file name,
 	choose to understand it as a format-patch argument (`--format-patch`)
 	or as a file name (`--no-format-patch`). By default, when such a conflict
-	occurs, git send-email will fail.
+	occurs, `git send-email` will fail.
 
 --quiet::
-	Make git-send-email less verbose.  One line per email should be
+	Make `git send-email` less verbose.  One line per email should be
 	all that is output.
 
 --[no-]validate::
@@ -525,7 +525,7 @@ edit `~/.gitconfig` to specify your account settings:
 ----
 
 If you have multi-factor authentication set up on your Gmail account, you can
-generate an app-specific password for use with 'git send-email'. Visit
+generate an app-specific password for use with `git send-email`. Visit
 https://security.google.com/settings/security/apppasswords to create it.
 
 You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
@@ -599,9 +599,16 @@ helpers.
 
 Note: the following core Perl modules that may be installed with your
 distribution of Perl are required:
-MIME::Base64, MIME::QuotedPrint, Net::Domain and Net::SMTP.
+
+https://metacpan.org/pod/MIME::Base64[MIME::Base64],
+https://metacpan.org/pod/MIME::QuotedPrint[MIME::QuotedPrint],
+https://metacpan.org/pod/Net::Domain[Net::Domain] and
+https://metacpan.org/pod/Net::SMTP[Net::SMTP].
+
 These additional Perl modules are also required:
-Authen::SASL and Mail::Address.
+
+https://metacpan.org/pod/Authen::SASL[Authen::SASL] and
+https://metacpan.org/pod/Mail::Address[Mail::Address].
 
 
 SEE ALSO
-- 
2.49.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v4 3/3] docs: remove credential helper links for emails from gitcredentials
  2025-05-19 12:51 ` [PATCH v4 0/3] docs: update email credential helpers and improve formatting Aditya Garg
  2025-05-19 12:52   ` [PATCH v4 1/3] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
  2025-05-19 12:52   ` [PATCH v4 2/3] docs: improve formatting in git-send-email documentation Aditya Garg
@ 2025-05-19 12:53   ` Aditya Garg
  2025-05-19 18:26   ` [PATCH v4 0/3] docs: update email credential helpers and improve formatting Junio C Hamano
  3 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-19 12:53 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Shengyu Qu

In a recent attempt to add links of email helpers to git-scm.com [1], I
came to a conclusion that the links in the gitcredentials page are meant
for people needing credential helpers for cloning, fetching and pushing
repositories to remote hosts, and not sending emails. gitcredentials
docs don't even talk about send emails, thus confirming this view.

So, lets remove these links from the gitcredentials page. The links are
still available in the git-send-email documentation, which is the right
place for them.

[1]: https://github.com/git/git-scm.com/pull/2005

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/gitcredentials.adoc | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/Documentation/gitcredentials.adoc b/Documentation/gitcredentials.adoc
index b49923db02..3337bb475d 100644
--- a/Documentation/gitcredentials.adoc
+++ b/Documentation/gitcredentials.adoc
@@ -133,10 +133,6 @@ Popular helpers with OAuth support include:
 
     - https://github.com/hickford/git-credential-oauth[git-credential-oauth] (cross platform, included in many Linux distributions)
 
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail] (cross platform, dedicated helper to authenticate Gmail accounts for linkgit:git-send-email[1])
-
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook] (cross platform, dedicated helper to authenticate Microsoft Outlook accounts for linkgit:git-send-email[1])
-
 CREDENTIAL CONTEXTS
 -------------------
 
-- 
2.49.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* Re: [PATCH v4 0/3] docs: update email credential helpers and improve formatting
  2025-05-19 12:51 ` [PATCH v4 0/3] docs: update email credential helpers and improve formatting Aditya Garg
                     ` (2 preceding siblings ...)
  2025-05-19 12:53   ` [PATCH v4 3/3] docs: remove credential helper links for emails from gitcredentials Aditya Garg
@ 2025-05-19 18:26   ` Junio C Hamano
  2025-05-19 18:29     ` Aditya Garg
  3 siblings, 1 reply; 52+ messages in thread
From: Junio C Hamano @ 2025-05-19 18:26 UTC (permalink / raw)
  To: Aditya Garg
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net, Shengyu Qu

Aditya Garg <gargaditya08@live.com> writes:

> 2. The second patch improves the formatting of the `git-send-email`
>    documentation, making it more readable and consistent.

What does this series build on?  The patch apparently does not seem
to apply to any recent tips of 'master'.

When you are not building on 'master', please leave a note to say
things like:

 - Because this breakage was introduced between Git 2.43 and Git
   2.44, and the area of the code hasn't changed since then, these
   patches are made against Git 2.44.0; the result applying this
   series there merges cleanly to 'master', too.

 - This change depends on the topic, xy/frotz, which hasn't been
   merged to 'master'.  The patches are made on top of the result of
   merging that topic to 'master'.

I am guessing that this is meant to apply on top of a merge of
ag/doc-send-email ba998f61 (docs: add credential helper for outlook
and gmail in OAuth list of helpers, 2025-05-08) into 'master', so
I'll tentatively queue them there.

Thanks.



^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v4 0/3] docs: update email credential helpers and improve formatting
  2025-05-19 18:26   ` [PATCH v4 0/3] docs: update email credential helpers and improve formatting Junio C Hamano
@ 2025-05-19 18:29     ` Aditya Garg
  0 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-19 18:29 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net, Shengyu Qu



On 19/05/25 11:56 pm, Junio C Hamano wrote:
> Aditya Garg <gargaditya08@live.com> writes:
> 
>> 2. The second patch improves the formatting of the `git-send-email`
>>    documentation, making it more readable and consistent.
> 
> What does this series build on?  The patch apparently does not seem
> to apply to any recent tips of 'master'.
> 
> When you are not building on 'master', please leave a note to say
> things like:
> 
>  - Because this breakage was introduced between Git 2.43 and Git
>    2.44, and the area of the code hasn't changed since then, these
>    patches are made against Git 2.44.0; the result applying this
>    series there merges cleanly to 'master', too.
> 
>  - This change depends on the topic, xy/frotz, which hasn't been
>    merged to 'master'.  The patches are made on top of the result of
>    merging that topic to 'master'.

I'm sorry, I'll make sure I specify that in the future.

> 
> I am guessing that this is meant to apply on top of a merge of
> ag/doc-send-email ba998f61 (docs: add credential helper for outlook
> and gmail in OAuth list of helpers, 2025-05-08) into 'master', so
> I'll tentatively queue them there.

Yes you are correct!

^ permalink raw reply	[flat|nested] 52+ messages in thread

* [PATCH v5 0/4] docs: update email credential helpers and improve formatting
  2025-05-13 18:28 [PATCH] docs: add instructions to use Yahoo with send-mail Aditya Garg
                   ` (3 preceding siblings ...)
  2025-05-19 12:51 ` [PATCH v4 0/3] docs: update email credential helpers and improve formatting Aditya Garg
@ 2025-05-28  7:05 ` Aditya Garg
  2025-05-28  7:05   ` [PATCH v5 1/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
                     ` (4 more replies)
  2025-05-30 11:37 ` [PATCH v6 " Aditya Garg
  2025-05-30 15:50 ` [PATCH v7 0/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
  6 siblings, 5 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-28  7:05 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin

Hi all,

This patch series included three patches:

1. The first patch adds a link to the `git-credential-yahoo` helper for
   Yahoo accounts and links Google's `sendgmail` tool as an alternative
   method for sending emails through Gmail.

2. The second patch improves the formatting of the `git-send-email`
   documentation, making it more readable and consistent.

3. The third patch removed the email credential helper links from the
   `gitcredentials` page. The links are still available in the
   `git-send-email` documentation, which is the right place for them.

Detailed explanation of the changes has been done in individual patch.

v2: Removed instructions for Yahoo SMTP server since I've realised that
    Yahoo *was* a popular email service. Also, the instructions were
    just making the docs more crowded. I've also added a link to
    Google's `sendgmail` tool in the first patch. The second patch has been
    added to address the issues that came up here:
    https://github.com/git/git-scm.com/pull/2005

v3: Added a patch to improve the formatting of the `git-send-email`
    documentation.

v4: Added cpan links of the perl modules requires for `git-send-email`
    to work.

v5: Added a patch to make the purpose of using app password for Gmail
    more clear in `send-email` documentation.

Aditya Garg (4):
  docs: add credential helper for yahoo and link Google's sendgmail tool
  docs: improve formatting in git-send-email documentation
  docs: remove credential helper links for emails from gitcredentials
  docs: make the purpose of using app password for Gmail more clear in
    send-email

 Documentation/config/sendemail.adoc |   8 +-
 Documentation/git-send-email.adoc   | 194 +++++++++++++++-------------
 Documentation/gitcredentials.adoc   |   4 -
 3 files changed, 109 insertions(+), 97 deletions(-)

Range-diff:
-:  ---------- > 1:  2c47cc5396 docs: add credential helper for yahoo and link Google's sendgmail tool
-:  ---------- > 2:  bc1d0471ca docs: improve formatting in git-send-email documentation
-:  ---------- > 3:  b9e41e2492 docs: remove credential helper links for emails from gitcredentials
-:  ---------- > 4:  a6ad7ac810 docs: make the purpose of using app password for Gmail more clear in send-email
-- 
2.43.0


^ permalink raw reply	[flat|nested] 52+ messages in thread

* [PATCH v5 1/4] docs: add credential helper for yahoo and link Google's sendgmail tool
  2025-05-28  7:05 ` [PATCH v5 0/4] " Aditya Garg
@ 2025-05-28  7:05   ` Aditya Garg
  2025-05-28  7:05   ` [PATCH v5 2/4] docs: improve formatting in git-send-email documentation Aditya Garg
                     ` (3 subsequent siblings)
  4 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-28  7:05 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin

This commit links `git-credential-yahoo` as a credential helper for
Yahoo accounts. Also, Google's `sendgmail` tool has been linked as an
alternative method for sending emails through Gmail.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/git-send-email.adoc | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 26fda63c2f..81f8cbc6f3 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -543,6 +543,10 @@ settings:
 	smtpAuth = OAUTHBEARER
 ----
 
+Alternatively, you can use a tool developed by Google known as
+https://github.com/google/gmail-oauth2-tools/tree/master/go/sendgmail[sendgmail]
+to send emails using `git send-email`.
+
 Use Microsoft Outlook as the SMTP Server
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
@@ -579,8 +583,7 @@ next time.
 
 If you are using OAuth2.0 authentication, you need to use an access token in
 place of a password when prompted. Various OAuth2.0 token generators are
-available online. Community maintained credential helpers for Gmail and Outlook
-are also available:
+available online. Community maintained credential helpers are also available:
 
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail]
 	  (cross platform, dedicated helper for authenticating Gmail accounts)
@@ -588,6 +591,9 @@ are also available:
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook]
 	  (cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
 
+	- https://github.com/AdityaGarg8/git-credential-email[git-credential-yahoo]
+	  (cross platform, dedicated helper for authenticating Yahoo accounts)
+
 You can also see linkgit:gitcredentials[7] for more OAuth based authentication
 helpers.
 
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v5 2/4] docs: improve formatting in git-send-email documentation
  2025-05-28  7:05 ` [PATCH v5 0/4] " Aditya Garg
  2025-05-28  7:05   ` [PATCH v5 1/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
@ 2025-05-28  7:05   ` Aditya Garg
  2025-05-29 18:15     ` Junio C Hamano
  2025-05-28  7:05   ` [PATCH v5 3/4] docs: remove credential helper links for emails from gitcredentials Aditya Garg
                     ` (2 subsequent siblings)
  4 siblings, 1 reply; 52+ messages in thread
From: Aditya Garg @ 2025-05-28  7:05 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin

The current documentation for git-send-email had an inconsistent use of
"", ``, and '' for quoting. This commit improves the formatting by
using the same style throughout the documentation.

Also, at some places, minor grammatical errors were fixed, and some
non existent links were removed.

Finally, the cpan links of necessary perl modules have been added to
make their installation easier.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/config/sendemail.adoc |   8 +-
 Documentation/git-send-email.adoc   | 181 +++++++++++++++-------------
 2 files changed, 98 insertions(+), 91 deletions(-)

diff --git a/Documentation/config/sendemail.adoc b/Documentation/config/sendemail.adoc
index 5ffcfc9f2a..0b1b2766f5 100644
--- a/Documentation/config/sendemail.adoc
+++ b/Documentation/config/sendemail.adoc
@@ -19,9 +19,9 @@ sendemail.<identity>.*::
 	`sendemail.identity`.
 
 sendemail.multiEdit::
-	If true (default), a single editor instance will be spawned to edit
+	If `true` (default), a single editor instance will be spawned to edit
 	files you have to edit (patches when `--annotate` is used, and the
-	summary when `--compose` is used). If false, files will be edited one
+	summary when `--compose` is used). If `false`, files will be edited one
 	after the other, spawning a new editor each time.
 
 sendemail.confirm::
@@ -101,7 +101,7 @@ sendemail.signedOffCc (deprecated)::
 
 sendemail.smtpBatchSize::
 	Number of messages to be sent per connection, after that a relogin
-	will happen.  If the value is 0 or undefined, send all messages in
+	will happen.  If the value is `0` or undefined, send all messages in
 	one connection.
 	See also the `--batch-size` option of linkgit:git-send-email[1].
 
@@ -111,5 +111,5 @@ sendemail.smtpReloginDelay::
 
 sendemail.forbidSendmailVariables::
 	To avoid common misconfiguration mistakes, linkgit:git-send-email[1]
-	will abort with a warning if any configuration options for "sendmail"
+	will abort with a warning if any configuration options for `sendmail`
 	exist. Set this variable to bypass the check.
diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 81f8cbc6f3..aff0861d29 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -21,7 +21,7 @@ Takes the patches given on the command line and emails them out.
 Patches can be specified as files, directories (which will send all
 files in the directory), or directly as a revision list.  In the
 last case, any format accepted by linkgit:git-format-patch[1] can
-be passed to git send-email, as well as options understood by
+be passed to `git send-email`, as well as options understood by
 linkgit:git-format-patch[1].
 
 The header of the email is configurable via command-line options.  If not
@@ -35,11 +35,11 @@ There are two formats accepted for patch files:
 This is what linkgit:git-format-patch[1] generates.  Most headers and MIME
 formatting are ignored.
 
-2. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl'
+2. The original format used by Greg Kroah-Hartman's `send_lots_of_email.pl`
    script
 +
-This format expects the first line of the file to contain the "Cc:" value
-and the "Subject:" of the message as the second line.
+This format expects the first line of the file to contain the 'Cc:' value
+and the 'Subject:' of the message as the second line.
 
 
 OPTIONS
@@ -54,13 +54,13 @@ Composing
 	`sendemail.multiEdit`.
 
 --bcc=<address>,...::
-	Specify a "Bcc:" value for each email. Default is the value of
+	Specify a 'Bcc:' value for each email. Default is the value of
 	`sendemail.bcc`.
 +
 This option may be specified multiple times.
 
 --cc=<address>,...::
-	Specify a starting "Cc:" value for each email.
+	Specify a starting 'Cc:' value for each email.
 	Default is the value of `sendemail.cc`.
 +
 This option may be specified multiple times.
@@ -69,14 +69,14 @@ This option may be specified multiple times.
 	Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
 	to edit an introductory message for the patch series.
 +
-When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
-Subject, Reply-To, and In-Reply-To headers specified in the message. If
-the body of the message (what you type after the headers and a blank
-line) only contains blank (or Git: prefixed) lines, the summary won't be
+When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
+'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
+message. If the body of the message (what you type after the headers and a
+blank line) only contains blank (or Git: prefixed) lines, the summary won't be
 sent, but the headers mentioned above will be used unless they are
 removed.
 +
-Missing From or In-Reply-To headers will be prompted for.
+Missing 'From' or 'In-Reply-To' headers will be prompted for.
 +
 See the CONFIGURATION section for `sendemail.multiEdit`.
 
@@ -85,13 +85,13 @@ See the CONFIGURATION section for `sendemail.multiEdit`.
 	the value of the `sendemail.from` configuration option is used.  If
 	neither the command-line option nor `sendemail.from` are set, then the
 	user will be prompted for the value.  The default for the prompt will be
-	the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
-	set, as returned by "git var -l".
+	the value of `GIT_AUTHOR_IDENT`, or `GIT_COMMITTER_IDENT` if that is not
+	set, as returned by `git var -l`.
 
 --reply-to=<address>::
 	Specify the address where replies from recipients should go to.
 	Use this if replies to messages should go to another address than what
-	is specified with the --from parameter.
+	is specified with the `--from` parameter.
 
 --in-reply-to=<identifier>::
 	Make the first mail (or all the mails with `--no-thread`) appear as a
@@ -112,14 +112,14 @@ illustration below where `[PATCH v2 0/3]` is in reply to `[PATCH 0/2]`:
       [PATCH v2 2/3] New tests
       [PATCH v2 3/3] Implementation
 +
-Only necessary if --compose is also set.  If --compose
+Only necessary if `--compose` is also set.  If `--compose`
 is not set, this will be prompted for.
 
 --[no-]outlook-id-fix::
 	Microsoft Outlook SMTP servers discard the Message-ID sent via email and
 	assign a new random Message-ID, thus breaking threads.
 +
-With `--outlook-id-fix`, 'git send-email' uses a mechanism specific to
+With `--outlook-id-fix`, `git send-email` uses a mechanism specific to
 Outlook servers to learn the Message-ID the server assigned to fix the
 threading. Use it only when you know that the server reports the
 rewritten Message-ID the same way as Outlook servers do.
@@ -130,14 +130,14 @@ to 'smtp.office365.com' or 'smtp-mail.outlook.com'. Use
 
 --subject=<string>::
 	Specify the initial subject of the email thread.
-	Only necessary if --compose is also set.  If --compose
+	Only necessary if `--compose` is also set.  If `--compose`
 	is not set, this will be prompted for.
 
 --to=<address>,...::
 	Specify the primary recipient of the emails generated. Generally, this
 	will be the upstream maintainer of the project involved. Default is the
 	value of the `sendemail.to` configuration value; if that is unspecified,
-	and --to-cmd is not specified, this will be prompted for.
+	and `--to-cmd` is not specified, this will be prompted for.
 +
 This option may be specified multiple times.
 
@@ -145,30 +145,30 @@ This option may be specified multiple times.
 	When encountering a non-ASCII message or subject that does not
 	declare its encoding, add headers/quoting to indicate it is
 	encoded in <encoding>.  Default is the value of the
-	'sendemail.assume8bitEncoding'; if that is unspecified, this
+	`sendemail.assume8bitEncoding`; if that is unspecified, this
 	will be prompted for if any non-ASCII files are encountered.
 +
 Note that no attempts whatsoever are made to validate the encoding.
 
 --compose-encoding=<encoding>::
 	Specify encoding of compose message. Default is the value of the
-	'sendemail.composeEncoding'; if that is unspecified, UTF-8 is assumed.
+	`sendemail.composeEncoding`; if that is unspecified, UTF-8 is assumed.
 
 --transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)::
 	Specify the transfer encoding to be used to send the message over SMTP.
-	7bit will fail upon encountering a non-ASCII message.  quoted-printable
+	'7bit' will fail upon encountering a non-ASCII message. 'quoted-printable'
 	can be useful when the repository contains files that contain carriage
-	returns, but makes the raw patch email file (as saved from a MUA) much
-	harder to inspect manually.  base64 is even more fool proof, but also
-	even more opaque.  auto will use 8bit when possible, and quoted-printable
-	otherwise.
+	returns, but makes the raw patch email file (as saved from an MUA) much
+	harder to inspect manually. 'base64' is even more fool proof, but also
+	even more opaque. 'auto' will use '8bit' when possible, and
+	'quoted-printable' otherwise.
 +
 Default is the value of the `sendemail.transferEncoding` configuration
-value; if that is unspecified, default to `auto`.
+value; if that is unspecified, default to 'auto'.
 
 --xmailer::
 --no-xmailer::
-	Add (or prevent adding) the "X-Mailer:" header.  By default,
+	Add (or prevent adding) the 'X-Mailer:' header.  By default,
 	the header is added, but it can be turned off by setting the
 	`sendemail.xmailer` configuration variable to `false`.
 
@@ -179,8 +179,8 @@ Sending
 	Specify the envelope sender used to send the emails.
 	This is useful if your default address is not the address that is
 	subscribed to a list. In order to use the 'From' address, set the
-	value to "auto". If you use the sendmail binary, you must have
-	suitable privileges for the -f parameter.  Default is the value of the
+	value to `auto`. If you use the `sendmail` binary, you must have
+	suitable privileges for the `-f` parameter.  Default is the value of the
 	`sendemail.envelopeSender` configuration variable; if that is
 	unspecified, choosing the envelope sender is left to your MTA.
 
@@ -189,8 +189,8 @@ Sending
 	be sendmail-like; specifically, it must support the `-i` option.
 	The command will be executed in the shell if necessary.  Default
 	is the value of `sendemail.sendmailCmd`.  If unspecified, and if
-	--smtp-server is also unspecified, git-send-email will search
-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH.
+	`--smtp-server` is also unspecified, `git send-email` will search
+	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH`.
 
 --smtp-encryption=<encryption>::
 	Specify in what way encrypting begins for the SMTP connection.
@@ -209,7 +209,7 @@ Sending
 --smtp-domain=<FQDN>::
 	Specifies the Fully Qualified Domain Name (FQDN) used in the
 	HELO/EHLO command to the SMTP server.  Some servers require the
-	FQDN to match your IP address.  If not set, git send-email attempts
+	FQDN to match your IP address.  If not set, `git send-email` attempts
 	to determine your FQDN automatically.  Default is the value of
 	`sendemail.smtpDomain`.
 
@@ -223,10 +223,10 @@ $ git send-email --smtp-auth="PLAIN LOGIN GSSAPI" ...
 +
 If at least one of the specified mechanisms matches the ones advertised by the
 SMTP server and if it is supported by the utilized SASL library, the mechanism
-is used for authentication. If neither 'sendemail.smtpAuth' nor `--smtp-auth`
+is used for authentication. If neither `sendemail.smtpAuth` nor `--smtp-auth`
 is specified, all mechanisms supported by the SASL library can be used. The
-special value 'none' maybe specified to completely disable authentication
-independently of `--smtp-user`
+special value `none` maybe specified to completely disable authentication
+independently of `--smtp-user`.
 
 --smtp-pass[=<password>]::
 	Password for SMTP-AUTH. The argument is optional: If no
@@ -238,16 +238,16 @@ Furthermore, passwords need not be specified in configuration files
 or on the command line. If a username has been specified (with
 `--smtp-user` or a `sendemail.smtpUser`), but no password has been
 specified (with `--smtp-pass` or `sendemail.smtpPass`), then
-a password is obtained using 'git-credential'.
+a password is obtained using linkgit:git-credential[1].
 
 --no-smtp-auth::
-	Disable SMTP authentication. Short hand for `--smtp-auth=none`
+	Disable SMTP authentication. Short hand for `--smtp-auth=none`.
 
 --smtp-server=<host>::
 	If set, specifies the outgoing SMTP server to use (e.g.
 	`smtp.example.com` or a raw IP address).  If unspecified, and if
 	`--sendmail-cmd` is also unspecified, the default is to search
-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH if such a
+	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH` if such a
 	program is available, falling back to `localhost` otherwise.
 +
 For backward compatibility, this option can also specify a full pathname
@@ -260,7 +260,7 @@ instead.
 	Specifies a port different from the default port (SMTP
 	servers typically listen to smtp port 25, but may also listen to
 	submission port 587, or the common SSL smtp port 465);
-	symbolic port names (e.g. "submission" instead of 587)
+	symbolic port names (e.g. `submission` instead of 587)
 	are also accepted. The port can also be set with the
 	`sendemail.smtpServerPort` configuration variable.
 
@@ -269,7 +269,7 @@ instead.
 	Default value can be specified by the `sendemail.smtpServerOption`
 	configuration option.
 +
-The --smtp-server-option option must be repeated for each option you want
+The `--smtp-server-option` option must be repeated for each option you want
 to pass to the server. Likewise, different lines in the configuration files
 must be used for each option.
 
@@ -279,9 +279,8 @@ must be used for each option.
 --smtp-ssl-cert-path::
 	Path to a store of trusted CA certificates for SMTP SSL/TLS
 	certificate validation (either a directory that has been processed
-	by 'c_rehash', or a single file containing one or more PEM format
-	certificates concatenated together: see verify(1) -CAfile and
-	-CApath for more information on these). Set it to an empty string
+	by `c_rehash`, or a single file containing one or more PEM format
+	certificates concatenated together). Set it to an empty string
 	to disable certificate verification. Defaults to the value of the
 	`sendemail.smtpSSLCertPath` configuration variable, if set, or the
 	backing SSL library's compiled-in default otherwise (which should
@@ -298,18 +297,18 @@ must be used for each option.
 	connection and authentication problems.
 
 --batch-size=<num>::
-	Some email servers (e.g. smtp.163.com) limit the number emails to be
+	Some email servers (e.g. 'smtp.163.com') limit the number of emails to be
 	sent per session (connection) and this will lead to a failure when
 	sending many messages.  With this option, send-email will disconnect after
-	sending $<num> messages and wait for a few seconds (see --relogin-delay)
-	and reconnect, to work around such a limit.  You may want to
-	use some form of credential helper to avoid having to retype
-	your password every time this happens.  Defaults to the
+	sending `$<num>` messages and wait for a few seconds
+	(see `--relogin-delay`) and reconnect, to work around such a limit.
+	You may want to use some form of credential helper to avoid having to
+	retype your password every time this happens.  Defaults to the
 	`sendemail.smtpBatchSize` configuration variable.
 
 --relogin-delay=<int>::
-	Waiting $<int> seconds before reconnecting to SMTP server. Used together
-	with --batch-size option.  Defaults to the `sendemail.smtpReloginDelay`
+	Waiting `$<int>` seconds before reconnecting to SMTP server. Used together
+	with `--batch-size` option.  Defaults to the `sendemail.smtpReloginDelay`
 	configuration variable.
 
 Automating
@@ -318,7 +317,7 @@ Automating
 --no-to::
 --no-cc::
 --no-bcc::
-	Clears any list of "To:", "Cc:", "Bcc:" addresses previously
+	Clears any list of 'To:', 'Cc:', 'Bcc:' addresses previously
 	set via config.
 
 --no-identity::
@@ -327,13 +326,13 @@ Automating
 
 --to-cmd=<command>::
 	Specify a command to execute once per patch file which
-	should generate patch file specific "To:" entries.
+	should generate patch file specific 'To:' entries.
 	Output of this command must be single email address per line.
-	Default is the value of 'sendemail.toCmd' configuration value.
+	Default is the value of `sendemail.toCmd` configuration value.
 
 --cc-cmd=<command>::
 	Specify a command to execute once per patch file which
-	should generate patch file specific "Cc:" entries.
+	should generate patch file specific 'Cc:' entries.
 	Output of this command must be single email address per line.
 	Default is the value of `sendemail.ccCmd` configuration value.
 
@@ -341,7 +340,7 @@ Automating
 	Specify a command that is executed once per outgoing message
 	and output RFC 2822 style header lines to be inserted into
 	them. When the `sendemail.headerCmd` configuration variable is
-	set, its value is always used. When --header-cmd is provided
+	set, its value is always used. When `--header-cmd` is provided
 	at the command line, its value takes precedence over the
 	`sendemail.headerCmd` configuration variable.
 
@@ -350,7 +349,7 @@ Automating
 
 --[no-]chain-reply-to::
 	If this is set, each email will be sent as a reply to the previous
-	email sent.  If disabled with "--no-chain-reply-to", all emails after
+	email sent.  If disabled with `--no-chain-reply-to`, all emails after
 	the first will be sent as replies to the first email sent.  When using
 	this, it is recommended that the first file given be an overview of the
 	entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
@@ -363,21 +362,22 @@ Automating
 	the value of `sendemail.identity`.
 
 --[no-]signed-off-by-cc::
-	If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
-	cc list. Default is the value of `sendemail.signedOffByCc` configuration
-	value; if that is unspecified, default to --signed-off-by-cc.
+	If this is set, add emails found in the `Signed-off-by` trailer or 'Cc:'
+	lines to the cc list. Default is the value of `sendemail.signedOffByCc`
+	configuration value; if that is unspecified, default to
+	`--signed-off-by-cc`.
 
 --[no-]cc-cover::
-	If this is set, emails found in Cc: headers in the first patch of
+	If this is set, emails found in 'Cc:' headers in the first patch of
 	the series (typically the cover letter) are added to the cc list
-	for each email set. Default is the value of 'sendemail.ccCover'
-	configuration value; if that is unspecified, default to --no-cc-cover.
+	for each email set. Default is the value of `sendemail.ccCover`
+	configuration value; if that is unspecified, default to `--no-cc-cover`.
 
 --[no-]to-cover::
-	If this is set, emails found in To: headers in the first patch of
+	If this is set, emails found in 'To:' headers in the first patch of
 	the series (typically the cover letter) are added to the to list
-	for each email set. Default is the value of 'sendemail.toCover'
-	configuration value; if that is unspecified, default to --no-to-cover.
+	for each email set. Default is the value of `sendemail.toCover`
+	configuration value; if that is unspecified, default to `--no-to-cover`.
 
 --suppress-cc=<category>::
 	Specify an additional category of recipients to suppress the
@@ -401,36 +401,36 @@ Automating
 --
 +
 Default is the value of `sendemail.suppressCc` configuration value; if
-that is unspecified, default to 'self' if --suppress-from is
-specified, as well as 'body' if --no-signed-off-cc is specified.
+that is unspecified, default to 'self' if `--suppress-from` is
+specified, as well as 'body' if `--no-signed-off-cc` is specified.
 
 --[no-]suppress-from::
-	If this is set, do not add the From: address to the cc: list.
+	If this is set, do not add the 'From:' address to the 'Cc:' list.
 	Default is the value of `sendemail.suppressFrom` configuration
-	value; if that is unspecified, default to --no-suppress-from.
+	value; if that is unspecified, default to `--no-suppress-from`.
 
 --[no-]thread::
-	If this is set, the In-Reply-To and References headers will be
+	If this is set, the 'In-Reply-To' and 'References' headers will be
 	added to each email sent.  Whether each mail refers to the
-	previous email (`deep` threading per 'git format-patch'
+	previous email (`deep` threading per `git format-patch`
 	wording) or to the first email (`shallow` threading) is
-	governed by "--[no-]chain-reply-to".
+	governed by `--[no-]chain-reply-to`.
 +
-If disabled with "--no-thread", those headers will not be added
-(unless specified with --in-reply-to).  Default is the value of the
+If disabled with `--no-thread`, those headers will not be added
+(unless specified with `--in-reply-to`).  Default is the value of the
 `sendemail.thread` configuration value; if that is unspecified,
-default to --thread.
+default to `--thread`.
 +
 It is up to the user to ensure that no In-Reply-To header already
-exists when 'git send-email' is asked to add it (especially note that
-'git format-patch' can be configured to do the threading itself).
+exists when `git send-email` is asked to add it (especially note that
+`git format-patch` can be configured to do the threading itself).
 Failure to do so may not produce the expected result in the
 recipient's MUA.
 
 --[no-]mailmap::
 	Use the mailmap file (see linkgit:gitmailmap[5]) to map all
 	addresses to their canonical real name and email address. Additional
-	mailmap data specific to git-send-email may be provided using the
+	mailmap data specific to `git send-email` may be provided using the
 	`sendemail.mailmap.file` or `sendemail.mailmap.blob` configuration
 	values. Defaults to `sendemail.mailmap`.
 
@@ -441,12 +441,12 @@ Administering
 	Confirm just before sending:
 +
 --
-- 'always' will always confirm before sending
-- 'never' will never confirm before sending
+- 'always' will always confirm before sending.
+- 'never' will never confirm before sending.
 - 'cc' will confirm before sending when send-email has automatically
-  added addresses from the patch to the Cc list
+  added addresses from the patch to the Cc list.
 - 'compose' will confirm before sending the first message when using --compose.
-- 'auto' is equivalent to 'cc' + 'compose'
+- 'auto' is equivalent to 'cc' + 'compose'.
 --
 +
 Default is the value of `sendemail.confirm` configuration value; if that
@@ -460,10 +460,10 @@ have been specified, in which case default to 'compose'.
 	When an argument may be understood either as a reference or as a file name,
 	choose to understand it as a format-patch argument (`--format-patch`)
 	or as a file name (`--no-format-patch`). By default, when such a conflict
-	occurs, git send-email will fail.
+	occurs, `git send-email` will fail.
 
 --quiet::
-	Make git-send-email less verbose.  One line per email should be
+	Make `git send-email` less verbose.  One line per email should be
 	all that is output.
 
 --[no-]validate::
@@ -525,7 +525,7 @@ edit `~/.gitconfig` to specify your account settings:
 ----
 
 If you have multi-factor authentication set up on your Gmail account, you can
-generate an app-specific password for use with 'git send-email'. Visit
+generate an app-specific password for use with `git send-email`. Visit
 https://security.google.com/settings/security/apppasswords to create it.
 
 You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
@@ -599,9 +599,16 @@ helpers.
 
 Note: the following core Perl modules that may be installed with your
 distribution of Perl are required:
-MIME::Base64, MIME::QuotedPrint, Net::Domain and Net::SMTP.
+
+https://metacpan.org/pod/MIME::Base64[MIME::Base64],
+https://metacpan.org/pod/MIME::QuotedPrint[MIME::QuotedPrint],
+https://metacpan.org/pod/Net::Domain[Net::Domain] and
+https://metacpan.org/pod/Net::SMTP[Net::SMTP].
+
 These additional Perl modules are also required:
-Authen::SASL and Mail::Address.
+
+https://metacpan.org/pod/Authen::SASL[Authen::SASL] and
+https://metacpan.org/pod/Mail::Address[Mail::Address].
 
 
 SEE ALSO
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v5 3/4] docs: remove credential helper links for emails from gitcredentials
  2025-05-28  7:05 ` [PATCH v5 0/4] " Aditya Garg
  2025-05-28  7:05   ` [PATCH v5 1/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
  2025-05-28  7:05   ` [PATCH v5 2/4] docs: improve formatting in git-send-email documentation Aditya Garg
@ 2025-05-28  7:05   ` Aditya Garg
  2025-05-28  7:05   ` [PATCH v5 4/4] docs: make the purpose of using app password for Gmail more clear in send-email Aditya Garg
  2025-05-28  7:23   ` [PATCH v5 0/4] docs: update email credential helpers and improve formatting Eric Sunshine
  4 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-28  7:05 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin

In a recent attempt to add links of email helpers to git-scm.com [1], I
came to a conclusion that the links in the gitcredentials page are meant
for people needing credential helpers for cloning, fetching and pushing
repositories to remote hosts, and not sending emails. gitcredentials
docs don't even talk about send emails, thus confirming this view.

So, lets remove these links from the gitcredentials page. The links are
still available in the git-send-email documentation, which is the right
place for them.

[1]: https://github.com/git/git-scm.com/pull/2005

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/gitcredentials.adoc | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/Documentation/gitcredentials.adoc b/Documentation/gitcredentials.adoc
index b49923db02..3337bb475d 100644
--- a/Documentation/gitcredentials.adoc
+++ b/Documentation/gitcredentials.adoc
@@ -133,10 +133,6 @@ Popular helpers with OAuth support include:
 
     - https://github.com/hickford/git-credential-oauth[git-credential-oauth] (cross platform, included in many Linux distributions)
 
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail] (cross platform, dedicated helper to authenticate Gmail accounts for linkgit:git-send-email[1])
-
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook] (cross platform, dedicated helper to authenticate Microsoft Outlook accounts for linkgit:git-send-email[1])
-
 CREDENTIAL CONTEXTS
 -------------------
 
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v5 4/4] docs: make the purpose of using app password for Gmail more clear in send-email
  2025-05-28  7:05 ` [PATCH v5 0/4] " Aditya Garg
                     ` (2 preceding siblings ...)
  2025-05-28  7:05   ` [PATCH v5 3/4] docs: remove credential helper links for emails from gitcredentials Aditya Garg
@ 2025-05-28  7:05   ` Aditya Garg
  2025-05-29 18:50     ` Junio C Hamano
  2025-05-28  7:23   ` [PATCH v5 0/4] docs: update email credential helpers and improve formatting Eric Sunshine
  4 siblings, 1 reply; 52+ messages in thread
From: Aditya Garg @ 2025-05-28  7:05 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin

The current example for Gmail suggests using app passwords for
send-email if user has multi-factor authentication set up for their
account. However, it does not clarify that the user cannot use their
normal password in case they do not have multi-factor authentication
enabled. Most likely the example was written in the days when Google
allowed using normal passwords without multi-factor authentication.

This commit clarifies that app passwords are required and suggests using
OAuth2 if the user does not want to enable multi-factor authentication.
---
 Documentation/git-send-email.adoc | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index aff0861d29..99c126cd5a 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -524,9 +524,12 @@ edit `~/.gitconfig` to specify your account settings:
 	smtpServerPort = 587
 ----
 
+Gmail does not allow using your account password for `git send-email`.
 If you have multi-factor authentication set up on your Gmail account, you can
 generate an app-specific password for use with `git send-email`. Visit
 https://security.google.com/settings/security/apppasswords to create it.
+If you do not want to enable multi-factor authentication, you can use OAuth2.0
+authentication as described below.
 
 You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
 `XOAUTH2` are common methods used for this type of authentication. Gmail
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 0/4] docs: update email credential helpers and improve formatting
  2025-05-28  7:05 ` [PATCH v5 0/4] " Aditya Garg
                     ` (3 preceding siblings ...)
  2025-05-28  7:05   ` [PATCH v5 4/4] docs: make the purpose of using app password for Gmail more clear in send-email Aditya Garg
@ 2025-05-28  7:23   ` Eric Sunshine
  2025-05-28  9:36     ` Aditya Garg
  4 siblings, 1 reply; 52+ messages in thread
From: Eric Sunshine @ 2025-05-28  7:23 UTC (permalink / raw)
  To: Aditya Garg
  Cc: Junio C Hamano, git@vger.kernel.org, Julian Swagemakers, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin

On Wed, May 28, 2025 at 3:05 AM Aditya Garg <gargaditya08@live.com> wrote:
> v5: Added a patch to make the purpose of using app password for Gmail
>     more clear in `send-email` documentation.
>
> Range-diff:
> -:  ---------- > 1:  2c47cc5396 docs: add credential helper for yahoo and link Google's sendgmail tool
> -:  ---------- > 2:  bc1d0471ca docs: improve formatting in git-send-email documentation
> -:  ---------- > 3:  b9e41e2492 docs: remove credential helper links for emails from gitcredentials
> -:  ---------- > 4:  a6ad7ac810 docs: make the purpose of using app password for Gmail more clear in send-email

Strange range-diff.

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 0/4] docs: update email credential helpers and improve formatting
  2025-05-28  7:23   ` [PATCH v5 0/4] docs: update email credential helpers and improve formatting Eric Sunshine
@ 2025-05-28  9:36     ` Aditya Garg
  2025-05-28  9:42       ` Aditya Garg
  2025-05-28 10:10       ` Aditya Garg
  0 siblings, 2 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-28  9:36 UTC (permalink / raw)
  To: Eric Sunshine
  Cc: Junio C Hamano, git@vger.kernel.org, Julian Swagemakers, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin



On 28-05-2025 12:53 pm, Eric Sunshine wrote:
> On Wed, May 28, 2025 at 3:05 AM Aditya Garg <gargaditya08@live.com> wrote:
>> v5: Added a patch to make the purpose of using app password for Gmail
>>     more clear in `send-email` documentation.
>>
>> Range-diff:
>> -:  ---------- > 1:  2c47cc5396 docs: add credential helper for yahoo and link Google's sendgmail tool
>> -:  ---------- > 2:  bc1d0471ca docs: improve formatting in git-send-email documentation
>> -:  ---------- > 3:  b9e41e2492 docs: remove credential helper links for emails from gitcredentials
>> -:  ---------- > 4:  a6ad7ac810 docs: make the purpose of using app password for Gmail more clear in send-email
> 
> Strange range-diff.

I think because I used git version 2.43. When I compiled my branch with changes, git format-patch over there
had a very different range-diff from this.

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 0/4] docs: update email credential helpers and improve formatting
  2025-05-28  9:36     ` Aditya Garg
@ 2025-05-28  9:42       ` Aditya Garg
  2025-05-28 10:05         ` Aditya Garg
  2025-05-28 10:10       ` Aditya Garg
  1 sibling, 1 reply; 52+ messages in thread
From: Aditya Garg @ 2025-05-28  9:42 UTC (permalink / raw)
  To: Eric Sunshine
  Cc: Junio C Hamano, git@vger.kernel.org, Julian Swagemakers, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin



On 28-05-2025 03:06 pm, Aditya Garg wrote:
> 
> 
> On 28-05-2025 12:53 pm, Eric Sunshine wrote:
>> On Wed, May 28, 2025 at 3:05 AM Aditya Garg <gargaditya08@live.com> wrote:
>>> v5: Added a patch to make the purpose of using app password for Gmail
>>>     more clear in `send-email` documentation.
>>>
>>> Range-diff:
>>> -:  ---------- > 1:  2c47cc5396 docs: add credential helper for yahoo and link Google's sendgmail tool
>>> -:  ---------- > 2:  bc1d0471ca docs: improve formatting in git-send-email documentation
>>> -:  ---------- > 3:  b9e41e2492 docs: remove credential helper links for emails from gitcredentials
>>> -:  ---------- > 4:  a6ad7ac810 docs: make the purpose of using app password for Gmail more clear in send-email
>>
>> Strange range-diff.
> 
> I think because I used git version 2.43. When I compiled my branch with changes, git format-patch over there
> had a very different range-diff from this.

I get this range-diff with git 2.49

Range-diff:
-:  ---------- > 1:  4757d0305d imap-send: fix bug causing cfg->folder being set to NULL
1:  62edbcfc6e ! 2:  f5ad01abc5 imap-send: enable specifying the folder using the command line
    @@ Metadata
     Author: Aditya Garg <gargaditya08@live.com>
     
      ## Commit message ##
    -    imap-send: enable specifying the folder using the command line
    +    imap-send: add support for OAuth2.0 authentication
     
    -    Some users may very often want to imap-send messages to a folder
    -    other than the default set in the config. Add a command line
    -    argument for the same.
    +    OAuth2.0 is a new way of authentication supported by various email providers
    +    these days. OAUTHBEARER and XOAUTH2 are the two most common mechanisms used
    +    for OAuth2.0. OAUTHBEARER is described in RFC5801[1] and RFC7628[2], whereas
    +    XOAUTH2 is Google's proprietary mechanism (See [3]).
    +
    +    [1]: https://datatracker.ietf.org/doc/html/rfc5801
    +    [2]: https://datatracker.ietf.org/doc/html/rfc7628
    +    [3]: https://developers.google.com/workspace/gmail/imap/xoauth2-protocol#initial_client_response
     
         Signed-off-by: Aditya Garg <gargaditya08@live.com>
     
      ## Documentation/config/imap.adoc ##
    -@@
    - imap.folder::
    - 	The folder to drop the mails into, which is typically the Drafts
    --	folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
    --	"[Gmail]/Drafts". Required.
    -+	folder. For example: 'INBOX.Drafts', 'INBOX/Drafts' or
    -+	'[Gmail]/Drafts'. Required if `--folder` argument is not used. If
    -+	set and `--folder` is also used, `--folder` will be preferred.
    - 
    - imap.tunnel::
    - 	Command used to set up a tunnel to the IMAP server through which
    +@@ Documentation/config/imap.adoc: imap.authMethod::
    + 	Specify the authentication method for authenticating with the IMAP server.
    + 	If Git was built with the NO_CURL option, or if your curl version is older
    + 	than 7.34.0, or if you're running git-imap-send with the `--no-curl`
    +-	option, the only supported method is 'CRAM-MD5'. If this is not set
    +-	then 'git imap-send' uses the basic IMAP plaintext LOGIN command.
    ++	option, the only supported methods are 'CRAM-MD5', 'OAUTHBEARER' and
    ++	'XOAUTH2'. If this is not set then `git imap-send` uses the basic IMAP
    ++	plaintext LOGIN command.
     
      ## Documentation/git-imap-send.adoc ##
    -@@ Documentation/git-imap-send.adoc: OPTIONS
    - --quiet::
    - 	Be quiet.
    - 
    -+-f <folder>::
    -+--folder <folder>::
    -+	Specify the folder in which the emails have to saved.
    -+	For example: `--folder [Gmail]/Drafts` or `-f INBOX/Drafts`.
    -+
    - --curl::
    - 	Use libcurl to communicate with the IMAP server, unless tunneling
    - 	into it.  Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND
    +@@ Documentation/git-imap-send.adoc: Using Gmail's IMAP interface:
    + 
    + ---------
    + [imap]
    +-	folder = "[Gmail]/Drafts"
    +-	host = imaps://imap.gmail.com
    +-	user = user@gmail.com
    +-	port = 993
    ++    folder = "[Gmail]/Drafts"
    ++    host = imaps://imap.gmail.com
    ++    user = user@gmail.com
    ++    port = 993
    + ---------
    + 
    ++Gmail does not allow using your account password for `git imap-send`.
    ++If you have multi-factor authentication set up on your Gmail account, you can generate
    ++an app-specific password for use with `git imap-send`.
    ++Visit https://security.google.com/settings/security/apppasswords to create it.
    ++If you do not want to enable multi-factor authentication, you can use OAuth2.0
    ++authentication as described below.
    ++
    + [NOTE]
    + You might need to instead use: `folder = "[Google Mail]/Drafts"` if you get an error
    + that the "Folder doesn't exist".
    +@@ Documentation/git-imap-send.adoc: that the "Folder doesn't exist".
    + If your Gmail account is set to another language than English, the name of the "Drafts"
    + folder will be localized.
    + 
    ++If you want to use OAuth2.0 based authentication, you can specify `OAUTHBEARER`
    ++or `XOAUTH2` mechanism in your config. In such a case you will have to use an
    ++OAuth2.0 access token in place of your password.
    ++
    ++---------
    ++[imap]
    ++    folder = "[Gmail]/Drafts"
    ++    host = imaps://imap.gmail.com
    ++    user = user@gmail.com
    ++    port = 993
    ++    authmethod = OAUTHBEARER
    ++---------
    ++
    ++Using Outlook's IMAP interface:
    ++
    ++Unlike Gmail, Outlook only supports OAuth2.0 based authentication. Also, it
    ++supports only `XOAUTH2` as the mechanism.
    ++
    ++---------
    ++[imap]
    ++    folder = "Drafts"
    ++    host = imaps://outlook.office365.com
    ++    user = user@outlook.com
    ++    port = 993
    ++    authmethod = XOAUTH2
    ++---------
    ++
    + Once the commits are ready to be sent, run the following command:
    + 
    +   $ git format-patch --cover-letter -M --stdout origin/master | git imap-send
    +@@ Documentation/git-imap-send.adoc: Just make sure to disable line wrapping in the email client (Gmail's web
    + interface will wrap lines no matter what, so you need to use a real
    + IMAP client).
    + 
    ++In case you are using OAuth2.0 authentication, it is easier to use credential
    ++helpers to generate tokens. Credential helpers suggested in
    ++linkgit:git-send-email[1] can be used for `git imap-send` as well.
    ++
    + CAUTION
    + -------
    + It is still your responsibility to make sure that the email message
     
      ## imap-send.c ##
    -@@
    +@@ imap-send.c: enum CAPABILITY {
    + 	LITERALPLUS,
    + 	NAMESPACE,
    + 	STARTTLS,
    +-	AUTH_CRAM_MD5
    ++	AUTH_CRAM_MD5,
    ++	AUTH_OAUTHBEARER,
    ++	AUTH_XOAUTH2
    + };
      
    - static int verbosity;
    - static int use_curl = USE_CURL_DEFAULT;
    -+static char *opt_folder = NULL;
    + static const char *cap_list[] = {
    +@@ imap-send.c: static const char *cap_list[] = {
    + 	"NAMESPACE",
    + 	"STARTTLS",
    + 	"AUTH=CRAM-MD5",
    ++	"AUTH=OAUTHBEARER",
    ++	"AUTH=XOAUTH2",
    + };
      
    - static const char * const imap_send_usage[] = { "git imap-send [-v] [-q] [--[no-]curl] < <mbox>", NULL };
    + #define RESP_OK    0
    +@@ imap-send.c: static char *cram(const char *challenge_64, const char *user, const char *pass)
    + 	return (char *)response_64;
    + }
      
    - static struct option imap_send_options[] = {
    - 	OPT__VERBOSITY(&verbosity),
    - 	OPT_BOOL(0, "curl", &use_curl, "use libcurl to communicate with the IMAP server"),
    -+	OPT_STRING('f', "folder", &opt_folder, "folder", "specify the IMAP folder"),
    - 	OPT_END()
    - };
    ++static char *oauthbearer_base64(const char *user, const char *access_token)
    ++{
    ++	int raw_len, b64_len;
    ++	char *raw, *b64;
    ++
    ++	/* Compose the OAUTHBEARER string
    ++	 *
    ++	 * "n,a=" {User} ",^Ahost=" {Host} "^Aport=" {Port} "^Aauth=Bearer " {Access Token} "^A^A
    ++	 *
    ++	 * The first part `n,a=" {User} ",` is the gs2 header described in RFC5801.
    ++	 * * gs2-cb-flag `n` -> client does not support CB
    ++	 * * gs2-authzid `a=" {User} "`
    ++	 *
    ++	 * The second part are key value pairs containing host, port and auth as
    ++	 * described in RFC7628.
    ++	 *
    ++	 * https://datatracker.ietf.org/doc/html/rfc5801
    ++	 * https://datatracker.ietf.org/doc/html/rfc7628
    ++	 */
    ++	raw_len = strlen(user) + strlen(access_token) + 20;
    ++	raw = xmallocz(raw_len + 1);
    ++	snprintf(raw, raw_len + 1, "n,a=%s,\001auth=Bearer %s\001\001", user, access_token);
    ++
    ++	/* Base64 encode */
    ++	b64 = xmallocz(ENCODED_SIZE(strlen(raw)));
    ++	b64_len = EVP_EncodeBlock((unsigned char *)b64, (unsigned char *)raw, strlen(raw));
    ++	free(raw);
    ++
    ++	if (b64_len < 0) {
    ++		free(b64);
    ++		return NULL;
    ++	}
    ++	return b64;
    ++}
    ++
    ++static char *xoauth2_base64(const char *user, const char *access_token)
    ++{
    ++	int raw_len, b64_len;
    ++	char *raw, *b64;
    ++
    ++	/* Compose the XOAUTH2 string
    ++	 * "user=" {User} "^Aauth=Bearer " {Access Token} "^A^A"
    ++	 * https://developers.google.com/workspace/gmail/imap/xoauth2-protocol#initial_client_response
    ++	 */
    ++	raw_len = strlen(user) + strlen(access_token) + 20;
    ++	raw = xmallocz(raw_len + 1);
    ++	snprintf(raw, raw_len + 1, "user=%s\001auth=Bearer %s\001\001", user, access_token);
    ++
    ++	/* Base64 encode */
    ++	b64 = xmallocz(ENCODED_SIZE(strlen(raw)));
    ++	b64_len = EVP_EncodeBlock((unsigned char *)b64, (unsigned char *)raw, strlen(raw));
    ++	free(raw);
    ++
    ++	if (b64_len < 0) {
    ++		free(b64);
    ++		return NULL;
    ++	}
    ++	return b64;
    ++}
    ++
    + #else
      
    -@@ imap-send.c: int cmd_main(int argc, const char **argv)
    + static char *cram(const char *challenge_64 UNUSED,
    +@@ imap-send.c: static char *cram(const char *challenge_64 UNUSED,
    + 	    "you have to build git-imap-send with OpenSSL library.");
    + }
      
    - 	argc = parse_options(argc, (const char **)argv, "", imap_send_options, imap_send_usage, 0);
    ++static char *oauthbearer_base64(const char *user UNUSED,
    ++		  const char *access_token UNUSED)
    ++{
    ++	die("You are trying to use OAUTHBEARER authenticate method "
    ++	    "with OpenSSL library, but it's support has not been compiled in.");
    ++}
    ++
    ++static char *xoauth2_base64(const char *user UNUSED,
    ++		  const char *access_token UNUSED)
    ++{
    ++	die("You are trying to use XOAUTH2 authenticate method "
    ++	    "with OpenSSL library, but it's support has not been compiled in.");
    ++}
    ++
    + #endif
      
    -+	if (opt_folder) {
    -+		free(server.folder);
    -+		server.folder = xstrdup(opt_folder);
    + static int auth_cram_md5(struct imap_store *ctx, const char *prompt)
    +@@ imap-send.c: static int auth_cram_md5(struct imap_store *ctx, const char *prompt)
    + 	return 0;
    + }
    + 
    ++static int auth_oauthbearer(struct imap_store *ctx, const char *prompt UNUSED)
    ++{
    ++	int ret;
    ++	char *b64;
    ++
    ++	b64 = oauthbearer_base64(ctx->cfg->user, ctx->cfg->pass);
    ++	if (!b64)
    ++		return error("OAUTHBEARER: base64 encoding failed");
    ++
    ++	/* Send the base64-encoded response */
    ++	ret = socket_write(&ctx->imap->buf.sock, b64, strlen(b64));
    ++	if (ret != (int)strlen(b64)) {
    ++		free(b64);
    ++		return error("IMAP error: sending OAUTHBEARER response failed");
    ++	}
    ++
    ++	free(b64);
    ++	return 0;
    ++}
    ++
    ++static int auth_xoauth2(struct imap_store *ctx, const char *prompt UNUSED)
    ++{
    ++	int ret;
    ++	char *b64;
    ++
    ++	b64 = xoauth2_base64(ctx->cfg->user, ctx->cfg->pass);
    ++	if (!b64)
    ++		return error("XOAUTH2: base64 encoding failed");
    ++
    ++	/* Send the base64-encoded response */
    ++	ret = socket_write(&ctx->imap->buf.sock, b64, strlen(b64));
    ++	if (ret != (int)strlen(b64)) {
    ++		free(b64);
    ++		return error("IMAP error: sending XOAUTH2 response failed");
     +	}
     +
    - 	if (argc)
    - 		usage_with_options(imap_send_usage, imap_send_options);
    ++	free(b64);
    ++	return 0;
    ++}
    ++
    + static void server_fill_credential(struct imap_server_conf *srvc, struct credential *cred)
    + {
    + 	if (srvc->user && srvc->pass)
    +@@ imap-send.c: static struct imap_store *imap_open_store(struct imap_server_conf *srvc, const c
    + 					fprintf(stderr, "IMAP error: AUTHENTICATE CRAM-MD5 failed\n");
    + 					goto bail;
    + 				}
    ++			} else if (!strcmp(srvc->auth_method, "OAUTHBEARER")) {
    ++				if (!CAP(AUTH_OAUTHBEARER)) {
    ++					fprintf(stderr, "You specified "
    ++						"OAUTHBEARER as authentication method, "
    ++						"but %s doesn't support it.\n", srvc->host);
    ++					goto bail;
    ++				}
    ++				/* OAUTHBEARER */
    ++
    ++				memset(&cb, 0, sizeof(cb));
    ++				cb.cont = auth_oauthbearer;
    ++				if (imap_exec(ctx, &cb, "AUTHENTICATE OAUTHBEARER") != RESP_OK) {
    ++					fprintf(stderr, "IMAP error: AUTHENTICATE OAUTHBEARER failed\n");
    ++					goto bail;
    ++				}
    ++			} else if (!strcmp(srvc->auth_method, "XOAUTH2")) {
    ++				if (!CAP(AUTH_XOAUTH2)) {
    ++					fprintf(stderr, "You specified "
    ++						"XOAUTH2 as authentication method, "
    ++						"but %s doesn't support it.\n", srvc->host);
    ++					goto bail;
    ++				}
    ++				/* XOAUTH2 */
    ++
    ++				memset(&cb, 0, sizeof(cb));
    ++				cb.cont = auth_xoauth2;
    ++				if (imap_exec(ctx, &cb, "AUTHENTICATE XOAUTH2") != RESP_OK) {
    ++					fprintf(stderr, "IMAP error: AUTHENTICATE XOAUTH2 failed\n");
    ++					goto bail;
    ++				}
    + 			} else {
    + 				fprintf(stderr, "Unknown authentication method:%s\n", srvc->host);
    + 				goto bail;
    +@@ imap-send.c: static CURL *setup_curl(struct imap_server_conf *srvc, struct credential *cred)
    + 
    + 	server_fill_credential(srvc, cred);
    + 	curl_easy_setopt(curl, CURLOPT_USERNAME, srvc->user);
    +-	curl_easy_setopt(curl, CURLOPT_PASSWORD, srvc->pass);
    ++
    ++	if (!srvc->auth_method ||
    ++	    strcmp(srvc->auth_method, "XOAUTH2") ||
    ++	    strcmp(srvc->auth_method, "OAUTHBEARER"))
    ++		curl_easy_setopt(curl, CURLOPT_PASSWORD, srvc->pass);
    + 
    + 	strbuf_addstr(&path, srvc->use_ssl ? "imaps://" : "imap://");
    + 	strbuf_addstr(&path, srvc->host);
    +@@ imap-send.c: static CURL *setup_curl(struct imap_server_conf *srvc, struct credential *cred)
    + 	curl_easy_setopt(curl, CURLOPT_PORT, srvc->port);
    + 
    + 	if (srvc->auth_method) {
    +-		struct strbuf auth = STRBUF_INIT;
    +-		strbuf_addstr(&auth, "AUTH=");
    +-		strbuf_addstr(&auth, srvc->auth_method);
    +-		curl_easy_setopt(curl, CURLOPT_LOGIN_OPTIONS, auth.buf);
    +-		strbuf_release(&auth);
    ++		if (!strcmp(srvc->auth_method, "XOAUTH2") ||
    ++		    !strcmp(srvc->auth_method, "OAUTHBEARER")) {
    ++
    ++			/* While CURLOPT_XOAUTH2_BEARER looks as if it only supports XOAUTH2,
    ++			 * upon debugging, it has been found that it is capable of detecting
    ++			 * the best option out of OAUTHBEARER and XOAUTH2.
    ++			 */
    ++			curl_easy_setopt(curl, CURLOPT_XOAUTH2_BEARER, srvc->pass);
    ++		} else {
    ++			struct strbuf auth = STRBUF_INIT;
    ++			strbuf_addstr(&auth, "AUTH=");
    ++			strbuf_addstr(&auth, srvc->auth_method);
    ++			curl_easy_setopt(curl, CURLOPT_LOGIN_OPTIONS, auth.buf);
    ++			strbuf_release(&auth);
    ++		}
    + 	}
      
    + 	if (!srvc->use_ssl)
-:  ---------- > 3:  e3dc19dc49 imap-send: add PLAIN authentication method to OpenSSL
-:  ---------- > 4:  11f7ac1325 imap-send: fix memory leak in case auth_cram_md5 fails
-:  ---------- > 5:  f6e7a5498e imap-send: enable specifying the folder using the command line
2:  245cc89cca = 6:  4769924781 imap-send: enable user to choose between libcurl and openssl using the config
-- 
2.49.0.windows.1



^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 0/4] docs: update email credential helpers and improve formatting
  2025-05-28  9:42       ` Aditya Garg
@ 2025-05-28 10:05         ` Aditya Garg
  0 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-28 10:05 UTC (permalink / raw)
  To: Eric Sunshine
  Cc: Junio C Hamano, git@vger.kernel.org, Julian Swagemakers, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin



On 28-05-2025 03:12 pm, Aditya Garg wrote:
> 
> 
> On 28-05-2025 03:06 pm, Aditya Garg wrote:
>>
>>
>> On 28-05-2025 12:53 pm, Eric Sunshine wrote:
>>> On Wed, May 28, 2025 at 3:05 AM Aditya Garg <gargaditya08@live.com> wrote:
>>>> v5: Added a patch to make the purpose of using app password for Gmail
>>>>     more clear in `send-email` documentation.
>>>>
>>>> Range-diff:
>>>> -:  ---------- > 1:  2c47cc5396 docs: add credential helper for yahoo and link Google's sendgmail tool
>>>> -:  ---------- > 2:  bc1d0471ca docs: improve formatting in git-send-email documentation
>>>> -:  ---------- > 3:  b9e41e2492 docs: remove credential helper links for emails from gitcredentials
>>>> -:  ---------- > 4:  a6ad7ac810 docs: make the purpose of using app password for Gmail more clear in send-email
>>>
>>> Strange range-diff.
>>
>> I think because I used git version 2.43. When I compiled my branch with changes, git format-patch over there
>> had a very different range-diff from this.
> 
> I get this range-diff with git 2.49

Disregard this message, I just mixed up two different threads.

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 0/4] docs: update email credential helpers and improve formatting
  2025-05-28  9:36     ` Aditya Garg
  2025-05-28  9:42       ` Aditya Garg
@ 2025-05-28 10:10       ` Aditya Garg
  1 sibling, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-28 10:10 UTC (permalink / raw)
  To: Eric Sunshine
  Cc: Junio C Hamano, git@vger.kernel.org, Julian Swagemakers, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin



On 28-05-2025 03:06 pm, Aditya Garg wrote:
> 
> 
> On 28-05-2025 12:53 pm, Eric Sunshine wrote:
>> On Wed, May 28, 2025 at 3:05 AM Aditya Garg <gargaditya08@live.com> wrote:
>>> v5: Added a patch to make the purpose of using app password for Gmail
>>>     more clear in `send-email` documentation.
>>>
>>> Range-diff:
>>> -:  ---------- > 1:  2c47cc5396 docs: add credential helper for yahoo and link Google's sendgmail tool
>>> -:  ---------- > 2:  bc1d0471ca docs: improve formatting in git-send-email documentation
>>> -:  ---------- > 3:  b9e41e2492 docs: remove credential helper links for emails from gitcredentials
>>> -:  ---------- > 4:  a6ad7ac810 docs: make the purpose of using app password for Gmail more clear in send-email
>>
>> Strange range-diff.
> 
> I think because I used git version 2.43. When I compiled my branch with changes, git format-patch over there
> had a very different range-diff from this.

This is the one from Git 2.49

Range-diff:
2:  72b3cd1bfb ! 1:  2c47cc5396 send-email: show the new message id assigned by outlook in the logs
    @@ Metadata
     Author: Aditya Garg <gargaditya08@live.com>
     
      ## Commit message ##
    -    send-email: show the new message id assigned by outlook in the logs
    +    docs: add credential helper for yahoo and link Google's sendgmail tool
     
    -    Whenever an email is sent, send-email shows a log at last, which
    -    contains all the headers of the email that were received by the
    -    receipients.
    -
    -    In case outlook changes the Message-ID, a log for the same is shown to
    -    the user, but that change is not reflected when the log containing all
    -    the headers is displayed. Here is an example of the log that is shown
    -    when outlook changes the Message-ID:
    -
    -    Outlook reassigned Message-ID to: <PN3PR01MB95973E5ACD7CCFADCB4E298CB865A@PN3PR01MB9597.INDPRD01.PROD.OUTLOOK.COM>
    -    OK. Log says:
    -    Server: smtp.office365.com
    -    MAIL FROM:<gargaditya08@live.com>
    -    RCPT TO:<negahe7142@nomrista.com>
    -    From: Aditya Garg <gargaditya08@live.com>
    -    To: negahe7142@nomrista.com
    -    Subject: [PATCH] send-email: show the new message id assigned by outlook in the logs
    -    Date: Mon, 26 May 2025 20:28:36 +0530
    -    Message-ID: <20250526145836.4825-1-gargaditya08@live.com>
    -    X-Mailer: git-send-email @GIT_VERSION@
    -    MIME-Version: 1.0
    -    Content-Transfer-Encoding: 8bit
    -
    -    Result: 250
    -
    -    This patch fixes this by modifying the $header variable, which is
    -    responsible for showing the logs at the end. Also, the log which states
    -    that the Message-ID has been changed will now be shown only when
    -    smtp-debug is enabled, since the main log having all of the headers is
    -    anyways displaying the new Message-ID. It should look like this after
    -    this patch:
    -
    -    OK. Log says:
    -    Server: smtp.office365.com
    -    MAIL FROM:<gargaditya08@live.com>
    -    RCPT TO:<negahe7142@nomrista.com>
    -    From: Aditya Garg <gargaditya08@live.com>
    -    To: negahe7142@nomrista.com
    -    Subject: [PATCH] send-email: show the new message id assigned by outlook in the logs
    -    Date: Mon, 26 May 2025 20:29:22 +0530
    -    Message-ID: <PN3PR01MB95977486061BD2542BD09B67B865A@PN3PR01MB9597.INDPRD01.PROD.OUTLOOK.COM>
    -    X-Mailer: git-send-email @GIT_VERSION@
    -    MIME-Version: 1.0
    -    Content-Transfer-Encoding: 8bit
    -
    -    Result: 250
    +    This commit links `git-credential-yahoo` as a credential helper for
    +    Yahoo accounts. Also, Google's `sendgmail` tool has been linked as an
    +    alternative method for sending emails through Gmail.
     
         Signed-off-by: Aditya Garg <gargaditya08@live.com>
     
    - ## git-send-email.perl ##
    -@@ git-send-email.perl: sub send_message {
    - 		if (is_outlook($smtp_server)) {
    - 			if ($smtp->message =~ /<([^>]+)>/) {
    - 				$message_id = "<$1>";
    --				printf __("Outlook reassigned Message-ID to: %s\n"), $message_id;
    -+				# Replace the original Message-ID in $header with the new one
    -+				$header =~ s/^(Message-ID:\s*).*\n/${1}$message_id\n/m;
    -+				printf __("Outlook reassigned Message-ID to: %s\n"), $message_id if $smtp->debug;
    - 			} else {
    - 				warn __("Warning: Could not retrieve Message-ID from server response.\n");
    - 			}
    + ## Documentation/git-send-email.adoc ##
    +@@ Documentation/git-send-email.adoc: settings:
    + 	smtpAuth = OAUTHBEARER
    + ----
    + 
    ++Alternatively, you can use a tool developed by Google known as
    ++https://github.com/google/gmail-oauth2-tools/tree/master/go/sendgmail[sendgmail]
    ++to send emails using `git send-email`.
    ++
    + Use Microsoft Outlook as the SMTP Server
    + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
    +@@ Documentation/git-send-email.adoc: next time.
    + 
    + If you are using OAuth2.0 authentication, you need to use an access token in
    + place of a password when prompted. Various OAuth2.0 token generators are
    +-available online. Community maintained credential helpers for Gmail and Outlook
    +-are also available:
    ++available online. Community maintained credential helpers are also available:
    + 
    + 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail]
    + 	  (cross platform, dedicated helper for authenticating Gmail accounts)
    +@@ Documentation/git-send-email.adoc: are also available:
    + 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook]
    + 	  (cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
    + 
    ++	- https://github.com/AdityaGarg8/git-credential-email[git-credential-yahoo]
    ++	  (cross platform, dedicated helper for authenticating Yahoo accounts)
    ++
    + You can also see linkgit:gitcredentials[7] for more OAuth based authentication
    + helpers.
    + 
1:  63addf9d9b ! 2:  bc1d0471ca send-email: fix bug resulting in increased message number if a message is edited
    @@ Metadata
     Author: Aditya Garg <gargaditya08@live.com>
     
      ## Commit message ##
    -    send-email: fix bug resulting in increased message number if a message is edited
    +    docs: improve formatting in git-send-email documentation
     
    -    Whenever we send a thread of emails using send-email, a message number
    -    is internally assigned to each email. This number is used to track the
    -    order of the emails in the thread. Whenever a new message is processed
    -    in a thread, the current script logic increases the message number by
    -    one, which is intended.
    +    The current documentation for git-send-email had an inconsistent use of
    +    "", ``, and '' for quoting. This commit improves the formatting by
    +    using the same style throughout the documentation.
     
    -    But, if a message is edited and then resent, its message number again
    -    gets increased. This is because the script uses the same logic to
    -    process the edited message, which is uses the send the next message.
    +    Also, at some places, minor grammatical errors were fixed, and some
    +    non existent links were removed.
     
    -    This minor bug is usually harmless unless some special situations arise.
    -    One such situation is when the first message in a thread is edited
    -    and resent, and an `--in-reply-to` argument is also passed to send-email.
    -    In this case if the user has chosen shallow threading, the threading
    -    does not work as expected, and all messaged become as replies to the
    -    Message-ID specified in the `--in-reply-to` argument.
    -
    -    The reason for this bug is hidden in the code for threading itself.
    -
    -    if ($thread) {
    -            if ($message_was_sent &&
    -              ($chain_reply_to || !defined $in_reply_to || length($in_reply_to) == 0 ||
    -              $message_num == 1)) {
    -                    $in_reply_to = $message_id;
    -                    if (length $references > 0) {
    -                            $references .= "\n $message_id";
    -                    } else {
    -                            $references = "$message_id";
    -                    }
    -            }
    -    }
    -
    -    Here $message_num is the current message number, and $in_reply_to is
    -    the Message-ID of the message to which the current message is a reply.
    -    In case `--in-reply-to` is specified, the `$in_reply_to` variable
    -    is set to the value of the `--in-reply-to` argument.
    -
    -    Whenever this whole set of conditions is true, the script sets the
    -    `$in_reply_to` variable to the current message's ID. This is done to
    -    ensure that the next message in the thread is a reply to this message.
    -
    -    In case we specify an `--in-reply-to` argument, and have shallow
    -    threading, the only condition that can make this true is
    -    `$message_num == 1`, which is true for the first message in a thread.
    -    Thus the $in_reply_to variable gets set to the first message's ID.
    -    For subsequent messages, the `$message_num` variable is always
    -    greater than 1, and the whole set of conditions is false, and thus the
    -    $in_reply_to variable remains as the first message's ID. This is what
    -    we expect in shallow threading. But, in case the user edits the first
    -    message and resends it, the `$message_num` variable gets increased by 1,
    -    and thus the condition `$message_num == 1` becomes false. This means
    -    that the `$in_reply_to` variable is not set to the first message's ID,
    -    and thus the next message in the thread is not a reply to the first
    -    message, but to the `--in-reply-to` argument, effectively breaking
    -    the threading.
    -
    -    In case the user does not specify an `--in-reply-to` argument, the
    -    !defined $in_reply_to condition is true, and thus the `$in_reply_to`
    -    variable is set to the first message's ID, and the threading works
    -    as expected, irrespective of what the message number is.
    -
    -    Just like $message_num, $message_id_serial variable also increases by 1
    -    whenever a new message is sent. This variable displays the message
    -    number is the Message-ID of the email.
    -
    -    So, in order to fix this bug, we need to ensure that the $message_num
    -    variable is not increased by 1 when a message is edited and resent.
    -    We do this by decreasing the $message_num and $message_id_serial
    -    variable by 1 whenever the request to edit a message is received. This
    -    way, the next message in the thread will have the same message number as
    -    the edited message, and thus the threading will work as expected.
    -
    -    The same logic has also been applied in case the user drops a single
    -    message from the thread by choosing the "[n]o" option during
    -    confirmation. By doing this, the next message in the thread is assigned
    -    the message number of the dropped message, and thus the threading
    -    works as expected.
    +    Finally, the cpan links of necessary perl modules have been added to
    +    make their installation easier.
     
         Signed-off-by: Aditya Garg <gargaditya08@live.com>
     
    - ## git-send-email.perl ##
    -@@ git-send-email.perl: sub send_message {
    - 		         default => $ask_default);
    - 		die __("Send this email reply required") unless defined $_;
    - 		if (/^n/i) {
    -+			# If we are skipping a message, we should make sure that
    -+			# the next message is treated as the successor to the
    -+			# previously sent message, and not the skipped message.
    -+			$message_num--;
    -+			$message_id_serial--;
    - 			return 0;
    - 		} elsif (/^e/i) {
    -+			# Since the same message will be sent again, we need to
    -+			# decrement the message number to the previous message.
    -+			# Otherwise, the edited message will be treated as a
    -+			# different message sent after the original non-edited
    -+			# message.
    -+			$message_num--;
    -+			$message_id_serial--;
    - 			return -1;
    - 		} elsif (/^q/i) {
    - 			cleanup_compose_files();
    + ## Documentation/config/sendemail.adoc ##
    +@@ Documentation/config/sendemail.adoc: sendemail.<identity>.*::
    + 	`sendemail.identity`.
    + 
    + sendemail.multiEdit::
    +-	If true (default), a single editor instance will be spawned to edit
    ++	If `true` (default), a single editor instance will be spawned to edit
    + 	files you have to edit (patches when `--annotate` is used, and the
    +-	summary when `--compose` is used). If false, files will be edited one
    ++	summary when `--compose` is used). If `false`, files will be edited one
    + 	after the other, spawning a new editor each time.
    + 
    + sendemail.confirm::
    +@@ Documentation/config/sendemail.adoc: sendemail.signedOffCc (deprecated)::
    + 
    + sendemail.smtpBatchSize::
    + 	Number of messages to be sent per connection, after that a relogin
    +-	will happen.  If the value is 0 or undefined, send all messages in
    ++	will happen.  If the value is `0` or undefined, send all messages in
    + 	one connection.
    + 	See also the `--batch-size` option of linkgit:git-send-email[1].
    + 
    +@@ Documentation/config/sendemail.adoc: sendemail.smtpReloginDelay::
    + 
    + sendemail.forbidSendmailVariables::
    + 	To avoid common misconfiguration mistakes, linkgit:git-send-email[1]
    +-	will abort with a warning if any configuration options for "sendmail"
    ++	will abort with a warning if any configuration options for `sendmail`
    + 	exist. Set this variable to bypass the check.
    +
    + ## Documentation/git-send-email.adoc ##
    +@@ Documentation/git-send-email.adoc: Takes the patches given on the command line and emails them out.
    + Patches can be specified as files, directories (which will send all
    + files in the directory), or directly as a revision list.  In the
    + last case, any format accepted by linkgit:git-format-patch[1] can
    +-be passed to git send-email, as well as options understood by
    ++be passed to `git send-email`, as well as options understood by
    + linkgit:git-format-patch[1].
    + 
    + The header of the email is configurable via command-line options.  If not
    +@@ Documentation/git-send-email.adoc: There are two formats accepted for patch files:
    + This is what linkgit:git-format-patch[1] generates.  Most headers and MIME
    + formatting are ignored.
    + 
    +-2. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl'
    ++2. The original format used by Greg Kroah-Hartman's `send_lots_of_email.pl`
    +    script
    + +
    +-This format expects the first line of the file to contain the "Cc:" value
    +-and the "Subject:" of the message as the second line.
    ++This format expects the first line of the file to contain the 'Cc:' value
    ++and the 'Subject:' of the message as the second line.
    + 
    + 
    + OPTIONS
    +@@ Documentation/git-send-email.adoc: Composing
    + 	`sendemail.multiEdit`.
    + 
    + --bcc=<address>,...::
    +-	Specify a "Bcc:" value for each email. Default is the value of
    ++	Specify a 'Bcc:' value for each email. Default is the value of
    + 	`sendemail.bcc`.
    + +
    + This option may be specified multiple times.
    + 
    + --cc=<address>,...::
    +-	Specify a starting "Cc:" value for each email.
    ++	Specify a starting 'Cc:' value for each email.
    + 	Default is the value of `sendemail.cc`.
    + +
    + This option may be specified multiple times.
    +@@ Documentation/git-send-email.adoc: This option may be specified multiple times.
    + 	Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
    + 	to edit an introductory message for the patch series.
    + +
    +-When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
    +-Subject, Reply-To, and In-Reply-To headers specified in the message. If
    +-the body of the message (what you type after the headers and a blank
    +-line) only contains blank (or Git: prefixed) lines, the summary won't be
    ++When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
    ++'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
    ++message. If the body of the message (what you type after the headers and a
    ++blank line) only contains blank (or Git: prefixed) lines, the summary won't be
    + sent, but the headers mentioned above will be used unless they are
    + removed.
    + +
    +-Missing From or In-Reply-To headers will be prompted for.
    ++Missing 'From' or 'In-Reply-To' headers will be prompted for.
    + +
    + See the CONFIGURATION section for `sendemail.multiEdit`.
    + 
    +@@ Documentation/git-send-email.adoc: See the CONFIGURATION section for `sendemail.multiEdit`.
    + 	the value of the `sendemail.from` configuration option is used.  If
    + 	neither the command-line option nor `sendemail.from` are set, then the
    + 	user will be prompted for the value.  The default for the prompt will be
    +-	the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
    +-	set, as returned by "git var -l".
    ++	the value of `GIT_AUTHOR_IDENT`, or `GIT_COMMITTER_IDENT` if that is not
    ++	set, as returned by `git var -l`.
    + 
    + --reply-to=<address>::
    + 	Specify the address where replies from recipients should go to.
    + 	Use this if replies to messages should go to another address than what
    +-	is specified with the --from parameter.
    ++	is specified with the `--from` parameter.
    + 
    + --in-reply-to=<identifier>::
    + 	Make the first mail (or all the mails with `--no-thread`) appear as a
    +@@ Documentation/git-send-email.adoc: illustration below where `[PATCH v2 0/3]` is in reply to `[PATCH 0/2]`:
    +       [PATCH v2 2/3] New tests
    +       [PATCH v2 3/3] Implementation
    + +
    +-Only necessary if --compose is also set.  If --compose
    ++Only necessary if `--compose` is also set.  If `--compose`
    + is not set, this will be prompted for.
    + 
    + --[no-]outlook-id-fix::
    + 	Microsoft Outlook SMTP servers discard the Message-ID sent via email and
    + 	assign a new random Message-ID, thus breaking threads.
    + +
    +-With `--outlook-id-fix`, 'git send-email' uses a mechanism specific to
    ++With `--outlook-id-fix`, `git send-email` uses a mechanism specific to
    + Outlook servers to learn the Message-ID the server assigned to fix the
    + threading. Use it only when you know that the server reports the
    + rewritten Message-ID the same way as Outlook servers do.
    +@@ Documentation/git-send-email.adoc: to 'smtp.office365.com' or 'smtp-mail.outlook.com'. Use
    + 
    + --subject=<string>::
    + 	Specify the initial subject of the email thread.
    +-	Only necessary if --compose is also set.  If --compose
    ++	Only necessary if `--compose` is also set.  If `--compose`
    + 	is not set, this will be prompted for.
    + 
    + --to=<address>,...::
    + 	Specify the primary recipient of the emails generated. Generally, this
    + 	will be the upstream maintainer of the project involved. Default is the
    + 	value of the `sendemail.to` configuration value; if that is unspecified,
    +-	and --to-cmd is not specified, this will be prompted for.
    ++	and `--to-cmd` is not specified, this will be prompted for.
    + +
    + This option may be specified multiple times.
    + 
    +@@ Documentation/git-send-email.adoc: This option may be specified multiple times.
    + 	When encountering a non-ASCII message or subject that does not
    + 	declare its encoding, add headers/quoting to indicate it is
    + 	encoded in <encoding>.  Default is the value of the
    +-	'sendemail.assume8bitEncoding'; if that is unspecified, this
    ++	`sendemail.assume8bitEncoding`; if that is unspecified, this
    + 	will be prompted for if any non-ASCII files are encountered.
    + +
    + Note that no attempts whatsoever are made to validate the encoding.
    + 
    + --compose-encoding=<encoding>::
    + 	Specify encoding of compose message. Default is the value of the
    +-	'sendemail.composeEncoding'; if that is unspecified, UTF-8 is assumed.
    ++	`sendemail.composeEncoding`; if that is unspecified, UTF-8 is assumed.
    + 
    + --transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)::
    + 	Specify the transfer encoding to be used to send the message over SMTP.
    +-	7bit will fail upon encountering a non-ASCII message.  quoted-printable
    ++	'7bit' will fail upon encountering a non-ASCII message. 'quoted-printable'
    + 	can be useful when the repository contains files that contain carriage
    +-	returns, but makes the raw patch email file (as saved from a MUA) much
    +-	harder to inspect manually.  base64 is even more fool proof, but also
    +-	even more opaque.  auto will use 8bit when possible, and quoted-printable
    +-	otherwise.
    ++	returns, but makes the raw patch email file (as saved from an MUA) much
    ++	harder to inspect manually. 'base64' is even more fool proof, but also
    ++	even more opaque. 'auto' will use '8bit' when possible, and
    ++	'quoted-printable' otherwise.
    + +
    + Default is the value of the `sendemail.transferEncoding` configuration
    +-value; if that is unspecified, default to `auto`.
    ++value; if that is unspecified, default to 'auto'.
    + 
    + --xmailer::
    + --no-xmailer::
    +-	Add (or prevent adding) the "X-Mailer:" header.  By default,
    ++	Add (or prevent adding) the 'X-Mailer:' header.  By default,
    + 	the header is added, but it can be turned off by setting the
    + 	`sendemail.xmailer` configuration variable to `false`.
    + 
    +@@ Documentation/git-send-email.adoc: Sending
    + 	Specify the envelope sender used to send the emails.
    + 	This is useful if your default address is not the address that is
    + 	subscribed to a list. In order to use the 'From' address, set the
    +-	value to "auto". If you use the sendmail binary, you must have
    +-	suitable privileges for the -f parameter.  Default is the value of the
    ++	value to `auto`. If you use the `sendmail` binary, you must have
    ++	suitable privileges for the `-f` parameter.  Default is the value of the
    + 	`sendemail.envelopeSender` configuration variable; if that is
    + 	unspecified, choosing the envelope sender is left to your MTA.
    + 
    +@@ Documentation/git-send-email.adoc: Sending
    + 	be sendmail-like; specifically, it must support the `-i` option.
    + 	The command will be executed in the shell if necessary.  Default
    + 	is the value of `sendemail.sendmailCmd`.  If unspecified, and if
    +-	--smtp-server is also unspecified, git-send-email will search
    +-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH.
    ++	`--smtp-server` is also unspecified, `git send-email` will search
    ++	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH`.
    + 
    + --smtp-encryption=<encryption>::
    + 	Specify in what way encrypting begins for the SMTP connection.
    +@@ Documentation/git-send-email.adoc: Sending
    + --smtp-domain=<FQDN>::
    + 	Specifies the Fully Qualified Domain Name (FQDN) used in the
    + 	HELO/EHLO command to the SMTP server.  Some servers require the
    +-	FQDN to match your IP address.  If not set, git send-email attempts
    ++	FQDN to match your IP address.  If not set, `git send-email` attempts
    + 	to determine your FQDN automatically.  Default is the value of
    + 	`sendemail.smtpDomain`.
    + 
    +@@ Documentation/git-send-email.adoc: $ git send-email --smtp-auth="PLAIN LOGIN GSSAPI" ...
    + +
    + If at least one of the specified mechanisms matches the ones advertised by the
    + SMTP server and if it is supported by the utilized SASL library, the mechanism
    +-is used for authentication. If neither 'sendemail.smtpAuth' nor `--smtp-auth`
    ++is used for authentication. If neither `sendemail.smtpAuth` nor `--smtp-auth`
    + is specified, all mechanisms supported by the SASL library can be used. The
    +-special value 'none' maybe specified to completely disable authentication
    +-independently of `--smtp-user`
    ++special value `none` maybe specified to completely disable authentication
    ++independently of `--smtp-user`.
    + 
    + --smtp-pass[=<password>]::
    + 	Password for SMTP-AUTH. The argument is optional: If no
    +@@ Documentation/git-send-email.adoc: Furthermore, passwords need not be specified in configuration files
    + or on the command line. If a username has been specified (with
    + `--smtp-user` or a `sendemail.smtpUser`), but no password has been
    + specified (with `--smtp-pass` or `sendemail.smtpPass`), then
    +-a password is obtained using 'git-credential'.
    ++a password is obtained using linkgit:git-credential[1].
    + 
    + --no-smtp-auth::
    +-	Disable SMTP authentication. Short hand for `--smtp-auth=none`
    ++	Disable SMTP authentication. Short hand for `--smtp-auth=none`.
    + 
    + --smtp-server=<host>::
    + 	If set, specifies the outgoing SMTP server to use (e.g.
    + 	`smtp.example.com` or a raw IP address).  If unspecified, and if
    + 	`--sendmail-cmd` is also unspecified, the default is to search
    +-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH if such a
    ++	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH` if such a
    + 	program is available, falling back to `localhost` otherwise.
    + +
    + For backward compatibility, this option can also specify a full pathname
    +@@ Documentation/git-send-email.adoc: instead.
    + 	Specifies a port different from the default port (SMTP
    + 	servers typically listen to smtp port 25, but may also listen to
    + 	submission port 587, or the common SSL smtp port 465);
    +-	symbolic port names (e.g. "submission" instead of 587)
    ++	symbolic port names (e.g. `submission` instead of 587)
    + 	are also accepted. The port can also be set with the
    + 	`sendemail.smtpServerPort` configuration variable.
    + 
    +@@ Documentation/git-send-email.adoc: instead.
    + 	Default value can be specified by the `sendemail.smtpServerOption`
    + 	configuration option.
    + +
    +-The --smtp-server-option option must be repeated for each option you want
    ++The `--smtp-server-option` option must be repeated for each option you want
    + to pass to the server. Likewise, different lines in the configuration files
    + must be used for each option.
    + 
    +@@ Documentation/git-send-email.adoc: must be used for each option.
    + --smtp-ssl-cert-path::
    + 	Path to a store of trusted CA certificates for SMTP SSL/TLS
    + 	certificate validation (either a directory that has been processed
    +-	by 'c_rehash', or a single file containing one or more PEM format
    +-	certificates concatenated together: see verify(1) -CAfile and
    +-	-CApath for more information on these). Set it to an empty string
    ++	by `c_rehash`, or a single file containing one or more PEM format
    ++	certificates concatenated together). Set it to an empty string
    + 	to disable certificate verification. Defaults to the value of the
    + 	`sendemail.smtpSSLCertPath` configuration variable, if set, or the
    + 	backing SSL library's compiled-in default otherwise (which should
    +@@ Documentation/git-send-email.adoc: must be used for each option.
    + 	connection and authentication problems.
    + 
    + --batch-size=<num>::
    +-	Some email servers (e.g. smtp.163.com) limit the number emails to be
    ++	Some email servers (e.g. 'smtp.163.com') limit the number of emails to be
    + 	sent per session (connection) and this will lead to a failure when
    + 	sending many messages.  With this option, send-email will disconnect after
    +-	sending $<num> messages and wait for a few seconds (see --relogin-delay)
    +-	and reconnect, to work around such a limit.  You may want to
    +-	use some form of credential helper to avoid having to retype
    +-	your password every time this happens.  Defaults to the
    ++	sending `$<num>` messages and wait for a few seconds
    ++	(see `--relogin-delay`) and reconnect, to work around such a limit.
    ++	You may want to use some form of credential helper to avoid having to
    ++	retype your password every time this happens.  Defaults to the
    + 	`sendemail.smtpBatchSize` configuration variable.
    + 
    + --relogin-delay=<int>::
    +-	Waiting $<int> seconds before reconnecting to SMTP server. Used together
    +-	with --batch-size option.  Defaults to the `sendemail.smtpReloginDelay`
    ++	Waiting `$<int>` seconds before reconnecting to SMTP server. Used together
    ++	with `--batch-size` option.  Defaults to the `sendemail.smtpReloginDelay`
    + 	configuration variable.
    + 
    + Automating
    +@@ Documentation/git-send-email.adoc: Automating
    + --no-to::
    + --no-cc::
    + --no-bcc::
    +-	Clears any list of "To:", "Cc:", "Bcc:" addresses previously
    ++	Clears any list of 'To:', 'Cc:', 'Bcc:' addresses previously
    + 	set via config.
    + 
    + --no-identity::
    +@@ Documentation/git-send-email.adoc: Automating
    + 
    + --to-cmd=<command>::
    + 	Specify a command to execute once per patch file which
    +-	should generate patch file specific "To:" entries.
    ++	should generate patch file specific 'To:' entries.
    + 	Output of this command must be single email address per line.
    +-	Default is the value of 'sendemail.toCmd' configuration value.
    ++	Default is the value of `sendemail.toCmd` configuration value.
    + 
    + --cc-cmd=<command>::
    + 	Specify a command to execute once per patch file which
    +-	should generate patch file specific "Cc:" entries.
    ++	should generate patch file specific 'Cc:' entries.
    + 	Output of this command must be single email address per line.
    + 	Default is the value of `sendemail.ccCmd` configuration value.
    + 
    +@@ Documentation/git-send-email.adoc: Automating
    + 	Specify a command that is executed once per outgoing message
    + 	and output RFC 2822 style header lines to be inserted into
    + 	them. When the `sendemail.headerCmd` configuration variable is
    +-	set, its value is always used. When --header-cmd is provided
    ++	set, its value is always used. When `--header-cmd` is provided
    + 	at the command line, its value takes precedence over the
    + 	`sendemail.headerCmd` configuration variable.
    + 
    +@@ Documentation/git-send-email.adoc: Automating
    + 
    + --[no-]chain-reply-to::
    + 	If this is set, each email will be sent as a reply to the previous
    +-	email sent.  If disabled with "--no-chain-reply-to", all emails after
    ++	email sent.  If disabled with `--no-chain-reply-to`, all emails after
    + 	the first will be sent as replies to the first email sent.  When using
    + 	this, it is recommended that the first file given be an overview of the
    + 	entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
    +@@ Documentation/git-send-email.adoc: Automating
    + 	the value of `sendemail.identity`.
    + 
    + --[no-]signed-off-by-cc::
    +-	If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
    +-	cc list. Default is the value of `sendemail.signedOffByCc` configuration
    +-	value; if that is unspecified, default to --signed-off-by-cc.
    ++	If this is set, add emails found in the `Signed-off-by` trailer or 'Cc:'
    ++	lines to the cc list. Default is the value of `sendemail.signedOffByCc`
    ++	configuration value; if that is unspecified, default to
    ++	`--signed-off-by-cc`.
    + 
    + --[no-]cc-cover::
    +-	If this is set, emails found in Cc: headers in the first patch of
    ++	If this is set, emails found in 'Cc:' headers in the first patch of
    + 	the series (typically the cover letter) are added to the cc list
    +-	for each email set. Default is the value of 'sendemail.ccCover'
    +-	configuration value; if that is unspecified, default to --no-cc-cover.
    ++	for each email set. Default is the value of `sendemail.ccCover`
    ++	configuration value; if that is unspecified, default to `--no-cc-cover`.
    + 
    + --[no-]to-cover::
    +-	If this is set, emails found in To: headers in the first patch of
    ++	If this is set, emails found in 'To:' headers in the first patch of
    + 	the series (typically the cover letter) are added to the to list
    +-	for each email set. Default is the value of 'sendemail.toCover'
    +-	configuration value; if that is unspecified, default to --no-to-cover.
    ++	for each email set. Default is the value of `sendemail.toCover`
    ++	configuration value; if that is unspecified, default to `--no-to-cover`.
    + 
    + --suppress-cc=<category>::
    + 	Specify an additional category of recipients to suppress the
    +@@ Documentation/git-send-email.adoc: Automating
    + --
    + +
    + Default is the value of `sendemail.suppressCc` configuration value; if
    +-that is unspecified, default to 'self' if --suppress-from is
    +-specified, as well as 'body' if --no-signed-off-cc is specified.
    ++that is unspecified, default to 'self' if `--suppress-from` is
    ++specified, as well as 'body' if `--no-signed-off-cc` is specified.
    + 
    + --[no-]suppress-from::
    +-	If this is set, do not add the From: address to the cc: list.
    ++	If this is set, do not add the 'From:' address to the 'Cc:' list.
    + 	Default is the value of `sendemail.suppressFrom` configuration
    +-	value; if that is unspecified, default to --no-suppress-from.
    ++	value; if that is unspecified, default to `--no-suppress-from`.
    + 
    + --[no-]thread::
    +-	If this is set, the In-Reply-To and References headers will be
    ++	If this is set, the 'In-Reply-To' and 'References' headers will be
    + 	added to each email sent.  Whether each mail refers to the
    +-	previous email (`deep` threading per 'git format-patch'
    ++	previous email (`deep` threading per `git format-patch`
    + 	wording) or to the first email (`shallow` threading) is
    +-	governed by "--[no-]chain-reply-to".
    ++	governed by `--[no-]chain-reply-to`.
    + +
    +-If disabled with "--no-thread", those headers will not be added
    +-(unless specified with --in-reply-to).  Default is the value of the
    ++If disabled with `--no-thread`, those headers will not be added
    ++(unless specified with `--in-reply-to`).  Default is the value of the
    + `sendemail.thread` configuration value; if that is unspecified,
    +-default to --thread.
    ++default to `--thread`.
    + +
    + It is up to the user to ensure that no In-Reply-To header already
    +-exists when 'git send-email' is asked to add it (especially note that
    +-'git format-patch' can be configured to do the threading itself).
    ++exists when `git send-email` is asked to add it (especially note that
    ++`git format-patch` can be configured to do the threading itself).
    + Failure to do so may not produce the expected result in the
    + recipient's MUA.
    + 
    + --[no-]mailmap::
    + 	Use the mailmap file (see linkgit:gitmailmap[5]) to map all
    + 	addresses to their canonical real name and email address. Additional
    +-	mailmap data specific to git-send-email may be provided using the
    ++	mailmap data specific to `git send-email` may be provided using the
    + 	`sendemail.mailmap.file` or `sendemail.mailmap.blob` configuration
    + 	values. Defaults to `sendemail.mailmap`.
    + 
    +@@ Documentation/git-send-email.adoc: Administering
    + 	Confirm just before sending:
    + +
    + --
    +-- 'always' will always confirm before sending
    +-- 'never' will never confirm before sending
    ++- 'always' will always confirm before sending.
    ++- 'never' will never confirm before sending.
    + - 'cc' will confirm before sending when send-email has automatically
    +-  added addresses from the patch to the Cc list
    ++  added addresses from the patch to the Cc list.
    + - 'compose' will confirm before sending the first message when using --compose.
    +-- 'auto' is equivalent to 'cc' + 'compose'
    ++- 'auto' is equivalent to 'cc' + 'compose'.
    + --
    + +
    + Default is the value of `sendemail.confirm` configuration value; if that
    +@@ Documentation/git-send-email.adoc: have been specified, in which case default to 'compose'.
    + 	When an argument may be understood either as a reference or as a file name,
    + 	choose to understand it as a format-patch argument (`--format-patch`)
    + 	or as a file name (`--no-format-patch`). By default, when such a conflict
    +-	occurs, git send-email will fail.
    ++	occurs, `git send-email` will fail.
    + 
    + --quiet::
    +-	Make git-send-email less verbose.  One line per email should be
    ++	Make `git send-email` less verbose.  One line per email should be
    + 	all that is output.
    + 
    + --[no-]validate::
    +@@ Documentation/git-send-email.adoc: edit `~/.gitconfig` to specify your account settings:
    + ----
    + 
    + If you have multi-factor authentication set up on your Gmail account, you can
    +-generate an app-specific password for use with 'git send-email'. Visit
    ++generate an app-specific password for use with `git send-email`. Visit
    + https://security.google.com/settings/security/apppasswords to create it.
    + 
    + You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
    +@@ Documentation/git-send-email.adoc: helpers.
    + 
    + Note: the following core Perl modules that may be installed with your
    + distribution of Perl are required:
    +-MIME::Base64, MIME::QuotedPrint, Net::Domain and Net::SMTP.
    ++
    ++https://metacpan.org/pod/MIME::Base64[MIME::Base64],
    ++https://metacpan.org/pod/MIME::QuotedPrint[MIME::QuotedPrint],
    ++https://metacpan.org/pod/Net::Domain[Net::Domain] and
    ++https://metacpan.org/pod/Net::SMTP[Net::SMTP].
    ++
    + These additional Perl modules are also required:
    +-Authen::SASL and Mail::Address.
    ++
    ++https://metacpan.org/pod/Authen::SASL[Authen::SASL] and
    ++https://metacpan.org/pod/Mail::Address[Mail::Address].
    + 
    + 
    + SEE ALSO
-:  ---------- > 3:  b9e41e2492 docs: remove credential helper links for emails from gitcredentials
-:  ---------- > 4:  a6ad7ac810 docs: make the purpose of using app password for Gmail more clear in send-email
-- 
2.49.0.windows.1


^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 2/4] docs: improve formatting in git-send-email documentation
  2025-05-28  7:05   ` [PATCH v5 2/4] docs: improve formatting in git-send-email documentation Aditya Garg
@ 2025-05-29 18:15     ` Junio C Hamano
  2025-05-29 19:04       ` Aditya Garg
  0 siblings, 1 reply; 52+ messages in thread
From: Junio C Hamano @ 2025-05-29 18:15 UTC (permalink / raw)
  To: Aditya Garg
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin

Aditya Garg <gargaditya08@live.com> writes:

> The current documentation for git-send-email had an inconsistent use of
> "", ``, and '' for quoting. This commit improves the formatting by
> using the same style throughout the documentation.

Nice.

> Also, at some places, minor grammatical errors were fixed, and some
> non existent links were removed.
>
> Finally, the cpan links of necessary perl modules have been added to
> make their installation easier.

Hmmm.

>  sendemail.multiEdit::
> -	If true (default), a single editor instance will be spawned to edit
> +	If `true` (default), a single editor instance will be spawned to edit
>  	files you have to edit (patches when `--annotate` is used, and the
> -	summary when `--compose` is used). If false, files will be edited one
> +	summary when `--compose` is used). If `false`, files will be edited one
>  	after the other, spawning a new editor each time.

Looks good.  "edit files you have to edit" reads somewhat funny, but
the topic of this change is to correct mark-up, so it is the right
thing to do to leave it as-is, at least in this step.

>  sendemail.confirm::
> @@ -101,7 +101,7 @@ sendemail.signedOffCc (deprecated)::
>  
>  sendemail.smtpBatchSize::
>  	Number of messages to be sent per connection, after that a relogin
> -	will happen.  If the value is 0 or undefined, send all messages in
> +	will happen.  If the value is `0` or undefined, send all messages in

Ditto.  "or undefined" will make readers wonder how they would
specify such a value (i.e. 'undef' in Perl) in their configuration
file, and may need rephrasing, but again not within the topic of
this step.

> -When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
> -Subject, Reply-To, and In-Reply-To headers specified in the message. If
> -the body of the message (what you type after the headers and a blank
> -line) only contains blank (or Git: prefixed) lines, the summary won't be
> +When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
> +'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
> +message. If the body of the message (what you type after the headers and a
> +blank line) only contains blank (or Git: prefixed) lines, the summary won't be

Shouldn't 'Git:' in "or Git: prefixed" be marked-up somehow as well?

As these mail header names are all literal parts, shouldn't ehy be
marked up like `To`, `Cc`, etc.?

> -	by 'c_rehash', or a single file containing one or more PEM format
> -	certificates concatenated together: see verify(1) -CAfile and
> -	-CApath for more information on these). Set it to an empty string
> +	by `c_rehash`, or a single file containing one or more PEM format
> +	certificates concatenated together). Set it to an empty string

What is this change about?  grammatical errors?  non existent links?
cpan links?  It does not look any of these.

> @@ -298,18 +297,18 @@ must be used for each option.
>  	connection and authentication problems.
>  
>  --batch-size=<num>::
> -	Some email servers (e.g. smtp.163.com) limit the number emails to be
> +	Some email servers (e.g. 'smtp.163.com') limit the number of emails to be
>  	sent per session (connection) and this will lead to a failure when
>  	sending many messages.  With this option, send-email will disconnect after
> -	sending $<num> messages and wait for a few seconds (see --relogin-delay)
> -	and reconnect, to work around such a limit.  You may want to
> -	use some form of credential helper to avoid having to retype
> -	your password every time this happens.  Defaults to the
> +	sending `$<num>` messages and wait for a few seconds
> +	(see `--relogin-delay`) and reconnect, to work around such a limit.
> +	You may want to use some form of credential helper to avoid having to
> +	retype your password every time this happens.  Defaults to the
>  	`sendemail.smtpBatchSize` configuration variable.
>  
>  --relogin-delay=<int>::
> -	Waiting $<int> seconds before reconnecting to SMTP server. Used together
> -	with --batch-size option.  Defaults to the `sendemail.smtpReloginDelay`
> +	Waiting `$<int>` seconds before reconnecting to SMTP server. Used together
> +	with `--batch-size` option.  Defaults to the `sendemail.smtpReloginDelay`
>  	configuration variable.

Together with the previous hunk, "$" before the placeholder looks
incorrect, but it would be preferrable to leave it alone in order to
keep the patch focused on mark-up fixes alone.

As <num> and <int> are both placeholders, not something the users
would literally give, neither `<num>` or `num` is appropriate
mark-up for them, though.  Probably "_<num>_" (without double quotes
around it), if you look at Documentation/CodingGuidelines, I guess.

>  Automating
> @@ -318,7 +317,7 @@ Automating
>  --no-to::
>  --no-cc::
>  --no-bcc::
> -	Clears any list of "To:", "Cc:", "Bcc:" addresses previously
> +	Clears any list of 'To:', 'Cc:', 'Bcc:' addresses previously
>  	set via config.

The same comment about mail-headers being literal applies here.

Even though the proposed log message talks about "minor grammatical
errors" and "non existent links", I didn't spot any changes about
them.  It is very possible that they are buried in the mark-up
fixes---it would make the patch much better to separate out such
changes and group the changes of the exact same kind into a single
patch.

I'll stop here for now; I may come back and continue from here
later.

Thanks.

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 4/4] docs: make the purpose of using app password for Gmail more clear in send-email
  2025-05-28  7:05   ` [PATCH v5 4/4] docs: make the purpose of using app password for Gmail more clear in send-email Aditya Garg
@ 2025-05-29 18:50     ` Junio C Hamano
  2025-05-29 19:06       ` Aditya Garg
  0 siblings, 1 reply; 52+ messages in thread
From: Junio C Hamano @ 2025-05-29 18:50 UTC (permalink / raw)
  To: Aditya Garg
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin

Aditya Garg <gargaditya08@live.com> writes:

> The current example for Gmail suggests using app passwords for
> send-email if user has multi-factor authentication set up for their
> account. However, it does not clarify that the user cannot use their
> normal password in case they do not have multi-factor authentication
> enabled.

Correct, and the clarification looks good.


> This commit clarifies that app passwords are required and suggests using
> OAuth2 if the user does not want to enable multi-factor authentication.

Dubious.  If the user does want to use 2FA (or already does use it),
there may be reasons why they still want to go the oauth route, no?

> ---
>  Documentation/git-send-email.adoc | 3 +++
>  1 file changed, 3 insertions(+)

Not signed off.

>
> diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
> index aff0861d29..99c126cd5a 100644
> --- a/Documentation/git-send-email.adoc
> +++ b/Documentation/git-send-email.adoc
> @@ -524,9 +524,12 @@ edit `~/.gitconfig` to specify your account settings:
>  	smtpServerPort = 587
>  ----
>  
> +Gmail does not allow using your account password for `git send-email`.
>  If you have multi-factor authentication set up on your Gmail account, you can
>  generate an app-specific password for use with `git send-email`. Visit
>  https://security.google.com/settings/security/apppasswords to create it.
> +If you do not want to enable multi-factor authentication, you can use OAuth2.0
> +authentication as described below.

How about phrasing it more neutrally like ...

    "Alternatively, instead of using app-specific password, you can use ..."

The original somehow makes it sound like using 2FA + app_password is
the golden way, and short of that you could fall back to OAUTH, but
that is not the impression you would want to give to your readers, I
think.

>  You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
>  `XOAUTH2` are common methods used for this type of authentication. Gmail

Whether you take my suggestion or not, I think the first sentence
here is now redundant and can be safely removed.


^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 2/4] docs: improve formatting in git-send-email documentation
  2025-05-29 18:15     ` Junio C Hamano
@ 2025-05-29 19:04       ` Aditya Garg
  2025-05-30 13:28         ` Junio C Hamano
  0 siblings, 1 reply; 52+ messages in thread
From: Aditya Garg @ 2025-05-29 19:04 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin



> On 29 May 2025, at 11:46 PM, Junio C Hamano <gitster@pobox.com> wrote:
> 
> Aditya Garg <gargaditya08@live.com> writes:
> 
>> The current documentation for git-send-email had an inconsistent use of
>> "", ``, and '' for quoting. This commit improves the formatting by
>> using the same style throughout the documentation.
> 
> Nice.
> 
>> Also, at some places, minor grammatical errors were fixed, and some
>> non existent links were removed.
>> 
>> Finally, the cpan links of necessary perl modules have been added to
>> make their installation easier.
> 
> Hmmm.
> 
>> sendemail.multiEdit::
>> -    If true (default), a single editor instance will be spawned to edit
>> +    If `true` (default), a single editor instance will be spawned to edit
>>    files you have to edit (patches when `--annotate` is used, and the
>> -    summary when `--compose` is used). If false, files will be edited one
>> +    summary when `--compose` is used). If `false`, files will be edited one
>>    after the other, spawning a new editor each time.
> 
> Looks good.  "edit files you have to edit" reads somewhat funny, but
> the topic of this change is to correct mark-up, so it is the right
> thing to do to leave it as-is, at least in this step.
> 
>> sendemail.confirm::
>> @@ -101,7 +101,7 @@ sendemail.signedOffCc (deprecated)::
>> 
>> sendemail.smtpBatchSize::
>>    Number of messages to be sent per connection, after that a relogin
>> -    will happen.  If the value is 0 or undefined, send all messages in
>> +    will happen.  If the value is `0` or undefined, send all messages in
> 
> Ditto.  "or undefined" will make readers wonder how they would
> specify such a value (i.e. 'undef' in Perl) in their configuration
> file, and may need rephrasing, but again not within the topic of
> this step.
> 
>> -When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
>> -Subject, Reply-To, and In-Reply-To headers specified in the message. If
>> -the body of the message (what you type after the headers and a blank
>> -line) only contains blank (or Git: prefixed) lines, the summary won't be
>> +When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
>> +'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
>> +message. If the body of the message (what you type after the headers and a
>> +blank line) only contains blank (or Git: prefixed) lines, the summary won't be
> 
> Shouldn't 'Git:' in "or Git: prefixed" be marked-up somehow as well?
> 
> As these mail header names are all literal parts, shouldn't ehy be
> marked up like `To`, `Cc`, etc.?

I think its ok to let these remain in '', and deviate from the rules a bit.
If backticks are used, it will be a mess when rendered on the website.

> 
>> -    by 'c_rehash', or a single file containing one or more PEM format
>> -    certificates concatenated together: see verify(1) -CAfile and
>> -    -CApath for more information on these). Set it to an empty string
>> +    by `c_rehash`, or a single file containing one or more PEM format
>> +    certificates concatenated together). Set it to an empty string
> 
> What is this change about?  grammatical errors?  non existent links?
> cpan links?  It does not look any of these.

Non existing links. Checkout the website.

> 
>> @@ -298,18 +297,18 @@ must be used for each option.
>>    connection and authentication problems.
>> 
>> --batch-size=<num>::
>> -    Some email servers (e.g. smtp.163.com) limit the number emails to be
>> +    Some email servers (e.g. 'smtp.163.com') limit the number of emails to be
>>    sent per session (connection) and this will lead to a failure when
>>    sending many messages.  With this option, send-email will disconnect after
>> -    sending $<num> messages and wait for a few seconds (see --relogin-delay)
>> -    and reconnect, to work around such a limit.  You may want to
>> -    use some form of credential helper to avoid having to retype
>> -    your password every time this happens.  Defaults to the
>> +    sending `$<num>` messages and wait for a few seconds
>> +    (see `--relogin-delay`) and reconnect, to work around such a limit.
>> +    You may want to use some form of credential helper to avoid having to
>> +    retype your password every time this happens.  Defaults to the
>>    `sendemail.smtpBatchSize` configuration variable.
>> 
>> --relogin-delay=<int>::
>> -    Waiting $<int> seconds before reconnecting to SMTP server. Used together
>> -    with --batch-size option.  Defaults to the `sendemail.smtpReloginDelay`
>> +    Waiting `$<int>` seconds before reconnecting to SMTP server. Used together
>> +    with `--batch-size` option.  Defaults to the `sendemail.smtpReloginDelay`
>>    configuration variable.
> 
> Together with the previous hunk, "$" before the placeholder looks
> incorrect, but it would be preferrable to leave it alone in order to
> keep the patch focused on mark-up fixes alone.
> 
> As <num> and <int> are both placeholders, not something the users
> would literally give, neither `<num>` or `num` is appropriate
> mark-up for them, though.  Probably "_<num>_" (without double quotes
> around it), if you look at Documentation/CodingGuidelines, I guess.

Ok

> 
>> Automating
>> @@ -318,7 +317,7 @@ Automating
>> --no-to::
>> --no-cc::
>> --no-bcc::
>> -    Clears any list of "To:", "Cc:", "Bcc:" addresses previously
>> +    Clears any list of 'To:', 'Cc:', 'Bcc:' addresses previously
>>    set via config.
> 
> The same comment about mail-headers being literal applies here.
> 
> Even though the proposed log message talks about "minor grammatical
> errors" and "non existent links", I didn't spot any changes about
> them.  It is very possible that they are buried in the mark-up
> fixes---it would make the patch much better to separate out such
> changes and group the changes of the exact same kind into a single
> patch.

Minor grammatical errors were that of a missing full stop at the end of a line.

Missing links, look above.
> 
> I'll stop here for now; I may come back and continue from here
> later.
> 
> Thanks.

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 4/4] docs: make the purpose of using app password for Gmail more clear in send-email
  2025-05-29 18:50     ` Junio C Hamano
@ 2025-05-29 19:06       ` Aditya Garg
  0 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-29 19:06 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin



> On 30 May 2025, at 12:20 AM, Junio C Hamano <gitster@pobox.com> wrote:
> 
> Aditya Garg <gargaditya08@live.com> writes:
> 
>> The current example for Gmail suggests using app passwords for
>> send-email if user has multi-factor authentication set up for their
>> account. However, it does not clarify that the user cannot use their
>> normal password in case they do not have multi-factor authentication
>> enabled.
> 
> Correct, and the clarification looks good.
> 
> 
>> This commit clarifies that app passwords are required and suggests using
>> OAuth2 if the user does not want to enable multi-factor authentication.
> 
> Dubious.  If the user does want to use 2FA (or already does use it),
> there may be reasons why they still want to go the oauth route, no?
> 
>> ---
>> Documentation/git-send-email.adoc | 3 +++
>> 1 file changed, 3 insertions(+)
> 
> Not signed off.

Oops.

> 
>> 
>> diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
>> index aff0861d29..99c126cd5a 100644
>> --- a/Documentation/git-send-email.adoc
>> +++ b/Documentation/git-send-email.adoc
>> @@ -524,9 +524,12 @@ edit `~/.gitconfig` to specify your account settings:
>>    smtpServerPort = 587
>> ----
>> 
>> +Gmail does not allow using your account password for `git send-email`.
>> If you have multi-factor authentication set up on your Gmail account, you can
>> generate an app-specific password for use with `git send-email`. Visit
>> https://security.google.com/settings/security/apppasswords to create it.
>> +If you do not want to enable multi-factor authentication, you can use OAuth2.0
>> +authentication as described below.
> 
> How about phrasing it more neutrally like ...
> 
>    "Alternatively, instead of using app-specific password, you can use ..."
> 
> The original somehow makes it sound like using 2FA + app_password is
> the golden way, and short of that you could fall back to OAUTH, but
> that is not the impression you would want to give to your readers, I
> think.
> 
>> You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
>> `XOAUTH2` are common methods used for this type of authentication. Gmail
> 
> Whether you take my suggestion or not, I think the first sentence
> here is now redundant and can be safely removed.
> 

I'll take your suggestion, and just reword this whole thing in a bit better way.

^ permalink raw reply	[flat|nested] 52+ messages in thread

* [PATCH v6 0/4] docs: update email credential helpers and improve formatting
  2025-05-13 18:28 [PATCH] docs: add instructions to use Yahoo with send-mail Aditya Garg
                   ` (4 preceding siblings ...)
  2025-05-28  7:05 ` [PATCH v5 0/4] " Aditya Garg
@ 2025-05-30 11:37 ` Aditya Garg
  2025-05-30 11:37   ` [PATCH v6 1/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
                     ` (3 more replies)
  2025-05-30 15:50 ` [PATCH v7 0/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
  6 siblings, 4 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 11:37 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin

Hi all,

This patch series included three patches:

1. The first patch adds a link to the `git-credential-yahoo` helper for
   Yahoo accounts and links Google's `sendgmail` tool as an alternative
   method for sending emails through Gmail.

2. The second patch improves the formatting of the `git-send-email`
   documentation, making it more readable and consistent.

3. The third patch removed the email credential helper links from the
   `gitcredentials` page. The links are still available in the
   `git-send-email` documentation, which is the right place for them.

Detailed explanation of the changes has been done in individual patch.

v2: - Removed instructions for Yahoo SMTP server since I've realised that
      Yahoo *was* a popular email service. Also, the instructions were
      just making the docs more crowded. I've also added a link to
      Google's `sendgmail` tool in the first patch. The second patch has been
      added to address the issues that came up here:
      https://github.com/git/git-scm.com/pull/2005

v3: - Added a patch to improve the formatting of the `git-send-email`
      documentation.

v4: - Added cpan links of the perl modules requires for `git-send-email`
      to work.

v5: - Added a patch to make the purpose of using app password for Gmail
      more clear in `send-email` documentation.

v6: - Reword the documentation a bit more in last patch.
    - Markdown Git: -> 'Git:' in the second patch.
    - Restore the non-existent link (atleast what I believed that to be) in the
      second patch.
    - Remove the unnecessary use of $ with <num> and <int> placeholders in the
      second patch.
    - White at it, also prefer using the word "mechanism" over "method" for
      `OAUTHBEARER` and `XOAUTH2` in git-send-email docs since that is what
      official docs use. This changes has been done in the last patch.

    NOTE: I have not used `` for Headers in the second patch. I think its ok
          to deviate a bit from the rules and not be army men here. If I
          markdown them as code, the whole doc will be filled with codestyled
          blocks, and I think, these headers demand "different treatement"
          than rest other code and variables. Codeblocks everywhere are more
          of hurting the readability of the documentation than helping it.

Aditya Garg (4):
  docs: add credential helper for yahoo and link Google's sendgmail tool
  docs: improve formatting in git-send-email documentation
  docs: remove credential helper links for emails from gitcredentials
  docs: make the purpose of using app password for Gmail more clear in
    send-email

 Documentation/config/sendemail.adoc |   8 +-
 Documentation/git-send-email.adoc   | 203 +++++++++++++++-------------
 Documentation/gitcredentials.adoc   |   4 -
 3 files changed, 114 insertions(+), 101 deletions(-)

Range-diff against v5:
-:  ---------- > 1:  2c47cc5396 docs: add credential helper for yahoo and link Google's sendgmail tool
1:  bc1d0471ca ! 2:  20da5d6a58 docs: improve formatting in git-send-email documentation
    @@ Commit message
     
         The current documentation for git-send-email had an inconsistent use of
         "", ``, and '' for quoting. This commit improves the formatting by
    -    using the same style throughout the documentation.
    -
    -    Also, at some places, minor grammatical errors were fixed, and some
    -    non existent links were removed.
    +    using the same style throughout the documentation. Missing full stops
    +    have also been added at some places.
     
         Finally, the cpan links of necessary perl modules have been added to
         make their installation easier.
     
    +    While at it, the unecessary use of $ with <num> and <int> placeholders
    +    has also been removed.
    +
         Signed-off-by: Aditya Garg <gargaditya08@live.com>
     
      ## Documentation/config/sendemail.adoc ##
    @@ Documentation/git-send-email.adoc: This option may be specified multiple times.
     +When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
     +'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
     +message. If the body of the message (what you type after the headers and a
    -+blank line) only contains blank (or Git: prefixed) lines, the summary won't be
    ++blank line) only contains blank (or 'Git:' prefixed) lines, the summary won't be
      sent, but the headers mentioned above will be used unless they are
      removed.
      +
    @@ Documentation/git-send-email.adoc: must be used for each option.
      	Path to a store of trusted CA certificates for SMTP SSL/TLS
      	certificate validation (either a directory that has been processed
     -	by 'c_rehash', or a single file containing one or more PEM format
    --	certificates concatenated together: see verify(1) -CAfile and
    --	-CApath for more information on these). Set it to an empty string
     +	by `c_rehash`, or a single file containing one or more PEM format
    -+	certificates concatenated together). Set it to an empty string
    + 	certificates concatenated together: see verify(1) -CAfile and
    + 	-CApath for more information on these). Set it to an empty string
      	to disable certificate verification. Defaults to the value of the
    - 	`sendemail.smtpSSLCertPath` configuration variable, if set, or the
    - 	backing SSL library's compiled-in default otherwise (which should
     @@ Documentation/git-send-email.adoc: must be used for each option.
      	connection and authentication problems.
      
    @@ Documentation/git-send-email.adoc: must be used for each option.
     -	and reconnect, to work around such a limit.  You may want to
     -	use some form of credential helper to avoid having to retype
     -	your password every time this happens.  Defaults to the
    -+	sending `$<num>` messages and wait for a few seconds
    ++	sending _<num>_ messages and wait for a few seconds
     +	(see `--relogin-delay`) and reconnect, to work around such a limit.
     +	You may want to use some form of credential helper to avoid having to
     +	retype your password every time this happens.  Defaults to the
    @@ Documentation/git-send-email.adoc: must be used for each option.
      --relogin-delay=<int>::
     -	Waiting $<int> seconds before reconnecting to SMTP server. Used together
     -	with --batch-size option.  Defaults to the `sendemail.smtpReloginDelay`
    -+	Waiting `$<int>` seconds before reconnecting to SMTP server. Used together
    ++	Waiting _<int>_ seconds before reconnecting to SMTP server. Used together
     +	with `--batch-size` option.  Defaults to the `sendemail.smtpReloginDelay`
      	configuration variable.
      
2:  b9e41e2492 = 3:  a05958c7aa docs: remove credential helper links for emails from gitcredentials
3:  a6ad7ac810 ! 4:  0bf48ac27d docs: make the purpose of using app password for Gmail more clear in send-email
    @@ Commit message
         enabled. Most likely the example was written in the days when Google
         allowed using normal passwords without multi-factor authentication.
     
    -    This commit clarifies that app passwords are required and suggests using
    -    OAuth2 if the user does not want to enable multi-factor authentication.
    +    Clarify that regular passwords do not work for Gmail and app-passwords
    +    are the only way for basic authentication. Also encourage users to use
    +    OAuth2 as a more secure alternative.
    +
    +    While at it, also prefer using the word "mechanism" over "method" for
    +    `OAUTHBEARER` and `XOAUTH2` since that is what official docs use.
    +
    +    Signed-off-by: Aditya Garg <gargaditya08@live.com>
     
      ## Documentation/git-send-email.adoc ##
     @@ Documentation/git-send-email.adoc: edit `~/.gitconfig` to specify your account settings:
      	smtpServerPort = 587
      ----
      
    -+Gmail does not allow using your account password for `git send-email`.
    ++Gmail does not allow using your regular password for `git send-email`.
      If you have multi-factor authentication set up on your Gmail account, you can
      generate an app-specific password for use with `git send-email`. Visit
      https://security.google.com/settings/security/apppasswords to create it.
    -+If you do not want to enable multi-factor authentication, you can use OAuth2.0
    -+authentication as described below.
      
    - You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
    - `XOAUTH2` are common methods used for this type of authentication. Gmail
    +-You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
    +-`XOAUTH2` are common methods used for this type of authentication. Gmail
    +-supports both of them. As an example, if you want to use `OAUTHBEARER`, edit
    +-your `~/.gitconfig` file and add `smtpAuth = OAUTHBEARER` to your account
    +-settings:
    ++Alternatively, instead of using an app-specific password, you can use
    ++OAuth2.0 authentication with Gmail. OAuth2.0 is more secure than
    ++app-specific passwords, and works regardless of whether you have multi-factor
    ++authentication set up. `OAUTHBEARER` and `XOAUTH2` are common mechanisms used
    ++for this type of authentication. Gmail supports both of them. As an example,
    ++if you want to use `OAUTHBEARER`, edit your `~/.gitconfig` file and add
    ++`smtpAuth = OAUTHBEARER` to your account settings:
    + 
    + ----
    + [sendemail]
    +@@ Documentation/git-send-email.adoc: settings:
    + 	smtpAuth = OAUTHBEARER
    + ----
    + 
    +-Alternatively, you can use a tool developed by Google known as
    ++Another alternative is using a tool developed by Google known as
    + https://github.com/google/gmail-oauth2-tools/tree/master/go/sendgmail[sendgmail]
    + to send emails using `git send-email`.
    + 
    +@@ Documentation/git-send-email.adoc: Use Microsoft Outlook as the SMTP Server
    + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
    + Therefore, OAuth2.0 authentication must be used for Outlook. Also, it only
    +-supports `XOAUTH2` authentication method.
    ++supports `XOAUTH2` authentication mechanism.
    + 
    + Edit `~/.gitconfig` to specify your account settings for Outlook and use its
    + SMTP server with `git send-email`:
-- 
2.49.0.638.g03d7d6a772


^ permalink raw reply	[flat|nested] 52+ messages in thread

* [PATCH v6 1/4] docs: add credential helper for yahoo and link Google's sendgmail tool
  2025-05-30 11:37 ` [PATCH v6 " Aditya Garg
@ 2025-05-30 11:37   ` Aditya Garg
  2025-05-30 11:37   ` [PATCH v6 2/4] docs: improve formatting in git-send-email documentation Aditya Garg
                     ` (2 subsequent siblings)
  3 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 11:37 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin

This commit links `git-credential-yahoo` as a credential helper for
Yahoo accounts. Also, Google's `sendgmail` tool has been linked as an
alternative method for sending emails through Gmail.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/git-send-email.adoc | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 26fda63c2f..81f8cbc6f3 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -543,6 +543,10 @@ settings:
 	smtpAuth = OAUTHBEARER
 ----
 
+Alternatively, you can use a tool developed by Google known as
+https://github.com/google/gmail-oauth2-tools/tree/master/go/sendgmail[sendgmail]
+to send emails using `git send-email`.
+
 Use Microsoft Outlook as the SMTP Server
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
@@ -579,8 +583,7 @@ next time.
 
 If you are using OAuth2.0 authentication, you need to use an access token in
 place of a password when prompted. Various OAuth2.0 token generators are
-available online. Community maintained credential helpers for Gmail and Outlook
-are also available:
+available online. Community maintained credential helpers are also available:
 
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail]
 	  (cross platform, dedicated helper for authenticating Gmail accounts)
@@ -588,6 +591,9 @@ are also available:
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook]
 	  (cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
 
+	- https://github.com/AdityaGarg8/git-credential-email[git-credential-yahoo]
+	  (cross platform, dedicated helper for authenticating Yahoo accounts)
+
 You can also see linkgit:gitcredentials[7] for more OAuth based authentication
 helpers.
 
-- 
2.49.0.638.g03d7d6a772


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v6 2/4] docs: improve formatting in git-send-email documentation
  2025-05-30 11:37 ` [PATCH v6 " Aditya Garg
  2025-05-30 11:37   ` [PATCH v6 1/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
@ 2025-05-30 11:37   ` Aditya Garg
  2025-05-30 11:37   ` [PATCH v6 3/4] docs: remove credential helper links for emails from gitcredentials Aditya Garg
  2025-05-30 11:37   ` [PATCH v6 4/4] docs: make the purpose of using app password for Gmail more clear in send-email Aditya Garg
  3 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 11:37 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin

The current documentation for git-send-email had an inconsistent use of
"", ``, and '' for quoting. This commit improves the formatting by
using the same style throughout the documentation. Missing full stops
have also been added at some places.

Finally, the cpan links of necessary perl modules have been added to
make their installation easier.

While at it, the unecessary use of $ with <num> and <int> placeholders
has also been removed.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/config/sendemail.adoc |   8 +-
 Documentation/git-send-email.adoc   | 178 +++++++++++++++-------------
 2 files changed, 97 insertions(+), 89 deletions(-)

diff --git a/Documentation/config/sendemail.adoc b/Documentation/config/sendemail.adoc
index 5ffcfc9f2a..0b1b2766f5 100644
--- a/Documentation/config/sendemail.adoc
+++ b/Documentation/config/sendemail.adoc
@@ -19,9 +19,9 @@ sendemail.<identity>.*::
 	`sendemail.identity`.
 
 sendemail.multiEdit::
-	If true (default), a single editor instance will be spawned to edit
+	If `true` (default), a single editor instance will be spawned to edit
 	files you have to edit (patches when `--annotate` is used, and the
-	summary when `--compose` is used). If false, files will be edited one
+	summary when `--compose` is used). If `false`, files will be edited one
 	after the other, spawning a new editor each time.
 
 sendemail.confirm::
@@ -101,7 +101,7 @@ sendemail.signedOffCc (deprecated)::
 
 sendemail.smtpBatchSize::
 	Number of messages to be sent per connection, after that a relogin
-	will happen.  If the value is 0 or undefined, send all messages in
+	will happen.  If the value is `0` or undefined, send all messages in
 	one connection.
 	See also the `--batch-size` option of linkgit:git-send-email[1].
 
@@ -111,5 +111,5 @@ sendemail.smtpReloginDelay::
 
 sendemail.forbidSendmailVariables::
 	To avoid common misconfiguration mistakes, linkgit:git-send-email[1]
-	will abort with a warning if any configuration options for "sendmail"
+	will abort with a warning if any configuration options for `sendmail`
 	exist. Set this variable to bypass the check.
diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 81f8cbc6f3..04e1c459b4 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -21,7 +21,7 @@ Takes the patches given on the command line and emails them out.
 Patches can be specified as files, directories (which will send all
 files in the directory), or directly as a revision list.  In the
 last case, any format accepted by linkgit:git-format-patch[1] can
-be passed to git send-email, as well as options understood by
+be passed to `git send-email`, as well as options understood by
 linkgit:git-format-patch[1].
 
 The header of the email is configurable via command-line options.  If not
@@ -35,11 +35,11 @@ There are two formats accepted for patch files:
 This is what linkgit:git-format-patch[1] generates.  Most headers and MIME
 formatting are ignored.
 
-2. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl'
+2. The original format used by Greg Kroah-Hartman's `send_lots_of_email.pl`
    script
 +
-This format expects the first line of the file to contain the "Cc:" value
-and the "Subject:" of the message as the second line.
+This format expects the first line of the file to contain the 'Cc:' value
+and the 'Subject:' of the message as the second line.
 
 
 OPTIONS
@@ -54,13 +54,13 @@ Composing
 	`sendemail.multiEdit`.
 
 --bcc=<address>,...::
-	Specify a "Bcc:" value for each email. Default is the value of
+	Specify a 'Bcc:' value for each email. Default is the value of
 	`sendemail.bcc`.
 +
 This option may be specified multiple times.
 
 --cc=<address>,...::
-	Specify a starting "Cc:" value for each email.
+	Specify a starting 'Cc:' value for each email.
 	Default is the value of `sendemail.cc`.
 +
 This option may be specified multiple times.
@@ -69,14 +69,14 @@ This option may be specified multiple times.
 	Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
 	to edit an introductory message for the patch series.
 +
-When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
-Subject, Reply-To, and In-Reply-To headers specified in the message. If
-the body of the message (what you type after the headers and a blank
-line) only contains blank (or Git: prefixed) lines, the summary won't be
+When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
+'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
+message. If the body of the message (what you type after the headers and a
+blank line) only contains blank (or 'Git:' prefixed) lines, the summary won't be
 sent, but the headers mentioned above will be used unless they are
 removed.
 +
-Missing From or In-Reply-To headers will be prompted for.
+Missing 'From' or 'In-Reply-To' headers will be prompted for.
 +
 See the CONFIGURATION section for `sendemail.multiEdit`.
 
@@ -85,13 +85,13 @@ See the CONFIGURATION section for `sendemail.multiEdit`.
 	the value of the `sendemail.from` configuration option is used.  If
 	neither the command-line option nor `sendemail.from` are set, then the
 	user will be prompted for the value.  The default for the prompt will be
-	the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
-	set, as returned by "git var -l".
+	the value of `GIT_AUTHOR_IDENT`, or `GIT_COMMITTER_IDENT` if that is not
+	set, as returned by `git var -l`.
 
 --reply-to=<address>::
 	Specify the address where replies from recipients should go to.
 	Use this if replies to messages should go to another address than what
-	is specified with the --from parameter.
+	is specified with the `--from` parameter.
 
 --in-reply-to=<identifier>::
 	Make the first mail (or all the mails with `--no-thread`) appear as a
@@ -112,14 +112,14 @@ illustration below where `[PATCH v2 0/3]` is in reply to `[PATCH 0/2]`:
       [PATCH v2 2/3] New tests
       [PATCH v2 3/3] Implementation
 +
-Only necessary if --compose is also set.  If --compose
+Only necessary if `--compose` is also set.  If `--compose`
 is not set, this will be prompted for.
 
 --[no-]outlook-id-fix::
 	Microsoft Outlook SMTP servers discard the Message-ID sent via email and
 	assign a new random Message-ID, thus breaking threads.
 +
-With `--outlook-id-fix`, 'git send-email' uses a mechanism specific to
+With `--outlook-id-fix`, `git send-email` uses a mechanism specific to
 Outlook servers to learn the Message-ID the server assigned to fix the
 threading. Use it only when you know that the server reports the
 rewritten Message-ID the same way as Outlook servers do.
@@ -130,14 +130,14 @@ to 'smtp.office365.com' or 'smtp-mail.outlook.com'. Use
 
 --subject=<string>::
 	Specify the initial subject of the email thread.
-	Only necessary if --compose is also set.  If --compose
+	Only necessary if `--compose` is also set.  If `--compose`
 	is not set, this will be prompted for.
 
 --to=<address>,...::
 	Specify the primary recipient of the emails generated. Generally, this
 	will be the upstream maintainer of the project involved. Default is the
 	value of the `sendemail.to` configuration value; if that is unspecified,
-	and --to-cmd is not specified, this will be prompted for.
+	and `--to-cmd` is not specified, this will be prompted for.
 +
 This option may be specified multiple times.
 
@@ -145,30 +145,30 @@ This option may be specified multiple times.
 	When encountering a non-ASCII message or subject that does not
 	declare its encoding, add headers/quoting to indicate it is
 	encoded in <encoding>.  Default is the value of the
-	'sendemail.assume8bitEncoding'; if that is unspecified, this
+	`sendemail.assume8bitEncoding`; if that is unspecified, this
 	will be prompted for if any non-ASCII files are encountered.
 +
 Note that no attempts whatsoever are made to validate the encoding.
 
 --compose-encoding=<encoding>::
 	Specify encoding of compose message. Default is the value of the
-	'sendemail.composeEncoding'; if that is unspecified, UTF-8 is assumed.
+	`sendemail.composeEncoding`; if that is unspecified, UTF-8 is assumed.
 
 --transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)::
 	Specify the transfer encoding to be used to send the message over SMTP.
-	7bit will fail upon encountering a non-ASCII message.  quoted-printable
+	'7bit' will fail upon encountering a non-ASCII message. 'quoted-printable'
 	can be useful when the repository contains files that contain carriage
-	returns, but makes the raw patch email file (as saved from a MUA) much
-	harder to inspect manually.  base64 is even more fool proof, but also
-	even more opaque.  auto will use 8bit when possible, and quoted-printable
-	otherwise.
+	returns, but makes the raw patch email file (as saved from an MUA) much
+	harder to inspect manually. 'base64' is even more fool proof, but also
+	even more opaque. 'auto' will use '8bit' when possible, and
+	'quoted-printable' otherwise.
 +
 Default is the value of the `sendemail.transferEncoding` configuration
-value; if that is unspecified, default to `auto`.
+value; if that is unspecified, default to 'auto'.
 
 --xmailer::
 --no-xmailer::
-	Add (or prevent adding) the "X-Mailer:" header.  By default,
+	Add (or prevent adding) the 'X-Mailer:' header.  By default,
 	the header is added, but it can be turned off by setting the
 	`sendemail.xmailer` configuration variable to `false`.
 
@@ -179,8 +179,8 @@ Sending
 	Specify the envelope sender used to send the emails.
 	This is useful if your default address is not the address that is
 	subscribed to a list. In order to use the 'From' address, set the
-	value to "auto". If you use the sendmail binary, you must have
-	suitable privileges for the -f parameter.  Default is the value of the
+	value to `auto`. If you use the `sendmail` binary, you must have
+	suitable privileges for the `-f` parameter.  Default is the value of the
 	`sendemail.envelopeSender` configuration variable; if that is
 	unspecified, choosing the envelope sender is left to your MTA.
 
@@ -189,8 +189,8 @@ Sending
 	be sendmail-like; specifically, it must support the `-i` option.
 	The command will be executed in the shell if necessary.  Default
 	is the value of `sendemail.sendmailCmd`.  If unspecified, and if
-	--smtp-server is also unspecified, git-send-email will search
-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH.
+	`--smtp-server` is also unspecified, `git send-email` will search
+	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH`.
 
 --smtp-encryption=<encryption>::
 	Specify in what way encrypting begins for the SMTP connection.
@@ -209,7 +209,7 @@ Sending
 --smtp-domain=<FQDN>::
 	Specifies the Fully Qualified Domain Name (FQDN) used in the
 	HELO/EHLO command to the SMTP server.  Some servers require the
-	FQDN to match your IP address.  If not set, git send-email attempts
+	FQDN to match your IP address.  If not set, `git send-email` attempts
 	to determine your FQDN automatically.  Default is the value of
 	`sendemail.smtpDomain`.
 
@@ -223,10 +223,10 @@ $ git send-email --smtp-auth="PLAIN LOGIN GSSAPI" ...
 +
 If at least one of the specified mechanisms matches the ones advertised by the
 SMTP server and if it is supported by the utilized SASL library, the mechanism
-is used for authentication. If neither 'sendemail.smtpAuth' nor `--smtp-auth`
+is used for authentication. If neither `sendemail.smtpAuth` nor `--smtp-auth`
 is specified, all mechanisms supported by the SASL library can be used. The
-special value 'none' maybe specified to completely disable authentication
-independently of `--smtp-user`
+special value `none` maybe specified to completely disable authentication
+independently of `--smtp-user`.
 
 --smtp-pass[=<password>]::
 	Password for SMTP-AUTH. The argument is optional: If no
@@ -238,16 +238,16 @@ Furthermore, passwords need not be specified in configuration files
 or on the command line. If a username has been specified (with
 `--smtp-user` or a `sendemail.smtpUser`), but no password has been
 specified (with `--smtp-pass` or `sendemail.smtpPass`), then
-a password is obtained using 'git-credential'.
+a password is obtained using linkgit:git-credential[1].
 
 --no-smtp-auth::
-	Disable SMTP authentication. Short hand for `--smtp-auth=none`
+	Disable SMTP authentication. Short hand for `--smtp-auth=none`.
 
 --smtp-server=<host>::
 	If set, specifies the outgoing SMTP server to use (e.g.
 	`smtp.example.com` or a raw IP address).  If unspecified, and if
 	`--sendmail-cmd` is also unspecified, the default is to search
-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH if such a
+	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH` if such a
 	program is available, falling back to `localhost` otherwise.
 +
 For backward compatibility, this option can also specify a full pathname
@@ -260,7 +260,7 @@ instead.
 	Specifies a port different from the default port (SMTP
 	servers typically listen to smtp port 25, but may also listen to
 	submission port 587, or the common SSL smtp port 465);
-	symbolic port names (e.g. "submission" instead of 587)
+	symbolic port names (e.g. `submission` instead of 587)
 	are also accepted. The port can also be set with the
 	`sendemail.smtpServerPort` configuration variable.
 
@@ -269,7 +269,7 @@ instead.
 	Default value can be specified by the `sendemail.smtpServerOption`
 	configuration option.
 +
-The --smtp-server-option option must be repeated for each option you want
+The `--smtp-server-option` option must be repeated for each option you want
 to pass to the server. Likewise, different lines in the configuration files
 must be used for each option.
 
@@ -279,7 +279,7 @@ must be used for each option.
 --smtp-ssl-cert-path::
 	Path to a store of trusted CA certificates for SMTP SSL/TLS
 	certificate validation (either a directory that has been processed
-	by 'c_rehash', or a single file containing one or more PEM format
+	by `c_rehash`, or a single file containing one or more PEM format
 	certificates concatenated together: see verify(1) -CAfile and
 	-CApath for more information on these). Set it to an empty string
 	to disable certificate verification. Defaults to the value of the
@@ -298,18 +298,18 @@ must be used for each option.
 	connection and authentication problems.
 
 --batch-size=<num>::
-	Some email servers (e.g. smtp.163.com) limit the number emails to be
+	Some email servers (e.g. 'smtp.163.com') limit the number of emails to be
 	sent per session (connection) and this will lead to a failure when
 	sending many messages.  With this option, send-email will disconnect after
-	sending $<num> messages and wait for a few seconds (see --relogin-delay)
-	and reconnect, to work around such a limit.  You may want to
-	use some form of credential helper to avoid having to retype
-	your password every time this happens.  Defaults to the
+	sending _<num>_ messages and wait for a few seconds
+	(see `--relogin-delay`) and reconnect, to work around such a limit.
+	You may want to use some form of credential helper to avoid having to
+	retype your password every time this happens.  Defaults to the
 	`sendemail.smtpBatchSize` configuration variable.
 
 --relogin-delay=<int>::
-	Waiting $<int> seconds before reconnecting to SMTP server. Used together
-	with --batch-size option.  Defaults to the `sendemail.smtpReloginDelay`
+	Waiting _<int>_ seconds before reconnecting to SMTP server. Used together
+	with `--batch-size` option.  Defaults to the `sendemail.smtpReloginDelay`
 	configuration variable.
 
 Automating
@@ -318,7 +318,7 @@ Automating
 --no-to::
 --no-cc::
 --no-bcc::
-	Clears any list of "To:", "Cc:", "Bcc:" addresses previously
+	Clears any list of 'To:', 'Cc:', 'Bcc:' addresses previously
 	set via config.
 
 --no-identity::
@@ -327,13 +327,13 @@ Automating
 
 --to-cmd=<command>::
 	Specify a command to execute once per patch file which
-	should generate patch file specific "To:" entries.
+	should generate patch file specific 'To:' entries.
 	Output of this command must be single email address per line.
-	Default is the value of 'sendemail.toCmd' configuration value.
+	Default is the value of `sendemail.toCmd` configuration value.
 
 --cc-cmd=<command>::
 	Specify a command to execute once per patch file which
-	should generate patch file specific "Cc:" entries.
+	should generate patch file specific 'Cc:' entries.
 	Output of this command must be single email address per line.
 	Default is the value of `sendemail.ccCmd` configuration value.
 
@@ -341,7 +341,7 @@ Automating
 	Specify a command that is executed once per outgoing message
 	and output RFC 2822 style header lines to be inserted into
 	them. When the `sendemail.headerCmd` configuration variable is
-	set, its value is always used. When --header-cmd is provided
+	set, its value is always used. When `--header-cmd` is provided
 	at the command line, its value takes precedence over the
 	`sendemail.headerCmd` configuration variable.
 
@@ -350,7 +350,7 @@ Automating
 
 --[no-]chain-reply-to::
 	If this is set, each email will be sent as a reply to the previous
-	email sent.  If disabled with "--no-chain-reply-to", all emails after
+	email sent.  If disabled with `--no-chain-reply-to`, all emails after
 	the first will be sent as replies to the first email sent.  When using
 	this, it is recommended that the first file given be an overview of the
 	entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
@@ -363,21 +363,22 @@ Automating
 	the value of `sendemail.identity`.
 
 --[no-]signed-off-by-cc::
-	If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
-	cc list. Default is the value of `sendemail.signedOffByCc` configuration
-	value; if that is unspecified, default to --signed-off-by-cc.
+	If this is set, add emails found in the `Signed-off-by` trailer or 'Cc:'
+	lines to the cc list. Default is the value of `sendemail.signedOffByCc`
+	configuration value; if that is unspecified, default to
+	`--signed-off-by-cc`.
 
 --[no-]cc-cover::
-	If this is set, emails found in Cc: headers in the first patch of
+	If this is set, emails found in 'Cc:' headers in the first patch of
 	the series (typically the cover letter) are added to the cc list
-	for each email set. Default is the value of 'sendemail.ccCover'
-	configuration value; if that is unspecified, default to --no-cc-cover.
+	for each email set. Default is the value of `sendemail.ccCover`
+	configuration value; if that is unspecified, default to `--no-cc-cover`.
 
 --[no-]to-cover::
-	If this is set, emails found in To: headers in the first patch of
+	If this is set, emails found in 'To:' headers in the first patch of
 	the series (typically the cover letter) are added to the to list
-	for each email set. Default is the value of 'sendemail.toCover'
-	configuration value; if that is unspecified, default to --no-to-cover.
+	for each email set. Default is the value of `sendemail.toCover`
+	configuration value; if that is unspecified, default to `--no-to-cover`.
 
 --suppress-cc=<category>::
 	Specify an additional category of recipients to suppress the
@@ -401,36 +402,36 @@ Automating
 --
 +
 Default is the value of `sendemail.suppressCc` configuration value; if
-that is unspecified, default to 'self' if --suppress-from is
-specified, as well as 'body' if --no-signed-off-cc is specified.
+that is unspecified, default to 'self' if `--suppress-from` is
+specified, as well as 'body' if `--no-signed-off-cc` is specified.
 
 --[no-]suppress-from::
-	If this is set, do not add the From: address to the cc: list.
+	If this is set, do not add the 'From:' address to the 'Cc:' list.
 	Default is the value of `sendemail.suppressFrom` configuration
-	value; if that is unspecified, default to --no-suppress-from.
+	value; if that is unspecified, default to `--no-suppress-from`.
 
 --[no-]thread::
-	If this is set, the In-Reply-To and References headers will be
+	If this is set, the 'In-Reply-To' and 'References' headers will be
 	added to each email sent.  Whether each mail refers to the
-	previous email (`deep` threading per 'git format-patch'
+	previous email (`deep` threading per `git format-patch`
 	wording) or to the first email (`shallow` threading) is
-	governed by "--[no-]chain-reply-to".
+	governed by `--[no-]chain-reply-to`.
 +
-If disabled with "--no-thread", those headers will not be added
-(unless specified with --in-reply-to).  Default is the value of the
+If disabled with `--no-thread`, those headers will not be added
+(unless specified with `--in-reply-to`).  Default is the value of the
 `sendemail.thread` configuration value; if that is unspecified,
-default to --thread.
+default to `--thread`.
 +
 It is up to the user to ensure that no In-Reply-To header already
-exists when 'git send-email' is asked to add it (especially note that
-'git format-patch' can be configured to do the threading itself).
+exists when `git send-email` is asked to add it (especially note that
+`git format-patch` can be configured to do the threading itself).
 Failure to do so may not produce the expected result in the
 recipient's MUA.
 
 --[no-]mailmap::
 	Use the mailmap file (see linkgit:gitmailmap[5]) to map all
 	addresses to their canonical real name and email address. Additional
-	mailmap data specific to git-send-email may be provided using the
+	mailmap data specific to `git send-email` may be provided using the
 	`sendemail.mailmap.file` or `sendemail.mailmap.blob` configuration
 	values. Defaults to `sendemail.mailmap`.
 
@@ -441,12 +442,12 @@ Administering
 	Confirm just before sending:
 +
 --
-- 'always' will always confirm before sending
-- 'never' will never confirm before sending
+- 'always' will always confirm before sending.
+- 'never' will never confirm before sending.
 - 'cc' will confirm before sending when send-email has automatically
-  added addresses from the patch to the Cc list
+  added addresses from the patch to the Cc list.
 - 'compose' will confirm before sending the first message when using --compose.
-- 'auto' is equivalent to 'cc' + 'compose'
+- 'auto' is equivalent to 'cc' + 'compose'.
 --
 +
 Default is the value of `sendemail.confirm` configuration value; if that
@@ -460,10 +461,10 @@ have been specified, in which case default to 'compose'.
 	When an argument may be understood either as a reference or as a file name,
 	choose to understand it as a format-patch argument (`--format-patch`)
 	or as a file name (`--no-format-patch`). By default, when such a conflict
-	occurs, git send-email will fail.
+	occurs, `git send-email` will fail.
 
 --quiet::
-	Make git-send-email less verbose.  One line per email should be
+	Make `git send-email` less verbose.  One line per email should be
 	all that is output.
 
 --[no-]validate::
@@ -525,7 +526,7 @@ edit `~/.gitconfig` to specify your account settings:
 ----
 
 If you have multi-factor authentication set up on your Gmail account, you can
-generate an app-specific password for use with 'git send-email'. Visit
+generate an app-specific password for use with `git send-email`. Visit
 https://security.google.com/settings/security/apppasswords to create it.
 
 You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
@@ -599,9 +600,16 @@ helpers.
 
 Note: the following core Perl modules that may be installed with your
 distribution of Perl are required:
-MIME::Base64, MIME::QuotedPrint, Net::Domain and Net::SMTP.
+
+https://metacpan.org/pod/MIME::Base64[MIME::Base64],
+https://metacpan.org/pod/MIME::QuotedPrint[MIME::QuotedPrint],
+https://metacpan.org/pod/Net::Domain[Net::Domain] and
+https://metacpan.org/pod/Net::SMTP[Net::SMTP].
+
 These additional Perl modules are also required:
-Authen::SASL and Mail::Address.
+
+https://metacpan.org/pod/Authen::SASL[Authen::SASL] and
+https://metacpan.org/pod/Mail::Address[Mail::Address].
 
 
 SEE ALSO
-- 
2.49.0.638.g03d7d6a772


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v6 3/4] docs: remove credential helper links for emails from gitcredentials
  2025-05-30 11:37 ` [PATCH v6 " Aditya Garg
  2025-05-30 11:37   ` [PATCH v6 1/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
  2025-05-30 11:37   ` [PATCH v6 2/4] docs: improve formatting in git-send-email documentation Aditya Garg
@ 2025-05-30 11:37   ` Aditya Garg
  2025-05-30 11:37   ` [PATCH v6 4/4] docs: make the purpose of using app password for Gmail more clear in send-email Aditya Garg
  3 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 11:37 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin

In a recent attempt to add links of email helpers to git-scm.com [1], I
came to a conclusion that the links in the gitcredentials page are meant
for people needing credential helpers for cloning, fetching and pushing
repositories to remote hosts, and not sending emails. gitcredentials
docs don't even talk about send emails, thus confirming this view.

So, lets remove these links from the gitcredentials page. The links are
still available in the git-send-email documentation, which is the right
place for them.

[1]: https://github.com/git/git-scm.com/pull/2005

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/gitcredentials.adoc | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/Documentation/gitcredentials.adoc b/Documentation/gitcredentials.adoc
index b49923db02..3337bb475d 100644
--- a/Documentation/gitcredentials.adoc
+++ b/Documentation/gitcredentials.adoc
@@ -133,10 +133,6 @@ Popular helpers with OAuth support include:
 
     - https://github.com/hickford/git-credential-oauth[git-credential-oauth] (cross platform, included in many Linux distributions)
 
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail] (cross platform, dedicated helper to authenticate Gmail accounts for linkgit:git-send-email[1])
-
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook] (cross platform, dedicated helper to authenticate Microsoft Outlook accounts for linkgit:git-send-email[1])
-
 CREDENTIAL CONTEXTS
 -------------------
 
-- 
2.49.0.638.g03d7d6a772


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v6 4/4] docs: make the purpose of using app password for Gmail more clear in send-email
  2025-05-30 11:37 ` [PATCH v6 " Aditya Garg
                     ` (2 preceding siblings ...)
  2025-05-30 11:37   ` [PATCH v6 3/4] docs: remove credential helper links for emails from gitcredentials Aditya Garg
@ 2025-05-30 11:37   ` Aditya Garg
  3 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 11:37 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin

The current example for Gmail suggests using app passwords for
send-email if user has multi-factor authentication set up for their
account. However, it does not clarify that the user cannot use their
normal password in case they do not have multi-factor authentication
enabled. Most likely the example was written in the days when Google
allowed using normal passwords without multi-factor authentication.

Clarify that regular passwords do not work for Gmail and app-passwords
are the only way for basic authentication. Also encourage users to use
OAuth2.0 as a more secure alternative.

While at it, also prefer using the word "mechanism" over "method" for
`OAUTHBEARER` and `XOAUTH2` since that is what official docs use.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/git-send-email.adoc | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 04e1c459b4..9c008dabe3 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -525,15 +525,18 @@ edit `~/.gitconfig` to specify your account settings:
 	smtpServerPort = 587
 ----
 
+Gmail does not allow using your regular password for `git send-email`.
 If you have multi-factor authentication set up on your Gmail account, you can
 generate an app-specific password for use with `git send-email`. Visit
 https://security.google.com/settings/security/apppasswords to create it.
 
-You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
-`XOAUTH2` are common methods used for this type of authentication. Gmail
-supports both of them. As an example, if you want to use `OAUTHBEARER`, edit
-your `~/.gitconfig` file and add `smtpAuth = OAUTHBEARER` to your account
-settings:
+Alternatively, instead of using an app-specific password, you can use
+OAuth2.0 authentication with Gmail. OAuth2.0 is more secure than
+app-specific passwords, and works regardless of whether you have multi-factor
+authentication set up. `OAUTHBEARER` and `XOAUTH2` are common mechanisms used
+for this type of authentication. Gmail supports both of them. As an example,
+if you want to use `OAUTHBEARER`, edit your `~/.gitconfig` file and add
+`smtpAuth = OAUTHBEARER` to your account settings:
 
 ----
 [sendemail]
@@ -544,7 +547,7 @@ settings:
 	smtpAuth = OAUTHBEARER
 ----
 
-Alternatively, you can use a tool developed by Google known as
+Another alternative is using a tool developed by Google known as
 https://github.com/google/gmail-oauth2-tools/tree/master/go/sendgmail[sendgmail]
 to send emails using `git send-email`.
 
@@ -552,7 +555,7 @@ Use Microsoft Outlook as the SMTP Server
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
 Therefore, OAuth2.0 authentication must be used for Outlook. Also, it only
-supports `XOAUTH2` authentication method.
+supports `XOAUTH2` authentication mechanism.
 
 Edit `~/.gitconfig` to specify your account settings for Outlook and use its
 SMTP server with `git send-email`:
-- 
2.49.0.638.g03d7d6a772


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 2/4] docs: improve formatting in git-send-email documentation
  2025-05-29 19:04       ` Aditya Garg
@ 2025-05-30 13:28         ` Junio C Hamano
  2025-05-30 13:32           ` Aditya Garg
  2025-05-30 14:48           ` Ben Knoble
  0 siblings, 2 replies; 52+ messages in thread
From: Junio C Hamano @ 2025-05-30 13:28 UTC (permalink / raw)
  To: Aditya Garg
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin

Aditya Garg <gargaditya08@live.com> writes:

>>> -When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
>>> -Subject, Reply-To, and In-Reply-To headers specified in the message. If
>>> -the body of the message (what you type after the headers and a blank
>>> -line) only contains blank (or Git: prefixed) lines, the summary won't be
>>> +When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
>>> +'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
>>> +message. If the body of the message (what you type after the headers and a
>>> +blank line) only contains blank (or Git: prefixed) lines, the summary won't be
>> 
>> Shouldn't 'Git:' in "or Git: prefixed" be marked-up somehow as well?
>> 
>> As these mail header names are all literal parts, shouldn't ehy be
>> marked up like `To`, `Cc`, etc.?
>
> I think its ok to let these remain in '', and deviate from the rules a bit.
> If backticks are used, it will be a mess when rendered on the website.

I do not think I agree; bending the rule only because the density of
literals in a single paragraph is too heavy does not sound like a
good application of a rule---it is hard to justify such an
exception.

>>> -    by 'c_rehash', or a single file containing one or more PEM format
>>> -    certificates concatenated together: see verify(1) -CAfile and
>>> -    -CApath for more information on these). Set it to an empty string
>>> +    by `c_rehash`, or a single file containing one or more PEM format
>>> +    certificates concatenated together). Set it to an empty string
>> 
>> What is this change about?  grammatical errors?  non existent links?
>> cpan links?  It does not look any of these.
>
> Non existing links. Checkout the website.

But I do not see any link in ...

>>> -    by 'c_rehash', or a single file containing one or more PEM format
>>> -    certificates concatenated together: see verify(1) -CAfile and
>>> -    -CApath for more information on these). Set it to an empty string

... the text that was removed.  The reference to verify(1) is a
command in the OpenSSL suite, right?

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 2/4] docs: improve formatting in git-send-email documentation
  2025-05-30 13:28         ` Junio C Hamano
@ 2025-05-30 13:32           ` Aditya Garg
  2025-05-30 17:15             ` Junio C Hamano
  2025-05-30 14:48           ` Ben Knoble
  1 sibling, 1 reply; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 13:32 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin



> On 30 May 2025, at 6:58 PM, Junio C Hamano <gitster@pobox.com> wrote:
> 
> Aditya Garg <gargaditya08@live.com> writes:
> 
>>>> -When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
>>>> -Subject, Reply-To, and In-Reply-To headers specified in the message. If
>>>> -the body of the message (what you type after the headers and a blank
>>>> -line) only contains blank (or Git: prefixed) lines, the summary won't be
>>>> +When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
>>>> +'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
>>>> +message. If the body of the message (what you type after the headers and a
>>>> +blank line) only contains blank (or Git: prefixed) lines, the summary won't be
>>> 
>>> Shouldn't 'Git:' in "or Git: prefixed" be marked-up somehow as well?
>>> 
>>> As these mail header names are all literal parts, shouldn't ehy be
>>> marked up like `To`, `Cc`, etc.?
>> 
>> I think its ok to let these remain in '', and deviate from the rules a bit.
>> If backticks are used, it will be a mess when rendered on the website.
> 
> I do not think I agree; bending the rule only because the density of
> literals in a single paragraph is too heavy does not sound like a
> good application of a rule---it is hard to justify such an
> exception.
> 
>>>> -    by 'c_rehash', or a single file containing one or more PEM format
>>>> -    certificates concatenated together: see verify(1) -CAfile and
>>>> -    -CApath for more information on these). Set it to an empty string
>>>> +    by `c_rehash`, or a single file containing one or more PEM format
>>>> +    certificates concatenated together). Set it to an empty string
>>> 
>>> What is this change about?  grammatical errors?  non existent links?
>>> cpan links?  It does not look any of these.
>> 
>> Non existing links. Checkout the website.
> 
> But I do not see any link in ...
> 
>>>> -    by 'c_rehash', or a single file containing one or more PEM format
>>>> -    certificates concatenated together: see verify(1) -CAfile and
>>>> -    -CApath for more information on these). Set it to an empty string
> 
> ... the text that was removed.  The reference to verify(1) is a
> command in the OpenSSL suite, right?

If this is a command, its not phrased nicely imo. I'll just leave it as is.

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 2/4] docs: improve formatting in git-send-email documentation
  2025-05-30 13:28         ` Junio C Hamano
  2025-05-30 13:32           ` Aditya Garg
@ 2025-05-30 14:48           ` Ben Knoble
  2025-05-30 14:51             ` Aditya Garg
  1 sibling, 1 reply; 52+ messages in thread
From: Ben Knoble @ 2025-05-30 14:48 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: Aditya Garg, git, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals, Johannes Schindelin


> Le 30 mai 2025 à 09:28, Junio C Hamano <gitster@pobox.com> a écrit :
> 
> Aditya Garg <gargaditya08@live.com> writes:
> 
>>>> -When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
>>>> -Subject, Reply-To, and In-Reply-To headers specified in the message. If
>>>> -the body of the message (what you type after the headers and a blank
>>>> -line) only contains blank (or Git: prefixed) lines, the summary won't be
>>>> +When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
>>>> +'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
>>>> +message. If the body of the message (what you type after the headers and a
>>>> +blank line) only contains blank (or Git: prefixed) lines, the summary won't be
>>> 
>>> Shouldn't 'Git:' in "or Git: prefixed" be marked-up somehow as well?
>>> 
>>> As these mail header names are all literal parts, shouldn't ehy be
>>> marked up like `To`, `Cc`, etc.?
>> 
>> I think its ok to let these remain in '', and deviate from the rules a bit.
>> If backticks are used, it will be a mess when rendered on the website.
> 
> I do not think I agree; bending the rule only because the density of
> literals in a single paragraph is too heavy does not sound like a
> good application of a rule---it is hard to justify such an
> exception.

To go a bit further, rendered HTML is also not the only output format, though I don’t think the markup here affects manual pages substantially? So using « the website » (which? presumably git-scm.com) as justification prioritizes the look of one output format over other concerns, no?

For plaintext viewing, consistency is probably helpful.  

> 
>>>> -    by 'c_rehash', or a single file containing one or more PEM format
>>>> -    certificates concatenated together: see verify(1) -CAfile and
>>>> -    -CApath for more information on these). Set it to an empty string
>>>> +    by `c_rehash`, or a single file containing one or more PEM format
>>>> +    certificates concatenated together). Set it to an empty string
>>> 
>>> What is this change about?  grammatical errors?  non existent links?
>>> cpan links?  It does not look any of these.
>> 
>> Non existing links. Checkout the website.
> 
> But I do not see any link in ...
> 
>>>> -    by 'c_rehash', or a single file containing one or more PEM format
>>>> -    certificates concatenated together: see verify(1) -CAfile and
>>>> -    -CApath for more information on these). Set it to an empty string
> 
> ... the text that was removed.  The reference to verify(1) is a
> command in the OpenSSL suite, right?
> 

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 2/4] docs: improve formatting in git-send-email documentation
  2025-05-30 14:48           ` Ben Knoble
@ 2025-05-30 14:51             ` Aditya Garg
  0 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 14:51 UTC (permalink / raw)
  To: Ben Knoble
  Cc: Junio C Hamano, git@vger.kernel.org, Julian Swagemakers,
	Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin



> On 30 May 2025, at 8:18 PM, Ben Knoble <ben.knoble@gmail.com> wrote:
> 
> 
>> Le 30 mai 2025 à 09:28, Junio C Hamano <gitster@pobox.com> a écrit :
>> 
>> Aditya Garg <gargaditya08@live.com> writes:
>> 
>>>>> -When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
>>>>> -Subject, Reply-To, and In-Reply-To headers specified in the message. If
>>>>> -the body of the message (what you type after the headers and a blank
>>>>> -line) only contains blank (or Git: prefixed) lines, the summary won't be
>>>>> +When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
>>>>> +'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
>>>>> +message. If the body of the message (what you type after the headers and a
>>>>> +blank line) only contains blank (or Git: prefixed) lines, the summary won't be
>>>> 
>>>> Shouldn't 'Git:' in "or Git: prefixed" be marked-up somehow as well?
>>>> 
>>>> As these mail header names are all literal parts, shouldn't ehy be
>>>> marked up like `To`, `Cc`, etc.?
>>> 
>>> I think its ok to let these remain in '', and deviate from the rules a bit.
>>> If backticks are used, it will be a mess when rendered on the website.
>> 
>> I do not think I agree; bending the rule only because the density of
>> literals in a single paragraph is too heavy does not sound like a
>> good application of a rule---it is hard to justify such an
>> exception.
> 
> To go a bit further, rendered HTML is also not the only output format, though I don’t think the markup here affects manual pages substantially? So using « the website » (which? presumably git-scm.com) as justification prioritizes the look of one output format over other concerns, no?
> 
> For plaintext viewing, consistency is probably helpful.  

Ok I'll send another revision.

^ permalink raw reply	[flat|nested] 52+ messages in thread

* [PATCH v7 0/4] docs: add credential helper for yahoo and link Google's sendgmail tool
  2025-05-13 18:28 [PATCH] docs: add instructions to use Yahoo with send-mail Aditya Garg
                   ` (5 preceding siblings ...)
  2025-05-30 11:37 ` [PATCH v6 " Aditya Garg
@ 2025-05-30 15:50 ` Aditya Garg
  2025-05-30 15:50   ` [PATCH v7 1/4] " Aditya Garg
                     ` (3 more replies)
  6 siblings, 4 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 15:50 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin, Ben Knoble

Hi all,

This patch series includes four patches:

1. The first patch adds a link to the `git-credential-yahoo` helper for
   Yahoo accounts and links Google's `sendgmail` tool as an alternative
   method for sending emails through Gmail.

2. The second patch improves the formatting of the `git-send-email`
   documentation, making it more readable and consistent.

3. The third patch removes the email credential helper links from the
   `gitcredentials` page. The links are still available in the
   `git-send-email` documentation, which is the right place for them.

4. The fourth patch clarifies the purpose of using an app password for
   Gmail in the `git-send-email` documentation. It also encourages
   users to use OAuth2.0 over app passwords for better security.

Detailed explanation of the changes has been done in individual patch.

v2: - Removed instructions for Yahoo SMTP server since I've realised that
      Yahoo *was* a popular email service. Also, the instructions were
      just making the docs more crowded. I've also added a link to
      Google's `sendgmail` tool in the first patch. The second patch has been
      added to address the issues that came up here:
      https://github.com/git/git-scm.com/pull/2005

v3: - Added a patch to improve the formatting of the `git-send-email`
      documentation.

v4: - Added cpan links of the perl modules requires for `git-send-email`
      to work.

v5: - Added a patch to make the purpose of using app password for Gmail
      more clear in `send-email` documentation.

v6: - Reword the documentation a bit more in last patch.
    - Markdown Git: -> 'Git:' in the second patch.
    - Restore the non-existent link (atleast what I believed that to be) in the
      second patch.
    - Remove the unnecessary use of $ with <num> and <int> placeholders in the
      second patch.
    - White at it, also prefer using the word "mechanism" over "method" for
      `OAUTHBEARER` and `XOAUTH2` in git-send-email docs since that is what
      official docs use. This changes has been done in the last patch.
    - Sign-off the last patch.

v7: - Use backticks consistently for all headers as well in second patch.

Aditya Garg (4):
  docs: add credential helper for yahoo and link Google's sendgmail tool
  docs: improve formatting in git-send-email documentation
  docs: remove credential helper links for emails from gitcredentials
  docs: make the purpose of using app password for Gmail more clear in
    send-email

 Documentation/config/sendemail.adoc |  20 +--
 Documentation/git-send-email.adoc   | 257 +++++++++++++++-------------
 Documentation/gitcredentials.adoc   |   4 -
 3 files changed, 147 insertions(+), 134 deletions(-)

Range-diff against v6:
-:  ---------- > 1:  2c47cc5396 docs: add credential helper for yahoo and link Google's sendgmail tool
1:  20da5d6a58 ! 2:  660305721d docs: improve formatting in git-send-email documentation
    @@ Commit message
         Signed-off-by: Aditya Garg <gargaditya08@live.com>
     
      ## Documentation/config/sendemail.adoc ##
    -@@ Documentation/config/sendemail.adoc: sendemail.<identity>.*::
    +@@
    + sendemail.identity::
    + 	A configuration identity. When given, causes values in the
    +-	'sendemail.<identity>' subsection to take precedence over
    +-	values in the 'sendemail' section. The default identity is
    ++	`sendemail.<identity>` subsection to take precedence over
    ++	values in the `sendemail` section. The default identity is
    + 	the value of `sendemail.identity`.
    + 
    + sendemail.smtpEncryption::
    + 	See linkgit:git-send-email[1] for description.  Note that this
    +-	setting is not subject to the 'identity' mechanism.
    ++	setting is not subject to the `identity` mechanism.
    + 
    + sendemail.smtpSSLCertPath::
    + 	Path to ca-certificates (either a directory or a single file).
    + 	Set it to an empty string to disable certificate verification.
    + 
    + sendemail.<identity>.*::
    +-	Identity-specific versions of the 'sendemail.*' parameters
    ++	Identity-specific versions of the `sendemail.*` parameters
    + 	found below, taking precedence over those when this
    + 	identity is selected, through either the command-line or
      	`sendemail.identity`.
      
      sendemail.multiEdit::
    @@ Documentation/config/sendemail.adoc: sendemail.<identity>.*::
      	after the other, spawning a new editor each time.
      
      sendemail.confirm::
    + 	Sets the default for whether to confirm before sending. Must be
    +-	one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm`
    ++	one of `always`, `never`, `cc`, `compose`, or `auto`. See `--confirm`
    + 	in the linkgit:git-send-email[1] documentation for the meaning of these
    + 	values.
    + 
    +@@ Documentation/config/sendemail.adoc: sendemail.aliasesFile::
    + 
    + sendemail.aliasFileType::
    + 	Format of the file(s) specified in sendemail.aliasesFile. Must be
    +-	one of 'mutt', 'mailrc', 'pine', 'elm', 'gnus', or 'sendmail'.
    ++	one of `mutt`, `mailrc`, `pine`, `elm`, `gnus`, or `sendmail`.
    + +
    + What an alias file in each format looks like can be found in
    + the documentation of the email program of the same name. The
     @@ Documentation/config/sendemail.adoc: sendemail.signedOffCc (deprecated)::
      
      sendemail.smtpBatchSize::
    @@ Documentation/git-send-email.adoc: There are two formats accepted for patch file
      +
     -This format expects the first line of the file to contain the "Cc:" value
     -and the "Subject:" of the message as the second line.
    -+This format expects the first line of the file to contain the 'Cc:' value
    -+and the 'Subject:' of the message as the second line.
    ++This format expects the first line of the file to contain the `Cc:` value
    ++and the `Subject:` of the message as the second line.
      
      
      OPTIONS
    @@ Documentation/git-send-email.adoc: Composing
      
      --bcc=<address>,...::
     -	Specify a "Bcc:" value for each email. Default is the value of
    -+	Specify a 'Bcc:' value for each email. Default is the value of
    ++	Specify a `Bcc:` value for each email. Default is the value of
      	`sendemail.bcc`.
      +
      This option may be specified multiple times.
      
      --cc=<address>,...::
     -	Specify a starting "Cc:" value for each email.
    -+	Specify a starting 'Cc:' value for each email.
    ++	Specify a starting `Cc:` value for each email.
      	Default is the value of `sendemail.cc`.
      +
      This option may be specified multiple times.
    @@ Documentation/git-send-email.adoc: This option may be specified multiple times.
     -Subject, Reply-To, and In-Reply-To headers specified in the message. If
     -the body of the message (what you type after the headers and a blank
     -line) only contains blank (or Git: prefixed) lines, the summary won't be
    -+When `--compose` is used, `git send-email` will use the 'From', 'To', 'Cc',
    -+'Bcc', 'Subject', 'Reply-To', and 'In-Reply-To' headers specified in the
    ++When `--compose` is used, `git send-email` will use the `From`, `To`, `Cc`,
    ++`Bcc`, `Subject`, `Reply-To`, and `In-Reply-To` headers specified in the
     +message. If the body of the message (what you type after the headers and a
    -+blank line) only contains blank (or 'Git:' prefixed) lines, the summary won't be
    ++blank line) only contains blank (or `Git:` prefixed) lines, the summary won't be
      sent, but the headers mentioned above will be used unless they are
      removed.
      +
     -Missing From or In-Reply-To headers will be prompted for.
    -+Missing 'From' or 'In-Reply-To' headers will be prompted for.
    ++Missing `From` or `In-Reply-To` headers will be prompted for.
      +
      See the CONFIGURATION section for `sendemail.multiEdit`.
      
    @@ Documentation/git-send-email.adoc: This option may be specified multiple times.
      --transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)::
      	Specify the transfer encoding to be used to send the message over SMTP.
     -	7bit will fail upon encountering a non-ASCII message.  quoted-printable
    -+	'7bit' will fail upon encountering a non-ASCII message. 'quoted-printable'
    ++	`7bit` will fail upon encountering a non-ASCII message. `quoted-printable`
      	can be useful when the repository contains files that contain carriage
     -	returns, but makes the raw patch email file (as saved from a MUA) much
     -	harder to inspect manually.  base64 is even more fool proof, but also
     -	even more opaque.  auto will use 8bit when possible, and quoted-printable
     -	otherwise.
     +	returns, but makes the raw patch email file (as saved from an MUA) much
    -+	harder to inspect manually. 'base64' is even more fool proof, but also
    -+	even more opaque. 'auto' will use '8bit' when possible, and
    -+	'quoted-printable' otherwise.
    ++	harder to inspect manually. `base64` is even more fool proof, but also
    ++	even more opaque. `auto` will use `8bit` when possible, and
    ++	`quoted-printable` otherwise.
      +
      Default is the value of the `sendemail.transferEncoding` configuration
    --value; if that is unspecified, default to `auto`.
    -+value; if that is unspecified, default to 'auto'.
    + value; if that is unspecified, default to `auto`.
      
      --xmailer::
      --no-xmailer::
     -	Add (or prevent adding) the "X-Mailer:" header.  By default,
    -+	Add (or prevent adding) the 'X-Mailer:' header.  By default,
    ++	Add (or prevent adding) the `X-Mailer:` header.  By default,
      	the header is added, but it can be turned off by setting the
      	`sendemail.xmailer` configuration variable to `false`.
      
     @@ Documentation/git-send-email.adoc: Sending
    + --envelope-sender=<address>::
      	Specify the envelope sender used to send the emails.
      	This is useful if your default address is not the address that is
    - 	subscribed to a list. In order to use the 'From' address, set the
    +-	subscribed to a list. In order to use the 'From' address, set the
     -	value to "auto". If you use the sendmail binary, you must have
     -	suitable privileges for the -f parameter.  Default is the value of the
    ++	subscribed to a list. In order to use the `From` address, set the
     +	value to `auto`. If you use the `sendmail` binary, you must have
     +	suitable privileges for the `-f` parameter.  Default is the value of the
      	`sendemail.envelopeSender` configuration variable; if that is
    @@ Documentation/git-send-email.adoc: Sending
      
      --smtp-encryption=<encryption>::
      	Specify in what way encrypting begins for the SMTP connection.
    -@@ Documentation/git-send-email.adoc: Sending
    +-	Valid values are 'ssl' and 'tls'. Any other value reverts to plain
    ++	Valid values are `ssl` and `tls`. Any other value reverts to plain
    + 	(unencrypted) SMTP, which defaults to port 25.
    + 	Despite the names, both values will use the same newer version of TLS,
    +-	but for historic reasons have these names. 'ssl' refers to "implicit"
    ++	but for historic reasons have these names. `ssl` refers to "implicit"
    + 	encryption (sometimes called SMTPS), that uses port 465 by default.
    +-	'tls' refers to "explicit" encryption (often known as STARTTLS),
    ++	`tls` refers to "explicit" encryption (often known as STARTTLS),
    + 	that uses port 25 by default. Other ports might be used by the SMTP
    + 	server, which are not the default. Commonly found alternative port for
    +-	'tls' and unencrypted is 587. You need to check your provider's
    ++	`tls` and unencrypted is 587. You need to check your provider's
    + 	documentation or your server configuration to make sure
    + 	for your own case. Default is the value of `sendemail.smtpEncryption`.
    + 
      --smtp-domain=<FQDN>::
      	Specifies the Fully Qualified Domain Name (FQDN) used in the
      	HELO/EHLO command to the SMTP server.  Some servers require the
    @@ Documentation/git-send-email.adoc: instead.
      to pass to the server. Likewise, different lines in the configuration files
      must be used for each option.
      
    -@@ Documentation/git-send-email.adoc: must be used for each option.
    + --smtp-ssl::
    +-	Legacy alias for '--smtp-encryption ssl'.
    ++	Legacy alias for `--smtp-encryption ssl`.
    + 
      --smtp-ssl-cert-path::
      	Path to a store of trusted CA certificates for SMTP SSL/TLS
      	certificate validation (either a directory that has been processed
    @@ Documentation/git-send-email.adoc: Automating
      --no-cc::
      --no-bcc::
     -	Clears any list of "To:", "Cc:", "Bcc:" addresses previously
    -+	Clears any list of 'To:', 'Cc:', 'Bcc:' addresses previously
    ++	Clears any list of `To:`, `Cc:`, `Bcc:` addresses previously
      	set via config.
      
      --no-identity::
    @@ Documentation/git-send-email.adoc: Automating
      --to-cmd=<command>::
      	Specify a command to execute once per patch file which
     -	should generate patch file specific "To:" entries.
    -+	should generate patch file specific 'To:' entries.
    ++	should generate patch file specific `To:` entries.
      	Output of this command must be single email address per line.
     -	Default is the value of 'sendemail.toCmd' configuration value.
     +	Default is the value of `sendemail.toCmd` configuration value.
    @@ Documentation/git-send-email.adoc: Automating
      --cc-cmd=<command>::
      	Specify a command to execute once per patch file which
     -	should generate patch file specific "Cc:" entries.
    -+	should generate patch file specific 'Cc:' entries.
    ++	should generate patch file specific `Cc:` entries.
      	Output of this command must be single email address per line.
      	Default is the value of `sendemail.ccCmd` configuration value.
      
    @@ Documentation/git-send-email.adoc: Automating
      	this, it is recommended that the first file given be an overview of the
      	entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
     @@ Documentation/git-send-email.adoc: Automating
    + 
    + --identity=<identity>::
    + 	A configuration identity. When given, causes values in the
    +-	'sendemail.<identity>' subsection to take precedence over
    +-	values in the 'sendemail' section. The default identity is
    ++	`sendemail.<identity>` subsection to take precedence over
    ++	values in the `sendemail` section. The default identity is
      	the value of `sendemail.identity`.
      
      --[no-]signed-off-by-cc::
     -	If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
     -	cc list. Default is the value of `sendemail.signedOffByCc` configuration
     -	value; if that is unspecified, default to --signed-off-by-cc.
    -+	If this is set, add emails found in the `Signed-off-by` trailer or 'Cc:'
    ++	If this is set, add emails found in the `Signed-off-by` trailer or `Cc:`
     +	lines to the cc list. Default is the value of `sendemail.signedOffByCc`
     +	configuration value; if that is unspecified, default to
     +	`--signed-off-by-cc`.
      
      --[no-]cc-cover::
     -	If this is set, emails found in Cc: headers in the first patch of
    -+	If this is set, emails found in 'Cc:' headers in the first patch of
    ++	If this is set, emails found in `Cc:` headers in the first patch of
      	the series (typically the cover letter) are added to the cc list
     -	for each email set. Default is the value of 'sendemail.ccCover'
     -	configuration value; if that is unspecified, default to --no-cc-cover.
    @@ Documentation/git-send-email.adoc: Automating
      
      --[no-]to-cover::
     -	If this is set, emails found in To: headers in the first patch of
    -+	If this is set, emails found in 'To:' headers in the first patch of
    ++	If this is set, emails found in `To:` headers in the first patch of
      	the series (typically the cover letter) are added to the to list
     -	for each email set. Default is the value of 'sendemail.toCover'
     -	configuration value; if that is unspecified, default to --no-to-cover.
    @@ Documentation/git-send-email.adoc: Automating
      
      --suppress-cc=<category>::
      	Specify an additional category of recipients to suppress the
    -@@ Documentation/git-send-email.adoc: Automating
    + 	auto-cc of:
    + +
    + --
    +-- 'author' will avoid including the patch author.
    +-- 'self' will avoid including the sender.
    +-- 'cc' will avoid including anyone mentioned in Cc lines in the patch header
    +-  except for self (use 'self' for that).
    +-- 'bodycc' will avoid including anyone mentioned in Cc lines in the
    +-  patch body (commit message) except for self (use 'self' for that).
    +-- 'sob' will avoid including anyone mentioned in the Signed-off-by trailers except
    +-  for self (use 'self' for that).
    +-- 'misc-by' will avoid including anyone mentioned in Acked-by,
    ++- `author` will avoid including the patch author.
    ++- `self` will avoid including the sender.
    ++- `cc` will avoid including anyone mentioned in Cc lines in the patch header
    ++  except for self (use `self` for that).
    ++- `bodycc` will avoid including anyone mentioned in Cc lines in the
    ++  patch body (commit message) except for self (use `self` for that).
    ++- `sob` will avoid including anyone mentioned in the Signed-off-by trailers except
    ++  for self (use `self` for that).
    ++- `misc-by` will avoid including anyone mentioned in Acked-by,
    +   Reviewed-by, Tested-by and other "-by" lines in the patch body,
    +-  except Signed-off-by (use 'sob' for that).
    +-- 'cccmd' will avoid running the --cc-cmd.
    +-- 'body' is equivalent to 'sob' + 'bodycc' + 'misc-by'.
    +-- 'all' will suppress all auto cc values.
    ++  except Signed-off-by (use `sob` for that).
    ++- `cccmd` will avoid running the --cc-cmd.
    ++- `body` is equivalent to `sob` + `bodycc` + `misc-by`.
    ++- `all` will suppress all auto cc values.
      --
      +
      Default is the value of `sendemail.suppressCc` configuration value; if
     -that is unspecified, default to 'self' if --suppress-from is
     -specified, as well as 'body' if --no-signed-off-cc is specified.
    -+that is unspecified, default to 'self' if `--suppress-from` is
    -+specified, as well as 'body' if `--no-signed-off-cc` is specified.
    ++that is unspecified, default to `self` if `--suppress-from` is
    ++specified, as well as `body` if `--no-signed-off-cc` is specified.
      
      --[no-]suppress-from::
     -	If this is set, do not add the From: address to the cc: list.
    -+	If this is set, do not add the 'From:' address to the 'Cc:' list.
    ++	If this is set, do not add the `From:` address to the `Cc:` list.
      	Default is the value of `sendemail.suppressFrom` configuration
     -	value; if that is unspecified, default to --no-suppress-from.
     +	value; if that is unspecified, default to `--no-suppress-from`.
      
      --[no-]thread::
     -	If this is set, the In-Reply-To and References headers will be
    -+	If this is set, the 'In-Reply-To' and 'References' headers will be
    ++	If this is set, the `In-Reply-To` and `References` headers will be
      	added to each email sent.  Whether each mail refers to the
     -	previous email (`deep` threading per 'git format-patch'
     +	previous email (`deep` threading per `git format-patch`
    @@ Documentation/git-send-email.adoc: Administering
      --
     -- 'always' will always confirm before sending
     -- 'never' will never confirm before sending
    -+- 'always' will always confirm before sending.
    -+- 'never' will never confirm before sending.
    - - 'cc' will confirm before sending when send-email has automatically
    +-- 'cc' will confirm before sending when send-email has automatically
     -  added addresses from the patch to the Cc list
    -+  added addresses from the patch to the Cc list.
    - - 'compose' will confirm before sending the first message when using --compose.
    +-- 'compose' will confirm before sending the first message when using --compose.
     -- 'auto' is equivalent to 'cc' + 'compose'
    -+- 'auto' is equivalent to 'cc' + 'compose'.
    ++- `always` will always confirm before sending.
    ++- `never` will never confirm before sending.
    ++- `cc` will confirm before sending when send-email has automatically
    ++  added addresses from the patch to the Cc list.
    ++- `compose` will confirm before sending the first message when using --compose.
    ++- `auto` is equivalent to `cc` + `compose`.
      --
      +
      Default is the value of `sendemail.confirm` configuration value; if that
    +-is unspecified, default to 'auto' unless any of the suppress options
    +-have been specified, in which case default to 'compose'.
    ++is unspecified, default to `auto` unless any of the suppress options
    ++have been specified, in which case default to `compose`.
    + 
    + --dry-run::
    + 	Do everything except actually send the emails.
     @@ Documentation/git-send-email.adoc: have been specified, in which case default to 'compose'.
      	When an argument may be understood either as a reference or as a file name,
      	choose to understand it as a format-patch argument (`--format-patch`)
    @@ Documentation/git-send-email.adoc: have been specified, in which case default to
      	all that is output.
      
      --[no-]validate::
    +@@ Documentation/git-send-email.adoc: have been specified, in which case default to 'compose'.
    + 		*	Invoke the sendemail-validate hook if present (see linkgit:githooks[5]).
    + 		*	Warn of patches that contain lines longer than
    + 			998 characters unless a suitable transfer encoding
    +-			('auto', 'base64', or 'quoted-printable') is used;
    ++			(`auto`, `base64`, or `quoted-printable`) is used;
    + 			this is due to SMTP limits as described by
    + 			https://www.ietf.org/rfc/rfc5322.txt.
    + --
    +@@ Documentation/git-send-email.adoc: Information
    + 	Instead of the normal operation, dump the shorthand alias names from
    + 	the configured alias file(s), one per line in alphabetical order. Note
    + 	that this only includes the alias name and not its expanded email addresses.
    +-	See 'sendemail.aliasesFile' for more information about aliases.
    ++	See `sendemail.aliasesFile` for more information about aliases.
    + 
    + --translate-aliases::
    + 	Instead of the normal operation, read from standard input and
    + 	interpret each line as an email alias. Translate it according to the
    + 	configured alias file(s). Output each translated name and email
    +-	address to standard output, one per line. See 'sendemail.aliasFile'
    ++	address to standard output, one per line. See `sendemail.aliasFile`
    + 	for more information about aliases.
    + 
    + CONFIGURATION
     @@ Documentation/git-send-email.adoc: edit `~/.gitconfig` to specify your account settings:
      ----
      
2:  a05958c7aa = 3:  4916bde9e5 docs: remove credential helper links for emails from gitcredentials
3:  e2dd5d9d81 = 4:  66c75485e2 docs: make the purpose of using app password for Gmail more clear in send-email
-- 
2.49.0.639.ge2dd5d9d81


^ permalink raw reply	[flat|nested] 52+ messages in thread

* [PATCH v7 1/4] docs: add credential helper for yahoo and link Google's sendgmail tool
  2025-05-30 15:50 ` [PATCH v7 0/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
@ 2025-05-30 15:50   ` Aditya Garg
  2025-05-30 15:50   ` [PATCH v7 2/4] docs: improve formatting in git-send-email documentation Aditya Garg
                     ` (2 subsequent siblings)
  3 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 15:50 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin, Ben Knoble

This commit links `git-credential-yahoo` as a credential helper for
Yahoo accounts. Also, Google's `sendgmail` tool has been linked as an
alternative method for sending emails through Gmail.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/git-send-email.adoc | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 26fda63c2f..81f8cbc6f3 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -543,6 +543,10 @@ settings:
 	smtpAuth = OAUTHBEARER
 ----
 
+Alternatively, you can use a tool developed by Google known as
+https://github.com/google/gmail-oauth2-tools/tree/master/go/sendgmail[sendgmail]
+to send emails using `git send-email`.
+
 Use Microsoft Outlook as the SMTP Server
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
@@ -579,8 +583,7 @@ next time.
 
 If you are using OAuth2.0 authentication, you need to use an access token in
 place of a password when prompted. Various OAuth2.0 token generators are
-available online. Community maintained credential helpers for Gmail and Outlook
-are also available:
+available online. Community maintained credential helpers are also available:
 
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail]
 	  (cross platform, dedicated helper for authenticating Gmail accounts)
@@ -588,6 +591,9 @@ are also available:
 	- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook]
 	  (cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
 
+	- https://github.com/AdityaGarg8/git-credential-email[git-credential-yahoo]
+	  (cross platform, dedicated helper for authenticating Yahoo accounts)
+
 You can also see linkgit:gitcredentials[7] for more OAuth based authentication
 helpers.
 
-- 
2.49.0.639.ge2dd5d9d81


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v7 2/4] docs: improve formatting in git-send-email documentation
  2025-05-30 15:50 ` [PATCH v7 0/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
  2025-05-30 15:50   ` [PATCH v7 1/4] " Aditya Garg
@ 2025-05-30 15:50   ` Aditya Garg
  2025-05-30 15:50   ` [PATCH v7 3/4] docs: remove credential helper links for emails from gitcredentials Aditya Garg
  2025-05-30 15:50   ` [PATCH v7 4/4] docs: make the purpose of using app password for Gmail more clear in send-email Aditya Garg
  3 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 15:50 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin, Ben Knoble

The current documentation for git-send-email had an inconsistent use of
"", ``, and '' for quoting. This commit improves the formatting by
using the same style throughout the documentation. Missing full stops
have also been added at some places.

Finally, the cpan links of necessary perl modules have been added to
make their installation easier.

While at it, the unecessary use of $ with <num> and <int> placeholders
has also been removed.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/config/sendemail.adoc |  20 +--
 Documentation/git-send-email.adoc   | 232 ++++++++++++++--------------
 2 files changed, 130 insertions(+), 122 deletions(-)

diff --git a/Documentation/config/sendemail.adoc b/Documentation/config/sendemail.adoc
index 5ffcfc9f2a..54f1248e64 100644
--- a/Documentation/config/sendemail.adoc
+++ b/Documentation/config/sendemail.adoc
@@ -1,32 +1,32 @@
 sendemail.identity::
 	A configuration identity. When given, causes values in the
-	'sendemail.<identity>' subsection to take precedence over
-	values in the 'sendemail' section. The default identity is
+	`sendemail.<identity>` subsection to take precedence over
+	values in the `sendemail` section. The default identity is
 	the value of `sendemail.identity`.
 
 sendemail.smtpEncryption::
 	See linkgit:git-send-email[1] for description.  Note that this
-	setting is not subject to the 'identity' mechanism.
+	setting is not subject to the `identity` mechanism.
 
 sendemail.smtpSSLCertPath::
 	Path to ca-certificates (either a directory or a single file).
 	Set it to an empty string to disable certificate verification.
 
 sendemail.<identity>.*::
-	Identity-specific versions of the 'sendemail.*' parameters
+	Identity-specific versions of the `sendemail.*` parameters
 	found below, taking precedence over those when this
 	identity is selected, through either the command-line or
 	`sendemail.identity`.
 
 sendemail.multiEdit::
-	If true (default), a single editor instance will be spawned to edit
+	If `true` (default), a single editor instance will be spawned to edit
 	files you have to edit (patches when `--annotate` is used, and the
-	summary when `--compose` is used). If false, files will be edited one
+	summary when `--compose` is used). If `false`, files will be edited one
 	after the other, spawning a new editor each time.
 
 sendemail.confirm::
 	Sets the default for whether to confirm before sending. Must be
-	one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm`
+	one of `always`, `never`, `cc`, `compose`, or `auto`. See `--confirm`
 	in the linkgit:git-send-email[1] documentation for the meaning of these
 	values.
 
@@ -51,7 +51,7 @@ sendemail.aliasesFile::
 
 sendemail.aliasFileType::
 	Format of the file(s) specified in sendemail.aliasesFile. Must be
-	one of 'mutt', 'mailrc', 'pine', 'elm', 'gnus', or 'sendmail'.
+	one of `mutt`, `mailrc`, `pine`, `elm`, `gnus`, or `sendmail`.
 +
 What an alias file in each format looks like can be found in
 the documentation of the email program of the same name. The
@@ -101,7 +101,7 @@ sendemail.signedOffCc (deprecated)::
 
 sendemail.smtpBatchSize::
 	Number of messages to be sent per connection, after that a relogin
-	will happen.  If the value is 0 or undefined, send all messages in
+	will happen.  If the value is `0` or undefined, send all messages in
 	one connection.
 	See also the `--batch-size` option of linkgit:git-send-email[1].
 
@@ -111,5 +111,5 @@ sendemail.smtpReloginDelay::
 
 sendemail.forbidSendmailVariables::
 	To avoid common misconfiguration mistakes, linkgit:git-send-email[1]
-	will abort with a warning if any configuration options for "sendmail"
+	will abort with a warning if any configuration options for `sendmail`
 	exist. Set this variable to bypass the check.
diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 81f8cbc6f3..5d13a856a7 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -21,7 +21,7 @@ Takes the patches given on the command line and emails them out.
 Patches can be specified as files, directories (which will send all
 files in the directory), or directly as a revision list.  In the
 last case, any format accepted by linkgit:git-format-patch[1] can
-be passed to git send-email, as well as options understood by
+be passed to `git send-email`, as well as options understood by
 linkgit:git-format-patch[1].
 
 The header of the email is configurable via command-line options.  If not
@@ -35,11 +35,11 @@ There are two formats accepted for patch files:
 This is what linkgit:git-format-patch[1] generates.  Most headers and MIME
 formatting are ignored.
 
-2. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl'
+2. The original format used by Greg Kroah-Hartman's `send_lots_of_email.pl`
    script
 +
-This format expects the first line of the file to contain the "Cc:" value
-and the "Subject:" of the message as the second line.
+This format expects the first line of the file to contain the `Cc:` value
+and the `Subject:` of the message as the second line.
 
 
 OPTIONS
@@ -54,13 +54,13 @@ Composing
 	`sendemail.multiEdit`.
 
 --bcc=<address>,...::
-	Specify a "Bcc:" value for each email. Default is the value of
+	Specify a `Bcc:` value for each email. Default is the value of
 	`sendemail.bcc`.
 +
 This option may be specified multiple times.
 
 --cc=<address>,...::
-	Specify a starting "Cc:" value for each email.
+	Specify a starting `Cc:` value for each email.
 	Default is the value of `sendemail.cc`.
 +
 This option may be specified multiple times.
@@ -69,14 +69,14 @@ This option may be specified multiple times.
 	Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
 	to edit an introductory message for the patch series.
 +
-When `--compose` is used, git send-email will use the From, To, Cc, Bcc,
-Subject, Reply-To, and In-Reply-To headers specified in the message. If
-the body of the message (what you type after the headers and a blank
-line) only contains blank (or Git: prefixed) lines, the summary won't be
+When `--compose` is used, `git send-email` will use the `From`, `To`, `Cc`,
+`Bcc`, `Subject`, `Reply-To`, and `In-Reply-To` headers specified in the
+message. If the body of the message (what you type after the headers and a
+blank line) only contains blank (or `Git:` prefixed) lines, the summary won't be
 sent, but the headers mentioned above will be used unless they are
 removed.
 +
-Missing From or In-Reply-To headers will be prompted for.
+Missing `From` or `In-Reply-To` headers will be prompted for.
 +
 See the CONFIGURATION section for `sendemail.multiEdit`.
 
@@ -85,13 +85,13 @@ See the CONFIGURATION section for `sendemail.multiEdit`.
 	the value of the `sendemail.from` configuration option is used.  If
 	neither the command-line option nor `sendemail.from` are set, then the
 	user will be prompted for the value.  The default for the prompt will be
-	the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
-	set, as returned by "git var -l".
+	the value of `GIT_AUTHOR_IDENT`, or `GIT_COMMITTER_IDENT` if that is not
+	set, as returned by `git var -l`.
 
 --reply-to=<address>::
 	Specify the address where replies from recipients should go to.
 	Use this if replies to messages should go to another address than what
-	is specified with the --from parameter.
+	is specified with the `--from` parameter.
 
 --in-reply-to=<identifier>::
 	Make the first mail (or all the mails with `--no-thread`) appear as a
@@ -112,14 +112,14 @@ illustration below where `[PATCH v2 0/3]` is in reply to `[PATCH 0/2]`:
       [PATCH v2 2/3] New tests
       [PATCH v2 3/3] Implementation
 +
-Only necessary if --compose is also set.  If --compose
+Only necessary if `--compose` is also set.  If `--compose`
 is not set, this will be prompted for.
 
 --[no-]outlook-id-fix::
 	Microsoft Outlook SMTP servers discard the Message-ID sent via email and
 	assign a new random Message-ID, thus breaking threads.
 +
-With `--outlook-id-fix`, 'git send-email' uses a mechanism specific to
+With `--outlook-id-fix`, `git send-email` uses a mechanism specific to
 Outlook servers to learn the Message-ID the server assigned to fix the
 threading. Use it only when you know that the server reports the
 rewritten Message-ID the same way as Outlook servers do.
@@ -130,14 +130,14 @@ to 'smtp.office365.com' or 'smtp-mail.outlook.com'. Use
 
 --subject=<string>::
 	Specify the initial subject of the email thread.
-	Only necessary if --compose is also set.  If --compose
+	Only necessary if `--compose` is also set.  If `--compose`
 	is not set, this will be prompted for.
 
 --to=<address>,...::
 	Specify the primary recipient of the emails generated. Generally, this
 	will be the upstream maintainer of the project involved. Default is the
 	value of the `sendemail.to` configuration value; if that is unspecified,
-	and --to-cmd is not specified, this will be prompted for.
+	and `--to-cmd` is not specified, this will be prompted for.
 +
 This option may be specified multiple times.
 
@@ -145,30 +145,30 @@ This option may be specified multiple times.
 	When encountering a non-ASCII message or subject that does not
 	declare its encoding, add headers/quoting to indicate it is
 	encoded in <encoding>.  Default is the value of the
-	'sendemail.assume8bitEncoding'; if that is unspecified, this
+	`sendemail.assume8bitEncoding`; if that is unspecified, this
 	will be prompted for if any non-ASCII files are encountered.
 +
 Note that no attempts whatsoever are made to validate the encoding.
 
 --compose-encoding=<encoding>::
 	Specify encoding of compose message. Default is the value of the
-	'sendemail.composeEncoding'; if that is unspecified, UTF-8 is assumed.
+	`sendemail.composeEncoding`; if that is unspecified, UTF-8 is assumed.
 
 --transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)::
 	Specify the transfer encoding to be used to send the message over SMTP.
-	7bit will fail upon encountering a non-ASCII message.  quoted-printable
+	`7bit` will fail upon encountering a non-ASCII message. `quoted-printable`
 	can be useful when the repository contains files that contain carriage
-	returns, but makes the raw patch email file (as saved from a MUA) much
-	harder to inspect manually.  base64 is even more fool proof, but also
-	even more opaque.  auto will use 8bit when possible, and quoted-printable
-	otherwise.
+	returns, but makes the raw patch email file (as saved from an MUA) much
+	harder to inspect manually. `base64` is even more fool proof, but also
+	even more opaque. `auto` will use `8bit` when possible, and
+	`quoted-printable` otherwise.
 +
 Default is the value of the `sendemail.transferEncoding` configuration
 value; if that is unspecified, default to `auto`.
 
 --xmailer::
 --no-xmailer::
-	Add (or prevent adding) the "X-Mailer:" header.  By default,
+	Add (or prevent adding) the `X-Mailer:` header.  By default,
 	the header is added, but it can be turned off by setting the
 	`sendemail.xmailer` configuration variable to `false`.
 
@@ -178,9 +178,9 @@ Sending
 --envelope-sender=<address>::
 	Specify the envelope sender used to send the emails.
 	This is useful if your default address is not the address that is
-	subscribed to a list. In order to use the 'From' address, set the
-	value to "auto". If you use the sendmail binary, you must have
-	suitable privileges for the -f parameter.  Default is the value of the
+	subscribed to a list. In order to use the `From` address, set the
+	value to `auto`. If you use the `sendmail` binary, you must have
+	suitable privileges for the `-f` parameter.  Default is the value of the
 	`sendemail.envelopeSender` configuration variable; if that is
 	unspecified, choosing the envelope sender is left to your MTA.
 
@@ -189,27 +189,27 @@ Sending
 	be sendmail-like; specifically, it must support the `-i` option.
 	The command will be executed in the shell if necessary.  Default
 	is the value of `sendemail.sendmailCmd`.  If unspecified, and if
-	--smtp-server is also unspecified, git-send-email will search
-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH.
+	`--smtp-server` is also unspecified, `git send-email` will search
+	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH`.
 
 --smtp-encryption=<encryption>::
 	Specify in what way encrypting begins for the SMTP connection.
-	Valid values are 'ssl' and 'tls'. Any other value reverts to plain
+	Valid values are `ssl` and `tls`. Any other value reverts to plain
 	(unencrypted) SMTP, which defaults to port 25.
 	Despite the names, both values will use the same newer version of TLS,
-	but for historic reasons have these names. 'ssl' refers to "implicit"
+	but for historic reasons have these names. `ssl` refers to "implicit"
 	encryption (sometimes called SMTPS), that uses port 465 by default.
-	'tls' refers to "explicit" encryption (often known as STARTTLS),
+	`tls` refers to "explicit" encryption (often known as STARTTLS),
 	that uses port 25 by default. Other ports might be used by the SMTP
 	server, which are not the default. Commonly found alternative port for
-	'tls' and unencrypted is 587. You need to check your provider's
+	`tls` and unencrypted is 587. You need to check your provider's
 	documentation or your server configuration to make sure
 	for your own case. Default is the value of `sendemail.smtpEncryption`.
 
 --smtp-domain=<FQDN>::
 	Specifies the Fully Qualified Domain Name (FQDN) used in the
 	HELO/EHLO command to the SMTP server.  Some servers require the
-	FQDN to match your IP address.  If not set, git send-email attempts
+	FQDN to match your IP address.  If not set, `git send-email` attempts
 	to determine your FQDN automatically.  Default is the value of
 	`sendemail.smtpDomain`.
 
@@ -223,10 +223,10 @@ $ git send-email --smtp-auth="PLAIN LOGIN GSSAPI" ...
 +
 If at least one of the specified mechanisms matches the ones advertised by the
 SMTP server and if it is supported by the utilized SASL library, the mechanism
-is used for authentication. If neither 'sendemail.smtpAuth' nor `--smtp-auth`
+is used for authentication. If neither `sendemail.smtpAuth` nor `--smtp-auth`
 is specified, all mechanisms supported by the SASL library can be used. The
-special value 'none' maybe specified to completely disable authentication
-independently of `--smtp-user`
+special value `none` maybe specified to completely disable authentication
+independently of `--smtp-user`.
 
 --smtp-pass[=<password>]::
 	Password for SMTP-AUTH. The argument is optional: If no
@@ -238,16 +238,16 @@ Furthermore, passwords need not be specified in configuration files
 or on the command line. If a username has been specified (with
 `--smtp-user` or a `sendemail.smtpUser`), but no password has been
 specified (with `--smtp-pass` or `sendemail.smtpPass`), then
-a password is obtained using 'git-credential'.
+a password is obtained using linkgit:git-credential[1].
 
 --no-smtp-auth::
-	Disable SMTP authentication. Short hand for `--smtp-auth=none`
+	Disable SMTP authentication. Short hand for `--smtp-auth=none`.
 
 --smtp-server=<host>::
 	If set, specifies the outgoing SMTP server to use (e.g.
 	`smtp.example.com` or a raw IP address).  If unspecified, and if
 	`--sendmail-cmd` is also unspecified, the default is to search
-	for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH if such a
+	for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH` if such a
 	program is available, falling back to `localhost` otherwise.
 +
 For backward compatibility, this option can also specify a full pathname
@@ -260,7 +260,7 @@ instead.
 	Specifies a port different from the default port (SMTP
 	servers typically listen to smtp port 25, but may also listen to
 	submission port 587, or the common SSL smtp port 465);
-	symbolic port names (e.g. "submission" instead of 587)
+	symbolic port names (e.g. `submission` instead of 587)
 	are also accepted. The port can also be set with the
 	`sendemail.smtpServerPort` configuration variable.
 
@@ -269,17 +269,17 @@ instead.
 	Default value can be specified by the `sendemail.smtpServerOption`
 	configuration option.
 +
-The --smtp-server-option option must be repeated for each option you want
+The `--smtp-server-option` option must be repeated for each option you want
 to pass to the server. Likewise, different lines in the configuration files
 must be used for each option.
 
 --smtp-ssl::
-	Legacy alias for '--smtp-encryption ssl'.
+	Legacy alias for `--smtp-encryption ssl`.
 
 --smtp-ssl-cert-path::
 	Path to a store of trusted CA certificates for SMTP SSL/TLS
 	certificate validation (either a directory that has been processed
-	by 'c_rehash', or a single file containing one or more PEM format
+	by `c_rehash`, or a single file containing one or more PEM format
 	certificates concatenated together: see verify(1) -CAfile and
 	-CApath for more information on these). Set it to an empty string
 	to disable certificate verification. Defaults to the value of the
@@ -298,18 +298,18 @@ must be used for each option.
 	connection and authentication problems.
 
 --batch-size=<num>::
-	Some email servers (e.g. smtp.163.com) limit the number emails to be
+	Some email servers (e.g. 'smtp.163.com') limit the number of emails to be
 	sent per session (connection) and this will lead to a failure when
 	sending many messages.  With this option, send-email will disconnect after
-	sending $<num> messages and wait for a few seconds (see --relogin-delay)
-	and reconnect, to work around such a limit.  You may want to
-	use some form of credential helper to avoid having to retype
-	your password every time this happens.  Defaults to the
+	sending _<num>_ messages and wait for a few seconds
+	(see `--relogin-delay`) and reconnect, to work around such a limit.
+	You may want to use some form of credential helper to avoid having to
+	retype your password every time this happens.  Defaults to the
 	`sendemail.smtpBatchSize` configuration variable.
 
 --relogin-delay=<int>::
-	Waiting $<int> seconds before reconnecting to SMTP server. Used together
-	with --batch-size option.  Defaults to the `sendemail.smtpReloginDelay`
+	Waiting _<int>_ seconds before reconnecting to SMTP server. Used together
+	with `--batch-size` option.  Defaults to the `sendemail.smtpReloginDelay`
 	configuration variable.
 
 Automating
@@ -318,7 +318,7 @@ Automating
 --no-to::
 --no-cc::
 --no-bcc::
-	Clears any list of "To:", "Cc:", "Bcc:" addresses previously
+	Clears any list of `To:`, `Cc:`, `Bcc:` addresses previously
 	set via config.
 
 --no-identity::
@@ -327,13 +327,13 @@ Automating
 
 --to-cmd=<command>::
 	Specify a command to execute once per patch file which
-	should generate patch file specific "To:" entries.
+	should generate patch file specific `To:` entries.
 	Output of this command must be single email address per line.
-	Default is the value of 'sendemail.toCmd' configuration value.
+	Default is the value of `sendemail.toCmd` configuration value.
 
 --cc-cmd=<command>::
 	Specify a command to execute once per patch file which
-	should generate patch file specific "Cc:" entries.
+	should generate patch file specific `Cc:` entries.
 	Output of this command must be single email address per line.
 	Default is the value of `sendemail.ccCmd` configuration value.
 
@@ -341,7 +341,7 @@ Automating
 	Specify a command that is executed once per outgoing message
 	and output RFC 2822 style header lines to be inserted into
 	them. When the `sendemail.headerCmd` configuration variable is
-	set, its value is always used. When --header-cmd is provided
+	set, its value is always used. When `--header-cmd` is provided
 	at the command line, its value takes precedence over the
 	`sendemail.headerCmd` configuration variable.
 
@@ -350,7 +350,7 @@ Automating
 
 --[no-]chain-reply-to::
 	If this is set, each email will be sent as a reply to the previous
-	email sent.  If disabled with "--no-chain-reply-to", all emails after
+	email sent.  If disabled with `--no-chain-reply-to`, all emails after
 	the first will be sent as replies to the first email sent.  When using
 	this, it is recommended that the first file given be an overview of the
 	entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
@@ -358,79 +358,80 @@ Automating
 
 --identity=<identity>::
 	A configuration identity. When given, causes values in the
-	'sendemail.<identity>' subsection to take precedence over
-	values in the 'sendemail' section. The default identity is
+	`sendemail.<identity>` subsection to take precedence over
+	values in the `sendemail` section. The default identity is
 	the value of `sendemail.identity`.
 
 --[no-]signed-off-by-cc::
-	If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
-	cc list. Default is the value of `sendemail.signedOffByCc` configuration
-	value; if that is unspecified, default to --signed-off-by-cc.
+	If this is set, add emails found in the `Signed-off-by` trailer or `Cc:`
+	lines to the cc list. Default is the value of `sendemail.signedOffByCc`
+	configuration value; if that is unspecified, default to
+	`--signed-off-by-cc`.
 
 --[no-]cc-cover::
-	If this is set, emails found in Cc: headers in the first patch of
+	If this is set, emails found in `Cc:` headers in the first patch of
 	the series (typically the cover letter) are added to the cc list
-	for each email set. Default is the value of 'sendemail.ccCover'
-	configuration value; if that is unspecified, default to --no-cc-cover.
+	for each email set. Default is the value of `sendemail.ccCover`
+	configuration value; if that is unspecified, default to `--no-cc-cover`.
 
 --[no-]to-cover::
-	If this is set, emails found in To: headers in the first patch of
+	If this is set, emails found in `To:` headers in the first patch of
 	the series (typically the cover letter) are added to the to list
-	for each email set. Default is the value of 'sendemail.toCover'
-	configuration value; if that is unspecified, default to --no-to-cover.
+	for each email set. Default is the value of `sendemail.toCover`
+	configuration value; if that is unspecified, default to `--no-to-cover`.
 
 --suppress-cc=<category>::
 	Specify an additional category of recipients to suppress the
 	auto-cc of:
 +
 --
-- 'author' will avoid including the patch author.
-- 'self' will avoid including the sender.
-- 'cc' will avoid including anyone mentioned in Cc lines in the patch header
-  except for self (use 'self' for that).
-- 'bodycc' will avoid including anyone mentioned in Cc lines in the
-  patch body (commit message) except for self (use 'self' for that).
-- 'sob' will avoid including anyone mentioned in the Signed-off-by trailers except
-  for self (use 'self' for that).
-- 'misc-by' will avoid including anyone mentioned in Acked-by,
+- `author` will avoid including the patch author.
+- `self` will avoid including the sender.
+- `cc` will avoid including anyone mentioned in Cc lines in the patch header
+  except for self (use `self` for that).
+- `bodycc` will avoid including anyone mentioned in Cc lines in the
+  patch body (commit message) except for self (use `self` for that).
+- `sob` will avoid including anyone mentioned in the Signed-off-by trailers except
+  for self (use `self` for that).
+- `misc-by` will avoid including anyone mentioned in Acked-by,
   Reviewed-by, Tested-by and other "-by" lines in the patch body,
-  except Signed-off-by (use 'sob' for that).
-- 'cccmd' will avoid running the --cc-cmd.
-- 'body' is equivalent to 'sob' + 'bodycc' + 'misc-by'.
-- 'all' will suppress all auto cc values.
+  except Signed-off-by (use `sob` for that).
+- `cccmd` will avoid running the --cc-cmd.
+- `body` is equivalent to `sob` + `bodycc` + `misc-by`.
+- `all` will suppress all auto cc values.
 --
 +
 Default is the value of `sendemail.suppressCc` configuration value; if
-that is unspecified, default to 'self' if --suppress-from is
-specified, as well as 'body' if --no-signed-off-cc is specified.
+that is unspecified, default to `self` if `--suppress-from` is
+specified, as well as `body` if `--no-signed-off-cc` is specified.
 
 --[no-]suppress-from::
-	If this is set, do not add the From: address to the cc: list.
+	If this is set, do not add the `From:` address to the `Cc:` list.
 	Default is the value of `sendemail.suppressFrom` configuration
-	value; if that is unspecified, default to --no-suppress-from.
+	value; if that is unspecified, default to `--no-suppress-from`.
 
 --[no-]thread::
-	If this is set, the In-Reply-To and References headers will be
+	If this is set, the `In-Reply-To` and `References` headers will be
 	added to each email sent.  Whether each mail refers to the
-	previous email (`deep` threading per 'git format-patch'
+	previous email (`deep` threading per `git format-patch`
 	wording) or to the first email (`shallow` threading) is
-	governed by "--[no-]chain-reply-to".
+	governed by `--[no-]chain-reply-to`.
 +
-If disabled with "--no-thread", those headers will not be added
-(unless specified with --in-reply-to).  Default is the value of the
+If disabled with `--no-thread`, those headers will not be added
+(unless specified with `--in-reply-to`).  Default is the value of the
 `sendemail.thread` configuration value; if that is unspecified,
-default to --thread.
+default to `--thread`.
 +
 It is up to the user to ensure that no In-Reply-To header already
-exists when 'git send-email' is asked to add it (especially note that
-'git format-patch' can be configured to do the threading itself).
+exists when `git send-email` is asked to add it (especially note that
+`git format-patch` can be configured to do the threading itself).
 Failure to do so may not produce the expected result in the
 recipient's MUA.
 
 --[no-]mailmap::
 	Use the mailmap file (see linkgit:gitmailmap[5]) to map all
 	addresses to their canonical real name and email address. Additional
-	mailmap data specific to git-send-email may be provided using the
+	mailmap data specific to `git send-email` may be provided using the
 	`sendemail.mailmap.file` or `sendemail.mailmap.blob` configuration
 	values. Defaults to `sendemail.mailmap`.
 
@@ -441,17 +442,17 @@ Administering
 	Confirm just before sending:
 +
 --
-- 'always' will always confirm before sending
-- 'never' will never confirm before sending
-- 'cc' will confirm before sending when send-email has automatically
-  added addresses from the patch to the Cc list
-- 'compose' will confirm before sending the first message when using --compose.
-- 'auto' is equivalent to 'cc' + 'compose'
+- `always` will always confirm before sending.
+- `never` will never confirm before sending.
+- `cc` will confirm before sending when send-email has automatically
+  added addresses from the patch to the Cc list.
+- `compose` will confirm before sending the first message when using --compose.
+- `auto` is equivalent to `cc` + `compose`.
 --
 +
 Default is the value of `sendemail.confirm` configuration value; if that
-is unspecified, default to 'auto' unless any of the suppress options
-have been specified, in which case default to 'compose'.
+is unspecified, default to `auto` unless any of the suppress options
+have been specified, in which case default to `compose`.
 
 --dry-run::
 	Do everything except actually send the emails.
@@ -460,10 +461,10 @@ have been specified, in which case default to 'compose'.
 	When an argument may be understood either as a reference or as a file name,
 	choose to understand it as a format-patch argument (`--format-patch`)
 	or as a file name (`--no-format-patch`). By default, when such a conflict
-	occurs, git send-email will fail.
+	occurs, `git send-email` will fail.
 
 --quiet::
-	Make git-send-email less verbose.  One line per email should be
+	Make `git send-email` less verbose.  One line per email should be
 	all that is output.
 
 --[no-]validate::
@@ -474,7 +475,7 @@ have been specified, in which case default to 'compose'.
 		*	Invoke the sendemail-validate hook if present (see linkgit:githooks[5]).
 		*	Warn of patches that contain lines longer than
 			998 characters unless a suitable transfer encoding
-			('auto', 'base64', or 'quoted-printable') is used;
+			(`auto`, `base64`, or `quoted-printable`) is used;
 			this is due to SMTP limits as described by
 			https://www.ietf.org/rfc/rfc5322.txt.
 --
@@ -493,13 +494,13 @@ Information
 	Instead of the normal operation, dump the shorthand alias names from
 	the configured alias file(s), one per line in alphabetical order. Note
 	that this only includes the alias name and not its expanded email addresses.
-	See 'sendemail.aliasesFile' for more information about aliases.
+	See `sendemail.aliasesFile` for more information about aliases.
 
 --translate-aliases::
 	Instead of the normal operation, read from standard input and
 	interpret each line as an email alias. Translate it according to the
 	configured alias file(s). Output each translated name and email
-	address to standard output, one per line. See 'sendemail.aliasFile'
+	address to standard output, one per line. See `sendemail.aliasFile`
 	for more information about aliases.
 
 CONFIGURATION
@@ -525,7 +526,7 @@ edit `~/.gitconfig` to specify your account settings:
 ----
 
 If you have multi-factor authentication set up on your Gmail account, you can
-generate an app-specific password for use with 'git send-email'. Visit
+generate an app-specific password for use with `git send-email`. Visit
 https://security.google.com/settings/security/apppasswords to create it.
 
 You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
@@ -599,9 +600,16 @@ helpers.
 
 Note: the following core Perl modules that may be installed with your
 distribution of Perl are required:
-MIME::Base64, MIME::QuotedPrint, Net::Domain and Net::SMTP.
+
+https://metacpan.org/pod/MIME::Base64[MIME::Base64],
+https://metacpan.org/pod/MIME::QuotedPrint[MIME::QuotedPrint],
+https://metacpan.org/pod/Net::Domain[Net::Domain] and
+https://metacpan.org/pod/Net::SMTP[Net::SMTP].
+
 These additional Perl modules are also required:
-Authen::SASL and Mail::Address.
+
+https://metacpan.org/pod/Authen::SASL[Authen::SASL] and
+https://metacpan.org/pod/Mail::Address[Mail::Address].
 
 
 SEE ALSO
-- 
2.49.0.639.ge2dd5d9d81


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v7 3/4] docs: remove credential helper links for emails from gitcredentials
  2025-05-30 15:50 ` [PATCH v7 0/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
  2025-05-30 15:50   ` [PATCH v7 1/4] " Aditya Garg
  2025-05-30 15:50   ` [PATCH v7 2/4] docs: improve formatting in git-send-email documentation Aditya Garg
@ 2025-05-30 15:50   ` Aditya Garg
  2025-05-30 15:50   ` [PATCH v7 4/4] docs: make the purpose of using app password for Gmail more clear in send-email Aditya Garg
  3 siblings, 0 replies; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 15:50 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin, Ben Knoble

In a recent attempt to add links of email helpers to git-scm.com [1], I
came to a conclusion that the links in the gitcredentials page are meant
for people needing credential helpers for cloning, fetching and pushing
repositories to remote hosts, and not sending emails. gitcredentials
docs don't even talk about send emails, thus confirming this view.

So, lets remove these links from the gitcredentials page. The links are
still available in the git-send-email documentation, which is the right
place for them.

[1]: https://github.com/git/git-scm.com/pull/2005

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/gitcredentials.adoc | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/Documentation/gitcredentials.adoc b/Documentation/gitcredentials.adoc
index b49923db02..3337bb475d 100644
--- a/Documentation/gitcredentials.adoc
+++ b/Documentation/gitcredentials.adoc
@@ -133,10 +133,6 @@ Popular helpers with OAuth support include:
 
     - https://github.com/hickford/git-credential-oauth[git-credential-oauth] (cross platform, included in many Linux distributions)
 
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail] (cross platform, dedicated helper to authenticate Gmail accounts for linkgit:git-send-email[1])
-
-    - https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook] (cross platform, dedicated helper to authenticate Microsoft Outlook accounts for linkgit:git-send-email[1])
-
 CREDENTIAL CONTEXTS
 -------------------
 
-- 
2.49.0.639.ge2dd5d9d81


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* [PATCH v7 4/4] docs: make the purpose of using app password for Gmail more clear in send-email
  2025-05-30 15:50 ` [PATCH v7 0/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
                     ` (2 preceding siblings ...)
  2025-05-30 15:50   ` [PATCH v7 3/4] docs: remove credential helper links for emails from gitcredentials Aditya Garg
@ 2025-05-30 15:50   ` Aditya Garg
  2025-05-30 17:28     ` Junio C Hamano
  3 siblings, 1 reply; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 15:50 UTC (permalink / raw)
  To: Junio C Hamano, git@vger.kernel.org
  Cc: Julian Swagemakers, Eric Sunshine, Zi Yao, Kristoffer Haugsbakk,
	sandals@crustytoothpaste.net, Johannes Schindelin, Ben Knoble

The current example for Gmail suggests using app passwords for
send-email if user has multi-factor authentication set up for their
account. However, it does not clarify that the user cannot use their
normal password in case they do not have multi-factor authentication
enabled. Most likely the example was written in the days when Google
allowed using normal passwords without multi-factor authentication.

Clarify that regular passwords do not work for Gmail and app-passwords
are the only way for basic authentication. Also encourage users to use
OAuth2.0 as a more secure alternative.

While at it, also prefer using the word "mechanism" over "method" for
`OAUTHBEARER` and `XOAUTH2` since that is what official docs use.

Signed-off-by: Aditya Garg <gargaditya08@live.com>
---
 Documentation/git-send-email.adoc | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 5d13a856a7..7bd09c254b 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -525,15 +525,18 @@ edit `~/.gitconfig` to specify your account settings:
 	smtpServerPort = 587
 ----
 
+Gmail does not allow using your regular password for `git send-email`.
 If you have multi-factor authentication set up on your Gmail account, you can
 generate an app-specific password for use with `git send-email`. Visit
 https://security.google.com/settings/security/apppasswords to create it.
 
-You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
-`XOAUTH2` are common methods used for this type of authentication. Gmail
-supports both of them. As an example, if you want to use `OAUTHBEARER`, edit
-your `~/.gitconfig` file and add `smtpAuth = OAUTHBEARER` to your account
-settings:
+Alternatively, instead of using an app-specific password, you can use
+OAuth2.0 authentication with Gmail. OAuth2.0 is more secure than
+app-specific passwords, and works regardless of whether you have multi-factor
+authentication set up. `OAUTHBEARER` and `XOAUTH2` are common mechanisms used
+for this type of authentication. Gmail supports both of them. As an example,
+if you want to use `OAUTHBEARER`, edit your `~/.gitconfig` file and add
+`smtpAuth = OAUTHBEARER` to your account settings:
 
 ----
 [sendemail]
@@ -544,7 +547,7 @@ settings:
 	smtpAuth = OAUTHBEARER
 ----
 
-Alternatively, you can use a tool developed by Google known as
+Another alternative is using a tool developed by Google known as
 https://github.com/google/gmail-oauth2-tools/tree/master/go/sendgmail[sendgmail]
 to send emails using `git send-email`.
 
@@ -552,7 +555,7 @@ Use Microsoft Outlook as the SMTP Server
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
 Therefore, OAuth2.0 authentication must be used for Outlook. Also, it only
-supports `XOAUTH2` authentication method.
+supports `XOAUTH2` authentication mechanism.
 
 Edit `~/.gitconfig` to specify your account settings for Outlook and use its
 SMTP server with `git send-email`:
-- 
2.49.0.639.ge2dd5d9d81


^ permalink raw reply related	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 2/4] docs: improve formatting in git-send-email documentation
  2025-05-30 13:32           ` Aditya Garg
@ 2025-05-30 17:15             ` Junio C Hamano
  2025-05-30 17:19               ` Aditya Garg
  0 siblings, 1 reply; 52+ messages in thread
From: Junio C Hamano @ 2025-05-30 17:15 UTC (permalink / raw)
  To: Aditya Garg
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin

Aditya Garg <gargaditya08@live.com> writes:

>> But I do not see any link in ...
>> 
>>>>> -    by 'c_rehash', or a single file containing one or more PEM format
>>>>> -    certificates concatenated together: see verify(1) -CAfile and
>>>>> -    -CApath for more information on these). Set it to an empty string
>> 
>> ... the text that was removed.  The reference to verify(1) is a
>> command in the OpenSSL suite, right?
>
> If this is a command, its not phrased nicely imo. I'll just leave it as is.

In any case, there isn't an link in the document that is dangling,
is there?  It is not like I am trying to prove you wrong.  I am
trying to see if the change you made is still addressing a valid
concern, and if so if there is a way to make the result better,
possibly in some other ways.

I agree with you that this passage is not nice to expect that the
readers are familiar with what appears in

    https://docs.openssl.org/master/man1/openssl-verify/

where `-CAfile` and `-CApath` are two of the command line options
described there and has "more information on these".  The
description of these options on that page redirects us to

    https://docs.openssl.org/master/man1/openssl-verification-options/

and expects us to scroll down to #trusted-certificate-options
anchor, which is doubly unnice, but that part is not a fault of our
own documentation ;-).

Perhaps something like this would clarify the description?

 Documentation/git-send-email.adoc | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git c/Documentation/git-send-email.adoc w/Documentation/git-send-email.adoc
index 7f223db42d..53f30fccf9 100644
--- c/Documentation/git-send-email.adoc
+++ w/Documentation/git-send-email.adoc
@@ -267,8 +267,10 @@ must be used for each option.
 	Path to a store of trusted CA certificates for SMTP SSL/TLS
 	certificate validation (either a directory that has been processed
 	by 'c_rehash', or a single file containing one or more PEM format
-	certificates concatenated together: see verify(1) -CAfile and
-	-CApath for more information on these). Set it to an empty string
+	certificates concatenated together: see the description of the
+	`-CAfile` _<file>_ and the `-CApath` _<dir>_ options of OpenSSL's
+	`verify(1)` manual page for more information on these).
+	Set it to an empty string
 	to disable certificate verification. Defaults to the value of the
 	`sendemail.smtpSSLCertPath` configuration variable, if set, or the
 	backing SSL library's compiled-in default otherwise (which should



^ permalink raw reply related	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 2/4] docs: improve formatting in git-send-email documentation
  2025-05-30 17:15             ` Junio C Hamano
@ 2025-05-30 17:19               ` Aditya Garg
  2025-05-30 21:55                 ` Junio C Hamano
  0 siblings, 1 reply; 52+ messages in thread
From: Aditya Garg @ 2025-05-30 17:19 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin



On 30/05/25 10:45 pm, Junio C Hamano wrote:
> Aditya Garg <gargaditya08@live.com> writes:
> 
>>> But I do not see any link in ...
>>>
>>>>>> -    by 'c_rehash', or a single file containing one or more PEM format
>>>>>> -    certificates concatenated together: see verify(1) -CAfile and
>>>>>> -    -CApath for more information on these). Set it to an empty string
>>>
>>> ... the text that was removed.  The reference to verify(1) is a
>>> command in the OpenSSL suite, right?
>>
>> If this is a command, its not phrased nicely imo. I'll just leave it as is.
> 
> In any case, there isn't an link in the document that is dangling,
> is there?  It is not like I am trying to prove you wrong.  I am
> trying to see if the change you made is still addressing a valid
> concern, and if so if there is a way to make the result better,
> possibly in some other ways.
> 
> I agree with you that this passage is not nice to expect that the
> readers are familiar with what appears in
> 
>     https://docs.openssl.org/master/man1/openssl-verify/
> 
> where `-CAfile` and `-CApath` are two of the command line options
> described there and has "more information on these".  The
> description of these options on that page redirects us to
> 
>     https://docs.openssl.org/master/man1/openssl-verification-options/
> 
> and expects us to scroll down to #trusted-certificate-options
> anchor, which is doubly unnice, but that part is not a fault of our
> own documentation ;-).
> 
> Perhaps something like this would clarify the description?

Thats definitely much better. Although, not really in the scope
of this patch series ;)

Maybe you could just append this alongwith v7 (the latest version
of this patch series at the time of writing)?

> 
>  Documentation/git-send-email.adoc | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git c/Documentation/git-send-email.adoc w/Documentation/git-send-email.adoc
> index 7f223db42d..53f30fccf9 100644
> --- c/Documentation/git-send-email.adoc
> +++ w/Documentation/git-send-email.adoc
> @@ -267,8 +267,10 @@ must be used for each option.
>  	Path to a store of trusted CA certificates for SMTP SSL/TLS
>  	certificate validation (either a directory that has been processed
>  	by 'c_rehash', or a single file containing one or more PEM format
> -	certificates concatenated together: see verify(1) -CAfile and
> -	-CApath for more information on these). Set it to an empty string
> +	certificates concatenated together: see the description of the
> +	`-CAfile` _<file>_ and the `-CApath` _<dir>_ options of OpenSSL's
> +	`verify(1)` manual page for more information on these).
> +	Set it to an empty string
>  	to disable certificate verification. Defaults to the value of the
>  	`sendemail.smtpSSLCertPath` configuration variable, if set, or the
>  	backing SSL library's compiled-in default otherwise (which should
> 
> 


^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v7 4/4] docs: make the purpose of using app password for Gmail more clear in send-email
  2025-05-30 15:50   ` [PATCH v7 4/4] docs: make the purpose of using app password for Gmail more clear in send-email Aditya Garg
@ 2025-05-30 17:28     ` Junio C Hamano
  0 siblings, 0 replies; 52+ messages in thread
From: Junio C Hamano @ 2025-05-30 17:28 UTC (permalink / raw)
  To: Aditya Garg
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin, Ben Knoble

Aditya Garg <gargaditya08@live.com> writes:

> +Gmail does not allow using your regular password for `git send-email`.
>  If you have multi-factor authentication set up on your Gmail account, you can
>  generate an app-specific password for use with `git send-email`. Visit
>  https://security.google.com/settings/security/apppasswords to create it.
>  
> -You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
> -`XOAUTH2` are common methods used for this type of authentication. Gmail
> -supports both of them. As an example, if you want to use `OAUTHBEARER`, edit
> -your `~/.gitconfig` file and add `smtpAuth = OAUTHBEARER` to your account
> -settings:
> +Alternatively, instead of using an app-specific password, you can use
> +OAuth2.0 authentication with Gmail. OAuth2.0 is more secure than
> +app-specific passwords, and works regardless of whether you have multi-factor
> +authentication set up.

Thanks.  Much nicer.

^ permalink raw reply	[flat|nested] 52+ messages in thread

* Re: [PATCH v5 2/4] docs: improve formatting in git-send-email documentation
  2025-05-30 17:19               ` Aditya Garg
@ 2025-05-30 21:55                 ` Junio C Hamano
  0 siblings, 0 replies; 52+ messages in thread
From: Junio C Hamano @ 2025-05-30 21:55 UTC (permalink / raw)
  To: Aditya Garg
  Cc: git@vger.kernel.org, Julian Swagemakers, Eric Sunshine, Zi Yao,
	Kristoffer Haugsbakk, sandals@crustytoothpaste.net,
	Johannes Schindelin

Aditya Garg <gargaditya08@live.com> writes:

> Thats definitely much better. Although, not really in the scope
> of this patch series ;)

I agree.  As you decided not to touch this part with your series, it
is perfectly fine to leave it as-is.  Your series is not making this
part any worse that way.

^ permalink raw reply	[flat|nested] 52+ messages in thread

end of thread, other threads:[~2025-05-30 21:55 UTC | newest]

Thread overview: 52+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-05-13 18:28 [PATCH] docs: add instructions to use Yahoo with send-mail Aditya Garg
2025-05-13 18:33 ` Aditya Garg
2025-05-13 18:42   ` Junio C Hamano
2025-05-13 18:51     ` Aditya Garg
2025-05-13 19:36       ` Aditya Garg
2025-05-14 12:58 ` Junio C Hamano
2025-05-14 13:05   ` Aditya Garg
2025-05-15 10:29 ` [PATCH v2 0/2] docs: update email credential helpers Aditya Garg
2025-05-15 10:29   ` [PATCH v2 1/2] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
2025-05-15 10:29   ` [PATCH v2 2/2] docs: remove credential helper links for emails from gitcredentials Aditya Garg
2025-05-18  7:34   ` [PATCH v3 0/3] docs: update email credential helpers and improve formatting Aditya Garg
2025-05-18  7:35     ` [PATCH v3 1/3] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
2025-05-18  7:36     ` [PATCH v3 2/3] docs: improve formatting in git-send-email documentation Aditya Garg
2025-05-18  7:36     ` [PATCH v3 3/3] docs: remove credential helper links for emails from gitcredentials Aditya Garg
2025-05-19 12:51 ` [PATCH v4 0/3] docs: update email credential helpers and improve formatting Aditya Garg
2025-05-19 12:52   ` [PATCH v4 1/3] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
2025-05-19 12:52   ` [PATCH v4 2/3] docs: improve formatting in git-send-email documentation Aditya Garg
2025-05-19 12:53   ` [PATCH v4 3/3] docs: remove credential helper links for emails from gitcredentials Aditya Garg
2025-05-19 18:26   ` [PATCH v4 0/3] docs: update email credential helpers and improve formatting Junio C Hamano
2025-05-19 18:29     ` Aditya Garg
2025-05-28  7:05 ` [PATCH v5 0/4] " Aditya Garg
2025-05-28  7:05   ` [PATCH v5 1/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
2025-05-28  7:05   ` [PATCH v5 2/4] docs: improve formatting in git-send-email documentation Aditya Garg
2025-05-29 18:15     ` Junio C Hamano
2025-05-29 19:04       ` Aditya Garg
2025-05-30 13:28         ` Junio C Hamano
2025-05-30 13:32           ` Aditya Garg
2025-05-30 17:15             ` Junio C Hamano
2025-05-30 17:19               ` Aditya Garg
2025-05-30 21:55                 ` Junio C Hamano
2025-05-30 14:48           ` Ben Knoble
2025-05-30 14:51             ` Aditya Garg
2025-05-28  7:05   ` [PATCH v5 3/4] docs: remove credential helper links for emails from gitcredentials Aditya Garg
2025-05-28  7:05   ` [PATCH v5 4/4] docs: make the purpose of using app password for Gmail more clear in send-email Aditya Garg
2025-05-29 18:50     ` Junio C Hamano
2025-05-29 19:06       ` Aditya Garg
2025-05-28  7:23   ` [PATCH v5 0/4] docs: update email credential helpers and improve formatting Eric Sunshine
2025-05-28  9:36     ` Aditya Garg
2025-05-28  9:42       ` Aditya Garg
2025-05-28 10:05         ` Aditya Garg
2025-05-28 10:10       ` Aditya Garg
2025-05-30 11:37 ` [PATCH v6 " Aditya Garg
2025-05-30 11:37   ` [PATCH v6 1/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
2025-05-30 11:37   ` [PATCH v6 2/4] docs: improve formatting in git-send-email documentation Aditya Garg
2025-05-30 11:37   ` [PATCH v6 3/4] docs: remove credential helper links for emails from gitcredentials Aditya Garg
2025-05-30 11:37   ` [PATCH v6 4/4] docs: make the purpose of using app password for Gmail more clear in send-email Aditya Garg
2025-05-30 15:50 ` [PATCH v7 0/4] docs: add credential helper for yahoo and link Google's sendgmail tool Aditya Garg
2025-05-30 15:50   ` [PATCH v7 1/4] " Aditya Garg
2025-05-30 15:50   ` [PATCH v7 2/4] docs: improve formatting in git-send-email documentation Aditya Garg
2025-05-30 15:50   ` [PATCH v7 3/4] docs: remove credential helper links for emails from gitcredentials Aditya Garg
2025-05-30 15:50   ` [PATCH v7 4/4] docs: make the purpose of using app password for Gmail more clear in send-email Aditya Garg
2025-05-30 17:28     ` Junio C Hamano

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).