From: Junio C Hamano <gitster@pobox.com>
To: Aditya Garg <gargaditya08@live.com>
Cc: git@vger.kernel.org, M Hickford <mirth.hickford@gmail.com>,
sandals@crustytoothpaste.net,
Julian Swagemakers <julian@swagemakers.org>,
Eric Sunshine <sunshine@sunshineco.com>,
Zi Yao <ziyao@disroot.org>,
Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
Subject: Re: [PATCH v4 2/3] docs: improve send-email documentation
Date: Wed, 07 May 2025 15:21:43 -0700 [thread overview]
Message-ID: <xmqq5xicawp4.fsf@gitster.g> (raw)
In-Reply-To: <PN3PR01MB959781C8A5B990B2CCB68836B888A@PN3PR01MB9597.INDPRD01.PROD.OUTLOOK.COM> (Aditya Garg's message of "Wed, 7 May 2025 12:33:06 +0000")
> -EXAMPLES
> ---------
> -Use gmail as the smtp server
> +EXAMPLES OF SMTP SERVERS
> +------------------------
> +Use Gmail as the SMTP Server
Nice to see that you got the capitalization got right while at it.
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> -To use 'git send-email' to send your patches through the GMail SMTP server,
> -edit ~/.gitconfig to specify your account settings:
> +To use 'git send-email' to send your patches through the Gmail SMTP server,
> +edit '~/.gitconfig' to specify your account settings:
The four single quotes above should probably be changed to back
quotes, to match the "You can also use OAuth2.0..." below.
> @@ -528,6 +528,37 @@ 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. To do this, edit your
> +`~/.gitconfig` file and add `smtpAuth = OAUTHBEARER` to your account settings:
> +
> +----
> +[sendemail]
> + smtpEncryption = tls
> + smtpServer = smtp.gmail.com
> + smtpUser = yourname@gmail.com
> + smtpServerPort = 587
> + smtpAuth = OAUTHBEARER
> +----
> +
> +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.
> +
> +Edit '~/.gitconfig' to specify your account settings for Outlook and use its
> +SMTP server with 'git send-email':
> +
> +----
> +[sendemail]
> + smtpEncryption = tls
> + smtpServer = smtp.office365.com
> + smtpUser = yourname@outlook.com
> + smtpServerPort = 587
> + smtpAuth = XOAUTH2
> +----
Just for my education, the above description does say why Outlook
needs to use OAuth2.0, but does not hint the reason for the
difference between the two example, OAUTHBEARER vs XOAUTH2. Do
these two services support both, or does Gmail support only
OAUTHBEARER while Outlook supports only XOAUTH2?
Given that the former is described in RFC and the latter sometimes
described as "Proprietary Google extension, not a standard", it is
somewhat funny to see that Gmail example uses OAUTHBEARER while
Outlook example uses XOAUTH2.
> +SENDING PATCHES
> +---------------
> Once your commits are ready to be sent to the mailing list, run the
> following commands:
>
> @@ -536,9 +567,23 @@ following commands:
> $ git send-email outgoing/*
>
> The first time you run it, you will be prompted for your credentials. Enter the
> -app-specific or your regular password as appropriate. If you have credential
> -helper configured (see linkgit:git-credential[1]), the password will be saved in
> -the credential store so you won't have to type it the next time.
> +app-specific or your regular password as appropriate.
> +
> +If you have a credential helper configured (see linkgit:git-credential[1]), the
> +password will be saved in the credential store so you won't have to type it the
> +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:
> +
> + - https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail] (cross platform, dedicated helper for authenticating Gmail accounts)
> +
> + - https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook] (cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
Given that this will be formatted via AsciiDoc (or asciidoctor),
would it make sense to make it easier for readers of the source
document by folding lines, like:
- https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail]
(cross platform, dedicated helper for authenticating Gmail accounts)
- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook]
(cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
or something?
Other than that, very nicely done. Thanks.
next prev parent reply other threads:[~2025-05-07 22:21 UTC|newest]
Thread overview: 68+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-04 13:54 [PATCH 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-04 13:54 ` [PATCH 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-04 14:22 ` Kristoffer Haugsbakk
2025-05-04 15:26 ` Aditya Garg
2025-05-04 16:05 ` Kristoffer Haugsbakk
2025-05-04 13:54 ` [PATCH 2/3] docs: improve send-email documentation Aditya Garg
2025-05-04 13:54 ` [PATCH 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-05 6:16 ` [PATCH v2 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-05 6:16 ` [PATCH v2 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-05 6:16 ` [PATCH v2 2/3] docs: improve send-email documentation Aditya Garg
2025-05-05 19:20 ` Junio C Hamano
2025-05-05 19:30 ` Aditya Garg
2025-05-05 6:16 ` [PATCH v2 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-05 15:23 ` [PATCH v3 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-05 15:23 ` [PATCH v3 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-05 23:49 ` Junio C Hamano
2025-05-06 5:38 ` Aditya Garg
2025-05-06 9:35 ` Aditya Garg
2025-05-06 16:50 ` Aditya Garg
2025-05-06 21:59 ` Junio C Hamano
2025-05-06 17:11 ` Junio C Hamano
2025-05-06 17:23 ` Aditya Garg
2025-05-06 17:49 ` Aditya Garg
2025-05-06 22:07 ` Junio C Hamano
2025-05-05 15:23 ` [PATCH v3 2/3] docs: improve send-email documentation Aditya Garg
2025-05-05 23:54 ` Junio C Hamano
2025-05-06 5:36 ` Aditya Garg
2025-05-05 15:23 ` [PATCH v3 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-07 12:33 ` [PATCH v4 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-07 12:33 ` [PATCH v4 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-07 12:48 ` Aditya Garg
2025-05-07 22:42 ` Junio C Hamano
2025-05-08 10:38 ` Aditya Garg
2025-05-07 12:33 ` [PATCH v4 2/3] docs: improve send-email documentation Aditya Garg
2025-05-07 22:21 ` Junio C Hamano [this message]
2025-05-08 3:29 ` Aditya Garg
2025-05-08 13:33 ` Junio C Hamano
2025-05-08 13:52 ` Aditya Garg
2025-05-08 16:23 ` Junio C Hamano
2025-05-08 16:38 ` Aditya Garg
2025-05-08 14:52 ` Junio C Hamano
2025-05-08 15:05 ` Aditya Garg
2025-05-08 15:08 ` Aditya Garg
2025-05-07 12:33 ` [PATCH v4 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-08 15:18 ` [PATCH v6 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-08 15:18 ` [PATCH v6 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-08 15:18 ` [PATCH v6 2/3] docs: improve send-email documentation Aditya Garg
2025-05-08 15:18 ` [PATCH v6 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-08 17:14 ` [PATCH v7 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-08 17:14 ` [PATCH v7 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-08 17:14 ` [PATCH v7 2/3] docs: improve send-email documentation Aditya Garg
2025-05-08 17:14 ` [PATCH v7 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-08 18:08 ` [PATCH v7 0/3] Improve checks for valid_fqdn in send-email and update documentation Junio C Hamano
2025-05-09 16:49 ` [PATCH] send-email: try to get fqdn by running hostname --fqdn on Linux and macOS Aditya Garg
2025-05-09 20:13 ` Junio C Hamano
2025-05-10 7:37 ` [PATCH v2] " Aditya Garg
2025-05-12 7:46 ` Julian Swagemakers
2025-05-12 7:49 ` Aditya Garg
2025-05-12 16:42 ` Junio C Hamano
2025-05-12 16:46 ` Aditya Garg
2025-05-12 17:34 ` Junio C Hamano
2025-05-12 17:42 ` Aditya Garg
2025-05-12 19:05 ` Eric Sunshine
2025-05-12 20:15 ` Junio C Hamano
2025-05-13 12:28 ` Aditya Garg
2025-05-12 13:32 ` Junio C Hamano
2025-05-12 8:11 ` [PATCH v3] send-email: try to get fqdn by running hostname -f " Aditya Garg
2025-05-12 17:16 ` [PATCH v4] " Aditya Garg
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq5xicawp4.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=gargaditya08@live.com \
--cc=git@vger.kernel.org \
--cc=julian@swagemakers.org \
--cc=kristofferhaugsbakk@fastmail.com \
--cc=mirth.hickford@gmail.com \
--cc=sandals@crustytoothpaste.net \
--cc=sunshine@sunshineco.com \
--cc=ziyao@disroot.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).