summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-08-18 14:48:02 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-08-30 15:54:59 +0100
commite05baab43c0da21d4dbf49cd7b701698b41638ef (patch)
tree52885f68d524a807aff8a6229229af296b20d358
parentab25d680aa9b0bdc1bb5e691cb53e52efa9c3a41 (diff)
downloadpoky-e05baab43c0da21d4dbf49cd7b701698b41638ef.tar.gz
manuals: README: update list of manuals
(From yocto-docs rev: 30166df4a85a2bbd1da98440e701de72e56fa9f3) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/README8
-rw-r--r--documentation/contributor-guide/submit-changes.rst48
2 files changed, 43 insertions, 13 deletions
diff --git a/documentation/README b/documentation/README
index e8aed86eb4..4d31036e69 100644
--- a/documentation/README
+++ b/documentation/README
@@ -34,16 +34,18 @@ Manual Organization
34 34
35Here the folders corresponding to individual manuals: 35Here the folders corresponding to individual manuals:
36 36
37* brief-yoctoprojectqs - Yocto Project Quick Start
37* overview-manual - Yocto Project Overview and Concepts Manual 38* overview-manual - Yocto Project Overview and Concepts Manual
38* sdk-manual - Yocto Project Software Development Kit (SDK) Developer's Guide. 39* contributor-guide - Yocto Project and OpenEmbedded Contributor Guide
40* ref-manual - Yocto Project Reference Manual
39* bsp-guide - Yocto Project Board Support Package (BSP) Developer's Guide 41* bsp-guide - Yocto Project Board Support Package (BSP) Developer's Guide
40* dev-manual - Yocto Project Development Tasks Manual 42* dev-manual - Yocto Project Development Tasks Manual
41* kernel-dev - Yocto Project Linux Kernel Development Manual 43* kernel-dev - Yocto Project Linux Kernel Development Manual
42* ref-manual - Yocto Project Reference Manual
43* brief-yoctoprojectqs - Yocto Project Quick Start
44* profile-manual - Yocto Project Profiling and Tracing Manual 44* profile-manual - Yocto Project Profiling and Tracing Manual
45* sdk-manual - Yocto Project Software Development Kit (SDK) Developer's Guide.
45* toaster-manual - Toaster User Manual 46* toaster-manual - Toaster User Manual
46* test-manual - Yocto Project Test Environment Manual 47* test-manual - Yocto Project Test Environment Manual
48* migration-guides - Yocto Project Release and Migration Notes
47 49
48Each folder is self-contained regarding content and figures. 50Each folder is self-contained regarding content and figures.
49 51
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index afed30717b..aeef2cc90a 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -349,16 +349,48 @@ introduces. The maintainer that receives your patches needs to be able
349to save and apply them directly from your emails, using the ``git am`` 349to save and apply them directly from your emails, using the ``git am``
350command. 350command.
351 351
352Using the ``git send-email`` command is the only error-proof way of 352Using the ``git send-email`` command is the only error-proof way of sending
353sending your patches using email since there is no risk of compromising 353your patches using email since there is no risk of compromising whitespace
354whitespace in the body of the message, which can occur when you use 354in the body of the message, which can occur when you use your own mail
355your own mail client. It will also properly include your patches 355client. It will also properly include your patches as *inline attachments*,
356as inline attachments, which is not easy to do with standard e-mail 356which is not easy to do with standard e-mail clients without breaking lines.
357clients without breaking lines. 357If you used your regular e-mail client and shared your patches as regular
358attachments, reviewers wouldn't be able to quote specific sections of your
359changes and make comments about them.
358 360
359Setting up Git to Send Email 361Setting up Git to Send Email
360---------------------------- 362----------------------------
361 363
364The ``git send-email`` command can send email by using a local or remote
365Mail Transport Agent (MTA) such as ``msmtp``, ``sendmail``, or
366through a direct SMTP configuration in your Git ``~/.gitconfig`` file.
367
368Here are the settings for letting ``git send-email`` send e-mail through your
369regular STMP server, using a Google Mail account as an example::
370
371 git config --global sendemail.smtpserver smtp.gmail.com
372 git config --global sendemail.smtpserverport 587
373 git config --global sendemail.smtpencryption tls
374 git config --global sendemail.smtpuser ada.lovelace@gmail.com
375 git config --global sendemail.smtppass = XXXXXXXX
376
377These settings will appear in the ``.gitconfig`` file in your home directory.
378
379If you neither can use a local MTA nor SMTP, make sure you use an email client
380that does not touch the message (turning spaces in tabs, wrapping lines, etc.).
381A good mail client to do so is Pine (or Alpine) or Mutt. For more
382information about suitable clients, see `Email clients info for Linux
383<https://www.kernel.org/doc/html/latest/process/email-clients.html>`__
384in the Linux kernel sources.
385
386If you use such clients, just include the patch in the body of your email.
387
388Subscribing to Mailing Lists
389----------------------------
390
391Sending Patches via Email
392-------------------------
393
362Depending on the components changed, you need to submit the email to a 394Depending on the components changed, you need to submit the email to a
363specific mailing list. For some guidance on which mailing list to use, 395specific mailing list. For some guidance on which mailing list to use,
364see the ":ref:`contributor-guide/submit-changes:finding a suitable mailing list`" 396see the ":ref:`contributor-guide/submit-changes:finding a suitable mailing list`"
@@ -367,10 +399,6 @@ section above.
367#. *Send the patches via email:* Send the patches to the recipients and 399#. *Send the patches via email:* Send the patches to the recipients and
368 relevant mailing lists by using the ``git send-email`` command. 400 relevant mailing lists by using the ``git send-email`` command.
369 401
370 The ``git send-email`` command sends email by using a local or remote
371 Mail Transport Agent (MTA) such as ``msmtp``, ``sendmail``, or
372 through a direct ``smtp`` configuration in your Git ``~/.gitconfig`` file.
373
374 The ``git send-email`` command is the preferred method for sending 402 The ``git send-email`` command is the preferred method for sending
375 your patches using email since there is no risk of compromising 403 your patches using email since there is no risk of compromising
376 whitespace in the body of the message, which can occur when you use 404 whitespace in the body of the message, which can occur when you use