From 70a2007b6768a6c535f101e5fdde28210929455f Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Tue, 20 Jan 2015 13:41:01 -0800
Subject: [PATCH] ref-manual: New variables added to the variable glossary

Fixes [YOCTO #7133]

This goes toward fixing the bug but not completing it.  I have
added the following variables to the variable glossary:

 SDKTARGETSYSROOT
 PKG_CONFIG_PATH
 CC
 CXX
 CPP
 AS
 LD
 TARGET_PREFIX
 AR
 STRIP
 OBJCOPY
 OBJDUMP
 RANLIB
 NM

(From yocto-docs rev: c9d9e422684dad7cdc81db309235d0d1751ac88a)

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

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 85803ef89d..3511f38855 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -18,7 +18,7 @@
     <para>
        <link linkend='var-ABIEXTENSION'>A</link>
        <link linkend='var-B'>B</link>
-       <link linkend='var-CFLAGS'>C</link>
+       <link linkend='var-CC'>C</link>
        <link linkend='var-D'>D</link>
        <link linkend='var-EFI_PROVIDER'>E</link>
        <link linkend='var-FEATURE_PACKAGES'>F</link>
@@ -30,10 +30,10 @@
        <link linkend='var-LABELS'>L</link>
        <link linkend='var-MACHINE'>M</link>
 <!--               <link linkend='var-glossary-n'>N</link> -->
-       <link linkend='var-OE_BINCONFIG_EXTRA_MANGLE'>O</link>
+       <link linkend='var-OBJCOPY'>O</link>
        <link linkend='var-P'>P</link>
        <link linkend='var-QMAKE_PROFILES'>Q</link>
-       <link linkend='var-RCONFLICTS'>R</link>
+       <link linkend='var-RANLIB'>R</link>
        <link linkend='var-S'>S</link>
        <link linkend='var-T'>T</link>
        <link linkend='var-UBOOT_CONFIG'>U</link>
@@ -260,6 +260,30 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-AR'><glossterm><imagedata fileref="figures/define-generic.png" />AR</glossterm>
+            <info>
+                AR[doc] = "Minimal command and arguments to run 'ar'."
+            </info>
+            <glossdef>
+                <para>
+                    The minimal command and arguments used to run
+                    <filename>ar</filename>.
+                </para>
+            </glossdef>
+        </glossentry>
+
+        <glossentry id='var-AS'><glossterm><imagedata fileref="figures/define-generic.png" />AS</glossterm>
+            <info>
+                AS[doc] = "Minimal command and arguments to run the assembler."
+            </info>
+            <glossdef>
+                <para>
+                    The minimal command and arguments used to run the
+                    assembler.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-ASSUME_PROVIDED'><glossterm><imagedata fileref="figures/define-generic.png" />ASSUME_PROVIDED</glossterm>
             <info>
                 ASSUME_PROVIDED[doc] = "Lists recipe names (PN values) BitBake does not attempt to build."
@@ -1545,6 +1569,18 @@
 
     <glossdiv id='var-glossary-c'><title>C</title>
 
+        <glossentry id='var-CC'><glossterm><imagedata fileref="figures/define-generic.png" />CC</glossterm>
+            <info>
+                CC[doc] = "Minimum command and arguments to run the C compiler."
+            </info>
+            <glossdef>
+                <para>
+                    The minimal command and arguments used to run the C
+                    compiler.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-CFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />CFLAGS</glossterm>
             <info>
                 CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the same as TARGET_CFLAGS."
@@ -1938,6 +1974,18 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-CPP'><glossterm><imagedata fileref="figures/define-generic.png" />CPP</glossterm>
+            <info>
+                CPP[doc] = "Minimum command and arguments to run the C preprocessor."
+            </info>
+            <glossdef>
+                <para>
+                    The minimal command and arguments used to run the C
+                    preprocessor.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-CPPFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />CPPFLAGS</glossterm>
             <info>
                 CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers)."
@@ -1974,6 +2022,18 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-CXX'><glossterm><imagedata fileref="figures/define-generic.png" />CXX</glossterm>
+            <info>
+                CXX[doc] = "Minimum command and arguments to run the C++ compiler."
+            </info>
+            <glossdef>
+                <para>
+                    The minimal command and arguments used to run the C++
+                    compiler.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-CXXFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />CXXFLAGS</glossterm>
             <info>
                 CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler."
@@ -5730,6 +5790,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-LD'><glossterm><imagedata fileref="figures/define-generic.png" />LD</glossterm>
+            <info>
+                LD[doc] = "Minimal command and arguments to run the linker."
+            </info>
+            <glossdef>
+                <para>
+                    The minimal command and arguments used to run the
+                    linker.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-LDFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />LDFLAGS</glossterm>
             <info>
                 LDFLAGS[doc] = "Specifies the flags to pass to the linker."
