ref-manual: Updated the MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS variable

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.

(From yocto-docs rev: 2c51eae23b634cdace5a119ee1a6c8e8ba76dc45)

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

1 files changed, 10 insertions, 0 deletions

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 82410941c2..93118c424a 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7510,6 +7510,16 @@ 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>
+                        In this example, the
+                        <filename>kernel-module-ab123</filename> recipe
+                        needs to explicitly set its
+                        <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>
+                        variable to ensure that BitBake does not use the
+                        kernel recipe's
+                        <link linkend='var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></link>
+                        variable to satisfy the dependency.
+                    </note>
                 </para>
 
                 <para>