ref-manual: Added 21 new variable to glossary.

I added the following:

 ASSUME_SHLIBS
 BBINCLUDELOGS_LINES
 BUILD_ARCH
 BUILD_OS
 CACHE
 CONF_VERSION
 CVSDIR
 DATE
 FONT_EXTRA_RDEPENDS
 GITDIR
 HOST_ARCH
 HOST_OS
 HOST_PREFIX
 HOST_VENDOR
 PACKAGE_INSTALL_ATTEMPTONLY
 PRIORITY
 SOURCE_MIRROR_FETCH
 SVNDIR
 TARGET_PREFIX
 TARGET_SYS
 TIME

(From yocto-docs rev: 76e5f7ca78db63b63ac6357218ef153e064e605f)

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

1 files changed, 299 insertions, 6 deletions

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 3511f38855..1911f33ba7 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -18,11 +18,11 @@
     <para>
        <link linkend='var-ABIEXTENSION'>A</link>
        <link linkend='var-B'>B</link>
-       <link linkend='var-CC'>C</link>
+       <link linkend='var-CACHE'>C</link>
        <link linkend='var-D'>D</link>
        <link linkend='var-EFI_PROVIDER'>E</link>
        <link linkend='var-FEATURE_PACKAGES'>F</link>
-       <link linkend='var-GLIBC_GENERATE_LOCALES'>G</link>
+       <link linkend='var-GITDIR'>G</link>
        <link linkend='var-HOMEPAGE'>H</link>
        <link linkend='var-ICECC_DISABLED'>I</link>
 <!--               <link linkend='var-glossary-j'>J</link> -->
@@ -307,6 +307,22 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-ASSUME_SHLIBS'><glossterm><imagedata fileref="figures/define-generic.png" />ASSUME_SHLIBS</glossterm>
+            <info>
+                ASSUME_SHLIBS[doc] = "List of shlib:package[_version] mappings. Useful for lib packages in ASSUME_PROVIDED, for which automatic shlib dependency tracking does not work."
+            </info>
+            <glossdef>
+                <para>
+                    List of <filename>shlib:package[_version]</filename>
+                    mappings.
+                    This variable is useful for library packages in
+                    <link linkend='var-ASSUME_PROVIDED'><filename>ASSUME_PROVIDED</filename></link>,
+                    for which automatic <filename>shlib</filename> dependency
+                    tracking does not work.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-AUTHOR'><glossterm><imagedata fileref="figures/define-generic.png" />AUTHOR</glossterm>
             <info>
                 AUTHOR[doc] = "Email address used to contact the original author or authors in order to send patches and forward bugs."
@@ -875,6 +891,18 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-BBINCLUDELOGS_LINES'><glossterm><imagedata fileref="figures/define-generic.png" />BBINCLUDELOGS_LINES</glossterm>
+            <info>
+                BBINCLUDELOGS_LINES[doc] = "Amount of log lines printed on failure."
+            </info>
+            <glossdef>
+                <para>
+                    The number of log lines the OpenEmbedded build system
+                    prints upon failure.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-BBLAYERS'><glossterm><imagedata fileref="figures/define-generic.png" />BBLAYERS</glossterm>
             <info>
                 BBLAYERS[doc] = "Lists the layers to enable during the build. This variable is defined in the bblayers.conf configuration file."
@@ -1157,6 +1185,18 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-BUILD_ARCH'><glossterm><imagedata fileref="figures/define-generic.png" />BUILD_ARCH</glossterm>
+            <info>
+                BUILD_ARCH[doc] = "The name of the building architecture (e.g. i686)."
+            </info>
+            <glossdef>
+                <para>
+                    Specifies the architecture of the build system
+                    (e.g. <filename>i686</filename>).
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-BUILD_CFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />BUILD_CFLAGS</glossterm>
             <info>
                 BUILD_CFLAGS[doc] = "Specifies the flags to pass to the C compiler when building for the build host."
@@ -1241,6 +1281,18 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-BUILD_OS'><glossterm><imagedata fileref="figures/define-generic.png" />BUILD_OS</glossterm>
+            <info>
+                BUILD_OS[doc] = "The operating system (in lower case) of the building architecture (e.g. Linux)."
+            </info>
+            <glossdef>
+                <para>
+                    Specifies the operating system in use on the build
+                    system (e.g. Linux).
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-BUILDDIR'><glossterm><imagedata fileref="figures/define-generic.png" />BUILDDIR</glossterm>
             <info>
                 BUILDDIR[doc] = "Points to the location of the Build Directory."
