diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/README | 8 | ||||
-rw-r--r-- | documentation/contributor-guide/submit-changes.rst | 48 |
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 | ||
35 | Here the folders corresponding to individual manuals: | 35 | Here 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 | ||
48 | Each folder is self-contained regarding content and figures. | 50 | Each 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 | |||
349 | to save and apply them directly from your emails, using the ``git am`` | 349 | to save and apply them directly from your emails, using the ``git am`` |
350 | command. | 350 | command. |
351 | 351 | ||
352 | Using the ``git send-email`` command is the only error-proof way of | 352 | Using the ``git send-email`` command is the only error-proof way of sending |
353 | sending your patches using email since there is no risk of compromising | 353 | your patches using email since there is no risk of compromising whitespace |
354 | whitespace in the body of the message, which can occur when you use | 354 | in the body of the message, which can occur when you use your own mail |
355 | your own mail client. It will also properly include your patches | 355 | client. It will also properly include your patches as *inline attachments*, |
356 | as inline attachments, which is not easy to do with standard e-mail | 356 | which is not easy to do with standard e-mail clients without breaking lines. |
357 | clients without breaking lines. | 357 | If you used your regular e-mail client and shared your patches as regular |
358 | attachments, reviewers wouldn't be able to quote specific sections of your | ||
359 | changes and make comments about them. | ||
358 | 360 | ||
359 | Setting up Git to Send Email | 361 | Setting up Git to Send Email |
360 | ---------------------------- | 362 | ---------------------------- |
361 | 363 | ||
364 | The ``git send-email`` command can send email by using a local or remote | ||
365 | Mail Transport Agent (MTA) such as ``msmtp``, ``sendmail``, or | ||
366 | through a direct SMTP configuration in your Git ``~/.gitconfig`` file. | ||
367 | |||
368 | Here are the settings for letting ``git send-email`` send e-mail through your | ||
369 | regular 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 | |||
377 | These settings will appear in the ``.gitconfig`` file in your home directory. | ||
378 | |||
379 | If you neither can use a local MTA nor SMTP, make sure you use an email client | ||
380 | that does not touch the message (turning spaces in tabs, wrapping lines, etc.). | ||
381 | A good mail client to do so is Pine (or Alpine) or Mutt. For more | ||
382 | information about suitable clients, see `Email clients info for Linux | ||
383 | <https://www.kernel.org/doc/html/latest/process/email-clients.html>`__ | ||
384 | in the Linux kernel sources. | ||
385 | |||
386 | If you use such clients, just include the patch in the body of your email. | ||
387 | |||
388 | Subscribing to Mailing Lists | ||
389 | ---------------------------- | ||
390 | |||
391 | Sending Patches via Email | ||
392 | ------------------------- | ||
393 | |||
362 | Depending on the components changed, you need to submit the email to a | 394 | Depending on the components changed, you need to submit the email to a |
363 | specific mailing list. For some guidance on which mailing list to use, | 395 | specific mailing list. For some guidance on which mailing list to use, |
364 | see the ":ref:`contributor-guide/submit-changes:finding a suitable mailing list`" | 396 | see 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 |