From 05cff8adcb22b43fa8135a37af4799cd00a8d11b Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Tue, 28 Feb 2012 12:21:35 -0600
Subject: documentation/poky-ref-manual/ref-variables.xml: B and BBCLASSEXTEND

Added two new variable entries.  This is part of the fix needed
as a result of the feedback from two Community members inside
Intel whose feedback was initially reported by Darren Hart.

Reported-by: Inaky Perez-Gonzales <inaky.perez-gonzales@intel.com>
Reported-by: Mohamed Abbas <mohamed.abbas@intel.com>
(From yocto-docs rev: ccabb9c905e7a1c9a211f805f8a326048903b7b0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/poky-ref-manual/ref-variables.xml | 50 +++++++++++++++++++++++--
 1 file changed, 47 insertions(+), 3 deletions(-)

(limited to 'documentation/poky-ref-manual')

diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 1e31e0a3ab..ec747bf5f9 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -16,7 +16,7 @@
 
     <para>
        <link linkend='var-AUTHOR'>A</link> 
-       <link linkend='var-BAD_RECOMMENDATIONS'>B</link> 
+       <link linkend='var-B'>B</link> 
        <link linkend='var-CFLAGS'>C</link> 
        <link linkend='var-D'>D</link> 
        <link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>E</link> 
@@ -64,14 +64,58 @@
 
     <glossdiv id='var-glossary-b'><title>B</title>
 
+        <glossentry id='var-B'><glossterm>B</glossterm>
+            <glossdef>
+                <para>
+                    The directory in which the Yocto Project build system places
+                    generated objects during a recipe's build process.
+                    By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
+                    directory:
+                    <literallayout class='monospaced'>
+     B = ${WORKDIR}/${BPN}-{PV}/
+                    </literallayout>
+                    You can separate the source directory (<filename>S</filename>) and the directory pointed to 
+                    by the <filename>B</filename> variable.
+                    In general, <filename>autotools</filename>, recipes such as <filename>gcc</filename>, 
+                    and some kernel recipes separate these directories by default.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-BAD_RECOMMENDATIONS'><glossterm>BAD_RECOMMENDATIONS</glossterm>
             <glossdef>
-                <para>A list of packages not to install despite being recommended by a recipe.
+                <para>
+                    A list of packages not to install despite being recommended by a recipe.
                     Support for this variable exists only for images that use the 
-                    <filename>ipkg</filename> packaging system.</para>
+                    <filename>ipkg</filename> packaging system.
+                </para>
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm>
+            <glossdef>
+                <para>
+                    Allows you to extend a recipe so that it builds variants of the software.
+                    Common variants for recipes exist such as "natives" like <filename>quilt-native</filename>,
+                    which is a copy of quilt built to run on the build system;
+                    "crosses" such as <filename>gcc-cross</filename>,
+                    which is a compiler built to run on the build machine but produces binaries
+                    that run on the target <link linkend='var-MACHINE'><filename>MACHINE</filename></link>;
+                    "nativesdk", which targets the SDK machine instead of <filename>MACHINE</filename>;
+                    and "mulitlibs" in the form "<filename>multilib:&lt;multilib_name&gt;</filename>".
+                </para>
+
+                <para>
+                    To build a different variant of the recipe with a minimal amount of code, it usually
+                    is as simple as adding the following to your recipe:
+                    <literallayout class='monospaced'>
+     BBCLASSEXTEND = "native nativesdk"
+     BBCLASSEXTEND = "multilib:&lt;multilib_name&gt;"
+                    </literallayout>
+                </para>
+             </glossdef>
+        </glossentry>
+
         <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm>
             <glossdef>
                 <para>Prevents BitBake from processing recipes and recipe append files.
-- 
cgit v1.2.3-54-g00ecf