diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-08-18 18:07:30 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-08-30 15:54:59 +0100 |
commit | c6f0512d227dd5ae6ed5922263eb62a907b83dcd (patch) | |
tree | aa599f9704d4d811f165249933281aa4f3406494 /documentation/contributor-guide | |
parent | a878e1591bcd8dc31fac0e9abd61aeb6af9b6440 (diff) | |
download | poky-c6f0512d227dd5ae6ed5922263eb62a907b83dcd.tar.gz |
contributor-guide: submit-changes: improvements to mailing lists section
- Add missing reference to openembedded-devel list
- Improve the text to clarify explanations, remove redundant information
and include information currently on
http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
(From yocto-docs rev: a359be596138d0454c7596ccbfd48f7ad307980a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/contributor-guide')
-rw-r--r-- | documentation/contributor-guide/submit-changes.rst | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 3098a76a6c..31674d313d 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst | |||
@@ -328,14 +328,16 @@ Finding a Suitable Mailing List | |||
328 | You should send patches to the appropriate mailing list so that they can be | 328 | You should send patches to the appropriate mailing list so that they can be |
329 | reviewed by the right contributors and merged by the appropriate maintainer. | 329 | reviewed by the right contributors and merged by the appropriate maintainer. |
330 | The specific mailing list you need to use depends on the location of the code | 330 | The specific mailing list you need to use depends on the location of the code |
331 | you are changing. Each component (e.g. layer) should have a ``README`` file | 331 | you are changing. |
332 | that indicates where to send the changes and which process to follow. | ||
333 | 332 | ||
334 | If people have concerns with any of the patches, they will usually voice | 333 | If people have concerns with any of the patches, they will usually voice |
335 | their concern over the mailing list. If patches do not receive any negative | 334 | their concern over the mailing list. If patches do not receive any negative |
336 | reviews, the maintainer of the affected layer typically takes them, tests them, | 335 | reviews, the maintainer of the affected layer typically takes them, tests them, |
337 | and then based on successful testing, merges them. | 336 | and then based on successful testing, merges them. |
338 | 337 | ||
338 | In general, each component (e.g. layer) should have a ``README`` file | ||
339 | that indicates where to send the changes and which process to follow. | ||
340 | |||
339 | The "poky" repository, which is the Yocto Project's reference build | 341 | The "poky" repository, which is the Yocto Project's reference build |
340 | environment, is a hybrid repository that contains several individual | 342 | environment, is a hybrid repository that contains several individual |
341 | pieces (e.g. BitBake, Metadata, documentation, and so forth) built using | 343 | pieces (e.g. BitBake, Metadata, documentation, and so forth) built using |
@@ -358,21 +360,22 @@ varies by component: | |||
358 | - *Documentation*: For changes to the Yocto Project documentation, use the | 360 | - *Documentation*: For changes to the Yocto Project documentation, use the |
359 | :yocto_lists:`docs </g/docs>` mailing list. | 361 | :yocto_lists:`docs </g/docs>` mailing list. |
360 | 362 | ||
361 | For changes to other layers hosted in the Yocto Project source | 363 | For changes to other layers and tools hosted in the Yocto Project source |
362 | repositories (i.e. ``yoctoproject.org``) and tools use the | 364 | repositories (i.e. :yocto_git:`git.yoctoproject.org <>`), use the |
363 | :yocto_lists:`yocto </g/yocto/>` general mailing list. | 365 | :yocto_lists:`yocto </g/yocto/>` general mailing list. |
364 | 366 | ||
365 | .. note:: | 367 | For changes to other layers hosted in the OpenEmbedded source |
368 | repositories (i.e. :oe_git:`git.openembedded.org <>`), use | ||
369 | the :oe_lists:`openembedded-devel </g/openembedded-devel>` | ||
370 | mailing list, unless specified otherwise in the layer's ``README`` file. | ||
366 | 371 | ||
367 | Sometimes a layer's documentation specifies to use a particular | 372 | If you intend to submit a new recipe that neither fits into the core Metadata, |
368 | mailing list. If so, use that list. | 373 | nor into :oe_git:`meta-openembedded </meta-openembedded/>`, you should |
374 | look for a suitable layer in https://layers.openembedded.org. If similar | ||
375 | recipes can be expected, you may consider :ref:`dev-manual/layers:creating your own layer`. | ||
369 | 376 | ||
370 | For additional recipes that do not fit into the core Metadata, you | 377 | If in doubt, please ask on the :yocto_lists:`yocto </g/yocto/>` general mailing list |
371 | should determine which layer the recipe should go into and submit the | 378 | or on the :oe_lists:`openembedded-devel </g/openembedded-devel>` mailing list. |
372 | changes in the manner recommended by the documentation (e.g. by the | ||
373 | ``README`` file) supplied with the layer. If in doubt, please ask on the | ||
374 | :yocto_lists:`yocto </g/yocto/>` general mailing list or on the | ||
375 | :oe_lists:`openembedded-devel </g/openembedded-devel>` mailing list. | ||
376 | 379 | ||
377 | Subscribing to the Mailing List | 380 | Subscribing to the Mailing List |
378 | ------------------------------- | 381 | ------------------------------- |