2 files changed, 124 insertions, 11 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 9089ccb65c..3e176f1963 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -663,29 +663,142 @@
            </glossdef>
         </glossentry>
-         <glossentry id='var-MACHINE_ESSENTIAL_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_RDEPENDS</glossterm>
+         <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm>
            <glossdef>
-                <para>Specifies the list of packages required to boot the device.</para>
+                <para>
+                    A list of packages that must be installed as part of the package being 
+                    built in order for the 
+                    resulting image to boot on the system. 
+                    The machine depends on these items - without them it will not boot.
+                    If a package in this list cannot be found during the build, the build
+                    will not complete.
+                    Some examples of these machine essentials are flash, screen, keyboard, mouse, 
+                    or touchscreen drivers (depending on the machine).
+                </para>
+                <para>
+                    For example, suppose you are building a runtime package that depends
+                    on a mouse driver.
+                    In this case, you would use the following 
+                    <filename>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</filename>
+                    statement:
+                    <literallayout class='monospaced'>
+     MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "&lt;mouse_driver&gt;"
+                    </literallayout>
+                </para>
            </glossdef>
         </glossentry>
-         <glossentry id='var-MACHINE_ESSENTIAL_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_RRECOMMENDS</glossterm>
+         <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm>
            <glossdef>
-                <para>Specifies the list of packages required to boot the device (usually
+                <para>
-                    additional kernel modules).</para>
+                    A list of packages that must be installed as part of the package being 
+                    built in order for the 
+                    resulting image to boot on the system. 
+                    The machine depends on these items - without them it will not boot.
+                    If a package in this list cannot be found during the build, the build
+                    will not complete.
+                </para>
+                <para>
+                    This variable is similar to the 
+                    <link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link>
+                    with the exception that the package being built does not have a build 
+                    dependency on the variable's list of packages.
+                </para>
+                <para> 
+                    Someone help me out here... How can this list be "recommended" yet part 
+                    of the machine essential list?
+                    Seems to me that anything that is machine essential pretty much needs to 
+                    be there.
+                    The rest of this section needs an appropriate example.
+                </para>
+                <para>
+                    Some examples of these machine essentials are flash, screen, keyboard, mouse, 
+                    or touchscreen drivers (depending on the machine).
+                </para>
+                <para>
+                    For example, suppose you are building a runtime package that depends
+                    on a mouse driver.
+                    In this case, you would use the following 
+                    <filename>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</filename>
+                    statement:
+                    <literallayout class='monospaced'>
+     MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "&lt;mouse_driver&gt;"
+                    </literallayout>
+                </para>
            </glossdef>
        </glossentry>
         <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm>
            <glossdef>
-                <para>Specifies the list of packages required to use the devices</para>
+                <para>
+                    A list of packages that should be installed as part of the package  
+                    being built in order for the 
+                    resulting image to boot on the system and achieve full functionality. 
+                    Although the machine does not need these items in order to boot, if you want the 
+                    extra functionality they provide the package being built depends on them
+                    being there.  
+                    If a package in this list cannot be found during the build, the build
+                    will not complete.
+                </para>
+                <para>
+                    I need a real-world example here....
+                </para>
+                <para>
+                    An example of a machine extra is a WiFi driver.
+                    The machine may or may not have a WiFi card.
+                    If it does, the package with the driver needs to be present for the card to work.
+                    However, if the machine does not have a WiFi card, the machine will still boot.
+                </para>
+                <para>
+                    For example, suppose you are building a runtime package that depends
+                    on a WiFi driver.
+                    In this case, you would use the following 
+                    <filename>MACHINE_EXTRA_RDEPENDS</filename>
+                    statement:
+                    <literallayout class='monospaced'>
+     MACHINE_EXTRA_RDEPENDS += "&lt;wifi_driver&gt;"
+                    </literallayout>
+                </para>
            </glossdef>
         </glossentry>
         <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm>
            <glossdef>
