ref-manual: Added new ICECC_DISABLED variable description.

(From yocto-docs rev: e1373a3824c0bc3a503451fb42087920f9607177)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 26 insertions, 1 deletions

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index f43f8e793d..5eaa5441b9 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -24,7 +24,7 @@
        <link linkend='var-FEED_DEPLOYDIR_BASE_URI'>F</link>
        <link linkend='var-GROUPADD_PARAM'>G</link>
        <link linkend='var-HOMEPAGE'>H</link>
-       <link linkend='var-ICECC_ENV_EXEC'>I</link>
+       <link linkend='var-ICECC_DISABLED'>I</link>
 <!--               <link linkend='var-glossary-j'>J</link> -->
        <link linkend='var-KARCH'>K</link>
        <link linkend='var-LABELS'>L</link>
@@ -2345,6 +2345,31 @@
 
     <glossdiv id='var-glossary-i'><title>I</title>
 
+        <glossentry id='var-ICECC_DISABLED'><glossterm>ICECC_DISABLED</glossterm>
+            <glossdef>
+                <para>
+                    Disables or enables the <filename>icecc</filename>
+                    (Icecream) function.
+                    For more information on this function and best practices
+                    for using this variable, see the
+                    "<link linkend='ref-classes-icecc'><filename>icecc.bbclass</filename></link>"
+                    section.
+                </para>
+
+                <para>
+                    Setting this variable to "1" in your
+                    <filename>local.conf</filename> enables the function:
+                    <literallayout class='monospaced'>
+     ICECC_DISABLED ??= "1"
+                    </literallayout>
+                    To enable the function, set the variable as follows:
+                    <literallayout class='monospaced'>
+     ICECC_DISABLED = ""
+                    </literallayout>
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-ICECC_ENV_EXEC'><glossterm>ICECC_ENV_EXEC</glossterm>
             <glossdef>
                 <para>