@@ -1569,6 +1621,17 @@
 
     <glossdiv id='var-glossary-c'><title>C</title>
 
+        <glossentry id='var-CACHE'><glossterm><imagedata fileref="figures/define-generic.png" />CACHE</glossterm>
+            <info>
+                CACHE[doc]  = "The directory holding the cache of the metadata."
+            </info>
+            <glossdef>
+                <para>
+                    The directory that contains the cache for the Metadata.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <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."
@@ -1774,6 +1837,20 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-CONF_VERSION'><glossterm><imagedata fileref="figures/define-generic.png" />CONF_VERSION</glossterm>
+            <info>
+                CONF_VERSION[doc] = "Tracks the version of local.conf.  Increased each time build/conf/ changes incompatibly."
+            </info>
+            <glossdef>
+                <para>
+                    Tracks the version of the local configuration file
+                    (i.e. <filename>local.conf</filename>).
+                    The value for <filename>CONF_VERSION</filename>
+                    increments each time <filename>build/conf/</filename>
+                    compatibility changes.
+                </para>
+            </glossdef>
+        </glossentry>
         <glossentry id='var-CONFFILES'><glossterm><imagedata fileref="figures/define-generic.png" />CONFFILES</glossterm>
             <info>
                 CONFFILES[doc] = "Identifies editable or configurable files that are part of a package."
@@ -2022,6 +2099,18 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-CVSDIR'><glossterm><imagedata fileref="figures/define-generic.png" />CVSDIR</glossterm>
+            <info>
+                CVSDIR[doc] = "The directory where cvs checkouts will be stored in."
+            </info>
+            <glossdef>
+                <para>
+                    The directory in which files checked out under the
+                    CVS system are stored.
+                </para>
+            </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."
@@ -2092,6 +2181,18 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-DATE'><glossterm><imagedata fileref="figures/define-generic.png" />DATE</glossterm>
+            <info>
+                DATE[doc] = "The date the build was started using YMD format."
+            </info>
+            <glossdef>
+                <para>
+                    The date the build was started.
+                    Dates appear using the year, month, and day (YMD) format.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-DATETIME'><glossterm><imagedata fileref="figures/define-generic.png" />DATETIME</glossterm>
             <info>
                 DATETIME[doc] = "The date and time the build was started."
@@ -3532,6 +3633,22 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-FONT_EXTRA_RDEPENDS'><glossterm><imagedata fileref="figures/define-generic.png" />FONT_EXTRA_RDEPENDS</glossterm>
+            <info>
+                FONT_EXTRA_RDEPENDS[doc] = "When a recipe inherits the fontcache class, this variable specifies runtime dependencies for font packages. This variable defaults to 'fontconfig-utils'."
+            </info>
+            <glossdef>
+                <para>
+                    When inheriting the
+                    <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link>
+                    class, this variable specifies the runtime dependencies
+                    for font packages.
+                    By default, the <filename>FONT_EXTRA_RDEPENDS</filename>
+                    is set to "fontconfig-utils".
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-FONT_PACKAGES'><glossterm><imagedata fileref="figures/define-generic.png" />FONT_PACKAGES</glossterm>
             <info>
                 FONT_PACKAGES[doc] = "When a recipe inherits the fontcache class, this variable identifies packages containing font files that need to be cached by Fontconfig."
@@ -3570,6 +3687,18 @@
 
     <glossdiv id='var-glossary-g'><title>G</title>
 
+        <glossentry id='var-GITDIR'><glossterm><imagedata fileref="figures/define-generic.png" />GITDIR</glossterm>
+            <info>
+                GITDIR[doc] = "The directory where Git clones will be stored."
+            </info>
+            <glossdef>
+                <para>
+                    The directory in which a local copy of a Git repository
+                    is stored when it is cloned.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-GLIBC_GENERATE_LOCALES'><glossterm><imagedata fileref="figures/define-generic.png" />GLIBC_GENERATE_LOCALES</glossterm>
             <info>
                 GLIBC_GENERATE_LOCALES[doc]= "Specifies the list of GLIBC locales to generate should you not wish generate all LIBC locals, which can be time consuming."