-                <para>Specifies the list of packages useful to use the device (e.g.
+                <para>
-                    additional kernel modules)</para>
+                    A list of packages that should be installed as part of the package  
+                    being built in order for the 
+                    machine to boot and achieve full functionality. 
+                    Although the machine does not need these items in order to boot, if you want the 
+                    extra functionality they provide the package being built should include
+                    them.  
+                </para>
+                <para>
+                    This variable is similar to the 
+                    <link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link>
+                    with the exception that the package being built does not have a build 
+                    dependency on the variable's list of packages.
+                    If a package in this list cannot be found during the build, the build
+                    will still continue.
+                </para>
+                <para>
+                    I need a real-world example to use here please....
+                </para>
+                <para>
+                    An example of a machine extra is a WiFi driver.
+                    The machine may or may not have a WiFi card.
+                    If it does, the package with the driver needs to be present for the card to work.
+                    However, if the machine does not have a WiFi card, the machine will still boot.
+                </para>
+                <para>
+                    For example, suppose you are building a runtime package that depends
+                    on a WiFi driver.
+                    In this case, you would use the following 
+                    <filename>MACHINE_EXTRA_RDEPENDS</filename>
+                    statement:
+                    <literallayout class='monospaced'>
+     MACHINE_EXTRA_RDEPENDS += "&lt;wifi_driver&gt;"
+                    </literallayout>
+                </para>
            </glossdef>
         </glossentry>
diff --git a/documentation/poky-ref-manual/ref-varlocality.xml b/documentation/poky-ref-manual/ref-varlocality.xml
index d3d931b4d0..0a2477c123 100644
--- a/documentation/poky-ref-manual/ref-varlocality.xml
+++ b/documentation/poky-ref-manual/ref-varlocality.xml
@@ -71,10 +71,10 @@
                        </link></filename></para></listitem>
                    <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS
                        </link></filename></para></listitem>
-                    <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_RDEPENDS'>MACHINE_ESSENTIAL_RDEPENDS
+                    <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS
                        </link></filename></para></listitem>
-                    <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_RRECOMMENDS'>
+                    <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>
-                        MACHINE_ESSENTIAL_RRECOMMENDS</link></filename></para></listitem>
+                        MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename></para></listitem>
                </itemizedlist>
            </para>
        </section>

diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 9089ccb65c..3e176f1963 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -663,29 +663,142 @@
663	</glossdef>	663	</glossdef>
664	</glossentry>	664	</glossentry>
665		665
666	<glossentry id='var-MACHINE_ESSENTIAL_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_RDEPENDS</glossterm>	666	<glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm>
667	<glossdef>	667	<glossdef>
668	<para>Specifies the list of packages required to boot the device.</para>	668	<para>
		669	A list of packages that must be installed as part of the package being
		670	built in order for the
		671	resulting image to boot on the system.
		672	The machine depends on these items - without them it will not boot.
		673	If a package in this list cannot be found during the build, the build
		674	will not complete.
		675	Some examples of these machine essentials are flash, screen, keyboard, mouse,
		676	or touchscreen drivers (depending on the machine).
		677	</para>
		678	<para>
		679	For example, suppose you are building a runtime package that depends
		680	on a mouse driver.
		681	In this case, you would use the following
		682	<filename>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</filename>
		683	statement:
		684	<literallayout class='monospaced'>
		685	MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "<mouse_driver>"
		686	</literallayout>
		687	</para>
669	</glossdef>	688	</glossdef>
670	</glossentry>	689	</glossentry>
671		690
672	<glossentry id='var-MACHINE_ESSENTIAL_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_RRECOMMENDS</glossterm>	691	<glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm>
673	<glossdef>	692	<glossdef>
674	<para>Specifies the list of packages required to boot the device (usually	693	<para>
675	additional kernel modules).</para>	694	A list of packages that must be installed as part of the package being
		695	built in order for the
		696	resulting image to boot on the system.
		697	The machine depends on these items - without them it will not boot.
		698	If a package in this list cannot be found during the build, the build
		699	will not complete.
		700	</para>
		701	<para>
		702	This variable is similar to the
		703	<link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link>
		704	with the exception that the package being built does not have a build
		705	dependency on the variable's list of packages.
		706	</para>
		707	<para>
		708	Someone help me out here... How can this list be "recommended" yet part
		709	of the machine essential list?
		710	Seems to me that anything that is machine essential pretty much needs to
		711	be there.
		712	The rest of this section needs an appropriate example.
		713	</para>
		714	<para>
		715	Some examples of these machine essentials are flash, screen, keyboard, mouse,
		716	or touchscreen drivers (depending on the machine).
		717	</para>
		718	<para>
		719	For example, suppose you are building a runtime package that depends
		720	on a mouse driver.
		721	In this case, you would use the following
		722	<filename>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</filename>
		723	statement:
		724	<literallayout class='monospaced'>
		725	MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "<mouse_driver>"
		726	</literallayout>
		727	</para>
