diff mbox series

[v2,06/56] contributor-guide/submit-changes.rst: remove obsolete poky repo references

Message ID 20260127-remove-poky-references-v2-6-74bf80cc4e5a@bootlin.com
State New
Headers show
Series Remove obsolete poky repo references | expand

Commit Message

Antonin Godard Jan. 27, 2026, 8:19 a.m. UTC 
Remove references to the Poky repository, replace by OpenEmbedded-Core
in most cases.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/contributor-guide/submit-changes.rst | 57 ++++++----------------
 1 file changed, 14 insertions(+), 43 deletions(-)

Comments

Quentin Schulz Jan. 27, 2026, 1:37 p.m. UTC | #1 
Hi Antonin,

On 1/27/26 9:19 AM, Antonin Godard via lists.yoctoproject.org wrote:
> Remove references to the Poky repository, replace by OpenEmbedded-Core
> in most cases.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/contributor-guide/submit-changes.rst | 57 ++++++----------------
>   1 file changed, 14 insertions(+), 43 deletions(-)
> 
> diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
> index 07989d7b6..4a4c60b41 100644
> --- a/documentation/contributor-guide/submit-changes.rst
> +++ b/documentation/contributor-guide/submit-changes.rst
> @@ -429,37 +429,6 @@ and then based on successful testing, merges them.
>   In general, each component (e.g. layer) should have a ``README`` file
>   that indicates where to send the changes and which process to follow.
>   
> -The "poky" repository, which is the Yocto Project's reference build
> -environment, is a hybrid repository that contains several individual
> -pieces (e.g. BitBake, Metadata, documentation, and so forth) built using
> -the combo-layer tool. The upstream location used for submitting changes
> -varies by component:
> -
> --  *Core Metadata:* Send your patches to the
> -   :oe_lists:`openembedded-core </g/openembedded-core>`
> -   mailing list. For example, a change to anything under the ``meta`` or
> -   ``scripts`` directories should be sent to this mailing list.
> -
> --  *BitBake:* For changes to BitBake (i.e. anything under the
> -   ``bitbake`` directory), send your patches to the
> -   :oe_lists:`bitbake-devel </g/bitbake-devel>`
> -   mailing list.
> -
> --  *meta-poky* and *meta-yocto-bsp* trees: These trees contain Metadata. Use the
> -   :yocto_lists:`poky </g/poky>` mailing list.
> -
> --  *Documentation*: For changes to the Yocto Project documentation, use the
> -   :yocto_lists:`docs </g/docs>` mailing list.
> -
> -For changes to other layers and tools hosted in the Yocto Project source
> -repositories (i.e. :yocto_git:`git.yoctoproject.org <>`), use the
> -:yocto_lists:`yocto-patches </g/yocto-patches/>` general mailing list.
> -
> -For changes to other layers hosted in the OpenEmbedded source
> -repositories (i.e. :oe_git:`git.openembedded.org <>`), use
> -the :oe_lists:`openembedded-devel </g/openembedded-devel>`
> -mailing list, unless specified otherwise in the layer's ``README`` file.
> -
>   If you intend to submit a new recipe that neither fits into the core Metadata,

In this patch, we just removed what we meant by Core Metadata, so now 
this can be quite confusing. Should we simply state OpenEmbedded-Core?

Also, how does one knows if the recipe can fit into OE-Core? (we do have 
some rules as to what's acceptable, must be a direct and default 
dependency of some other recipe in OE-Core, or with a demonstrable 
valuable benefit for OE-Core).

[...]

> @@ -857,14 +825,17 @@ used testing branches for OpenEmbedded-Core are as follows:
>      :oe_git:`openembedded-core </openembedded-core/>` repository and contains
>      proposed changes to the core metadata.
>   
> --  *poky "master-next" branch:* This branch is part of the
> -   :yocto_git:`poky </poky/>` repository and combines proposed
> -   changes to BitBake, the core metadata and the poky distro.
> +- *bitbake "master-next" branch:* This branch is part of the :oe_git:`bitbake
> +  </bitbake/>` repository and contains changes to :term:`BitBake`.
> +

Missing a (second) whitespace after - in the first line and a third 
whitespace in the second line.

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 07989d7b6..4a4c60b41 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -429,37 +429,6 @@  and then based on successful testing, merges them.
 In general, each component (e.g. layer) should have a ``README`` file
 that indicates where to send the changes and which process to follow.
 
