path: root/handbook/ref-variables.xml

<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!-- Dummy chapter -->
<appendix id='ref-variables-glos'>

<title>Reference: Variables Glossary</title>

<para>
    This section lists common variables used in Poky and gives an overview
    of their function and contents.
</para>

<glossary id='ref-variables-glossary'>


    <para>
       <link linkend='var-glossary-a'>A</link> 
       <link linkend='var-glossary-b'>B</link> 
       <link linkend='var-glossary-c'>C</link> 
       <link linkend='var-glossary-d'>D</link> 
       <link linkend='var-glossary-e'>E</link> 
       <link linkend='var-glossary-f'>F</link> 
<!--               <link linkend='var-glossary-g'>G</link> -->
       <link linkend='var-glossary-h'>H</link> 
       <link linkend='var-glossary-i'>I</link> 
<!--               <link linkend='var-glossary-j'>J</link> -->
       <link linkend='var-glossary-k'>K</link>
       <link linkend='var-glossary-l'>L</link> 
       <link linkend='var-glossary-m'>M</link> 
<!--               <link linkend='var-glossary-n'>N</link> -->
<!--               <link linkend='var-glossary-o'>O</link> -->
       <link linkend='var-glossary-p'>P</link> 
<!--               <link linkend='var-glossary-q'>Q</link> -->
       <link linkend='var-glossary-r'>R</link> 
       <link linkend='var-glossary-s'>S</link> 
       <link linkend='var-glossary-t'>T</link> 
<!--               <link linkend='var-glossary-u'>U</link> -->
<!--               <link linkend='var-glossary-v'>V</link> -->
       <link linkend='var-glossary-w'>W</link> 
<!--               <link linkend='var-glossary-x'>X</link> -->
<!--               <link linkend='var-glossary-y'>Y</link> -->
<!--               <link linkend='var-glossary-z'>Z</link>-->
    </para>

    <glossdiv id='var-glossary-a'><title>A</title>

         <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm>
            <glossdef>
                <para>E-mail address to contact original author(s) - to
                send patches, forward bugs...</para>
            </glossdef>
         </glossentry>

        <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm>
            <glossdef>
                <para>Use current (newest) source revision - used with
                    <glossterm><link linkend='var-SRCREV'>SRCREV</link></glossterm>
                    variable.</para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-b'><title>B</title>

        <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm>
            <glossdef>
                <para>The maximum number of tasks BitBake should run in parallel at any one time</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm>
            <glossdef>
                <para>List of recipes used by BitBake to build software</para>
            </glossdef>
        </glossentry>

        <!-- BBPATH is not a usable variable in .bb files and should not be listed here -->

        <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm>
            <glossdef>
                <para>Variable which controls how BitBake displays logs on build failure.</para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-c'><title>C</title>

        <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm>
            <glossdef>
                <para>
                    Flags passed to C compiler for the target system. Evaluates to the same 
                    as <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link>.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm>
            <glossdef>
                <para>A regular expression which evalutates to match the machines the recipe 
                works with. It stops recipes being run on machines they're incompatible with 
                which is partciuarly useful with kernels. It also helps to to increase parsing 
                speed as if its found the current machine is not compatible, further parsing 
                of the recipe is skipped.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm>
            <glossdef>
                <para>
                    Contains a list of files which containing autoconf test results relevant 
                    to the current build. This variable is used by the autotools utilities 
                    when running configure.
                </para>
            </glossdef>
        </glossentry>


        <glossentry id='var-CVS_TARBALL_STASH'><glossterm>CVS_TARBALL_STASH</glossterm>
            <glossdef>
                <para>Location to search for
                pre-generated tarballs when fetching from remote SCM
                repositories (CVS/SVN/GIT)</para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-d'><title>D</title>

        <glossentry id='var-D'><glossterm>D</glossterm>
            <glossdef>
                <para>Destination directory</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm>
            <glossdef>
                <para>
                    Build packages with debugging information. This influences the value 
                    <link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link> 
                    takes.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm>
            <glossdef>
                <para>
                    The options to pass in <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link>
                    and <link linkend='var-CFLAGS'>CFLAGS</link> when compiling a system for debugging.
                    This defaults to "-O -fno-omit-frame-pointer -g".
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm>
            <glossdef>
                <para>Priority of recipe</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm>
            <glossdef>
                <para>
                    A list of build time dependencies for a given recipe. These indicate 
                    recipes that must have staged before this recipe can configure.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm>
            <glossdef>
                <para>Package description used by package
                    managers</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DESTDIR'><glossterm>DESTDIR</glossterm>
            <glossdef>
                <para>Destination directory</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm>
            <glossdef>
                <para>Short name of distribution</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm>
            <glossdef>
                <para>List of packages required by distribution.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm>
            <glossdef>
                <para>List of packages which extend usability of
                    image. Those packages will be automatically
                    installed but can be removed by user.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm>
            <glossdef>
                <para>Features of the distribution.</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm>
            <glossdef>
                <para>Long name of distribution</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm>
            <glossdef>
                <para>Version of distribution</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm>
            <glossdef>
                <para>Directory where all fetched sources will be stored</para>
            </glossdef>

        </glossentry>
    </glossdiv>

    <glossdiv id='var-glossary-e'><title>E</title>

        <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm>
            <glossdef>
                <para>Variable which control which locales for glibc are
                to be generated during build (useful if target device
                has 64M RAM or less)</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm>
            <glossdef>
                <para>Additional 'configure' script options</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm>
            <glossdef>
                <para>Additional GNU make options</para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-f'><title>F</title>

        <glossentry id='var-FILES'><glossterm>FILES</glossterm>
            <glossdef>
                <para>list of directories/files which will be placed
                    in packages</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm>
            <glossdef>
                <para>
                    The options to pass in <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link>
                    and <link linkend='var-CFLAGS'>CFLAGS</link> when compiling an optimised system.
                    This defaults to "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2".
                </para>
            </glossdef>
        </glossentry>

    </glossdiv>