676	</glossdef>	728	</glossdef>
677	</glossentry>	729	</glossentry>
678		730
679	<glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm>	731	<glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm>
680	<glossdef>	732	<glossdef>
681	<para>Specifies the list of packages required to use the devices</para>	733	<para>
		734	A list of packages that should be installed as part of the package
		735	being built in order for the
		736	resulting image to boot on the system and achieve full functionality.
		737	Although the machine does not need these items in order to boot, if you want the
		738	extra functionality they provide the package being built depends on them
		739	being there.
		740	If a package in this list cannot be found during the build, the build
		741	will not complete.
		742	</para>
		743	<para>
		744	I need a real-world example here....
		745	</para>
		746	<para>
		747	An example of a machine extra is a WiFi driver.
		748	The machine may or may not have a WiFi card.
		749	If it does, the package with the driver needs to be present for the card to work.
		750	However, if the machine does not have a WiFi card, the machine will still boot.
		751	</para>
		752	<para>
		753	For example, suppose you are building a runtime package that depends
		754	on a WiFi driver.
		755	In this case, you would use the following
		756	<filename>MACHINE_EXTRA_RDEPENDS</filename>
		757	statement:
		758	<literallayout class='monospaced'>
		759	MACHINE_EXTRA_RDEPENDS += "<wifi_driver>"
		760	</literallayout>
		761	</para>
682	</glossdef>	762	</glossdef>
683	</glossentry>	763	</glossentry>
684		764
685	<glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm>	765	<glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm>
686	<glossdef>	766	<glossdef>
687	<para>Specifies the list of packages useful to use the device (e.g.	767	<para>
688	additional kernel modules)</para>	768	A list of packages that should be installed as part of the package
		769	being built in order for the
		770	machine to boot and achieve full functionality.
		771	Although the machine does not need these items in order to boot, if you want the
		772	extra functionality they provide the package being built should include
		773	them.
		774	</para>
		775	<para>
		776	This variable is similar to the
		777	<link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link>
		778	with the exception that the package being built does not have a build
		779	dependency on the variable's list of packages.
		780	If a package in this list cannot be found during the build, the build
		781	will still continue.
		782	</para>
		783	<para>
		784	I need a real-world example to use here please....
		785	</para>
		786	<para>
		787	An example of a machine extra is a WiFi driver.
		788	The machine may or may not have a WiFi card.
		789	If it does, the package with the driver needs to be present for the card to work.
		790	However, if the machine does not have a WiFi card, the machine will still boot.
		791	</para>
		792	<para>
		793	For example, suppose you are building a runtime package that depends
		794	on a WiFi driver.
		795	In this case, you would use the following
		796	<filename>MACHINE_EXTRA_RDEPENDS</filename>
		797	statement:
		798	<literallayout class='monospaced'>
		799	MACHINE_EXTRA_RDEPENDS += "<wifi_driver>"
		800	</literallayout>
		801	</para>
689	</glossdef>	802	</glossdef>
690	</glossentry>	803	</glossentry>
691		804


diff --git a/documentation/poky-ref-manual/ref-varlocality.xml b/documentation/poky-ref-manual/ref-varlocality.xml index d3d931b4d0..0a2477c123 100644 --- a/documentation/poky-ref-manual/ref-varlocality.xml +++ b/documentation/poky-ref-manual/ref-varlocality.xml
@@ -71,10 +71,10 @@
71	</link></filename></para></listitem>	71	</link></filename></para></listitem>
72	<listitem><para><filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS	72	<listitem><para><filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS
73	</link></filename></para></listitem>	73	</link></filename></para></listitem>
74	<listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_RDEPENDS'>MACHINE_ESSENTIAL_RDEPENDS	74	<listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS
75	</link></filename></para></listitem>	75	</link></filename></para></listitem>
76	<listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_RRECOMMENDS'>	76	<listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>
77	MACHINE_ESSENTIAL_RRECOMMENDS</link></filename></para></listitem>	77	MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename></para></listitem>
78	</itemizedlist>	78	</itemizedlist>
79	</para>	79	</para>
80	</section>	80	</section>