ref-manual: Added BINCONFIG variable and binconfig-disabled class.

(From yocto-docs rev: 16e0176db9927296f721c25792d87b2495b5405b)

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

2 files changed, 27 insertions, 0 deletions

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 4e9e442757..34142cb152 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -232,6 +232,21 @@
     </para>
 </section>
 
+<section id='ref-classes-binconfig-disabled'>
+    <title><filename>binconfig-disabled.bbclass</filename></title>
+
+    <para>
+        An alternative version of the
+        <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link>
+        class, which disables binary configuration scripts by making them
+        return an error in favor of installing them using
+        <filename>pkg-config</filename>.
+        The scripts to be disabled should be specified using the
+        <link linkend='var-BINCONFIG'><filename>BINCONFIG</filename></link>
+        variable within the recipe inheriting the class.
+    </para>
+</section>
+
 <section id='ref-classes-blacklist'>
     <title><filename>blacklist.bbclass</filename></title>
 
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index fe5738ec9f..fcb62d22b1 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -887,6 +887,18 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-BINCONFIG'><glossterm>BINCONFIG</glossterm>
+            <glossdef>
+                <para>
+                    Specifies binary configuration scripts to disable
+                    rather than installing them using
+                    <filename>pkg-config</filename>.
+                    The OpenEmbedded build system returns an error for the
+                    disabled scripts.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm>
             <glossdef>
                 <para>