@@ -3821,6 +3950,34 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-HOST_ARCH'><glossterm><imagedata fileref="figures/define-generic.png" />HOST_ARCH</glossterm>
+            <info>
+                HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH."
+
+            </info>
+            <glossdef>
+                <para>
+                    The name of the target architecture, which is normally
+                    the same as
+                    <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>.
+                    The OpenEmbedded build system supports many
+                    architectures.
+                    Here is an example list of architectures supported.
+                    This list is by no means complete as the architecture
+                    is configurable:
+                    <literallayout class='monospaced'>
+     arm
+     i586
+     x86_64
+     powerpc
+     powerpc64
+     mips
+     mipsel
+                    </literallayout>
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-HOST_CC_ARCH'><glossterm><imagedata fileref="figures/define-generic.png" />HOST_CC_ARCH</glossterm>
             <info>
                 HOST_CC_ARCH[doc] = "The name of the host architecture. Normally same as the TARGET_CC_ARCH."
@@ -3854,6 +4011,36 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-HOST_OS'><glossterm><imagedata fileref="figures/define-generic.png" />HOST_OS</glossterm>
+            <info>
+                HOST_OS[doc] = "The name of the target operating system. Normally the same as the TARGET_OS."
+            </info>
+            <glossdef>
+                <para>
+                    Specifies the name of the target operating system, which
+                    is normally the same as the
+                    <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link>.
+                    The variable can be set to "linux" for <filename>glibc</filename>-based systems and
+                    to "linux-uclibc" for <filename>uclibc</filename>.
+                    For ARM/EABI targets, there are also "linux-gnueabi" and
+                    "linux-uclibc-gnueabi" values possible.
+                </para>
+            </glossdef>
+        </glossentry>
+
+        <glossentry id='var-HOST_PREFIX'><glossterm><imagedata fileref="figures/define-generic.png" />HOST_PREFIX</glossterm>
+            <info>
+                HOST_PREFIX[doc] = "The prefix for the cross compile toolchain. Normally same as the TARGET_PREFIX."
+            </info>
+            <glossdef>
+                <para>
+                    Specifies the prefix for the cross-comile toolchain.
+                    <filename>HOST_PREFIX</filename> is normally the same as
+                    <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link>.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-HOST_SYS'><glossterm><imagedata fileref="figures/define-generic.png" />HOST_SYS</glossterm>
             <info>
                 HOST_SYS[doc] = "Specifies the system, including the architecture and the operating system, for with the build is occurring in the context of the current recipe."
@@ -3861,9 +4048,8 @@
             <glossdef>
                 <para>
                     Specifies the system, including the architecture and the
-                    operating system, for with the build is occurring
-                    in the context of the current
-                    recipe.
+                    operating system, for which the build is occurring
+                    in the context of the current recipe.
                     The OpenEmbedded build system automatically sets this
                     variable.
                     You do not need to set the variable yourself.
@@ -3885,6 +4071,19 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-HOST_VENDOR'><glossterm><imagedata fileref="figures/define-generic.png" />HOST_VENDOR</glossterm>
+            <info>
+                HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR."
+            </info>
+            <glossdef>
+                <para>
+                    Specifies the name of the vendor.
+                    <filename>HOST_VENDOR</filename> is normally the same as
+                    <link linkend='var-TARGET_PREFIX'><filename>TARGET_VENDOR</filename></link>.
+                </para>
+            </glossdef>
+        </glossentry>
+
     </glossdiv>
 
     <glossdiv id='var-glossary-i'><title>I</title>
@@ -7242,6 +7441,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-PACKAGE_INSTALL_ATTEMPTONLY'><glossterm><imagedata fileref="figures/define-generic.png" />PACKAGE_INSTALL_ATTEMPTONLY</glossterm>
+            <info>
+                PACKAGE_INSTALL_ATTEMPTONLY[doc] = "List of packages attempted to be installed. If a listed package fails to install, the build system does not generate an error. This variable is generally not user-defined."
+            </info>
+            <glossdef>
+                <para>
+                    Specifies a list of packages the OpenEmbedded build
+                    system attempts to install.
+                    If a listed package fails to install, the build system
+                    does not generate an error.
+                    This variable is generally not user-defined.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-PACKAGE_PREPROCESS_FUNCS'><glossterm><imagedata fileref="figures/define-generic.png" />PACKAGE_PREPROCESS_FUNCS</glossterm>
             <info>
                 PACKAGE_PREPROCESS_FUNCS[doc] = "Specifies a list of functions run to pre-process the PKGD directory prior to splitting the files out to individual packages."