@@ -6595,6 +6667,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-NM'><glossterm><imagedata fileref="figures/define-generic.png" />NM</glossterm>
+            <info>
+                NM[doc] = "Minimal command and arguments to run 'nm'."
+            </info>
+            <glossdef>
+                <para>
+                    The minimal command and arguments to run
+                    <filename>nm</filename>.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-NO_RECOMMENDATIONS'><glossterm><imagedata fileref="figures/define-generic.png" />NO_RECOMMENDATIONS</glossterm>
             <info>
                 NO_RECOMMENDATIONS[doc] = "When set to '1', no recommended packages will be installed. Realize that some recommended packages might be required for certain system functionality, such as kernel-modules. It is up to the user to add packages to IMAGE_INSTALL as needed."
@@ -6691,6 +6775,30 @@ 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-OBJCOPY'><glossterm><imagedata fileref="figures/define-generic.png" />OBJCOPY</glossterm>
+            <info>
+                OBJCOPY[doc] = "Minimal command and arguments to run 'objcopy'."
+            </info>
+            <glossdef>
+                <para>
+                    The minimal command and arguments to run
+                    <filename>objcopy</filename>.
+                </para>
+            </glossdef>
+        </glossentry>
+
+        <glossentry id='var-OBJDUMP'><glossterm><imagedata fileref="figures/define-generic.png" />OBJDUMP</glossterm>
+            <info>
+                OBJDUMP[doc] = "Minimal command and arguments to run 'objdump'."
+            </info>
+            <glossdef>
+                <para>
+                    The minimal command and arguments to run
+                    <filename>objdump</filename>.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm><imagedata fileref="figures/define-generic.png" />OE_BINCONFIG_EXTRA_MANGLE</glossterm>
             <info>
                 OE_BINCONFIG_EXTRA_MANGLE[doc] = "When a recipe inherits the binconfig.bbclass class, this variable specifies additional arguments passed to the "sed" command."
@@ -7538,6 +7646,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-PKG_CONFIG_PATH'><glossterm><imagedata fileref="figures/define-generic.png" />PKG_CONFIG_PATH</glossterm>
+            <info>
+                PKG_CONFIG_PATH[doc] = "Path to pkg-config files for the target."
+            </info>
+            <glossdef>
+                <para>
+                    The path to <filename>pkg-config</filename> files for the
+                    target.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-PKGD'><glossterm><imagedata fileref="figures/define-generic.png" />PKGD</glossterm>
             <info>
                 PKGD[doc] = "Points to the destination directory for files to be packaged before they are split into individual packages."
@@ -8109,6 +8229,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
 
     <glossdiv id='var-glossary-r'><title>R</title>
 
+        <glossentry id='var-RANLIB'><glossterm><imagedata fileref="figures/define-generic.png" />RANLIB</glossterm>
+            <info>
+                RANLIB[doc] = "Minimal command and arguments to run 'ranlib'."
+            </info>
+            <glossdef>
+                <para>
+                    The minimal command and arguments to run
+                    <filename>ranlib</filename>.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-RCONFLICTS'><glossterm><imagedata fileref="figures/define-generic.png" />RCONFLICTS</glossterm>
             <info>
                 RCONFLICTS[doc] = "The list of packages that conflict with another package. Note that the package will not be installed if the conflicting packages are not first removed."
@@ -8891,6 +9023,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-SDKTARGETSYSROOT'><glossterm><imagedata fileref="figures/define-generic.png" />SDKTARGETSYSROOT</glossterm>
+            <info>
+                SDKTARGETSYSROOT[doc] = "Path to the sysroot used for cross-compilation."
+            </info>
+            <glossdef>
+                <para>
+                    The path to the sysroot used for cross-compilation.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-SECTION'><glossterm><imagedata fileref="figures/define-generic.png" />SECTION</glossterm>
             <info>
                 SECTION[doc] = "The section in which packages should be categorized. Package management utilities can make use of this variable."
@@ -9827,6 +9970,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-STRIP'><glossterm><imagedata fileref="figures/define-generic.png" />STRIP</glossterm>
+            <info>
+                STRIP[doc] = "Minimal command and arguments to run 'strip' (strip symbols)."
+            </info>
+            <glossdef>
+                <para>
+                    The minimal command and arguments to run
+                    <filename>strip</filename>, which is used to strip
+                    symbols.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-SUMMARY'><glossterm><imagedata fileref="figures/define-generic.png" />SUMMARY</glossterm>
             <info>
                 SUMMARY[doc] = "The short (80 characters or less) summary of the binary package for packaging systems such as opkg, rpm or dpkg. By default, SUMMARY is used to define the DESCRIPTION variable if DESCRIPTION is not set in the recipe."
@@ -10327,6 +10483,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-TARGET_PREFIX'><glossterm><imagedata fileref="figures/define-generic.png" />TARGET_PREFIX</glossterm>
+            <info>
+                TARGET_PREFIX[doc] = "Toolchain binary prefix for the target tools."
+            </info>
+            <glossdef>
+                <para>
+                    The toolchain binary prefix for the target tools.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-TCLIBCAPPEND'><glossterm><imagedata fileref="figures/define-generic.png" />TCLIBCAPPEND</glossterm>
             <info>
                 TCLIBCAPPEND[doc] = "Specifies a suffix appended to TMPDIR that identifies the libc variant for the build."