ref-manual: Added warning for nativesdk recipe naming convention

Fixes [YOCTO #11411]

To help clear up the importance of the naming convention a user
must follow when creating a nativesdk-myrecipe.bb recipe that
inherits the nativesdk class, I placed a warning note at the end
of the section for the "nativesdk.bbclass" section.

(From yocto-docs rev: e6dc512aaeb0267c2c15c17a599c6950728b4547)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 8 insertions, 0 deletions

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 8f25c521c6..8fc0449ff9 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -2258,6 +2258,14 @@
                 functionality specific to the respective SDK machine or target
                 case.</para></listitem>
         </itemizedlist>
+        <note><title>Warning</title>
+            When creating a recipe, you must follow this naming convention:
+            <literallayout class='monospaced'>
+     nativesdk-<replaceable>myrecipe</replaceable>.bb
+            </literallayout>
+            Not doing so can lead to subtle problems because code exists
+            that depends on the naming convention.
+        </note>
     </para>
 
     <para>