ref-manual: Added glossary description for OE_BINCONFIG_EXTRA_MANGLE variable.

(From yocto-docs rev: 55bbcbebc707d95ee357aa3d8075218d0f31b2f1)

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

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 171b8df8f352ba1054087748316c9a8f82634fd5..da051e5e455566eb439ed7dfaccbef023640aa89 100644 (file)
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -30,7 +30,7 @@
        <link linkend='var-LAYERDEPENDS'>L</link>
        <link linkend='var-MACHINE'>M</link>
 <!--               <link linkend='var-glossary-n'>N</link> -->
-       <link linkend='var-OE_IMPORTS'>O</link>
+       <link linkend='var-OE_BINCONFIG_EXTRA_MANGLE'>O</link>
        <link linkend='var-P'>P</link>
 <!--               <link linkend='var-glossary-q'>Q</link> -->
        <link linkend='var-RCONFLICTS'>R</link>
@@ -2696,6 +2696,33 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
 
     <glossdiv id='var-glossary-o'><title>O</title>
 
+        <glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm>OE_BINCONFIG_EXTRA_MANGLE</glossterm>
+            <glossdef>
+                <para>
+                    When a recipe inherits the
+                    <filename>binconfig.bbclass</filename> class, this variable
+                    specifies additional arguments passed to the "sed" command.
+                    The sed command alters any paths in configuration scripts
+                    that have been set up during compilation.
+                    This alteration ensures the commands are correct for use
+                    when installed into the sysroot and called by the build
+                    processes of other recipes.
+                </para>
+
+                <para>
+                    See the <filename>meta/classes/binconfig.bbclass</filename>
+                    in the
+                    <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
+                    for details on how this class applies these additional
+                    sed command arguments.
+                    For general information on the
+                    <filename>binconfig.bbclass</filename> class, see the
+                    "<link linkend='ref-classes-binconfig'>Binary Configuration Scripts - <filename>binconfig.bbclass</filename></link>"
+                    section.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-OE_IMPORTS'><glossterm>OE_IMPORTS</glossterm>
             <glossdef>
                 <para>