<!--            <glossdiv id='var-glossary-g'><title>G</title>-->
<!--            </glossdiv>-->

    <glossdiv id='var-glossary-h'><title>H</title>

        <glossentry id='var-HOMEPAGE'><glossterm>HOMEPAGE</glossterm>
            <glossdef>
                <para>Website where more info about package can be found</para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-i'><title>I</title>

        <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm>
            <glossdef>
                <para><link linkend="ref-features-image">List of
                features</link> present in resulting images</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm>
            <glossdef>
                <para>Formats of rootfs images which we want to have
                    created</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm>
            <glossdef>
                <para>List of packages used to build image</para>
            </glossdef>
        </glossentry>

        <glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm>
            <glossdef>
                <para>
                    This variable causes the build to not strip binaries in
                    resulting packages.
                </para>
            </glossdef>
        </glossentry>


        <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm>
            <glossdef>
                <para>
                    This variable causes the named class to be inherited at 
                    this point during parsing. Its only valid in configuration 
                    files.
                </para>
            </glossdef>
        </glossentry>


        <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm>
            <glossdef>
                <para>
                    Scope: Used in recipes when using update-rc.d.bbclass. Optional, defaults to PN.
                </para>
                <para>
                    A list of the packages which contain initscripts. If multiple 
                    packages are specified you need to append the package name 
                    to the other INITSCRIPT_* as an override.
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm>
            <glossdef>
                <para>
                    Scope: Used in recipes when using update-rc.d.bbclass. Mandatory.
                </para>
                <para>
                    The filename of the initscript (as installed to ${etcdir}/init.d).
                </para>
            </glossdef>
        </glossentry>

        <glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm>
            <glossdef>
                <para>
                    Scope: Used in recipes when using update-rc.d.bbclass. Mandatory.
                </para>
                <para>
                    Specifies the options to pass to update-rc.d. An example is
                     "start 99 5 2 . stop 20 0 1 6 ." which gives the script a 
                    runlevel of 99, starts the script in initlevels 2 and 5 and 
                     stops it in levels 0, 1 and 6. 
                </para>
            </glossdef>
        </glossentry>


    </glossdiv>

<!--            <glossdiv id='var-glossary-j'><title>J</title>-->
<!--            </glossdiv>-->

   <glossdiv id='var-glossary-k'><title>K</title>

        <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm>
            <glossdef>
                <para>The type of kernel to build for a device, usually set by the 
                machine configuration files and defaults to "zImage". This is used 
                when building the kernel and is passed to "make" as the target to 
                build.</para>
            </glossdef>
        </glossentry>

   </glossdiv>

    <glossdiv id='var-glossary-l'><title>L</title>

        <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm>
            <glossdef>
                <para>List of package source licenses.</para>
            </glossdef>
        </glossentry>

    </glossdiv>

    <glossdiv id='var-glossary-m'><title>M</title>

         <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm>
            <glossdef>
                <para>Target device</para>
            </glossdef>
         </glossentry>

         <glossentry id='var-MACHINE_ESSENTIAL_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_RDEPENDS</glossterm>
            <glossdef>
                <para>List of packages required to boot device</para>
            </glossdef>
         </glossentry>

         <glossentry id='var-MACHINE_ESSENTIAL_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_RRECOOMENDS