-The "poky" repository, which is the Yocto Project's reference build
-environment, is a hybrid repository that contains several individual
-pieces (e.g. BitBake, Metadata, documentation, and so forth) built using
-the combo-layer tool. The upstream location used for submitting changes
-varies by component:
-
--  *Core Metadata:* Send your patches to the
-   :oe_lists:`openembedded-core </g/openembedded-core>`
-   mailing list. For example, a change to anything under the ``meta`` or
-   ``scripts`` directories should be sent to this mailing list.
-
--  *BitBake:* For changes to BitBake (i.e. anything under the
-   ``bitbake`` directory), send your patches to the
-   :oe_lists:`bitbake-devel </g/bitbake-devel>`
-   mailing list.
-
--  *meta-poky* and *meta-yocto-bsp* trees: These trees contain Metadata. Use the
-   :yocto_lists:`poky </g/poky>` mailing list.
-
--  *Documentation*: For changes to the Yocto Project documentation, use the
-   :yocto_lists:`docs </g/docs>` mailing list.
-
-For changes to other layers and tools hosted in the Yocto Project source
-repositories (i.e. :yocto_git:`git.yoctoproject.org <>`), use the
-:yocto_lists:`yocto-patches </g/yocto-patches/>` general mailing list.
-
-For changes to other layers hosted in the OpenEmbedded source
-repositories (i.e. :oe_git:`git.openembedded.org <>`), use
-the :oe_lists:`openembedded-devel </g/openembedded-devel>`
-mailing list, unless specified otherwise in the layer's ``README`` file.
-
 If you intend to submit a new recipe that neither fits into the core Metadata,
 nor into :oe_git:`meta-openembedded </meta-openembedded/>`, you should
 look for a suitable layer in https://layers.openembedded.org. If similar
@@ -620,7 +589,7 @@  have been followed:
    methods to find out:
 
    -  *Maintenance File:* Examine the ``maintainers.inc`` file, which is
-      located in the :term:`Source Directory` at
+      located in :term:`OpenEmbedded-Core (OE-Core)` at
       ``meta/conf/distro/include``, to see who is responsible for code.
 
    -  *Search by File:* Using :ref:`overview-manual/development-environment:git`, you can
@@ -645,9 +614,8 @@  have been followed:
    The Yocto Project provides two scripts that conveniently let you
    generate and send pull requests to the Yocto Project. These scripts
    are ``create-pull-request`` and ``send-pull-request``. You can find
-   these scripts in the ``scripts`` directory within the
-   :term:`Source Directory` (e.g.
-   ``poky/scripts``).
+   these scripts in the ``scripts`` directory within
+   :term:`OpenEmbedded-Core (OE-Core)`.
 
    Using these scripts correctly formats the requests without
    introducing any whitespace or HTML formatting. The maintainer that
@@ -660,7 +628,7 @@  have been followed:
    directory into which you pushed the change, and provides a subject
    line in the created patch files::
 
-      $ poky/scripts/create-pull-request -u meta-intel-contrib -s "Updated Manual Section Reference in README"
+      $ ./scripts/create-pull-request -u meta-intel-contrib -s "Updated Manual Section Reference in README"
 
    Running this script forms ``*.patch`` files in a folder named
    ``pull-``\ `PID` in the current directory. One of the patch files is a
@@ -673,7 +641,7 @@  have been followed:
    and email address. In this example, the email address is a mailing
    list::
 
-      $ poky/scripts/send-pull-request -p ~/meta-intel/pull-10565 -t meta-intel@lists.yoctoproject.org
+      $ ./scripts/send-pull-request -p ~/meta-intel/pull-10565 -t meta-intel@lists.yoctoproject.org
 
    You need to follow the prompts as the script is interactive.
 
@@ -682,8 +650,8 @@  have been followed:
       For help on using these scripts, simply provide the ``-h``
       argument as follows::
 
-              $ poky/scripts/create-pull-request -h
-              $ poky/scripts/send-pull-request -h
+              $ ./scripts/create-pull-request -h
+              $ ./scripts/send-pull-request -h
 
 Submitting Changes to Stable Release Branches
 =============================================
@@ -857,14 +825,17 @@  used testing branches for OpenEmbedded-Core are as follows:
    :oe_git:`openembedded-core </openembedded-core/>` repository and contains
    proposed changes to the core metadata.
 
--  *poky "master-next" branch:* This branch is part of the
-   :yocto_git:`poky </poky/>` repository and combines proposed
-   changes to BitBake, the core metadata and the poky distro.
+- *bitbake "master-next" branch:* This branch is part of the :oe_git:`bitbake
+  </bitbake/>` repository and contains changes to :term:`BitBake`.
+
+-  *meta-yocto "master-next" branch:* This branch is part of the
+   :yocto_git:`meta-yocto </meta-yocto/>` repository and contains proposed
+   changes to meta-yocto.
 
 Similarly, stable branches maintained by the project may have corresponding
 ``-next`` branches which collect proposed changes. For example,
 ``&DISTRO_NAME_NO_CAP;-next`` and ``&DISTRO_NAME_NO_CAP_MINUS_ONE;-next``
-branches in both the "openembdedded-core" and "poky" repositories.
+branches in both the "openembedded-core" and "meta-yocto" repositories.
 
 Other layers may have similar testing branches but there is no formal
 requirement or standard for these so please check the documentation for the