From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Jon.Mason@arm.com, JPEWhacker@gmail.com,
Michael Opdenacker <michael.opdenacker@bootlin.com>
Subject: [PATCH 05/10] contributor-guide: submit-changes: develop sending patches section
Date: Fri, 18 Aug 2023 19:10:00 +0200 [thread overview]
Message-ID: <20230818171005.92381-6-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20230818171005.92381-1-michael.opdenacker@bootlin.com>
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
.../contributor-guide/submit-changes.rst | 29 +++++++++++++------
1 file changed, 20 insertions(+), 9 deletions(-)
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 314b41bb63..afed30717b 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -340,6 +340,25 @@ Here is the general procedure on how to create patches to be sent through email:
Sending the Patches via Email
=============================
+Using Git to Send Patches
+-------------------------
+
+To submit patches through email, it is very important that you send them
+without any whitespace or HTML formatting that either you or your mailer
+introduces. The maintainer that receives your patches needs to be able
+to save and apply them directly from your emails, using the ``git am``
+command.
+
+Using the ``git send-email`` command is the only error-proof way of
+sending your patches using email since there is no risk of compromising
+whitespace in the body of the message, which can occur when you use
+your own mail client. It will also properly include your patches
+as inline attachments, which is not easy to do with standard e-mail
+clients without breaking lines.
+
+Setting up Git to Send Email
+----------------------------
+
Depending on the components changed, you need to submit the email to a
specific mailing list. For some guidance on which mailing list to use,
see the ":ref:`contributor-guide/submit-changes:finding a suitable mailing list`"
@@ -350,15 +369,7 @@ section above.
The ``git send-email`` command sends email by using a local or remote
Mail Transport Agent (MTA) such as ``msmtp``, ``sendmail``, or
- through a direct ``smtp`` configuration in your Git ``~/.gitconfig``
- file. If you are submitting patches through email only, it is very
- important that you submit them without any whitespace or HTML
- formatting that either you or your mailer introduces. The maintainer
- that receives your patches needs to be able to save and apply them
- directly from your emails. A good way to verify that what you are
- sending will be applicable by the maintainer is to do a dry run and
- send them to yourself and then save and apply them as the maintainer
- would.
+ through a direct ``smtp`` configuration in your Git ``~/.gitconfig`` file.
The ``git send-email`` command is the preferred method for sending
your patches using email since there is no risk of compromising
--
2.34.1
next prev parent reply other threads:[~2023-08-18 17:10 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-18 17:09 [PATCH 00/10] Further work on the Contributor Manual michael.opdenacker
2023-08-18 17:09 ` [PATCH 01/10] contributor-guide: move to 2nd place in top menu michael.opdenacker
2023-08-18 17:09 ` [PATCH 02/10] contributor-guide: submit-changes: simplify note michael.opdenacker
2023-08-18 17:09 ` [PATCH 03/10] contributor-guide: identify component: provide link to repositories michael.opdenacker
2023-08-18 17:09 ` [PATCH 04/10] contributor-guide: submit-changes: detail commit and patch creation michael.opdenacker
2023-08-18 17:10 ` michael.opdenacker [this message]
2023-08-18 17:10 ` [PATCH 06/10] manuals: README: update list of manuals michael.opdenacker
2023-08-18 17:10 ` [PATCH 07/10] contributor-guide: submit-changes: reorganize and develop sections michael.opdenacker
2023-08-18 17:10 ` [PATCH 08/10] contributor-guide: submit-changes: improvements to mailing lists section michael.opdenacker
2023-08-18 17:10 ` [PATCH 09/10] contributor-guide: submit-changes: commit guidelines for recipes michael.opdenacker
2023-08-18 17:10 ` [PATCH 10/10] contributor-guide: submit-changes: how to request push access to repositories michael.opdenacker
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=20230818171005.92381-6-michael.opdenacker@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=JPEWhacker@gmail.com \
--cc=Jon.Mason@arm.com \
--cc=docs@lists.yoctoproject.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