git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v4 2/3] docs: improve send-email documentation

From
Aditya Garg <gargaditya08@live.com>
Date
May 8, 2025, 16:38 UTC
Message-ID
<PN0PR01MB9588D6EE5C0719810B836463B88BA@PN0PR01MB9588.INDPRD01.PROD.OUTLOOK.COM>
In-Reply-To
<xmqq7c2r6phg.fsf@gitster.g>
Show 64 quoted lines
> On 8 May 2025, at 9:53 PM, Junio C Hamano <gitster@pobox.com> wrote:
> 
> Aditya Garg <gargaditya08@live.com> writes:
> 
>>> "Is this something the end-user would type verbatim?" is the criteria,
>> 
>> So the end user won't type it. It's just a path of a file to be edited.
>> If you still want to change it to backticks, I'll change it. Do confirm the same btw.
>> 
>>> not "Is this a command name?".
> 
> Then perhaps 'type' -> 'use'; the idea is the same.  Are we showing
> the exact concrete thing (e.g. "file at this path, which you would
> spell `like so`") or a concept (e.g. "per-user configuration file")?
> The `literal` mark-up is for the former.
> 
>> git send email can use any smtpAuth method that is supported by Authen::SASL
>> and the server. So using XOAUTH2 with gmail will also work just fine.
> 
> OK.
> 
>> As far as giving information about supported authentication methods is concerned,
>> we are writing an example, not giving a detailed guide with the providers docs.
> 
> Yes, but giving a passing mention, like
> 
>    You can also use OAuth2.0 authentication with Gmail.  Edit
>    `~/.gitconfig` and set `sendemail.smtpAuth = OAUTHBEARER`
>    there (they support both XOAUTH2 and OAUTHBEARER, but the
>    latter is more recent and in the standard):
> 
>    ---
>    ... example here ...
>    ---    
> 
> would make it easier to see to those who learn from elsewhere that
> they can use their e-mail client (not `git send-email`) with Gmail
> with OAuth, come here because they want to use the same account with
> `git send-email` too.  If that 'elsewhere' only mentioned XOAUTH2,
> writing something like the above would be more helpful than using
> OAUTHBEARER without mentioning XOAUTH2 at all, no?
> 
>> Also, by this logic, Gmail also supports smtpAuth=LOGIN with app passwords.
> 
> But the question we need to answer is: does talking about it help
> when people want to learn how to use OAuth2.0 instead of plain
> vanilla password login?  I think talking about smtpAuth=OAUTHBEARER
> and smtpAuth=XOAUTH2 does help; does talking about smtpAuth=LOGIN
> help?
> 
> So, no, LOGIN is irrelevant, and I do not quite see the above as
> making a meaningful analogy "by this logic".
> 
>> Plus, anyone reading this guide would most likely be a newbie, who will be more
>> interested in "how to get this thing working" than knowing "oh, I can use XOAUTH2
>> as well in gmail".
> 
> I am suggeting that you can cater to both of them with minimum
> effort.  A newbie can fall into the latter class; those who used
> XOAUTH2 when setting up other software (hence they know XOAUTH2
> works with Gmail) but did not know that OAUTHBEARER also worked as
> well.
> 
> Thanks.
Alright. I'll just add some docs regarding this then
Previous: Junio C HamanoNext: Junio C Hamano
Message 40 of 68 in “Improve checks for valid_fqdn in send-email and update documentation”
  1. 0/3 Improve checks for valid_fqdn in send-email and update documentationAditya Garg, May 4, 2025
  2. 1/3 send-mail: improve checks for valid_fqdnAditya Garg, May 4, 2025
  3. Kristoffer HaugsbakkMay 4, 2025
  4. Aditya GargMay 4, 2025
  5. Kristoffer HaugsbakkMay 4, 2025
  6. 2/3 docs: improve send-email documentationAditya Garg, May 4, 2025
  7. 3/3 docs: add credential helper for outlook and gmail in OAuth list of helpersAditya Garg, May 4, 2025
  8. 0/3 Improve checks for valid_fqdn in send-email and update documentationAditya Garg, May 5, 2025
  9. 1/3 send-mail: improve checks for valid_fqdnAditya Garg, May 5, 2025
  10. 2/3 docs: improve send-email documentationAditya Garg, May 5, 2025
  11. Junio C HamanoMay 5, 2025
  12. Aditya GargMay 5, 2025
  13. 3/3 docs: add credential helper for outlook and gmail in OAuth list of helpersAditya Garg, May 5, 2025
  14. 0/3 Improve checks for valid_fqdn in send-email and update documentationAditya Garg, May 5, 2025
  15. 3/3 docs: add credential helper for outlook and gmail in OAuth list of helpersAditya Garg, May 5, 2025
  16. 1/3 send-mail: improve checks for valid_fqdnAditya Garg, May 5, 2025
  17. Junio C HamanoMay 5, 2025
  18. Aditya GargMay 6, 2025
  19. Aditya GargMay 6, 2025
  20. Aditya GargMay 6, 2025
  21. Junio C HamanoMay 6, 2025
  22. Junio C HamanoMay 6, 2025
  23. Aditya GargMay 6, 2025
  24. Aditya GargMay 6, 2025
  25. Junio C HamanoMay 6, 2025
  26. 2/3 docs: improve send-email documentationAditya Garg, May 5, 2025
  27. Junio C HamanoMay 5, 2025
  28. Aditya GargMay 6, 2025
  29. 0/3 Improve checks for valid_fqdn in send-email and update documentationAditya Garg, May 7, 2025
  30. 1/3 send-mail: improve checks for valid_fqdnAditya Garg, May 7, 2025
  31. Aditya GargMay 7, 2025
  32. Junio C HamanoMay 7, 2025
  33. Aditya GargMay 8, 2025
  34. 2/3 docs: improve send-email documentationAditya Garg, May 7, 2025
  35. Junio C HamanoMay 7, 2025
  36. Aditya GargMay 8, 2025
  37. Junio C HamanoMay 8, 2025
  38. Aditya GargMay 8, 2025
  39. Junio C HamanoMay 8, 2025
  40. Aditya GargMay 8, 2025
  41. Junio C HamanoMay 8, 2025
  42. Aditya GargMay 8, 2025
  43. Aditya GargMay 8, 2025
  44. 3/3 docs: add credential helper for outlook and gmail in OAuth list of helpersAditya Garg, May 7, 2025
  45. 0/3 Improve checks for valid_fqdn in send-email and update documentationAditya Garg, May 8, 2025
  46. 1/3 send-mail: improve checks for valid_fqdnAditya Garg, May 8, 2025
  47. 2/3 docs: improve send-email documentationAditya Garg, May 8, 2025
  48. 3/3 docs: add credential helper for outlook and gmail in OAuth list of helpersAditya Garg, May 8, 2025
  49. 0/3 Improve checks for valid_fqdn in send-email and update documentationAditya Garg, May 8, 2025
  50. 1/3 send-mail: improve checks for valid_fqdnAditya Garg, May 8, 2025
  51. 2/3 docs: improve send-email documentationAditya Garg, May 8, 2025
  52. 3/3 docs: add credential helper for outlook and gmail in OAuth list of helpersAditya Garg, May 8, 2025
  53. Junio C HamanoMay 8, 2025
  54. send-email: try to get fqdn by running hostname --fqdn on Linux and macOSAditya Garg, May 9, 2025
  55. Junio C HamanoMay 9, 2025
  56. send-email: try to get fqdn by running hostname --fqdn on Linux and macOSAditya Garg, May 10, 2025
  57. Julian SwagemakersMay 12, 2025
  58. Aditya GargMay 12, 2025
  59. Junio C HamanoMay 12, 2025
  60. Aditya GargMay 12, 2025
  61. Junio C HamanoMay 12, 2025
  62. Aditya GargMay 12, 2025
  63. Eric SunshineMay 12, 2025
  64. Junio C HamanoMay 12, 2025
  65. Aditya GargMay 13, 2025
  66. Junio C HamanoMay 12, 2025
  67. send-email: try to get fqdn by running hostname -f on Linux and macOSAditya Garg, May 12, 2025
  68. send-email: try to get fqdn by running hostname -f on Linux and macOSAditya Garg, May 12, 2025

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.