mirror of
https://git.yoctoproject.org/poky
synced 2026-05-31 00:39:46 +00:00
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>
This commit is contained in:
committed by
Richard Purdie
parent
ab25d680aa
commit
e05baab43c
@@ -34,16 +34,18 @@ Manual Organization
|
|||||||
|
|
||||||
Here the folders corresponding to individual manuals:
|
Here the folders corresponding to individual manuals:
|
||||||
|
|
||||||
|
* brief-yoctoprojectqs - Yocto Project Quick Start
|
||||||
* overview-manual - Yocto Project Overview and Concepts Manual
|
* overview-manual - Yocto Project Overview and Concepts Manual
|
||||||
* sdk-manual - Yocto Project Software Development Kit (SDK) Developer's Guide.
|
* contributor-guide - Yocto Project and OpenEmbedded Contributor Guide
|
||||||
|
* ref-manual - Yocto Project Reference Manual
|
||||||
* bsp-guide - Yocto Project Board Support Package (BSP) Developer's Guide
|
* bsp-guide - Yocto Project Board Support Package (BSP) Developer's Guide
|
||||||
* dev-manual - Yocto Project Development Tasks Manual
|
* dev-manual - Yocto Project Development Tasks Manual
|
||||||
* kernel-dev - Yocto Project Linux Kernel Development Manual
|
* kernel-dev - Yocto Project Linux Kernel Development Manual
|
||||||
* ref-manual - Yocto Project Reference Manual
|
|
||||||
* brief-yoctoprojectqs - Yocto Project Quick Start
|
|
||||||
* profile-manual - Yocto Project Profiling and Tracing Manual
|
* profile-manual - Yocto Project Profiling and Tracing Manual
|
||||||
|
* sdk-manual - Yocto Project Software Development Kit (SDK) Developer's Guide.
|
||||||
* toaster-manual - Toaster User Manual
|
* toaster-manual - Toaster User Manual
|
||||||
* test-manual - Yocto Project Test Environment Manual
|
* test-manual - Yocto Project Test Environment Manual
|
||||||
|
* migration-guides - Yocto Project Release and Migration Notes
|
||||||
|
|
||||||
Each folder is self-contained regarding content and figures.
|
Each folder is self-contained regarding content and figures.
|
||||||
|
|
||||||
|
|||||||
@@ -349,16 +349,48 @@ introduces. The maintainer that receives your patches needs to be able
|
|||||||
to save and apply them directly from your emails, using the ``git am``
|
to save and apply them directly from your emails, using the ``git am``
|
||||||
command.
|
command.
|
||||||
|
|
||||||
Using the ``git send-email`` command is the only error-proof way of
|
Using the ``git send-email`` command is the only error-proof way of sending
|
||||||
sending your patches using email since there is no risk of compromising
|
your patches using email since there is no risk of compromising whitespace
|
||||||
whitespace in the body of the message, which can occur when you use
|
in the body of the message, which can occur when you use your own mail
|
||||||
your own mail client. It will also properly include your patches
|
client. It will also properly include your patches as *inline attachments*,
|
||||||
as inline attachments, which is not easy to do with standard e-mail
|
which is not easy to do with standard e-mail clients without breaking lines.
|
||||||
clients without breaking lines.
|
If you used your regular e-mail client and shared your patches as regular
|
||||||
|
attachments, reviewers wouldn't be able to quote specific sections of your
|
||||||
|
changes and make comments about them.
|
||||||
|
|
||||||
Setting up Git to Send Email
|
Setting up Git to Send Email
|
||||||
----------------------------
|
----------------------------
|
||||||
|
|
||||||
|
The ``git send-email`` command can send 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.
|
||||||
|
|
||||||
|
Here are the settings for letting ``git send-email`` send e-mail through your
|
||||||
|
regular STMP server, using a Google Mail account as an example::
|
||||||
|
|
||||||
|
git config --global sendemail.smtpserver smtp.gmail.com
|
||||||
|
git config --global sendemail.smtpserverport 587
|
||||||
|
git config --global sendemail.smtpencryption tls
|
||||||
|
git config --global sendemail.smtpuser ada.lovelace@gmail.com
|
||||||
|
git config --global sendemail.smtppass = XXXXXXXX
|
||||||
|
|
||||||
|
These settings will appear in the ``.gitconfig`` file in your home directory.
|
||||||
|
|
||||||
|
If you neither can use a local MTA nor SMTP, make sure you use an email client
|
||||||
|
that does not touch the message (turning spaces in tabs, wrapping lines, etc.).
|
||||||
|
A good mail client to do so is Pine (or Alpine) or Mutt. For more
|
||||||
|
information about suitable clients, see `Email clients info for Linux
|
||||||
|
<https://www.kernel.org/doc/html/latest/process/email-clients.html>`__
|
||||||
|
in the Linux kernel sources.
|
||||||
|
|
||||||
|
If you use such clients, just include the patch in the body of your email.
|
||||||
|
|
||||||
|
Subscribing to Mailing Lists
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
Sending Patches via Email
|
||||||
|
-------------------------
|
||||||
|
|
||||||
Depending on the components changed, you need to submit the email to a
|
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,
|
specific mailing list. For some guidance on which mailing list to use,
|
||||||
see the ":ref:`contributor-guide/submit-changes:finding a suitable mailing list`"
|
see the ":ref:`contributor-guide/submit-changes:finding a suitable mailing list`"
|
||||||
@@ -367,10 +399,6 @@ section above.
|
|||||||
#. *Send the patches via email:* Send the patches to the recipients and
|
#. *Send the patches via email:* Send the patches to the recipients and
|
||||||
relevant mailing lists by using the ``git send-email`` command.
|
relevant mailing lists by using the ``git send-email`` command.
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
The ``git send-email`` command is the preferred method for sending
|
The ``git send-email`` command is the preferred method for sending
|
||||||
your patches using email since there is no risk of compromising
|
your patches using email since there is no risk of compromising
|
||||||
whitespace in the body of the message, which can occur when you use
|
whitespace in the body of the message, which can occur when you use
|
||||||
|
|||||||
Reference in New Issue
Block a user