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@xxxxxxxxx>
---
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@xxxxxxxxx>
@@ 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)
