diff mbox series

[v3] MyFirstContribution: add note about SMTP server config

Message ID 20230223082759.36021-1-gvivan6@gmail.com (mailing list archive)
State New, archived
Headers show
Series [v3] MyFirstContribution: add note about SMTP server config | expand

Commit Message

Vivan Garg Feb. 23, 2023, 8:27 a.m. UTC 
The documentation on using git-send-email previously mentioned the need
to configure git for your operating system and email provider, but did
not provide specific details on the relevant configuration settings.
This commit adds a note specifying that the relevant settings can be
found under the 'sendemail' section of Git's configuration file, with a
link to the relevant documentation. The aim is to provide users with a
more complete understanding of the configuration process and help them
avoid potential roadblocks in setting up git-send-email.

Signed-off-by: Vivan Garg <gvivan6@gmail.com>
---
 Documentation/MyFirstContribution.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
 
Range-diff against v2:
1:  d295b4d913 ! 1:  8710c50b1d MyFirstContribution: add note about SMTP server config
    @@ Metadata
      ## Commit message ##
         MyFirstContribution: add note about SMTP server config
     
    -    In the documentation on using git-send-email, it was noted that the configuration
    -    for sending email can vary based on your operating system and email provider.
    -    However, it was not explicitly stated that you will need to set up your SMTP
    -    server details in git's configuration file under the 'sendemail' section. This
    -    information is critical for users who are new to using git-send-email and may
    -    not be familiar with the additional setup required to use their SMTP server. By
    -    adding this note to the documentation, the aim is to provide users with a more
    -    complete understanding of the configuration process and help them avoid
    -    potential roadblocks in setting up git-send-email.
    +    The documentation on using git-send-email previously mentioned the need
    +    to configure git for your operating system and email provider, but did
    +    not provide specific details on the relevant configuration settings.
    +    This commit adds a note specifying that the relevant settings can be
    +    found under the 'sendemail' section of Git's configuration file, with a
    +    link to the relevant documentation. The aim is to provide users with a
    +    more complete understanding of the configuration process and help them
    +    avoid potential roadblocks in setting up git-send-email.
     
         Signed-off-by: Vivan Garg <gvivan6@gmail.com>
     
    @@ Documentation/MyFirstContribution.txt: typical `git` install. You may need to in
      determine the right way to configure it to use your SMTP server; again, as this
      configuration can change significantly based on your system and email setup, it
     -is out of scope for the context of this tutorial.
    -+is out of scope for the context of this tutorial. Additionally, note that you 
    -+will need to set up your SMTP server details in git's configuration file. The 
    -+relevant settings can be found under the 'sendemail' section (see 
    ++is out of scope for the context of this tutorial. The relevant settings can be 
    ++found under the 'sendemail' section of Git's configuration file. (see 
     +linkgit:git-config[1]).

Comments

Benson Muite Feb. 23, 2023, 8:45 a.m. UTC | #1 
On 2/23/23 11:27, Vivan Garg wrote:
> The documentation on using git-send-email previously mentioned the need
> to configure git for your operating system and email provider, but did
> not provide specific details on the relevant configuration settings.
> This commit adds a note specifying that the relevant settings can be
> found under the 'sendemail' section of Git's configuration file, with a
> link to the relevant documentation. The aim is to provide users with a
> more complete understanding of the configuration process and help them
> avoid potential roadblocks in setting up git-send-email.
Maybe https://git-send-email.io/ is also helpful.
Vivan Garg Feb. 23, 2023, 9:20 a.m. UTC | #2 
> Maybe https://git-send-email.io/ is also helpful.
If you look at v1 of this patch, you'll notice that I added a template with
instructions that are nearly identical to the generic ones in the link.
I was told that it doesn't work for all setups. Although there are instructions
for a few different setups, they most likely do not cover all of them? Perhaps
it's best to leave it up to the contributor to decide what to do. Also, I'm not
sure how credible the configuration settings for the other setups are.
However, if the other setups are correct, I also believe it may be beneficial.
What are your thoughts? I suppose I'd like to hear what other people think
as well? Thanks!
Benson Muite Feb. 23, 2023, 10:37 a.m. UTC | #3 
On 2/23/23 12:20, Vivan Garg wrote:
>> Maybe https://git-send-email.io/ is also helpful.
> If you look at v1 of this patch, you'll notice that I added a template with
> instructions that are nearly identical to the generic ones in the link.
> I was told that it doesn't work for all setups. Although there are instructions
> for a few different setups, they most likely do not cover all of them? Perhaps
> it's best to leave it up to the contributor to decide what to do. Also, I'm not
> sure how credible the configuration settings for the other setups are.
> However, if the other setups are correct, I also believe it may be beneficial.
> What are your thoughts? I suppose I'd like to hear what other people think
> as well? Thanks!
Have not tested all of the setups in https://git-send-email.io/ The
Fedora instructions seem fine.  It can be updated through Git, so
contributions for other setups are possible. There is a nice way to test:
https://git-send-email.io/#step-3
Vivan Garg Feb. 26, 2023, 12:49 a.m. UTC | #4 
> Have not tested all of the setups in https://git-send-email.io/ The
> Fedora instructions seem fine.  It can be updated through Git, so
> contributions for other setups are possible. There is a nice way to test:
> https://git-send-email.io/#step-3

I am waiting for someone else to offer their input on the matter. However,
I appreciate your suggestion nonetheless.
Bagas Sanjaya Feb. 26, 2023, 1:07 p.m. UTC | #5 
On 2/23/23 15:27, Vivan Garg wrote:
> @@ -1001,7 +1001,9 @@ typical `git` install. You may need to install this additional package; there
>  are a number of resources online to help you do so. You will also need to
>  determine the right way to configure it to use your SMTP server; again, as this
>  configuration can change significantly based on your system and email setup, it
> -is out of scope for the context of this tutorial.
> +is out of scope for the context of this tutorial. The relevant settings can be 
> +found under the 'sendemail' section of Git's configuration file. (see 
> +linkgit:git-config[1]).
>  

Personally said, besides above, I'd like to also add "Instructions
on how to set up sending email with git send-email can be found at
https://git-send-email.io".

Thanks.
Bagas Sanjaya Feb. 26, 2023, 1:19 p.m. UTC | #6 
On 2/23/23 17:37, Benson Muite wrote:
> Have not tested all of the setups in https://git-send-email.io/ The
> Fedora instructions seem fine.  It can be updated through Git, so
> contributions for other setups are possible. There is a nice way to test:
> https://git-send-email.io/#step-3

For me, my setup is to use Postfix as "null-client" MTA, where all
outgoing mails are relayed to Gmail. This way, configuring SMTP
credentials is delegated to the MTA and applications can be set up
to simply specifying `/usr/sbin/sendmail` as mailer.

However, in order for system-generated mails to be sent to my
real address, I have to canonicalize local `root` and `postmaster`
recipients via `recipient_canonical_maps` setting.

Thanks.
diff mbox series

Patch

diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index ccfd0cb5f3..0430434822 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -1001,7 +1001,9 @@  typical `git` install. You may need to install this additional package; there
 are a number of resources online to help you do so. You will also need to
 determine the right way to configure it to use your SMTP server; again, as this
 configuration can change significantly based on your system and email setup, it
-is out of scope for the context of this tutorial.
+is out of scope for the context of this tutorial. The relevant settings can be 
+found under the 'sendemail' section of Git's configuration file. (see 
+linkgit:git-config[1]).
 
 [[format-patch]]
 === Preparing Initial Patchset