[yocto] [yocto-docs][PATCH] ref-manual: Document MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS quirk

[california.l.sullivan at intel.com]

From: California Sullivan <california.l.sullivan at intel.com>

MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS won't always grab your out-of-tree
module recipe since the kernel recipe's PACKAGES_DYNAMIC variable
provides kernel-module-*. This patch documents that your out-of-tree
module needs to explicitly set its PACKAGES variable to avoid this
behavior.

Fixes [YOCTO #7591]

Signed-off-by: California Sullivan <california.l.sullivan at intel.com>
---
 documentation/ref-manual/ref-variables.xml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 8241094..6270a83 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7510,6 +7510,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     <literallayout class='monospaced'>
      MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123"
                     </literallayout>
+                    Note that in this example, <filename>kernel-module-ab123</filename>'s recipe
+                    would need to explicitly set its
+                    <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> variable
+                    to ensure that bitbake does not use the kernel recipe's
+                    <filename><link linkend='var-PACKAGES_DYNAMIC'>PACKAGES_DYNAMIC</link></filename>
+                    variable to satisfy the dependancy.
                 </para>
 
                 <para>
-- 
2.1.0