From ab25d680aa9b0bdc1bb5e691cb53e52efa9c3a41 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Fri, 18 Aug 2023 09:45:56 +0200 Subject: contributor-guide: submit-changes: develop sending patches section (From yocto-docs rev: 0cfb8417236a8a82eebe7901bc24164227cfe4b2) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/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 -- cgit v1.2.3-54-g00ecf