@@ -7997,6 +8211,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-PRIORITY'><glossterm><imagedata fileref="figures/define-generic.png" />PRIORITY</glossterm>
+            <info>
+                PRIORITY[doc] = "Indicates the importance of a package.  The default value is 'optional'.  Other standard values are 'required', 'standard' and 'extra'."
+            </info>
+            <glossdef>
+
+                <para>
+                    Indicates the importance of a package.
+                    You can set <filename>PRIORITY</filename> to "required",
+                    "standard", "extra", and "optional", which is the default.
+                </para>
+-->
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-PRIVATE_LIBS'><glossterm><imagedata fileref="figures/define-generic.png" />PRIVATE_LIBS</glossterm>
             <info>
                 PRIVATE_LIBS[doc] = "Specifies libraries installed within a recipe that should be ignored by the OpenEmbedded build system's shared library resolver."
@@ -9266,6 +9495,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-SOURCE_MIRROR_FETCH'><glossterm><imagedata fileref="figures/define-generic.png" />SOURCE_MIRROR_FETCH</glossterm>
+            <info>
+                SOURCE_MIRROR_FETCH[doc] = "Switch marking build as source fetcher. Used to skip COMPATIBLE_* checking."
+            </info>
+            <glossdef>
+                <para>
+                    Switch marking build as source fetcher.
+                    This variable is used to skip
+                    <filename>COMPATIBLE_*</filename> checking.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-SOURCE_MIRROR_URL'><glossterm><imagedata fileref="figures/define-generic.png" />SOURCE_MIRROR_URL</glossterm>
             <info>
                 SOURCE_MIRROR_URL[doc] = "URL to source mirror that will be used before fetching from original SRC_URI."
@@ -9999,6 +10241,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-SVNDIR'><glossterm><imagedata fileref="figures/define-generic.png" />SVNDIR</glossterm>
+            <info>
+                SVNDIR[doc] = "The directory where Subversion checkouts will be stored."
+
+            </info>
+            <glossdef>
+                <para>
+                    The directory in which files checked out of a Subversion
+                    system are stored.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-SYSLINUX_DEFAULT_CONSOLE'><glossterm><imagedata fileref="figures/define-generic.png" />SYSLINUX_DEFAULT_CONSOLE</glossterm>
             <info>
                 SYSLINUX_DEFAULT_CONSOLE[doc] = "Specifies the kernel boot default console."
@@ -10494,6 +10749,32 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-TARGET_SYS'><glossterm><imagedata fileref="figures/define-generic.png" />TARGET_SYS</glossterm>
+            <info>
+                TARGET_SYS[doc] = "The target system is comprised of TARGET_ARCH,TARGET_VENDOR and TARGET_OS."
+            </info>
+            <glossdef>
+                <para>
+                    The target system, which is comprised of
+                    <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>,
+                    <link linkend='var-TARGET_VENDOR'><filename>TARGET_VENDOR</filename></link>,
+                    and
+                    <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link>.
+                </para>
+            </glossdef>
+        </glossentry>
+
+        <glossentry id='var-TARGET_VENDOR'><glossterm><imagedata fileref="figures/define-generic.png" />TARGET_VENDOR</glossterm>
+            <info>
+                TARGET_VENDOR[doc] = "The name of the target vendor."
+            </info>
+            <glossdef>
+                <para>
+                    Specifies the name of the target vendor.
+                </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."
@@ -10982,6 +11263,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-TIME'><glossterm><imagedata fileref="figures/define-generic.png" />TIME</glossterm>
+            <info>
+                TIME[doc] = "The time the build was started using HMS format."
+            </info>
+            <glossdef>
+                <para>
+                    The time the build was started.
+                    Times appear using the hour, minute, and second (HMS) format.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-TMPDIR'><glossterm><imagedata fileref="figures/define-generic.png" />TMPDIR</glossterm>
             <info>
                 TMPDIR[doc] = "The temporary directory the OpenEmbedded build system uses when it does its work building images. By default, the TMPDIR variable is named tmp within the Build Directory."
@@ -11640,7 +11933,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
 
         <glossentry id='var-USE_DEVFS'><glossterm><imagedata fileref="figures/define-generic.png" />USE_DEVFS</glossterm>
             <info>
-               USE_DEVFS[doc] = "Determines if devtmpfs is used for/dev population."
+               USE_DEVFS[doc] = "Determines if devtmpfs is used for /dev population."
             </info>
             <glossdef>
                 <para>