diff mbox series

[2/2] ref-manual: classes: nativesdk: move note to appropriate section

Message ID 20250606-native-options-v1-2-2ad99a184f90@cherry.de
State New
Headers show
Series ref-manual: classes: clarify native/nativesdk classes exclusive options | expand

Commit Message

Quentin Schulz June 6, 2025, 3:01 p.m. UTC 
From: Quentin Schulz <quentin.schulz@cherry.de>

The nativesdk- prefix to the recipe filename should only be used when
using the inherit method as the BBCLASSEXTEND method will do some magic
when generating the "implicit" name of the recipe.

This matches the instructions for the native class.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 documentation/ref-manual/classes.rst | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index b5121aec0f28eaaee43db107977f45d43ee45801..da2bd028d8b96f27ca222fd72358ba0b64be5126 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2082,6 +2082,16 @@  couple different ways:
    inherit statement in the recipe after all other inherit statements so
    that the :ref:`ref-classes-nativesdk` class is inherited last.
 
+   .. note::
+
+      When creating a recipe, you must follow this naming convention::
+
+              nativesdk-myrecipe.bb
+
+
+      Not doing so can lead to subtle problems because there is code that
+      depends on the naming convention.
+
 -  Or, create a :ref:`ref-classes-nativesdk` variant of any target recipe (e.g.
    ``myrecipe.bb``) by adding the following to the recipe::
 
@@ -2092,16 +2102,6 @@  couple different ways:
    specify any functionality specific to the respective SDK machine or
    target case.
 
-.. note::
-
-   When creating a recipe, you must follow this naming convention::
-
-           nativesdk-myrecipe.bb
-
-
-   Not doing so can lead to subtle problems because there is code that
-   depends on the naming convention.
-
 Although applied differently, the :ref:`ref-classes-nativesdk` class is used with both
 methods. The advantage of the second method is that you do not need to
 have two separate recipes (assuming you need both) for the SDK machine