From 61ce3fd240620da28ba35f5b1461b77e64ae9903 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Fri, 9 Aug 2013 11:08:38 +0300
Subject: ref-manual: Added BINCONFIG_GLOB variable and updated
 binconfig.bbclass

New variable.

Changed the class section to have a reference-like section title.
Added a link back to the GLOB variable.

(From yocto-docs rev: 42dbafc1b64d8572930501f25a0470038721524f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/ref-manual/ref-classes.xml   | 16 ++++++++++++----
 documentation/ref-manual/ref-variables.xml | 23 +++++++++++++++++++++++
 2 files changed, 35 insertions(+), 4 deletions(-)

(limited to 'documentation')

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index af07b144d6..d230ddd935 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -157,12 +157,17 @@
 </section>
 
 <section id='ref-classes-binconfig'>
-    <title>Binary Configuration Scripts - <filename>binconfig.bbclass</filename></title>
+    <title><filename>binconfig.bbclass</filename></title>
 
     <para>
-        Before <filename>pkg-config</filename> had become widespread, libraries shipped shell
-        scripts to give information about the libraries and include paths needed
-        to build software (usually named <filename>LIBNAME-config</filename>).
+        This class helps to correct paths in shell scripts.
+    </para>
+
+    <para>
+        Before <filename>pkg-config</filename> had become widespread, libraries
+        shipped shell scripts to give information about the libraries and
+        include paths needed to build software (usually named
+        <filename>LIBNAME-config</filename>).
         This class assists any recipe using such scripts.
     </para>
 
@@ -173,6 +178,9 @@
         changed to point into the <filename>sysroots/</filename> directory so
         that all builds that use the script use the correct directories
         for the cross compiling layout.
+        See the
+        <link linkend='var-BINCONFIG_GLOB'><filename>BINCONFIG_GLOB</filename></link>
+        variable for more information.
     </para>
 </section>
 
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index ded45262c8..a357377032 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -672,6 +672,29 @@ Core layer for images cannot be removed
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm>
+            <glossdef>
+                <para>
+                    When inheriting <filename>binconfig.bbclass</filename>
+                    from a recipe, this variable specifies a wildcard for
+                    configuration scripts that need editing.
+                    The scripts are edited to correct any paths that have been
+                    set up during compilation so that they are correct for
+                    use when installed into the sysroot and called by the
+                    build processes of other recipes.
+                </para>
+
+                <para>
+                    For more information on how this variable works, see
+                    <filename>meta/classes/binconfig.bbclass</filename> in the
+                    <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
+                    You can also find general information on the class in the
+                    "<link linkend='ref-classes-binconfig'><filename>binconfig.bbclass</filename></link>"
+                    section.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-BP'><glossterm>BP</glossterm>
             <glossdef>
                 <para>The base recipe name and version but without any special
-- 
cgit v1.2.3-54-g00ecf