git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Vivan Garg <gvivan6@gmail.com>
To: git@vger.kernel.org
Cc: vdye@github.com, nasamuffin@google.com, Vivan Garg <gvivan6@gmail.com>
Subject: [PATCH v3] MyFirstContribution: add note about SMTP server config
Date: Thu, 23 Feb 2023 01:27:59 -0700	[thread overview]
Message-ID: <20230223082759.36021-1-gvivan6@gmail.com> (raw)
In-Reply-To: <20230222011317.97943-1-gvivan6@gmail.com>

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]).

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
-- 
2.37.0 (Apple Git-136)


  parent reply	other threads:[~2023-02-23  8:28 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-02-22  1:13 [PATCH] Documentation/MyFirstContribution: add setup template for git send-email Vivan Garg
2023-02-22 21:18 ` Victoria Dye
2023-02-23  4:09   ` Vivan Garg
2023-02-23  5:40 ` [PATCH v2 0/1] MyFirstContribution: add note about SMTP server config Vivan Garg
2023-02-23  5:40   ` [PATCH v2 1/1] " Vivan Garg
2023-02-23  6:23     ` Victoria Dye
2023-02-23  6:24   ` [PATCH v2 0/1] " Victoria Dye
2023-02-23  6:47     ` Vivan Garg
2023-02-23  8:27 ` Vivan Garg [this message]
2023-02-23  8:45   ` [PATCH v3] " Benson Muite
2023-02-23  9:20     ` Vivan Garg
2023-02-23 10:37       ` Benson Muite
2023-02-26  0:49         ` Vivan Garg
2023-02-26 13:19         ` Bagas Sanjaya
2023-02-26 13:07   ` Bagas Sanjaya

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=20230223082759.36021-1-gvivan6@gmail.com \
    --to=gvivan6@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=nasamuffin@google.com \
    --cc=vdye@github.com \
    /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).