diff options
Diffstat (limited to 'documentation/ref-manual')
18 files changed, 3769 insertions, 925 deletions
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index c0c0d619a4..eaf07d665f 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml @@ -162,9 +162,10 @@ <itemizedlist> <listitem><para><emphasis>Parallelism Options:</emphasis> Controlled by the - <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> + <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>, + <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>, and - <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> + <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> variables.</para></listitem> <listitem><para><emphasis>Target Machine Selection:</emphasis> Controlled by the @@ -216,12 +217,10 @@ For example, suppose you had several build environments and they shared some common features. You can set these default build properties here. - A good example is perhaps the level of parallelism you want - to use through the - <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> - and - <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> - variables.</para> + A good example is perhaps the packaging format to use + through the + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + variable.</para> <para>One useful scenario for using the <filename>conf/site.conf</filename> file is to extend your <link linkend='var-BBPATH'><filename>BBPATH</filename></link> diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml index da6ce20eef..c53d458029 100644 --- a/documentation/ref-manual/faq.xml +++ b/documentation/ref-manual/faq.xml @@ -364,6 +364,41 @@ <qandaentry> <question> <para> + When I try to build a native recipe, the build fails with <filename>iconv.h</filename> problems. + </para> + </question> + <answer> + <para> + If you get an error message that indicates GNU + <filename>libiconv</filename> is not in use but + <filename>iconv.h</filename> has been included from + <filename>libiconv</filename>, you need to check to see if + you have a previously installed version of the header file + in <filename>/usr/local/include</filename>. + <literallayout class='monospaced'> + #error GNU libiconv not in use but included iconv.h is from libiconv + </literallayout> + If you find a previously installed file, you should either + uninstall it or temporarily rename it and try the build again. + </para> + + <para> + This issue is just a single manifestation of "system + leakage" issues caused when the OpenEbedded build system + finds and uses previously installed files during a native + build. + This type of issue might not be limited to + <filename>iconv.h</filename>. + Be sure that leakage cannot occur from + <filename>/usr/local/include</filename> and + <filename>/opt</filename> locations. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> What do we need to ship for license compliance? </para> </question> diff --git a/documentation/ref-manual/figures/buildhistory.png b/documentation/ref-manual/figures/buildhistory.png Binary files differindex 9a77bde68b..bd5f8a4908 100644 --- a/documentation/ref-manual/figures/buildhistory.png +++ b/documentation/ref-manual/figures/buildhistory.png diff --git a/documentation/ref-manual/figures/define-generic.png b/documentation/ref-manual/figures/define-generic.png Binary files differnew file mode 100644 index 0000000000..bd22718a55 --- /dev/null +++ b/documentation/ref-manual/figures/define-generic.png diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index f986f7c28e..be33ca965d 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml @@ -2,7 +2,7 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > -<chapter id='intro'> +<chapter id='ref-manual-intro'> <title>Introduction</title> <section id='intro-welcome'> @@ -160,16 +160,16 @@ <listitem><para>CentOS release 5.7 (Final)</para></listitem> <listitem><para>CentOS release 5.8 (Final)</para></listitem> <listitem><para>CentOS release 6.3 (Final)</para></listitem> --> - <listitem><para>CentOS release 6.4</para></listitem> - <listitem><para>CentOS release 6.5</para></listitem> + <listitem><para>CentOS release 6.x</para></listitem> + <listitem><para>CentOS release 7.x</para></listitem> <!-- <listitem><para>Debian GNU/Linux 6.0 (Squeeze)</para></listitem> --> - <listitem><para>Debian GNU/Linux 7.0 (Wheezy)</para></listitem> - <listitem><para>Debian GNU/Linux 7.1 (Wheezy)</para></listitem> + <listitem><para>Debian GNU/Linux 7.x (Wheezy)</para></listitem> +<!-- <listitem><para>Debian GNU/Linux 7.1 (Wheezy)</para></listitem> <listitem><para>Debian GNU/Linux 7.2 (Wheezy)</para></listitem> <listitem><para>Debian GNU/Linux 7.3 (Wheezy)</para></listitem> <listitem><para>Debian GNU/Linux 7.4 (Wheezy)</para></listitem> <listitem><para>Debian GNU/Linux 7.5 (Wheezy)</para></listitem> - <listitem><para>Debian GNU/Linux 7.6 (Wheezy)</para></listitem> + <listitem><para>Debian GNU/Linux 7.6 (Wheezy)</para></listitem> --> <!-- <listitem><para>openSUSE 11.4</para></listitem> <listitem><para>openSUSE 12.1</para></listitem> --> <listitem><para>openSUSE 12.2</para></listitem> @@ -398,7 +398,7 @@ Execute the installation script. Here is an example: <literallayout class='monospaced'> - $ sh poky-eglibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh + $ sh poky-glibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh </literallayout> During execution, a prompt appears that allows you to choose the installation directory. @@ -484,7 +484,7 @@ to install the tools. Here is an example: <literallayout class='monospaced'> - $ sh poky-eglibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh + $ sh poky-glibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh </literallayout> During execution, a prompt appears that allows you to choose the installation directory. diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index d072ecfa0e..3dc141c552 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml @@ -1014,7 +1014,7 @@ The <filename>buildhistory-diff</filename> and <filename>buildhistory-collect-srcrevs</filename> utilities have improved command-line handling. - Use the <filename>‐‐help</filename> option for + Use the <filename>--help</filename> option for each utility for more information on the new syntax. </para></listitem> </itemizedlist> @@ -1730,7 +1730,7 @@ The minimum <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> version required on the build host is now 1.7.8 because the - <filename>‐‐list</filename> option is now required by + <filename>--list</filename> option is now required by BitBake's Git fetcher. As always, if your host distribution does not provide a version of Git that meets this requirement, you can use the @@ -1770,7 +1770,7 @@ class instead of the <filename>autotools</filename> class. </para></listitem> <listitem><para><emphasis> - The <filename>‐‐foreign</filename> option is + The <filename>--foreign</filename> option is no longer passed to <filename>automake</filename> when running <filename>autoconf</filename>:</emphasis> This option tells <filename>automake</filename> that a diff --git a/documentation/ref-manual/ref-bitbake.xml b/documentation/ref-manual/ref-bitbake.xml index 28496dec9a..30aff6431f 100644 --- a/documentation/ref-manual/ref-bitbake.xml +++ b/documentation/ref-manual/ref-bitbake.xml @@ -169,7 +169,7 @@ <filename>packagegroup-core-x11-sato</filename>, which in turn leads to recipes like <filename>matchbox-terminal</filename>, <filename>pcmanfm</filename> and <filename>gthumb</filename>. - These recipes in turn depend on <filename>eglibc</filename> and the toolchain. + These recipes in turn depend on <filename>glibc</filename> and the toolchain. </para> <para> diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index fed25b25e6..f2c4c79c5a 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -580,8 +580,8 @@ <para> The <filename>debian</filename> class renames output packages so that - they follow the Debian naming policy (i.e. <filename>eglibc</filename> - becomes <filename>libc6</filename> and <filename>eglibc-devel</filename> + they follow the Debian naming policy (i.e. <filename>glibc</filename> + becomes <filename>libc6</filename> and <filename>glibc-devel</filename> becomes <filename>libc6-dev</filename>.) Renaming includes the library name and version as part of the package name. @@ -1177,7 +1177,7 @@ <link linkend='var-ICECC_DISABLED'><filename>ICECC_DISABLED</filename></link> variable to "1" as follows: <literallayout class='monospaced'> - INHERIT_DISTRO += "icecc" + INHERIT_DISTRO_append = " icecc" ICECC_DISABLED ??= "1" </literallayout> This practice makes sure everyone is using the same signatures but also @@ -2160,6 +2160,11 @@ <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>, and <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>. + <note><title>Warning</title> + The <filename>package_tar</filename> class is broken and not + supported. + It is recommended that you do not use this class. + </note> </para> <para> @@ -2298,6 +2303,12 @@ <section id='ref-classes-package_tar'> <title><filename>package_tar.bbclass</filename></title> + <note><title>Warning</title> + The <filename>package_tar</filename> class is broken and is not + supported. + It is recommended that you do not use it. + </note> + <para> The <filename>package_tar</filename> class provides support for creating packages that use the @@ -2797,7 +2808,7 @@ file. Here is an example: <literallayout class='monospaced'> - RM_WORK_EXCLUDE += "busybox eglibc" + RM_WORK_EXCLUDE += "busybox glibc" </literallayout> </para> </section> diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml index 230cabd155..e1a8cde464 100644 --- a/documentation/ref-manual/ref-features.xml +++ b/documentation/ref-manual/ref-features.xml @@ -222,13 +222,23 @@ <para> The following image features are available for all images: <itemizedlist> + <listitem><para><emphasis>allow-empty-password:</emphasis> + When 'debug-tweaks' is in + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>, + runs <filename>ssh_allow_empty_password</filename>, + which allows Dropbear and OpenSSH to accept root logins + and logins from accounts having an empty password string. + </para></listitem> <listitem><para><emphasis>dbg-pkgs:</emphasis> Installs debug symbol packages for all packages installed in a given image. </para></listitem> <listitem><para><emphasis>debug-tweaks:</emphasis> Makes an image suitable for development (e.g. - allows root logins without passwords). + allows root logins without passwords and enables + post-installation logging). + See the 'allow-empty-password' and 'post-install-logging' + features in this list for additional information. </para></listitem> <listitem><para><emphasis>dev-pkgs:</emphasis> Installs development packages (headers and extra library @@ -238,10 +248,22 @@ documentation packages for all packages installed in a given image. </para></listitem> + <listitem><para><emphasis>empty-root-password:</emphasis> + When 'debug-tweaks' is not in + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>, + runs <filename>zap_empty_root_password</filename>, + which disallows an empty root password. + </para></listitem> <listitem><para><emphasis>package-management:</emphasis> Installs package management tools and preserves the package manager database. </para></listitem> + <listitem><para><emphasis>post-install-logging:</emphasis> + When 'debug-tweaks' is in + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>, + runs <filename>postinst_enable_logging</filename>, which + enables post-installation logging. + </para></listitem> <listitem><para><emphasis>ptest-pkgs:</emphasis> Installs ptest packages for all ptest-enabled recipes. </para></listitem> diff --git a/documentation/ref-manual/ref-manual-customization.xsl b/documentation/ref-manual/ref-manual-customization.xsl index b58b1dcaf9..1bee3bd5d3 100644 --- a/documentation/ref-manual/ref-manual-customization.xsl +++ b/documentation/ref-manual/ref-manual-customization.xsl @@ -1,7 +1,7 @@ <?xml version='1.0'?> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" /> + <xsl:import href="http://docbook.sourceforge.net/release/xsl/1.76.1/xhtml/docbook.xsl" /> <xsl:include href="../template/permalinks.xsl"/> <xsl:include href="../template/section.title.xsl"/> diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml index 39b64e07bb..58f6ae390e 100644 --- a/documentation/ref-manual/ref-manual.xml +++ b/documentation/ref-manual/ref-manual.xml @@ -88,9 +88,9 @@ <revremark>Released with the Yocto Project 1.7 Release.</revremark> </revision> <revision> - <revnumber>1.7.1</revnumber> - <date>January 2015</date> - <revremark>Released with the Yocto Project 1.7.1 Release.</revremark> + <revnumber>1.8</revnumber> + <date>April 2015</date> + <revremark>Released with the Yocto Project 1.8 Release.</revremark> </revision> </revhistory> diff --git a/documentation/ref-manual/ref-qa-checks.xml b/documentation/ref-manual/ref-qa-checks.xml index 871cd294f6..43cb26db4c 100644 --- a/documentation/ref-manual/ref-qa-checks.xml +++ b/documentation/ref-manual/ref-qa-checks.xml @@ -894,7 +894,7 @@ can be found then it should be implemented. I can't find one at the moment. and there is another option that should be used instead. If you are unsure, consult the upstream build documentation, the - <filename>./configure ‐‐help</filename> output, + <filename>./configure --help</filename> output, and the upstream change log or release notes. Once you have worked out what the appropriate change is, you can update diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 14419d3a84..8976097d36 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml @@ -467,12 +467,8 @@ <filename><link linkend='var-MACHINE'>MACHINE</link></filename> for which you want to build, which package types you wish to use (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), - the location from which you want to access downloaded files - (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>), - and how you want your host machine to use resources - (<link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> - and - <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>). + and the location from which you want to access downloaded files + (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>). </para> <para> @@ -695,7 +691,7 @@ <para> This directory receives package licensing information. For example, the directory contains sub-directories for <filename>bash</filename>, - <filename>busybox</filename>, and <filename>eglibc</filename> (among others) that in turn + <filename>busybox</filename>, and <filename>glibc</filename> (among others) that in turn contain appropriate <filename>COPYING</filename> license files with other licensing information. For information on licensing, see the "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" @@ -833,7 +829,7 @@ Within this directory, the source is unpacked to <filename>linux-qemux86-standard-build</filename> and then patched by Quilt. (See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Using a Quilt Flow</ulink>" + "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Using Quilt in Your Workflow</ulink>" section in the Yocto Project Development Manual for more information.) Within the <filename>linux-qemux86-standard-build</filename> directory, standard Quilt directories <filename>linux-3.0/patches</filename> diff --git a/documentation/ref-manual/ref-style.css b/documentation/ref-manual/ref-style.css index e04b5006b4..a54083fc8a 100644 --- a/documentation/ref-manual/ref-style.css +++ b/documentation/ref-manual/ref-style.css @@ -201,7 +201,7 @@ div.variablelist dl { .variablelist dl dt, .variablelist dl dt span.term { font-weight: normal; - width: 20em; + width: 0em; text-align: right; } @@ -211,8 +211,9 @@ div.variablelist dl { .glossary dl dd, .variablelist dl dd { - margin-top: -1em; - margin-left: 25.5em; + margin-top: 0em; + margin-left: 15.5em; + margin-bottom: 2em; } .glossary dd p, @@ -221,6 +222,9 @@ div.variablelist dl { margin-bottom: 1em; } +.glossdeffirst { + text-indent: -70px; +} div.calloutlist table td { padding: 0em 0em 0em 0em; diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index f325f0e233..2b3031538f 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml @@ -628,7 +628,8 @@ <para> Checks the size of the kernel image against - <filename>KERNEL_IMAGE_MAXSIZE</filename> when set. + <link linkend='var-KERNEL_IMAGE_MAXSIZE'><filename>KERNEL_IMAGE_MAXSIZE</filename></link> + when set. </para> </section> diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index b22c661421..a79d8e5bcb 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-CFLAGS'>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-GDB'>G</link> <link linkend='var-HOMEPAGE'>H</link> <link linkend='var-ICECC_DISABLED'>I</link> <!-- <link linkend='var-glossary-j'>J</link> --> @@ -30,16 +30,16 @@ <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> <!-- <link linkend='var-glossary-v'>V</link> --> <link linkend='var-WARN_QA'>W</link> -<!-- <link linkend='var-glossary-x'>X</link> --> + <link linkend='var-XSERVER'>X</link> <!-- <link linkend='var-glossary-y'>Y</link> --> <!-- <link linkend='var-glossary-z'>Z</link>--> </para> @@ -47,8 +47,11 @@ <glossdiv id='var-glossary-a'><title>A</title> <glossentry id='var-ABIEXTENSION'><glossterm>ABIEXTENSION</glossterm> + <info> + ABIEXTENSION[doc] = "Extension to the Application Binary Interface (ABI) field of the GNU canonical architecture name (e.g. "eabi")." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Extension to the Application Binary Interface (ABI) field of the GNU canonical architecture name (e.g. "eabi"). @@ -66,9 +69,12 @@ </glossdef> </glossentry> - <glossentry id='var-ALLOW_EMPTY'><glossterm>ALLOW_EMPTY</glossterm> + <glossentry id='var-ALLOW_EMPTY'><glossterm>ALLOW_EMPTY</glossterm> + <info> + ALLOW_EMPTY[doc] = "Specifies if an output package should still be produced if it is empty." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies if an output package should still be produced if it is empty. By default, BitBake does not produce empty packages. This default behavior can cause issues when there is an @@ -86,11 +92,14 @@ </literallayout> </para> </glossdef> - </glossentry> + </glossentry> - <glossentry id='var-ALTERNATIVE'><glossterm>ALTERNATIVE</glossterm> + <glossentry id='var-ALTERNATIVE'><glossterm>ALTERNATIVE</glossterm> + <info> + ALTERNATIVE[doc] = "Lists commands in a package that need an alternative binary naming scheme." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists commands in a package that need an alternative binary naming scheme. Sometimes the same command is provided in multiple packages. @@ -113,11 +122,14 @@ section. </para> </glossdef> - </glossentry> + </glossentry> - <glossentry id='var-ALTERNATIVE_LINK_NAME'><glossterm>ALTERNATIVE_LINK_NAME</glossterm> + <glossentry id='var-ALTERNATIVE_LINK_NAME'><glossterm>ALTERNATIVE_LINK_NAME</glossterm> + <info> + ALTERNATIVE_LINK_NAME[doc] = "Used by the alternatives system to map duplicated commands to actual locations." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Used by the alternatives system to map duplicated commands to actual locations. For example, if the <filename>bracket</filename> command @@ -128,6 +140,9 @@ <literallayout class='monospaced'> ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/[" </literallayout> + </para> + + <para> In this example, the binary for the <filename>bracket</filename> command (i.e. <filename>[</filename>) from the @@ -146,11 +161,14 @@ section. </para> </glossdef> - </glossentry> + </glossentry> - <glossentry id='var-ALTERNATIVE_PRIORITY'><glossterm>ALTERNATIVE_PRIORITY</glossterm> + <glossentry id='var-ALTERNATIVE_PRIORITY'><glossterm>ALTERNATIVE_PRIORITY</glossterm> + <info> + ALTERNATIVE_PRIORITY[doc] = "Used by the alternatives system to create default priorities for duplicated commands." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Used by the alternatives system to create default priorities for duplicated commands. You can use the variable to create a single default @@ -171,11 +189,14 @@ section. </para> </glossdef> - </glossentry> + </glossentry> - <glossentry id='var-ALTERNATIVE_TARGET'><glossterm>ALTERNATIVE_TARGET</glossterm> + <glossentry id='var-ALTERNATIVE_TARGET'><glossterm>ALTERNATIVE_TARGET</glossterm> + <info> + ALTERNATIVE_TARGET[doc] = "Used by the alternatives system to create default link locations for duplicated commands." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Used by the alternatives system to create default link locations for duplicated commands. You can use the variable to create a single default @@ -222,11 +243,14 @@ section. </para> </glossdef> - </glossentry> + </glossentry> - <glossentry id='var-APPEND'><glossterm>APPEND</glossterm> + <glossentry id='var-APPEND'><glossterm>APPEND</glossterm> + <info> + APPEND[doc] = "An override list of append strings for each LABEL." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> An override list of append strings for each <link linkend='var-LABELS'><filename>LABEL</filename></link>. </para> @@ -237,11 +261,38 @@ class for more information on how this variable is used. </para> </glossdef> - </glossentry> + </glossentry> - <glossentry id='var-ASSUME_PROVIDED'><glossterm>ASSUME_PROVIDED</glossterm> + <glossentry id='var-AR'><glossterm>AR</glossterm> + <info> + AR[doc] = "Minimal command and arguments to run 'ar'." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments used to run + <filename>ar</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-AS'><glossterm>AS</glossterm> + <info> + AS[doc] = "Minimal command and arguments to run the assembler." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments used to run the + assembler. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ASSUME_PROVIDED'><glossterm>ASSUME_PROVIDED</glossterm> + <info> + ASSUME_PROVIDED[doc] = "Lists recipe names (PN values) BitBake does not attempt to build." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists recipe names (<link linkend='var-PN'><filename>PN</filename></link> values) BitBake does not attempt to build. @@ -257,43 +308,133 @@ used rather than building <filename>git-native</filename>. </para> </glossdef> - </glossentry> + </glossentry> + + <glossentry id='var-ASSUME_SHLIBS'><glossterm>ASSUME_SHLIBS</glossterm> + <info> + ASSUME_SHLIBS[doc] = Provides additional shlibs provider mapping information, which adds to or overwrites the information provided automatically by the system." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Provides additional <filename>shlibs</filename> provider + mapping information, which adds to or overwrites the + information provided automatically by the system. + Separate multiple entries using spaces. + </para> + + <para> + As an example, use the following form to add an + <filename>shlib</filename> provider of + <replaceable>shlibname</replaceable> in + <replaceable>packagename</replaceable> with the optional + <replaceable>version</replaceable>: + <literallayout class='monospaced'> + <replaceable>shlibname:packagename</replaceable>[_<replaceable>version</replaceable>] + </literallayout> + </para> - <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> + <para> + Here is an example that adds a shared library named + <filename>libEGL.so.1</filename> as being provided by + the <filename>libegl-implementation</filename> package: + <literallayout class='monospaced'> + ASSUME_SHLIBS = "libEGL.so.1:libegl-implementation" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> + <info> + AUTHOR[doc] = "Email address used to contact the original author or authors in order to send patches and forward bugs." + </info> <glossdef> - <para>The email address used to contact the original author - or authors in order to send patches and forward bugs.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The email address used to contact the original author + or authors in order to send patches and forward bugs. + </para> </glossdef> - </glossentry> + </glossentry> - <glossentry id='var-AUTO_SYSLINUXMENU'><glossterm>AUTO_SYSLINUXMENU</glossterm> + <glossentry id='var-AUTO_LIBNAME_PKGS'><glossterm>AUTO_LIBNAME_PKGS</glossterm> + <info> + AUTO_LIBNAME_PKGS[doc] = "Specifies which packages should be checked for libraries and renamed according to Debian library package naming." + </info> <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + When the + <link linkend='ref-classes-debian'><filename>debian</filename></link> + class is inherited, which is the default behavior, + <filename>AUTO_LIBNAME_PKGS</filename> specifies which + packages should be checked for libraries and renamed + according to Debian library package naming. + </para> + <para> - Enables creating an automatic menu. - You must set this in your recipe. + The default value is "${PACKAGES}", which causes the + debian class to act on all packages that are + explicitly generated by the recipe. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-AUTO_SYSLINUXMENU'><glossterm>AUTO_SYSLINUXMENU</glossterm> + <info> + AUTO_SYSLINUXMENU[doc] = "Enables creating an automatic menu for the syslinux bootloader." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Enables creating an automatic menu for the syslinux + bootloader. + You must set this variable in your recipe. The <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> class checks this variable. </para> </glossdef> - </glossentry> + </glossentry> <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm> + <info> + AUTOREV[doc] = "When SRCREV is set to the value of this variable, it specifies to use the latest source revision in the repository." + </info> <glossdef> - <para>When <filename><link linkend='var-SRCREV'>SRCREV</link></filename> - is set to the value of this variable, it specifies to use the latest - source revision in the repository. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + When + <filename><link linkend='var-SRCREV'>SRCREV</link></filename> + is set to the value of this variable, it specifies to use + the latest source revision in the repository. Here is an example: <literallayout class='monospaced'> SRCREV = "${AUTOREV}" </literallayout> </para> + + <para> + If you use the previous statement to retrieve the latest + version of software, you need to be sure + <link linkend='var-PV'><filename>PV</filename></link> + contains + <filename>${</filename><link linkend='var-SRCPV'><filename>SRCPV</filename></link><filename>}</filename>. + For example, suppose you have a kernel recipe that + inherits the + <link linkend='ref-classes-kernel'>kernel</link> class + and you use the previous statement. + In this example, <filename>${SRCPV}</filename> does not + automatically get into <filename>PV</filename>. + Consequently, you need to change <filename>PV</filename> + in your recipe so that it does contain + <filename>${SRCPV}</filename>. + </para> </glossdef> </glossentry> <glossentry id='var-AVAILTUNES'><glossterm>AVAILTUNES</glossterm> + <info> + AVAILTUNES[doc] = "The list of defined CPU and Application Binary Interface (ABI) tunings (i.e. "tunes") available for use by the OpenEmbedded build system." + </info> <glossdef> - <para> + <para id='var-define-AVAILTUNES' role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The list of defined CPU and Application Binary Interface (ABI) tunings (i.e. "tunes") available for use by the OpenEmbedded build system. @@ -318,14 +459,16 @@ </glossdef> </glossentry> - </glossdiv> <glossdiv id='var-glossary-b'><title>B</title> <glossentry id='var-B'><glossterm>B</glossterm> + <info> + B[doc] = "The Build Directory. The OpenEmbedded build system places generated objects into the Build Directory during a recipe's build process." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The directory within the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> in which the OpenEmbedded build system places generated @@ -335,6 +478,9 @@ <literallayout class='monospaced'> S = "${WORKDIR}/${BP}/" </literallayout> + </para> + + <para> You can separate the (<filename>S</filename>) directory and the directory pointed to by the <filename>B</filename> variable. @@ -347,8 +493,11 @@ </glossentry> <glossentry id='var-BAD_RECOMMENDATIONS'><glossterm>BAD_RECOMMENDATIONS</glossterm> + <info> + BAD_RECOMMENDATIONS[doc] = "A list of packages not to install despite being recommended by a recipe. Support for this variable exists only when using the IPK packaging backend." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists "recommended-only" packages to not install. Recommended-only packages are packages installed only through the @@ -360,6 +509,9 @@ <literallayout class='monospaced'> BAD_RECOMMENDATIONS = "<replaceable>package_name</replaceable> <replaceable>package_name</replaceable> <replaceable>package_name</replaceable> ..." </literallayout> + </para> + + <para> You can set this variable globally in your <filename>local.conf</filename> file or you can attach it to a specific image recipe by using the recipe name override: @@ -395,8 +547,11 @@ </glossentry> <glossentry id='var-BASE_LIB'><glossterm>BASE_LIB</glossterm> + <info> + BASE_LIB[doc] = "The library directory name for the CPU or Application Binary Interface (ABI) tune." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The library directory name for the CPU or Application Binary Interface (ABI) tune. The <filename>BASE_LIB</filename> applies only in the @@ -416,9 +571,24 @@ </glossdef> </glossentry> + <glossentry id='var-BASE_WORKDIR'><glossterm>BASE_WORKDIR</glossterm> + <info> + BASE_WORKDIR[doc] = "Points to the base of the work directory for all recipes." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Points to the base of the work directory for all recipes. + The default value is "${TMPDIR}/work". + </para> + </glossdef> + </glossentry> + <glossentry id='var-BB_DANGLINGAPPENDS_WARNONLY'><glossterm>BB_DANGLINGAPPENDS_WARNONLY</glossterm> + <info> + BB_DANGLINGAPPENDS_WARNONLY[doc] = "Defines how BitBake handles situations where an append file (.bbappend) has no corresponding recipe file (.bb)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines how BitBake handles situations where an append file (<filename>.bbappend</filename>) has no corresponding recipe file (<filename>.bb</filename>). @@ -451,8 +621,11 @@ </glossentry> <glossentry id='var-BB_DISKMON_DIRS'><glossterm>BB_DISKMON_DIRS</glossterm> + <info> + BB_DISKMON_DIRS[doc] = "Monitors disk space and available inodes during the build and allows you to control the build based on these parameters." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Monitors disk space and available inodes during the build and allows you to control the build based on these parameters. @@ -546,8 +719,11 @@ </glossentry> <glossentry id='var-BB_DISKMON_WARNINTERVAL'><glossterm>BB_DISKMON_WARNINTERVAL</glossterm> + <info> + BB_DISKMON_WARNINTERVAL[doc] = "Defines the disk space and free inode warning intervals. To set these intervals, define the variable in the conf/local.conf file in the Build Directory." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the disk space and free inode warning intervals. To set these intervals, define the variable in your <filename>conf/local.conf</filename> file in the @@ -614,8 +790,11 @@ </glossentry> <glossentry id='var-BB_GENERATE_MIRROR_TARBALLS'><glossterm>BB_GENERATE_MIRROR_TARBALLS</glossterm> + <info> + BB_GENERATE_MIRROR_TARBALLS[doc] = "Causes tarballs of the Git repositories to be placed in the DL_DIR directory." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Causes tarballs of the Git repositories, including the Git metadata, to be placed in the <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> @@ -637,25 +816,28 @@ </glossentry> <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm> + <info> + BB_NUMBER_THREADS[doc] = "The maximum number of tasks BitBake should run in parallel at any one time. This variable is automatically configured to be equal to the number of build system cores." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The maximum number of tasks BitBake should run in parallel at any one time. - If your host development system supports multiple cores, - a good rule of thumb is to set this variable to twice the - number of cores. - </para> - - <para> - The default value for <filename>BB_NUMBER_THREADS</filename> - is equal to the number of cores your build system has. + The OpenEmbedded build system automatically configures + this variable to be equal to the number of cores on the + build system. + To gain optimal parallelism, you should not have to + override this variable. </para> </glossdef> </glossentry> <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm> + <info> + BBCLASSEXTEND[doc] = "Allows you to extend a recipe so that it builds variants of the software. Common variants for recipes are 'native', 'cross', 'nativesdk' and multilibs." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> 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; @@ -678,8 +860,12 @@ </glossentry> <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm> + <info> + BBFILE_COLLECTIONS[doc] = "Lists the names of configured layers. These names are used to find the other BBFILE_* variables." + </info> <glossdef> - <para>Lists the names of configured layers. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Lists the names of configured layers. These names are used to find the other <filename>BBFILE_*</filename> variables. Typically, each layer will append its name to this variable in its @@ -689,20 +875,32 @@ </glossentry> <glossentry id='var-BBFILE_PATTERN'><glossterm>BBFILE_PATTERN</glossterm> + <info> + BBFILE_PATTERN[doc] = "Variable that expands to match files from BBFILES in a particular layer. This variable is used in the layer.conf file and must be suffixed with the name of a layer." + </info> <glossdef> - <para>Variable that expands to match files from + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Variable that expands to match files from <link linkend='var-BBFILES'><filename>BBFILES</filename></link> in a particular layer. This variable is used in the <filename>conf/layer.conf</filename> file and must be suffixed with the name of the specific layer (e.g. - <filename>BBFILE_PATTERN_emenlow</filename>).</para> + <filename>BBFILE_PATTERN_emenlow</filename>). + </para> </glossdef> </glossentry> <glossentry id='var-BBFILE_PRIORITY'><glossterm>BBFILE_PRIORITY</glossterm> + <info> + BBFILE_PRIORITY[doc] = "Assigns the priority for recipe files in each layer. Setting this variable allows you to prioritize a layer against other layers that contain the same recipe." + </info> <glossdef> - <para>Assigns the priority for recipe files in each layer.</para> - <para>This variable is useful in situations where the same recipe appears in + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Assigns the priority for recipe files in each layer. + </para> + + <para> + This variable is useful in situations where the same recipe appears in more than one layer. Setting this variable allows you to prioritize a layer against other layers that contain the same recipe - effectively @@ -712,8 +910,11 @@ (<link linkend='var-PV'><filename>PV</filename></link> variable). For example, a layer that has a recipe with a higher <filename>PV</filename> value but for which the <filename>BBFILE_PRIORITY</filename> is set to have a lower precedence still has a - lower precedence.</para> - <para>A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher + lower precedence. + </para> + + <para> + A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher precedence. For example, the value 6 has a higher precedence than the value 5. If not specified, the <filename>BBFILE_PRIORITY</filename> variable is set based on layer @@ -722,7 +923,8 @@ more information. The default priority, if unspecified for a layer with no dependencies, is the lowest defined priority + 1 - (or 1 if no priorities are defined).</para> + (or 1 if no priorities are defined). + </para> <tip> You can use the command <filename>bitbake-layers show-layers</filename> to list all configured layers along with their priorities. @@ -731,20 +933,50 @@ </glossentry> <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm> + <info> + BBFILES[doc] = "List of recipe files used by BitBake to build software." + </info> <glossdef> - <para>List of recipe files used by BitBake to build software.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + List of recipe files used by BitBake to build software. + </para> </glossdef> </glossentry> <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm> + <info> + BBINCLUDELOGS[doc] = "Variable that controls how BitBake displays logs on build failure." + </info> <glossdef> - <para>Variable that controls how BitBake displays logs on build failure.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Variable that controls how BitBake displays logs on build failure. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BBINCLUDELOGS_LINES'><glossterm>BBINCLUDELOGS_LINES</glossterm> + <info> + BBINCLUDELOGS_LINES[doc] = "Amount of log lines printed on failure." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + If + <link linkend='var-BBINCLUDELOGS'><filename>BBINCLUDELOGS</filename></link> + is set, specifies the maximum number of lines from the + task log file to print when reporting a failed task. + If you do not set <filename>BBINCLUDELOGS_LINES</filename>, + the entire log is printed. + </para> </glossdef> </glossentry> <glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm> + <info> + BBLAYERS[doc] = "Lists the layers to enable during the build. This variable is defined in the bblayers.conf configuration file." + </info> <glossdef> - <para>Lists the layers to enable during the build. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Lists the layers to enable during the build. This variable is defined in the <filename>bblayers.conf</filename> configuration file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. Here is an example: @@ -761,6 +993,9 @@ /home/scottrif/poky/meta-yocto \ " </literallayout> + </para> + + <para> This example enables four layers, one of which is a custom, user-defined layer named <filename>meta-mykernel</filename>. </para> @@ -768,8 +1003,12 @@ </glossentry> <glossentry id='var-BBLAYERS_NON_REMOVABLE'><glossterm>BBLAYERS_NON_REMOVABLE</glossterm> + <info> + BBLAYERS_NON_REMOVABLE[doc] = "Lists core layers that cannot be removed from the bblayers.conf file." + </info> <glossdef> - <para>Lists core layers that cannot be removed from the + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Lists core layers that cannot be removed from the <filename>bblayers.conf</filename> file during a build using the <ulink url='https://www.yoctoproject.org/tools-resources/projects/hob'>Hob</ulink>. @@ -777,6 +1016,9 @@ When building an image outside of Hob, this variable is ignored. </note> + </para> + + <para> In order for BitBake to build your image using Hob, your <filename>bblayers.conf</filename> file must include the <filename>meta</filename> and <filename>meta-yocto</filename> @@ -802,7 +1044,10 @@ <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm> <glossdef> - <para> + <info> + BBMASK[doc] = "Prevents BitBake from processing specific recipes or recipe append files. Use the BBMASK variable from within conf/local.conf." + </info> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Prevents BitBake from processing recipes and recipe append files. Use the <filename>BBMASK</filename> variable from within the @@ -861,8 +1106,11 @@ </glossentry> <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm> + <info> + BBPATH[doc] = "Used by BitBake to locate .bbclass and configuration files. This variable is analogous to the PATH variable." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Used by BitBake to locate <filename>.bbclass</filename> and configuration files. This variable is analogous to the @@ -886,8 +1134,11 @@ </glossentry> <glossentry id='var-BBSERVER'><glossterm>BBSERVER</glossterm> + <info> + BBSERVER[doc] = "Points to the server that runs memory-resident BitBake." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to the server that runs memory-resident BitBake. This variable is set by the <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> @@ -898,6 +1149,9 @@ <literallayout class='monospaced'> export BBSERVER=localhost:$port </literallayout> + </para> + + <para> For more information on how the <filename>BBSERVER</filename> is used, see the <filename>oe-init-build-env-memres</filename> script, which @@ -908,8 +1162,11 @@ </glossentry> <glossentry id='var-BINCONFIG'><glossterm>BINCONFIG</glossterm> + <info> + BINCONFIG[doc] = "When inheriting the binconfig-disabled class, this variable specifies binary configuration scripts to disable in favor of using pkg-config to query the information." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-binconfig-disabled'><filename>binconfig-disabled</filename></link> class, this variable specifies binary configuration @@ -932,8 +1189,11 @@ </glossentry> <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm> + <info> + BINCONFIG_GLOB[doc] = "When inheriting binconfig.bbclass from a recipe, this variable specifies a wildcard for configuration scripts that need editing." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link> class, this variable specifies a wildcard for @@ -956,20 +1216,29 @@ </glossentry> <glossentry id='var-BP'><glossterm>BP</glossterm> + <info> + BP[doc] = "The base recipe name and version but without any special recipe name suffix (i.e. -native, lib64-, and so forth). BP is comprised of ${BPN}-${PV}" + </info> <glossdef> - <para>The base recipe name and version but without any special + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The base recipe name and version but without any special recipe name suffix (i.e. <filename>-native</filename>, <filename>lib64-</filename>, and so forth). <filename>BP</filename> is comprised of the following: <literallayout class="monospaced"> ${BPN}-${PV} - </literallayout></para> + </literallayout> + </para> </glossdef> </glossentry> <glossentry id='var-BPN'><glossterm>BPN</glossterm> + <info> + BPN[doc] = "The bare name of the recipe. This variable is a version of the PN variable but removes common suffixes and prefixes." + </info> <glossdef> - <para>The bare name of the recipe. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The bare name of the recipe. This variable is a version of the <link linkend='var-PN'><filename>PN</filename></link> variable but removes common suffixes such as "-native" and "-cross" as well as removes common prefixes such as multilib's "lib64-" and "lib32-". @@ -978,13 +1247,17 @@ The exact list of prefixes removed is specified by the <link linkend='var-MLPREFIX'><filename>MLPREFIX</filename></link> variable. Prefixes are removed for <filename>multilib</filename> - and <filename>nativesdk</filename> cases.</para> + and <filename>nativesdk</filename> cases. + </para> </glossdef> </glossentry> <glossentry id='var-BUGTRACKER'><glossterm>BUGTRACKER</glossterm> + <info> + BUGTRACKER[doc] = "Specifies a URL for an upstream bug tracking website for a recipe." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a URL for an upstream bug tracking website for a recipe. The OpenEmbedded build system does not use this variable. @@ -994,9 +1267,27 @@ </glossdef> </glossentry> + <glossentry id='var-BUILD_ARCH'><glossterm>BUILD_ARCH</glossterm> + <info> + BUILD_ARCH[doc] = "The name of the building architecture (e.g. i686)." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the architecture of the build host + (e.g. <filename>i686</filename>). + The OpenEmbedded build system sets the value of + <filename>BUILD_ARCH</filename> from the machine name + reported by the <filename>uname</filename> command. + </para> + </glossdef> + </glossentry> + <glossentry id='var-BUILD_CFLAGS'><glossterm>BUILD_CFLAGS</glossterm> + <info> + BUILD_CFLAGS[doc] = "Specifies the flags to pass to the C compiler when building for the build host." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C compiler when building for the build host. When building in the <filename>-native</filename> context, @@ -1007,8 +1298,11 @@ </glossentry> <glossentry id='var-BUILD_CPPFLAGS'><glossterm>BUILD_CPPFLAGS</glossterm> + <info> + BUILD_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the build host." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the build host. @@ -1020,8 +1314,11 @@ </glossentry> <glossentry id='var-BUILD_CXXFLAGS'><glossterm>BUILD_CXXFLAGS</glossterm> + <info> + BUILD_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the build host." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C++ compiler when building for the build host. When building in the <filename>native</filename> context, @@ -1032,8 +1329,11 @@ </glossentry> <glossentry id='var-BUILD_LDFLAGS'><glossterm>BUILD_LDFLAGS</glossterm> + <info> + BUILD_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the build host." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the linker when building for the build host. When building in the <filename>-native</filename> context, @@ -1044,8 +1344,11 @@ </glossentry> <glossentry id='var-BUILD_OPTIMIZATION'><glossterm>BUILD_OPTIMIZATION</glossterm> + <info> + BUILD_OPTIMIZATION[doc] = "Specifies the optimization flags passed to the C compiler when building for the build host or the SDK." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the optimization flags passed to the C compiler when building for the build host or the SDK. The flags are passed through the @@ -1063,9 +1366,81 @@ </glossdef> </glossentry> - <glossentry id='var-BUILDDIR'><glossterm>BUILDDIR</glossterm> + <glossentry id='var-BUILD_OS'><glossterm>BUILD_OS</glossterm> + <info> + BUILD_OS[doc] = "The operating system (in lower case) of the building architecture (e.g. Linux)." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the operating system in use on the build + host (e.g. "linux"). + The OpenEmbedded build system sets the value of + <filename>BUILD_OS</filename> from the OS reported by + the <filename>uname</filename> command - the first word, + converted to lower-case characters. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_PREFIX'><glossterm>BUILD_PREFIX</glossterm> + <info> + BUILD_PREFIX[doc] = "The toolchain binary prefix used for native recipes." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The toolchain binary prefix used for native recipes. + The OpenEmbedded build system uses the + <filename>BUILD_PREFIX</filename> value to set the + <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link> + when building for native recipes. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_SYS'><glossterm>BUILD_SYS</glossterm> + <info> + BUILD_SYS[doc] = "The toolchain binary prefix used for native recipes." + </info> <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the system, including the architecture and + the operating system, to use when building for the build + host (i.e. when building <filename>native</filename> + recipes). + </para> + <para> + The OpenEmbedded build system automatically sets this + variable based on + <link linkend='var-BUILD_ARCH'><filename>BUILD_ARCH</filename></link>, + <link linkend='var-BUILD_VENDOR'><filename>BUILD_VENDOR</filename></link>, + and + <link linkend='var-BUILD_OS'><filename>BUILD_OS</filename></link>. + You do not need to set the <filename>BUILD_SYS</filename> + variable yourself. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_VENDOR'><glossterm>BUILD_VENDOR</glossterm> + <info> + BUILD_VENDOR[doc] = "The vendor name to use when building for the build host." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the vendor name to use when building for the + build host. + The default value is an empty string (""). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDDIR'><glossterm>BUILDDIR</glossterm> + <info> + BUILDDIR[doc] = "Points to the location of the Build Directory." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to the location of the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. You can define this directory indirectly through the @@ -1082,8 +1457,11 @@ </glossentry> <glossentry id='var-BUILDHISTORY_COMMIT'><glossterm>BUILDHISTORY_COMMIT</glossterm> + <info> + BUILDHISTORY_COMMIT[doc] = "When inheriting the buildhistory class, this variable specifies whether or not to commit the build history output in a local Git repository." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable specifies whether or not to commit the @@ -1110,8 +1488,11 @@ </glossentry> <glossentry id='var-BUILDHISTORY_COMMIT_AUTHOR'><glossterm>BUILDHISTORY_COMMIT_AUTHOR</glossterm> + <info> + BUILDHISTORY_COMMIT_AUTHOR[doc] = "When inheriting the buildhistory class, this variable specifies the author to use for each Git commit." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable specifies the author to use for each @@ -1141,8 +1522,11 @@ </glossentry> <glossentry id='var-BUILDHISTORY_DIR'><glossterm>BUILDHISTORY_DIR</glossterm> + <info> + BUILDHISTORY_DIR[doc] = "When inheriting the buildhistory class, this variable specifies the directory in which build history information is kept." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable specifies the directory in which @@ -1162,8 +1546,11 @@ </glossentry> <glossentry id='var-BUILDHISTORY_FEATURES'><glossterm>BUILDHISTORY_FEATURES</glossterm> + <info> + BUILDHISTORY_FEATURES[doc] = "When inheriting the buildhistory class, this variable specifies the build history features to be enabled." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable specifies the build history features @@ -1203,8 +1590,11 @@ </glossentry> <glossentry id='var-BUILDHISTORY_IMAGE_FILES'><glossterm>BUILDHISTORY_IMAGE_FILES</glossterm> + <info> + BUILDHISTORY_IMAGE_FILES[doc] = "When inheriting the buildhistory class, this variable specifies a list of paths to files copied from the image contents into the build history directory under an "image-files" directory in the directory for the image, so that you can track the contents of each file." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable specifies a list of paths to files @@ -1232,8 +1622,11 @@ </glossentry> <glossentry id='var-BUILDHISTORY_PUSH_REPO'><glossterm>BUILDHISTORY_PUSH_REPO</glossterm> + <info> + BUILDHISTORY_PUSH_REPO[doc] = "When inheriting the buildhistory class, this variable optionally specifies a remote repository to which build history pushes Git changes." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable optionally specifies a remote @@ -1263,8 +1656,11 @@ </glossentry> <glossentry id='var-BUILDSDK_CFLAGS'><glossterm>BUILDSDK_CFLAGS</glossterm> + <info> + BUILDSDK_CFLAGS[doc] = "Specifies the flags to pass to the C compiler when building for the SDK." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C compiler when building for the SDK. When building in the <filename>nativesdk</filename> @@ -1276,8 +1672,11 @@ </glossentry> <glossentry id='var-BUILDSDK_CPPFLAGS'><glossterm>BUILDSDK_CPPFLAGS</glossterm> + <info> + BUILDSDK_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the SDK." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the SDK. @@ -1290,8 +1689,11 @@ </glossentry> <glossentry id='var-BUILDSDK_CXXFLAGS'><glossterm>BUILDSDK_CXXFLAGS</glossterm> + <info> + BUILDSDK_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the SDK." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C++ compiler when building for the SDK. When building in the <filename>nativesdk</filename> @@ -1303,8 +1705,11 @@ </glossentry> <glossentry id='var-BUILDSDK_LDFLAGS'><glossterm>BUILDSDK_LDFLAGS</glossterm> + <info> + BUILDSDK_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the SDK." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the linker when building for the SDK. When building in the <filename>nativesdk-</filename> @@ -1316,8 +1721,11 @@ </glossentry> <glossentry id='var-BUILDSTATS_BASE'><glossterm>BUILDSTATS_BASE</glossterm> + <info> + BUILDSTATS_BASE[doc] = "Points to the location of the directory that holds build statistics when you use and enable the buildstats class." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to the location of the directory that holds build statistics when you use and enable the <link linkend='ref-classes-buildstats'><filename>buildstats</filename></link> @@ -1330,8 +1738,11 @@ </glossentry> <glossentry id='var-BUSYBOX_SPLIT_SUID'><glossterm>BUSYBOX_SPLIT_SUID</glossterm> + <info> + BUSYBOX_SPLIT_SUID[doc] = "For the BusyBox recipe, specifies whether to split the output executable file into two parts: one for features that require setuid root, and one for the remaining features." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> For the BusyBox recipe, specifies whether to split the output executable file into two parts: one for features that require <filename>setuid root</filename>, and one for @@ -1352,9 +1763,39 @@ <glossdiv id='var-glossary-c'><title>C</title> + <glossentry id='var-CACHE'><glossterm>CACHE</glossterm> + <info> + CACHE[doc] = "The directory BitBake uses to store a cache of the metadata." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the directory BitBake uses to store a cache + of the + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> + so it does not need to be parsed every time BitBake is + started. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CC'><glossterm>CC</glossterm> + <info> + CC[doc] = "Minimum command and arguments to run the C compiler." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments used to run the C + compiler. + </para> + </glossdef> + </glossentry> + <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm> + <info> + CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the same as TARGET_CFLAGS." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C compiler. This variable is exported to an environment variable and thus made visible to the software being @@ -1385,8 +1826,11 @@ </glossentry> <glossentry id='var-CLASSOVERRIDE'><glossterm>CLASSOVERRIDE</glossterm> + <info> + CLASSOVERRIDE[doc] = "An internal variable specifying the special class override that should currently apply (e.g. "class-target", "class-native", and so forth)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> An internal variable specifying the special class override that should currently apply (e.g. "class-target", "class-native", and so forth). @@ -1410,9 +1854,30 @@ </glossdef> </glossentry> + <glossentry id='var-CLEANBROKEN'><glossterm>CLEANBROKEN</glossterm> + <info> + CLEANBROKEN[doc] = "Prevents the build system from running 'make clean' during the do_configure task." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + If set to "1" within a recipe, + <filename>CLEANBROKEN</filename> specifies that + the <filename>make clean</filename> command does + not work for the software being built. + Consequently, the OpenEmbedded build system will not try + to run <filename>make clean</filename> during the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task, which is the default behavior. + </para> + </glossdef> + </glossentry> + <glossentry id='var-COMBINED_FEATURES'><glossterm>COMBINED_FEATURES</glossterm> + <info> + COMBINED_FEATURES[doc] = "A set of features common between MACHINE_FEATURES and DISTRO_FEATURES." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Provides a list of hardware features that are enabled in both <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> @@ -1437,8 +1902,11 @@ </glossentry> <glossentry id='var-COMMON_LICENSE_DIR'><glossterm>COMMON_LICENSE_DIR</glossterm> + <info> + COMMON_LICENSE_DIR[doc] = "Points to meta/files/common-licenses in the Source Directory, which is where generic license files reside." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to <filename>meta/files/common-licenses</filename> in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>, @@ -1448,8 +1916,12 @@ </glossentry> <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm> + <info> + COMPATIBLE_HOST[doc] = "A regular expression that resolves to one or more hosts (when the recipe is native) or one or more targets (when the recipe is non-native) with which a recipe is compatible." + </info> <glossdef> - <para>A regular expression that resolves to one or more hosts + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + A regular expression that resolves to one or more hosts (when the recipe is native) or one or more targets (when the recipe is non-native) with which a recipe is compatible. The regular expression is matched against @@ -1460,13 +1932,18 @@ Stopping these builds is particularly useful with kernels. The variable also helps to increase parsing speed since the build system skips parsing recipes not - compatible with the current system.</para> + compatible with the current system. + </para> </glossdef> </glossentry> <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> + <info> + COMPATIBLE_MACHINE[doc] = "A regular expression that resolves to one or more target machines with which a recipe is compatible." + </info> <glossdef> - <para>A regular expression that resolves to one or more + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + A regular expression that resolves to one or more target machines with which a recipe is compatible. The regular expression is matched against <link linkend="var-MACHINEOVERRIDES"><filename>MACHINEOVERRIDES</filename></link>. @@ -1475,13 +1952,17 @@ Stopping these builds is particularly useful with kernels. The variable also helps to increase parsing speed since the build system skips parsing recipes not - compatible with the current machine.</para> + compatible with the current machine. + </para> </glossdef> </glossentry> <glossentry id='var-COMPLEMENTARY_GLOB'><glossterm>COMPLEMENTARY_GLOB</glossterm> + <info> + COMPLEMENTARY_GLOB[doc] = "Defines wildcards to match when installing a list of complementary packages for all the packages installed in an image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines wildcards to match when installing a list of complementary packages for all the packages explicitly (or implicitly) installed in an image. @@ -1506,9 +1987,27 @@ </glossdef> </glossentry> + <glossentry id='var-CONF_VERSION'><glossterm>CONF_VERSION</glossterm> + <info> + CONF_VERSION[doc] = "Tracks the version of local.conf. Increased each time build/conf/ changes incompatibly." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + 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>CONFFILES</glossterm> + <info> + CONFFILES[doc] = "Identifies editable or configurable files that are part of a package." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Identifies editable or configurable files that are part of a package. If the Package Management System (PMS) is being used to update packages on the target system, it is possible that @@ -1557,8 +2056,11 @@ </glossentry> <glossentry id='var-CONFIG_INITRAMFS_SOURCE'><glossterm>CONFIG_INITRAMFS_SOURCE</glossterm> + <info> + CONFIG_INITRAMFS_SOURCE[doc] = "Identifies the initial RAM disk (initramfs) source files. The OpenEmbedded build system receives and uses this kernel Kconfig variable as an environment variable." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Identifies the initial RAM disk (initramfs) source files. The OpenEmbedded build system receives and uses this kernel Kconfig variable as an environment variable. @@ -1589,8 +2091,11 @@ </glossentry> <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm> + <info> + CONFIG_SITE[doc] = "A list of files that contains autoconf test results relevant to the current build. This variable is used by the Autotools utilities when running configure." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of files that contains <filename>autoconf</filename> test results relevant to the current build. This variable is used by the Autotools utilities when running @@ -1599,9 +2104,23 @@ </glossdef> </glossentry> + <glossentry id='var-CONFIGURE_FLAGS'><glossterm>CONFIGURE_FLAGS</glossterm> + <info> + CONFIGURE_FLAGS[doc] = "The minimal arguments for GNU configure." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal arguments for GNU configure. + </para> + </glossdef> + </glossentry> + <glossentry id='var-CONFLICT_DISTRO_FEATURES'><glossterm>CONFLICT_DISTRO_FEATURES</glossterm> + <info> + CONFLICT_DISTRO_FEATURES[doc] = "When a recipe inherits the distro_features_check class, this variable identifies distribution features that would be in conflict should the recipe be built." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link> class, this @@ -1619,8 +2138,11 @@ </glossentry> <glossentry id='var-COPY_LIC_DIRS'><glossterm>COPY_LIC_DIRS</glossterm> + <info> + COPY_LIC_DIRS[doc] = "If set to "1" along with the COPY_LIC_MANIFEST variable, the OpenEmbedded build system copies into the image the license files, which are located in /usr/share/common-licenses, for each package." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> If set to "1" along with the <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link> variable, the OpenEmbedded build system copies @@ -1629,13 +2151,16 @@ for each package. The license files are placed in directories within the image itself. - </para> + </para> </glossdef> </glossentry> <glossentry id='var-COPY_LIC_MANIFEST'><glossterm>COPY_LIC_MANIFEST</glossterm> + <info> + COPY_LIC_MANIFEST[doc] = "If set to "1", the OpenEmbedded build system copies the license manifest for the image to /usr/share/common-licenses/license.manifest within the image itself." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> If set to "1", the OpenEmbedded build system copies the license manifest for the image to <filename>/usr/share/common-licenses/license.manifest</filename> @@ -1645,8 +2170,11 @@ </glossentry> <glossentry id='var-CORE_IMAGE_EXTRA_INSTALL'><glossterm>CORE_IMAGE_EXTRA_INSTALL</glossterm> + <info> + CORE_IMAGE_EXTRA_INSTALL[doc] = "Specifies the list of packages to be added to the image. You should only set this variable in the conf/local.conf file in the Build Directory." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the list of packages to be added to the image. You should only set this variable in the <filename>local.conf</filename> configuration file found @@ -1661,8 +2189,11 @@ </glossentry> <glossentry id='var-COREBASE'><glossterm>COREBASE</glossterm> + <info> + COREBASE[doc] = "Specifies the parent directory of the OpenEmbedded Core Metadata layer (i.e. meta)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the parent directory of the OpenEmbedded Core Metadata layer (i.e. <filename>meta</filename>). </para> @@ -1682,9 +2213,24 @@ </glossdef> </glossentry> + <glossentry id='var-CPP'><glossterm>CPP</glossterm> + <info> + CPP[doc] = "Minimum command and arguments to run the C preprocessor." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments used to run the C + preprocessor. + </para> + </glossdef> + </glossentry> + <glossentry id='var-CPPFLAGS'><glossterm>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)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers). This variable is exported to an environment @@ -1715,9 +2261,57 @@ </glossdef> </glossentry> + <glossentry id='var-CROSS_COMPILE'><glossterm>CROSS_COMPILE</glossterm> + <info> + CROSS_COMPILE[doc] = "The toolchain binary prefix for the target tools." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The toolchain binary prefix for the target tools. + The <filename>CROSS_COMPILE</filename> variable is the + same as the + <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link> + variable. + <note> + The OpenEmbedded build system sets the + <filename>CROSS_COMPILE</filename> variable only in + certain contexts (e.g. when building for kernel + and kernel module recipes). + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CVSDIR'><glossterm>CVSDIR</glossterm> + <info> + CVSDIR[doc] = "The directory where cvs checkouts will be stored in." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The directory in which files checked out under the + CVS system are stored. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CXX'><glossterm>CXX</glossterm> + <info> + CXX[doc] = "Minimum command and arguments to run the C++ compiler." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments used to run the C++ + compiler. + </para> + </glossdef> + </glossentry> + <glossentry id='var-CXXFLAGS'><glossterm>CXXFLAGS</glossterm> + <info> + CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C++ compiler. This variable is exported to an environment variable and thus made visible to the software being @@ -1752,8 +2346,11 @@ <glossdiv id='var-glossary-d'><title>D</title> <glossentry id='var-D'><glossterm>D</glossterm> + <info> + D[doc] = "The destination directory." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The destination directory. The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> where components are installed by the @@ -1767,18 +2364,83 @@ </glossdef> </glossentry> + <glossentry id='var-DATE'><glossterm>DATE</glossterm> + <info> + DATE[doc] = "The date the build was started using YMD format." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The date the build was started. + Dates appear using the year, month, and day (YMD) format + (e.g. "20150209" for February 9th, 2015). + </para> + </glossdef> + </glossentry> + <glossentry id='var-DATETIME'><glossterm>DATETIME</glossterm> + <info> + DATETIME[doc] = "The date and time the build was started." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The date and time on which the current build started. The format is suitable for timestamps. </para> </glossdef> </glossentry> + <glossentry id='var-DEBIAN_NOAUTONAME'><glossterm>DEBIAN_NOAUTONAME</glossterm> + <info> + DEBIAN_NOAUTONAME[doc] = "Prevents a particular package from being renamed according to Debian package naming." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + When the + <link linkend='ref-classes-debian'><filename>debian</filename></link> + class is inherited, which is the default behavior, + <filename>DEBIAN_NOAUTONAME</filename> specifies a + particular package should not be renamed according to + Debian library package naming. + You must use the package name as an override when you + set this variable. + Here is an example from the <filename>fontconfig</filename> + recipe: + <literallayout class='monospaced'> + DEBIAN_NOAUTONAME_fontconfig-utils = "1" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEBIANNAME'><glossterm>DEBIANNAME</glossterm> + <info> + DEBIANNAME[doc] = "Allows you to override the library name for an individual package for Debian library package renaming." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + When the + <link linkend='ref-classes-debian'><filename>debian</filename></link> + class is inherited, which is the default behavior, + <filename>DEBIANNAME</filename> allows you to override the + library name for an individual package. + Overriding the library name in these cases is rare. + You must use the package name as an override when you + set this variable. + Here is an example from the <filename>dbus</filename> + recipe: + <literallayout class='monospaced'> + DEBIANNAME_${PN} = "dbus-1" + </literallayout> + </para> + </glossdef> + </glossentry> + <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm> + <info> + DEBUG_BUILD[doc] = "Specifies to build packages with debugging information. This influences the value of the SELECTED_OPTIMIZATION variable." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies to build packages with debugging information. This influences the value of the <filename><link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link></filename> @@ -1788,8 +2450,11 @@ </glossentry> <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm> + <info> + DEBUG_OPTIMIZATION[doc] = "The options to pass in TARGET_CFLAGS and CFLAGS when compiling a system for debugging. This variable defaults to '-O -fno-omit-frame-pointer -g'." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The options to pass in <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> when compiling @@ -1800,10 +2465,14 @@ </glossentry> <glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm> + <info> + DEFAULT_PREFERENCE[doc] = "Specifies a weak bias for recipe selection priority." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a weak bias for recipe selection priority. </para> + <para> The most common usage of this is variable is to set it to "-1" within a recipe for a development version of a @@ -1813,6 +2482,7 @@ <filename><link linkend='var-PREFERRED_VERSION'>PREFERRED_VERSION</link></filename> being used to build the development version. </para> + <note> The bias provided by <filename>DEFAULT_PREFERENCE</filename> is weak and is overridden by @@ -1824,8 +2494,11 @@ </glossentry> <glossentry id='var-DEFAULTTUNE'><glossterm>DEFAULTTUNE</glossterm> + <info> + DEFAULTTUNE[doc] = "The default CPU and Application Binary Interface (ABI) tunings (i.e. the "tune") used by the OpenEmbedded build system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The default CPU and Application Binary Interface (ABI) tunings (i.e. the "tune") used by the OpenEmbedded build system. @@ -1845,8 +2518,11 @@ </glossentry> <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm> + <info> + DEPENDS[doc] = "Lists a recipe's build-time dependencies (i.e. other recipe files)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists a recipe's build-time dependencies (i.e. other recipe files). The system ensures that all the dependencies listed @@ -1880,8 +2556,11 @@ </glossentry> <glossentry id='var-DEPLOY_DIR'><glossterm>DEPLOY_DIR</glossterm> + <info> + DEPLOY_DIR[doc] = "Points to the general area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to the general area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system. @@ -1905,8 +2584,11 @@ </glossentry> <glossentry id='var-DEPLOY_DIR_IMAGE'><glossterm>DEPLOY_DIR_IMAGE</glossterm> + <info> + DEPLOY_DIR_IMAGE[doc] = "Points to the area that the OpenEmbedded build system uses to place images and other associated output files that are ready to be deployed onto the target machine." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to the area that the OpenEmbedded build system uses to place images and other associated output files that are ready to be deployed onto the target machine. @@ -1932,8 +2614,11 @@ </glossentry> <glossentry id='var-DEPLOYDIR'><glossterm>DEPLOYDIR</glossterm> + <info> + DEPLOYDIR[doc] = "For recipes that inherit the deploy class, the DEPLOYDIR points to a temporary work area for deployed files." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-deploy'><filename>deploy</filename></link> class, the <filename>DEPLOYDIR</filename> points to a @@ -1942,6 +2627,9 @@ <literallayout class='monospaced'> DEPLOYDIR = "${WORKDIR}/deploy-${<link linkend='var-PN'><filename>PN</filename></link>}" </literallayout> + </para> + + <para> Recipes inheriting the <filename>deploy</filename> class should copy files to be deployed into <filename>DEPLOYDIR</filename>, and the class will take @@ -1953,19 +2641,26 @@ </glossentry> <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm> - <glossdef> - <para>The package description used by package managers. - If not set, <filename>DESCRIPTION</filename> takes - the value of the - <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link> - variable. + <info> + DESCRIPTION[doc] = "The package description used by package managers. If not set, DESCRIPTION takes the value of the SUMMARY variable." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The package description used by package managers. + If not set, <filename>DESCRIPTION</filename> takes + the value of the + <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link> + variable. </para> </glossdef> </glossentry> <glossentry id='var-DISK_SIGNATURE'><glossterm>DISK_SIGNATURE</glossterm> + <info> + DISK_SIGNATURE[doc] = "A 32-bit MBR disk signature used by directdisk images." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A 32-bit MBR disk signature used by <filename>directdisk</filename> images. </para> @@ -2014,8 +2709,11 @@ </glossentry> <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm> + <info> + DISTRO[doc] = "The short name of the distribution. If the variable is blank, meta/conf/distro/defaultsetup.conf will be used." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The short name of the distribution. This variable corresponds to a distribution configuration file whose root name is the same as the @@ -2055,9 +2753,23 @@ </glossdef> </glossentry> + <glossentry id='var-DISTRO_CODENAME'><glossterm>DISTRO_CODENAME</glossterm> + <info> + DISTRO_CODENAME[doc] = "Specifies a codename for the distribution being built." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies a codename for the distribution being built. + </para> + </glossdef> + </glossentry> + <glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm> + <info> + DISTRO_EXTRA_RDEPENDS[doc] = "Specifies a list of distro-specific packages to add to all images. The variable only applies to the images that include packagegroup-base." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a list of distro-specific packages to add to all images. This variable takes affect through <filename>packagegroup-base</filename> so the @@ -2072,8 +2784,11 @@ </glossentry> <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm> + <info> + DISTRO_EXTRA_RRECOMMENDS[doc] = "Specifies a list of distro-specific packages to add to all images if the packages exist. The list of packages are automatically installed but you can remove them." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a list of distro-specific packages to add to all images if the packages exist. The packages might not exist or be empty (e.g. kernel modules). @@ -2084,8 +2799,11 @@ </glossentry> <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm> + <info> + DISTRO_FEATURES[doc] = "The features enabled for the distribution." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The software support you want in your distribution for various features. You define your distribution features in the distribution @@ -2117,8 +2835,12 @@ </glossentry> <glossentry id='var-DISTRO_FEATURES_BACKFILL'><glossterm>DISTRO_FEATURES_BACKFILL</glossterm> + <info> + DISTRO_FEATURES_BACKFILL[doc] = "Features to be added to DISTRO_FEATURES if not also present in DISTRO_FEATURES_BACKFILL_CONSIDERED. This variable is set in the meta/conf/bitbake.conf file and it is not intended to be user-configurable." + </info> <glossdef> - <para>Features to be added to + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Features to be added to <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename> if not also present in <filename><link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'>DISTRO_FEATURES_BACKFILL_CONSIDERED</link></filename>. @@ -2136,43 +2858,93 @@ </glossentry> <glossentry id='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><glossterm>DISTRO_FEATURES_BACKFILL_CONSIDERED</glossterm> + <info> + DISTRO_FEATURES_BACKFILL_CONSIDERED[doc] = "Features from DISTRO_FEATURES_BACKFILL that should not be backfilled (i.e. added to DISTRO_FEATURES) during the build." + </info> <glossdef> - <para>Features from + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Features from <filename><link linkend='var-DISTRO_FEATURES_BACKFILL'>DISTRO_FEATURES_BACKFILL</link></filename> that should not be backfilled (i.e. added to <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>) during the build. See the "<link linkend='ref-features-backfill'>Feature Backfilling</link>" section for more information. - </para> + </para> </glossdef> </glossentry> - <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm> + <glossentry id='var-DISTRO_FEATURES_DEFAULT'><glossterm>DISTRO_FEATURES_DEFAULT</glossterm> + <info> + DISTRO_FEATURES_DEFAULT[doc] = "Provides the default list of distro features with the exception of any libc-specific features." + </info> <glossdef> - <para>The long name of the distribution.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + A convenience variable that gives you the default + list of distro features with the exception of any + features specific to the C library + (<filename>libc</filename>). + </para> + + <para> + When creating a custom distribution, you might find it + useful to be able to reuse the default + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> + options without the need to write out the full set. + Here is an example that uses + <filename>DISTRO_FEATURES_DEFAULT</filename> from a + custom distro configuration file: + <literallayout class='monospaced'> + DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} ${DISTRO_FEATURES_LIBC} myfeature" + </literallayout> + </para> </glossdef> </glossentry> - <glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm> + <glossentry id='var-DISTRO_FEATURES_LIBC'><glossterm>DISTRO_FEATURES_LIBC</glossterm> + <info> + DISTRO_FEATURES_LIBC[doc] = "Specifies the list of distro features that are specific to the C library (libc)." + </info> <glossdef> - <para>Alias names used for the recipe in various Linux distributions.</para> - <para>See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-configuring-DISTRO_PN_ALIAS'>Handling - a Package Name Alias</ulink>" section in the Yocto Project Development - Manual for more information.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + A convenience variable that specifies the list of distro + features that are specific to the C library + (<filename>libc</filename>). + Typically, these features are prefixed with "libc-" and + control which features are enabled at during the build + within the C library itself. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm> + <info> + DISTRO_NAME[doc] = "The long name of the distribution." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The long name of the distribution. + </para> </glossdef> </glossentry> <glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm> + <info> + DISTRO_VERSION[doc] = "The version of the distribution." + </info> <glossdef> - <para>The version of the distribution.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The version of the distribution. + </para> </glossdef> </glossentry> <glossentry id='var-DISTROOVERRIDES'><glossterm>DISTROOVERRIDES</glossterm> + <info> + DISTROOVERRIDES[doc] = "Lists overrides specific to the current distribution. By default, the variable list includes the value of the DISTRO variable." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> This variable lists overrides specific to the current distribution. By default, the variable list includes the value of the @@ -2187,8 +2959,11 @@ </glossentry> <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> + <info> + DL_DIR[doc] = "The central download directory used by the build process to store downloads. By default, the directory is 'downloads' in the Build Directory." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The central download directory used by the build process to store downloads. By default, <filename>DL_DIR</filename> gets files @@ -2243,8 +3018,11 @@ </glossentry> <glossentry id='var-DOC_COMPRESS'><glossterm>DOC_COMPRESS</glossterm> + <info> + DOC_COMPRESS[doc] = "When inheriting the compress_doc class, this variable sets the compression policy used when the OpenEmbedded build system compresses man pages and info pages." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-compress_doc'><filename>compress_doc</filename></link> class, this variable sets the compression policy used when @@ -2267,13 +3045,16 @@ <glossdiv id='var-glossary-e'><title>E</title> <glossentry id='var-EFI_PROVIDER'><glossterm>EFI_PROVIDER</glossterm> + <info> + EFI_PROVIDER[doc] = "When building bootable images (i.e. where hddimg or vmdk is in IMAGE_FSTYPES), the EFI_PROVIDER variable specifies the EFI bootloader to use." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When building bootable images (i.e. where <filename>hddimg</filename> or <filename>vmdk</filename> is in <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>), - The <filename>EFI_PROVIDER</filename> variable specifies + the <filename>EFI_PROVIDER</filename> variable specifies the EFI bootloader to use. The default is "grub-efi", but "gummiboot" can be used instead. @@ -2288,32 +3069,25 @@ </glossentry> <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm> + <info> + ENABLE_BINARY_LOCALE_GENERATION[doc] = "Controls which locales for glibc are generated during the build. The variable is useful if the target device has 64Mbytes of RAM or less." + </info> <glossdef> - <para>Variable that controls which locales for - <filename>eglibc</filename> are generated during the + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Variable that controls which locales for + <filename>glibc</filename> are generated during the build (useful if the target device has 64Mbytes - of RAM or less).</para> - </glossdef> - </glossentry> - - <glossentry id='var-ERROR_QA'><glossterm>ERROR_QA</glossterm> - <glossdef> - <para> - Specifies the quality assurance checks whose failures are - reported as errors by the OpenEmbedded build system. - You set this variable in your distribution configuration - file. - For a list of the checks you can control with this variable, - see the - "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" - section. + of RAM or less). </para> </glossdef> </glossentry> <glossentry id='var-ERR_REPORT_DIR'><glossterm>ERR_REPORT_DIR</glossterm> + <info> + ERR_REPORT_DIR[doc] = "When used with the report-error class, specifies the path used for storing the debug files created by the error reporting tool, which allows you to submit build errors you encounter to a central database." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When used with the <link linkend='ref-classes-report-error'><filename>report-error</filename></link> class, specifies the path used for storing the debug files @@ -2336,9 +3110,30 @@ </glossdef> </glossentry> + <glossentry id='var-ERROR_QA'><glossterm>ERROR_QA</glossterm> + <info> + ERROR_QA[doc] = "Specifies the quality assurance checks whose failures are reported as errors by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the quality assurance checks whose failures are + reported as errors by the OpenEmbedded build system. + You set this variable in your distribution configuration + file. + For a list of the checks you can control with this variable, + see the + "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + <glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm> + <info> + EXCLUDE_FROM_WORLD[doc] = "Directs BitBake to exclude a recipe from world builds (i.e. bitbake world)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Directs BitBake to exclude a recipe from world builds (i.e. <filename>bitbake world</filename>). During world builds, BitBake locates, parses and builds all @@ -2363,8 +3158,11 @@ </glossentry> <glossentry id='var-EXTENDPE'><glossterm>EXTENDPE</glossterm> + <info> + EXTENDPE[doc] = "Used with file and pathnames to create a prefix for a recipe's version based on the recipe's PE value. If PE is set and greater than zero for a recipe, EXTENDPE becomes that value." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Used with file and pathnames to create a prefix for a recipe's version based on the recipe's <link linkend='var-PE'><filename>PE</filename></link> value. @@ -2381,8 +3179,11 @@ </glossentry> <glossentry id='var-EXTENDPKGV'><glossterm>EXTENDPKGV</glossterm> + <info> + EXTENDPKGV[doc] = "The full package version specification as it appears on the final packages produced by a recipe." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The full package version specification as it appears on the final packages produced by a recipe. The variable's value is normally used to fix a runtime @@ -2402,8 +3203,11 @@ </glossentry> <glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm> + <info> + EXTERNALSRC[doc] = "If externalsrc.bbclass is inherited, this variable points to the source tree, which is outside of the OpenEmbedded build system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link> class, this variable points to the source tree, which is @@ -2428,8 +3232,11 @@ </glossentry> <glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm> + <info> + EXTERNALSRC_BUILD[doc] = "If externalsrc.bbclass is inherited, this variable points to the directory in which the recipe's source code is built, which is outside of the OpenEmbedded build system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link> class, this variable points to the directory in which the @@ -2454,9 +3261,34 @@ </glossdef> </glossentry> - <glossentry id='var-EXTRA_IMAGE_FEATURES'><glossterm>EXTRA_IMAGE_FEATURES</glossterm> + <glossentry id='var-EXTRA_AUTORECONF'><glossterm>EXTRA_AUTORECONF</glossterm> + <info> + EXTRA_AUTORECONF[doc] = "Extra options passed to the autoreconf command, which is executed during do_configure." + </info> <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + For recipes inheriting the + <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + class, you can use <filename>EXTRA_AUTORECONF</filename> to + specify extra options to pass to the + <filename>autoreconf</filename> command that is + executed during the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task. + </para> + <para> + The default value is "--exclude=autopoint". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTRA_IMAGE_FEATURES'><glossterm>EXTRA_IMAGE_FEATURES</glossterm> + <info> + EXTRA_IMAGE_FEATURES[doc] = "The list of additional features to include in an image. Configure this variable in the conf/local.conf file in the Build Directory." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The list of additional features to include in an image. Typically, you configure this variable in your <filename>local.conf</filename> file, which is found in the @@ -2478,10 +3310,13 @@ including symbol information for debugging and profiling. -"debug-tweaks" - Makes an image suitable for development. - For example, ssh root access has a blank - password. You should remove this feature - before you produce a production image. +"debug-tweaks" - Makes an image suitable for debugging. + For example, allows root logins without + passwords and enables post-installation + logging. See the 'allow-empty-password' + and 'post-install-logging' features in + the "<link linkend='ref-features-image'>Image Features</link>" section for + more information. "dev-pkgs" - Adds -dev packages for all installed packages. This is useful if you want to develop against @@ -2527,8 +3362,11 @@ </glossentry> <glossentry id='var-EXTRA_IMAGECMD'><glossterm>EXTRA_IMAGECMD</glossterm> + <info> + EXTRA_IMAGECMD[doc] = "Specifies additional options for the image creation command that has been specified in IMAGE_CMD. When setting this variable, you should use an override for the associated type." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies additional options for the image creation command that has been specified in <link linkend='var-IMAGE_CMD'><filename>IMAGE_CMD</filename></link>. @@ -2543,16 +3381,23 @@ </glossentry> <glossentry id='var-EXTRA_IMAGEDEPENDS'><glossterm>EXTRA_IMAGEDEPENDS</glossterm> + <info> + EXTRA_IMAGEDEPENDS[doc] = "A list of recipes to build that do not provide packages for installing into the root filesystem. Use this variable to list recipes that are required to build the final image, but not needed in the root filesystem." + </info> <glossdef> - <para>A list of recipes to build that do not provide packages + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + A list of recipes to build that do not provide packages for installing into the root filesystem. </para> - <para>Sometimes a recipe is required to build the final image but is not + + <para> + Sometimes a recipe is required to build the final image but is not needed in the root filesystem. You can use the <filename>EXTRA_IMAGEDEPENDS</filename> variable to list these recipes and thus specify the dependencies. A typical example is a required bootloader in a machine configuration. </para> + <note> To add packages to the root filesystem, see the various <filename>*<link linkend='var-RDEPENDS'>RDEPENDS</link></filename> @@ -2563,26 +3408,44 @@ </glossentry> <glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm> + <info> + EXTRA_OECMAKE[doc] = "Additional cmake options." + </info> <glossdef> - <para>Additional <filename>cmake</filename> options.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Additional <filename>cmake</filename> options. + </para> </glossdef> </glossentry> <glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm> + <info> + EXTRA_OECONF[doc] = "Additional configure script options." + </info> <glossdef> - <para>Additional <filename>configure</filename> script options.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Additional <filename>configure</filename> script options. + </para> </glossdef> </glossentry> <glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm> + <info> + EXTRA_OEMAKE[doc] = "Additional GNU make options." + </info> <glossdef> - <para>Additional GNU <filename>make</filename> options.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Additional GNU <filename>make</filename> options. + </para> </glossdef> </glossentry> <glossentry id='var-EXTRA_OESCONS'><glossterm>EXTRA_OESCONS</glossterm> + <info> + EXTRA_OESCONS[doc] = "When a recipe inherits the scons class, this variable specifies additional configuration options you want to pass to the scons command line." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-scons'><filename>scons</filename></link> class, this variable specifies additional configuration @@ -2593,8 +3456,11 @@ </glossentry> <glossentry id='var-EXTRA_QMAKEVARS_POST'><glossterm>EXTRA_QMAKEVARS_POST</glossterm> + <info> + EXTRA_QMAKEVARS_POST[doc] = "Configuration variables or options you want to pass to qmake when the arguments need to be after the .pro file list on the command line." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Configuration variables or options you want to pass to <filename>qmake</filename>. Use this variable when the arguments need to be after the @@ -2611,8 +3477,11 @@ </glossentry> <glossentry id='var-EXTRA_QMAKEVARS_PRE'><glossterm>EXTRA_QMAKEVARS_PRE</glossterm> + <info> + EXTRA_QMAKEVARS_PRE[doc] = "Configuration variables or options you want to pass to qmake when the arguments need to be before the .pro file list on the command line." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Configuration variables or options you want to pass to <filename>qmake</filename>. Use this variable when the arguments need to be before the @@ -2629,8 +3498,11 @@ </glossentry> <glossentry id='var-EXTRA_USERS_PARAMS'><glossterm>EXTRA_USERS_PARAMS</glossterm> + <info> + EXTRA_USERS_PARAMS[doc] = "When a recipe inherits the extrausers class, this variable provides image level user and group operations." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-extrausers'><filename>extrausers</filename></link> class, this variable provides image level user and group @@ -2667,8 +3539,11 @@ <glossdiv id='var-glossary-f'><title>F</title> <glossentry id='var-FEATURE_PACKAGES'><glossterm>FEATURE_PACKAGES</glossterm> + <info> + FEATURE_PACKAGES[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES. When setting the value, FEATURE_PACKAGES should have the name of the feature item as an override." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines one or more packages to include in an image when a specific item is included in <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. @@ -2678,6 +3553,9 @@ <literallayout class='monospaced'> FEATURE_PACKAGES_widget = "<replaceable>package1</replaceable> <replaceable>package2</replaceable>" </literallayout> + </para> + + <para> In this example, if "widget" were added to <filename>IMAGE_FEATURES</filename>, <replaceable>package1</replaceable> and <replaceable>package2</replaceable> would be included in the image. @@ -2695,8 +3573,11 @@ </glossentry> <glossentry id='var-FEED_DEPLOYDIR_BASE_URI'><glossterm>FEED_DEPLOYDIR_BASE_URI</glossterm> + <info> + FEED_DEPLOYDIR_BASE_URI[doc] = "Allow to serve ipk deploy directory as an ad hoc feed (bogofeed). Set to base URL of the directory as exported by HTTP. Set of ad hoc feed configs will be generated in the image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to the base URL of the server and location within the document-root that provides the metadata and packages required by OPKG to support runtime package @@ -2722,8 +3603,11 @@ </glossentry> <glossentry id='var-FILES'><glossterm>FILES</glossterm> + <info> + FILES[doc] = "The list of directories or files that are placed in packages." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The list of directories or files that are placed in packages. </para> @@ -2768,9 +3652,35 @@ </glossdef> </glossentry> - <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm> + <glossentry id='var-FILES_SOLIBSDEV'><glossterm>FILES_SOLIBSDEV</glossterm> + <info> + FILES_SOLIBSDEV[doc] = "Defines the full path name of the development symbolic link (symlink) for shared libraries on the target platform." + </info> <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Defines the file specification to match + <link linkend='var-SOLIBSDEV'><filename>SOLIBSDEV</filename></link>. + In other words, <filename>FILES_SOLIBSDEV</filename> + defines the full path name of the development symbolic link + (symlink) for shared libraries on the target platform. + </para> + <para> + The following statement from the + <filename>bitbake.conf</filename> shows how it is set: + <literallayout class='monospaced'> + FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm> + <info> + FILESEXTRAPATHS[doc] = "Extends the search path the OpenEmbedded build system uses when looking for files and patches as it processes recipes and append files." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Extends the search path the OpenEmbedded build system uses when looking for files and patches as it processes recipes and append files. @@ -2836,8 +3746,11 @@ </glossentry> <glossentry id='var-FILESOVERRIDES'><glossterm>FILESOVERRIDES</glossterm> + <info> + FILESOVERRIDES[doc] = "A subset of OVERRIDES used by the OpenEmbedded build system for creating FILESPATH." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A subset of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> used by the OpenEmbedded build system for creating <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>. @@ -2864,8 +3777,11 @@ </glossentry> <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm> + <info> + FILESPATH[doc] = "The default set of directories the OpenEmbedded build system uses when searching for patches and files. It is defined in the base.bbclass class found in meta/classes in the Source Directory. Do not hand-edit the FILESPATH variable." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The default set of directories the OpenEmbedded build system uses when searching for patches and files. During the build process, BitBake searches each directory in @@ -2907,14 +3823,19 @@ </glossentry> <glossentry id='var-FILESYSTEM_PERMS_TABLES'><glossterm>FILESYSTEM_PERMS_TABLES</glossterm> + <info> + FILESYSTEM_PERMS_TABLES[doc] = "Allows you to define your own file permissions settings table as part of your configuration for the packaging process." + </info> <glossdef> - <para>Allows you to define your own file permissions settings table as part of + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Allows you to define your own file permissions settings table as part of your configuration for the packaging process. For example, suppose you need a consistent set of custom permissions for a set of groups and users across an entire work project. It is best to do this in the packages themselves but this is not always possible. </para> + <para> By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which is located in the <filename>meta/files</filename> folder in the @@ -2922,6 +3843,7 @@ If you create your own file permissions setting table, you should place it in your layer or the distro's layer. </para> + <para> You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the <filename>conf/local.conf</filename> file, which is found in the @@ -2931,6 +3853,7 @@ The paths you specify to these files must be defined within the <link linkend='var-BBPATH'><filename>BBPATH</filename></link> variable. </para> + <para> For guidance on how to create your own file permissions settings table file, examine the existing <filename>fs-perms.txt</filename>. @@ -2938,9 +3861,28 @@ </glossdef> </glossentry> + <glossentry id='var-FONT_EXTRA_RDEPENDS'><glossterm>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 role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + 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>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." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link> class, this variable identifies packages containing font @@ -2955,8 +3897,11 @@ </glossentry> <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm> + <info> + FULL_OPTIMIZATION[doc]= "The options to pass in TARGET_CFLAGS and CFLAGS when compiling an optimized system. This variable defaults to '-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2'." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The options to pass in <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> @@ -2970,9 +3915,35 @@ <glossdiv id='var-glossary-g'><title>G</title> + <glossentry id='var-GDB'><glossterm>GDB</glossterm> + <info> + GDB[doc] = "The minimal command and arguments to run the GNU Debugger." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments to run the GNU Debugger. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GITDIR'><glossterm>GITDIR</glossterm> + <info> + GITDIR[doc] = "The directory where Git clones will be stored." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + 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>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." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the list of GLIBC locales to generate should you not wish generate all LIBC locals, which can be time consuming. @@ -2982,6 +3953,9 @@ <link linkend='var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></link> appropriately. </note> + </para> + + <para> You can set <filename>GLIBC_GENERATE_LOCALES</filename> in your <filename>local.conf</filename> file. By default, all locales are generated. @@ -2993,8 +3967,11 @@ </glossentry> <glossentry id='var-GROUPADD_PARAM'><glossterm>GROUPADD_PARAM</glossterm> + <info> + GROUPADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the groupadd command if you wish to add a group to the system when the package is installed." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-useradd'><filename>useradd</filename></link> class, this variable @@ -3018,8 +3995,11 @@ </glossentry> <glossentry id='var-GROUPMEMS_PARAM'><glossterm>GROUPMEMS_PARAM</glossterm> + <info> + GROUPMEMS_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the groupmems command if you wish to modify the members of a group when the package is installed." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-useradd'><filename>useradd</filename></link> class, this variable @@ -3038,8 +4018,11 @@ </glossentry> <glossentry id='var-GRUB_GFXSERIAL'><glossterm>GRUB_GFXSERIAL</glossterm> + <info> + GRUB_GFXSERIAL[doc] = "Configures the GNU GRand Unified Bootloader (GRUB) to have graphics and serial in the boot menu." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Configures the GNU GRand Unified Bootloader (GRUB) to have graphics and serial in the boot menu. Set this variable to "1" in your @@ -3057,8 +4040,11 @@ </glossentry> <glossentry id='var-GRUB_OPTS'><glossterm>GRUB_OPTS</glossterm> + <info> + GRUB_OPTS[doc] = "Additional options to add to the GNU GRand Unified Bootloader (GRUB) configuration." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Additional options to add to the GNU GRand Unified Bootloader (GRUB) configuration. Use a semi-colon character (<filename>;</filename>) to @@ -3075,8 +4061,11 @@ </glossentry> <glossentry id='var-GRUB_TIMEOUT'><glossterm>GRUB_TIMEOUT</glossterm> + <info> + GRUB_TIMEOUT[doc] = "Specifies the timeout before executing the default LABEL in the GNU GRand Unified Bootloader (GRUB)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the timeout before executing the default <filename>LABEL</filename> in the GNU GRand Unified Bootloader (GRUB). @@ -3092,8 +4081,11 @@ </glossentry> <glossentry id='var-GTKIMMODULES_PACKAGES'><glossterm>GTKIMMODULES_PACKAGES</glossterm> + <info> + GTKIMMODULES_PACKAGES[doc] = "For recipes that inherit the gtk-immodules-cache class, this variable specifies the packages that contain the GTK+ input method modules being installed when the modules are in packages other than the main package." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-gtk-immodules-cache'><filename>gtk-immodules-cache</filename></link> class, this variable specifies the packages that contain the @@ -3104,8 +4096,11 @@ </glossentry> <glossentry id='var-GUMMIBOOT_CFG'><glossterm>GUMMIBOOT_CFG</glossterm> + <info> + GUMMIBOOT_CFG[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_CFG variable specifies the configuration file that should be used." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> is set to "gummiboot", the @@ -3128,8 +4123,11 @@ </glossentry> <glossentry id='var-GUMMIBOOT_ENTRIES'><glossterm>GUMMIBOOT_ENTRIES</glossterm> + <info> + GUMMIBOOT_ENTRIES[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_ENTRIES variable specifies a list of entry files (*.conf) to be installed containing one boot entry per file." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> is set to "gummiboot", the @@ -3154,8 +4152,11 @@ </glossentry> <glossentry id='var-GUMMIBOOT_TIMEOUT'><glossterm>GUMMIBOOT_TIMEOUT</glossterm> + <info> + GUMMIBOOT_TIMEOUT[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_TIMEOUT variable specifies the boot menu timeout in seconds." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> is set to "gummiboot", the @@ -3182,15 +4183,51 @@ <glossdiv id='var-glossary-h'><title>H</title> <glossentry id='var-HOMEPAGE'><glossterm>HOMEPAGE</glossterm> + <info> + HOMEPAGE[doc] = "Website where more information about the software the recipe is building can be found." + </info> <glossdef> - <para>Website where more information about the software the recipe is building - can be found.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Website where more information about the software the recipe is building + can be found. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-HOST_ARCH'><glossterm>HOST_ARCH</glossterm> + <info> + HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH." + + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + 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>HOST_CC_ARCH</glossterm> + <info> + HOST_CC_ARCH[doc] = "The name of the host architecture. Normally same as the TARGET_CC_ARCH." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies architecture-specific compiler flags that are passed to the C compiler. </para> @@ -3218,20 +4255,62 @@ </glossdef> </glossentry> + <glossentry id='var-HOST_OS'><glossterm>HOST_OS</glossterm> + <info> + HOST_OS[doc] = "The name of the target operating system. Normally the same as the TARGET_OS." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + 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>HOST_PREFIX</glossterm> + <info> + HOST_PREFIX[doc] = "The prefix for the cross compile toolchain. Normally same as the TARGET_PREFIX." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the prefix for the cross-compile 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>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." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> 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. + </para> + + <para> The OpenEmbedded build system automatically sets this - variable. - You do not need to set the variable yourself. + variable based on + <link linkend='var-HOST_ARCH'><filename>HOST_ARCH</filename></link>, + <link linkend='var-HOST_VENDOR'><filename>HOST_VENDOR</filename></link>, + and + <link linkend='var-HOST_OS'><filename>HOST_OS</filename></link> + variables. + <note> + You do not need to set the variable yourself. + </note> </para> <para> - Here are two examples: + Consider these two examples: <itemizedlist> <listitem><para>Given a native recipe on a 32-bit x86 machine running Linux, the value is @@ -3246,13 +4325,29 @@ </glossdef> </glossentry> + <glossentry id='var-HOST_VENDOR'><glossterm>HOST_VENDOR</glossterm> + <info> + HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + 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> <glossentry id='var-ICECC_DISABLED'><glossterm>ICECC_DISABLED</glossterm> + <info> + ICECC_DISABLED[doc] = "Disables or enables the icecc (Icecream) function." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Disables or enables the <filename>icecc</filename> (Icecream) function. For more information on this function and best practices @@ -3276,8 +4371,11 @@ </glossentry> <glossentry id='var-ICECC_ENV_EXEC'><glossterm>ICECC_ENV_EXEC</glossterm> + <info> + ICECC_ENV_EXEC[doc] = "Points to the icecc-create-env script that you provide." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to the <filename>icecc-create-env</filename> script that you provide. This variable is used by the @@ -3298,8 +4396,11 @@ </glossentry> <glossentry id='var-ICECC_PARALLEL_MAKE'><glossterm>ICECC_PARALLEL_MAKE</glossterm> + <info> + ICECC_PARALLEL_MAKE[doc] = "Extra options passed to the make command during the do_compile task that specify parallel compilation." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Extra options passed to the <filename>make</filename> command during the <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> @@ -3339,8 +4440,11 @@ </glossentry> <glossentry id='var-ICECC_PATH'><glossterm>ICECC_PATH</glossterm> + <info> + ICECC_PATH[doc] = "The location of the icecc binary." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The location of the <filename>icecc</filename> binary. You can set this variable in your <filename>local.conf</filename> file. @@ -3354,8 +4458,11 @@ </glossentry> <glossentry id='var-ICECC_USER_CLASS_BL'><glossterm>ICECC_USER_CLASS_BL</glossterm> + <info> + ICECC_USER_CLASS_BL[doc] = "Identifies user classes that you do not want the Icecream distributed compile support to consider." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Identifies user classes that you do not want the Icecream distributed compile support to consider. This variable is used by the @@ -3376,8 +4483,11 @@ </glossentry> <glossentry id='var-ICECC_USER_PACKAGE_BL'><glossterm>ICECC_USER_PACKAGE_BL</glossterm> + <info> + ICECC_USER_PACKAGE_BL[doc] = "Identifies user recipes that you do not want the Icecream distributed compile support to consider." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Identifies user recipes that you do not want the Icecream distributed compile support to consider. This variable is used by the @@ -3398,8 +4508,11 @@ </glossentry> <glossentry id='var-ICECC_USER_PACKAGE_WL'><glossterm>ICECC_USER_PACKAGE_WL</glossterm> + <info> + ICECC_USER_PACKAGE_WL[doc] = "Identifies user recipes that use an empty PARALLEL_MAKE variable that you want to force remote distributed compilation on using the Icecream distributed compile support." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Identifies user recipes that use an empty <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> variable that you want to force remote distributed @@ -3415,8 +4528,11 @@ </glossentry> <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm> + <info> + IMAGE_BASENAME[doc] = "The base name of image output files." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The base name of image output files. This variable defaults to the recipe name (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>). @@ -3425,12 +4541,18 @@ </glossentry> <glossentry id='var-IMAGE_BOOT_FILES'><glossterm>IMAGE_BOOT_FILES</glossterm> + <info> + IMAGE_BOOT_FILES[doc] = "Whitespace separated list of files from ${DEPLOY_DIR_IMAGE} to place in boot partition. Entries will be installed under a same name as the source file. To change the destination file name, pass a desired name after a semicolon (eg. u-boot.img;uboot)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A space-separated list of files installed into the - boot partition when preparing an image. - By default, the files are installed under the same name as - the source files. + boot partition when preparing an image using the + <filename>wic</filename> tool with the + <filename>bootimg-partition</filename> source + plugin. + By default, the files are installed under + the same name as the source files. To change the installed name, separate it from the original name with a semi-colon (;). Source files need to be located in @@ -3440,13 +4562,39 @@ <literallayout class="monospaced"> IMAGE_BOOT_FILES = "u-boot.img uImage;kernel" IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}" - </literallayout></para> + </literallayout> + </para> + + <para> + Alternatively, source files can be picked up using + a glob pattern. + In this case, the destination file + will have the same name as the base name of the source file + path. + To install files into a directory within the + target location, pass its name after a semi-colon + (;). + Here are two examples: + <literallayout class="monospaced"> + IMAGE_BOOT_FILES = "bcm2835-bootfiles/*" + IMAGE_BOOT_FILES = "bcm2835-bootfiles/*;boot/" + </literallayout> + The first example installs all files from + <filename>${DEPLOY_DIR_IMAGE}/bcm2835-bootfiles</filename> + into the root of the target partition. + The second example installs the same files into a + <filename>boot</filename> directory within the + target partition. + </para> </glossdef> </glossentry> <glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm> + <info> + IMAGE_CLASSES[doc] = "A list of classes that all images should inherit." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of classes that all images should inherit. You typically use this variable to specify the list of classes that register the different types of images @@ -3470,8 +4618,11 @@ </glossentry> <glossentry id='var-IMAGE_CMD'><glossterm>IMAGE_CMD</glossterm> + <info> + IMAGE_CMD[doc] = "Specifies the command to create the image file for a specific image type, which corresponds to the value set set in IMAGE_FSTYPES, (e.g. ext3, btrfs, and so forth)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the command to create the image file for a specific image type, which corresponds to the value set set in @@ -3486,6 +4637,9 @@ --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \ ${EXTRA_IMAGECMD}" </literallayout> + </para> + + <para> You typically do not need to set this variable unless you are adding support for a new image type. For more examples on how to set this variable, see the @@ -3497,8 +4651,11 @@ </glossentry> <glossentry id='var-IMAGE_DEVICE_TABLES'><glossterm>IMAGE_DEVICE_TABLES</glossterm> + <info> + IMAGE_DEVICE_TABLES[doc] = "Specifies one or more files that contain custom device tables that are passed to the makedevs command as part of creating an image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies one or more files that contain custom device tables that are passed to the <filename>makedevs</filename> command as part of creating @@ -3517,8 +4674,11 @@ </glossentry> <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm> + <info> + IMAGE_FEATURES[doc] = "The primary list of features to include in an image. Configure this variable in an image recipe." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The primary list of features to include in an image. Typically, you configure this variable in an image recipe. Although you can use this variable from your @@ -3530,6 +4690,9 @@ use the <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. </note> + </para> + + <para> For a list of image features that ships with the Yocto Project, see the "<link linkend="ref-features-image">Image Features</link>" @@ -3546,8 +4709,11 @@ </glossentry> <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm> + <info> + IMAGE_FSTYPES[doc] = "Formats of root filesystem images that you want to have created." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the formats the OpenEmbedded build system uses during the build when creating the root filesystem. For example, setting <filename>IMAGE_FSTYPES</filename> @@ -3557,6 +4723,9 @@ <literallayout class='monospaced'> IMAGE_FSTYPES = "ext3 tar.bz2" </literallayout> + </para> + + <para> For the complete list of supported image formats from which you can choose, see <link linkend='var-IMAGE_TYPES'><filename>IMAGE_TYPES</filename></link>. @@ -3581,8 +4750,11 @@ </glossentry> <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm> + <info> + IMAGE_INSTALL[doc] = "Specifies the packages to install into an image. Image recipes set IMAGE_INSTALL to specify the packages to install into an image through image.bbclass." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the packages to install into an image. The <filename>IMAGE_INSTALL</filename> variable is a mechanism for an image recipe and you should use it @@ -3644,8 +4816,11 @@ </glossentry> <glossentry id='var-IMAGE_LINGUAS'><glossterm>IMAGE_LINGUAS</glossterm> + <info> + IMAGE_LINGUAS[doc] = "Specifies the list of locales to install into the image during the root filesystem construction process." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the list of locales to install into the image during the root filesystem construction process. The OpenEmbedded build system automatically splits locale @@ -3659,6 +4834,9 @@ <literallayout class='monospaced'> IMAGE_LINGUAS = "pt-br de-de" </literallayout> + </para> + + <para> In this example, the build system ensures any Brazilian Portuguese and German locale files that correspond to packages in the image are installed (i.e. @@ -3679,8 +4857,11 @@ </glossentry> <glossentry id='var-IMAGE_MANIFEST'><glossterm>IMAGE_MANIFEST</glossterm> + <info> + IMAGE_MANIFEST[doc] = "The manifest file for the image. This file lists all the installed packages that make up the image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The manifest file for the image. This file lists all the installed packages that make up the image. @@ -3712,8 +4893,11 @@ </glossentry> <glossentry id='var-IMAGE_NAME'><glossterm>IMAGE_NAME</glossterm> + <info> + IMAGE_NAME[doc] = "The name of the output image files minus the extension." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The name of the output image files minus the extension. This variable is derived using the <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>, @@ -3729,8 +4913,11 @@ </glossentry> <glossentry id='var-IMAGE_OVERHEAD_FACTOR'><glossterm>IMAGE_OVERHEAD_FACTOR</glossterm> + <info> + IMAGE_OVERHEAD_FACTOR[doc] = "Defines a multiplier that the build system applies to the initial image size for cases when the multiplier times the returned disk usage value for the image is greater than the sum of IMAGE_ROOTFS_SIZE and IMAGE_ROOTFS_EXTRA_SPACE." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines a multiplier that the build system applies to the initial image size for cases when the multiplier times the returned disk usage value for the image is greater than the sum of @@ -3771,8 +4958,11 @@ </glossentry> <glossentry id='var-IMAGE_PKGTYPE'><glossterm>IMAGE_PKGTYPE</glossterm> + <info> + IMAGE_PKGTYPE[doc] = "Defines the package type (DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the package type (DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system. The variable is defined appropriately by the @@ -3782,6 +4972,11 @@ or <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link> class. + <note><title>Warning</title> + The <filename>package_tar</filename> class is broken + and is not supported. + It is recommended that you do not use it. + </note> </para> <para> @@ -3814,14 +5009,20 @@ </glossentry> <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm> + <info> + IMAGE_POSTPROCESS_COMMAND[doc] = "Added by classes to run post processing commands once the OpenEmbedded build system has created the image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Added by classes to run post processing commands once the OpenEmbedded build system has created the image. You can specify shell commands separated by semicolons: <literallayout class='monospaced'> IMAGE_POSTPROCESS_COMMAND += "<replaceable>shell_command</replaceable>; ... " </literallayout> + </para> + + <para> If you need to pass the path to the root filesystem within the command, you can use <filename>${IMAGE_ROOTFS}</filename>, which points to @@ -3831,8 +5032,11 @@ </glossentry> <glossentry id='var-IMAGE_ROOTFS'><glossterm>IMAGE_ROOTFS</glossterm> + <info> + IMAGE_ROOTFS[doc] = "The location of the root filesystem while it is under construction (i.e. during do_rootfs)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The location of the root filesystem while it is under construction (i.e. during the <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> @@ -3844,8 +5048,11 @@ </glossentry> <glossentry id='var-IMAGE_ROOTFS_ALIGNMENT'><glossterm>IMAGE_ROOTFS_ALIGNMENT</glossterm> + <info> + IMAGE_ROOTFS_ALIGNMENT[doc] = "Specifies the alignment for the output image file in Kbytes." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the alignment for the output image file in Kbytes. If the size of the image is not a multiple of @@ -3860,8 +5067,11 @@ </glossentry> <glossentry id='var-IMAGE_ROOTFS_EXTRA_SPACE'><glossterm>IMAGE_ROOTFS_EXTRA_SPACE</glossterm> + <info> + IMAGE_ROOTFS_EXTRA_SPACE[doc] = "Defines additional free disk space created in the image in Kbytes. By default, this variable is set to '0'." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines additional free disk space created in the image in Kbytes. By default, this variable is set to "0". This free disk space is added to the image after the build system determines @@ -3891,8 +5101,11 @@ </glossentry> <glossentry id='var-IMAGE_ROOTFS_SIZE'><glossterm>IMAGE_ROOTFS_SIZE</glossterm> + <info> + IMAGE_ROOTFS_SIZE[doc] = "Defines the size in Kbytes for the generated image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the size in Kbytes for the generated image. The OpenEmbedded build system determines the final size for the generated image using an algorithm that takes into account the initial disk space used @@ -3920,6 +5133,9 @@ xspace = IMAGE_ROOTFS_EXTRA_SPACE </literallayout> + </para> + + <para> See the <link linkend='var-IMAGE_OVERHEAD_FACTOR'><filename>IMAGE_OVERHEAD_FACTOR</filename></link> and <link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'><filename>IMAGE_ROOTFS_EXTRA_SPACE</filename></link> variables for related information. @@ -3934,8 +5150,11 @@ </glossentry> <glossentry id='var-IMAGE_TYPEDEP'><glossterm>IMAGE_TYPEDEP</glossterm> + <info> + IMAGE_TYPEDEP[doc] = "Specifies a dependency from one image type on another." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a dependency from one image type on another. Here is an example from the <link linkend='ref-classes-image-live'><filename>image-live</filename></link> @@ -3943,6 +5162,9 @@ <literallayout class='monospaced'> IMAGE_TYPEDEP_live = "ext3" </literallayout> + </para> + + <para> In the previous example, the variable ensures that when "live" is listed with the <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> @@ -3957,8 +5179,11 @@ </glossentry> <glossentry id='var-IMAGE_TYPES'><glossterm>IMAGE_TYPES</glossterm> + <info> + IMAGE_TYPES[doc] = "Specifies the complete list of supported image types by default." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the complete list of supported image types by default: <literallayout class='monospaced'> @@ -3988,6 +5213,9 @@ vmdk elf </literallayout> + </para> + + <para> For more information about these types of images, see <filename>meta/classes/image_types*.bbclass</filename> in the @@ -3997,12 +5225,19 @@ </glossentry> <glossentry id='var-INC_PR'><glossterm>INC_PR</glossterm> + <info> + INC_PR[doc] = "Helps define the recipe revision for recipes that share a common include file." + </info> <glossdef> - <para>Helps define the recipe revision for recipes that share + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Helps define the recipe revision for recipes that share a common <filename>include</filename> file. You can think of this variable as part of the recipe revision - as set from within an include file.</para> - <para>Suppose, for example, you have a set of recipes that + as set from within an include file. + </para> + + <para> + Suppose, for example, you have a set of recipes that are used across several projects. And, within each of those recipes the revision (its <link linkend='var-PR'><filename>PR</filename></link> @@ -4013,14 +5248,18 @@ version of the recipe. In this scenario, it can get complicated when recipes that are used in many places and provide common functionality - are upgraded to a new revision.</para> - <para>A more efficient way of dealing with this situation is + are upgraded to a new revision. + </para> + + <para> + A more efficient way of dealing with this situation is to set the <filename>INC_PR</filename> variable inside the <filename>include</filename> files that the recipes share and then expand the <filename>INC_PR</filename> variable within the recipes to help define the recipe revision. - </para> + </para> + <para> The following provides an example that shows how to use the <filename>INC_PR</filename> variable @@ -4045,13 +5284,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <filename>include</filename> file. The remaining lines in the example are from individual recipes and show how the <filename>PR</filename> value - is set.</para> + is set. + </para> </glossdef> </glossentry> <glossentry id='var-INCOMPATIBLE_LICENSE'><glossterm>INCOMPATIBLE_LICENSE</glossterm> + <info> + INCOMPATIBLE_LICENSE[doc] = "Specifies a space-separated list of license names (as they would appear in LICENSE) that should be excluded from the build." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a space-separated list of license names (as they would appear in <link linkend='var-LICENSE'><filename>LICENSE</filename></link>) @@ -4077,8 +5320,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INHIBIT_DEFAULT_DEPS'><glossterm>INHIBIT_DEFAULT_DEPS</glossterm> + <info> + INHIBIT_DEFAULT_DEPS[doc] = "Prevents the default dependencies, namely the C compiler and standard C library (libc), from being added to DEPENDS." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Prevents the default dependencies, namely the C compiler and standard C library (libc), from being added to <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>. @@ -4094,9 +5340,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INHIBIT_PACKAGE_DEBUG_SPLIT'><glossterm>INHIBIT_PACKAGE_DEBUG_SPLIT</glossterm> + <info> + INHIBIT_PACKAGE_STRIP[doc] = "If set to "1", causes the build to not strip binaries in resulting packages." + </info> <glossdef> - - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Prevents the OpenEmbedded build system from splitting out debug information during packaging. By default, the build system splits out debugging @@ -4122,16 +5370,22 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm> + <info> + INHIBIT_PACKAGE_STRIP[doc] = "If set to "1", causes the build to not strip binaries in resulting packages." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> If set to "1", causes the build to not strip binaries in resulting packages. </para> </glossdef> </glossentry> <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm> + <info> + INHERIT[doc] = "Causes the named class to be inherited at this point during parsing. The variable is only valid in configuration files." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Causes the named class to be inherited at this point during parsing. The variable is only valid in configuration files. @@ -4140,8 +5394,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INHERIT_DISTRO'><glossterm>INHERIT_DISTRO</glossterm> + <info> + INHERIT_DISTRO[doc] = "Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable. @@ -4159,8 +5416,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm> + <info> + INITRAMFS_FSTYPES[doc] = "Defines the format for the output image of an initial RAM disk (initramfs), which is used during boot." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the format for the output image of an initial RAM disk (initramfs), which is used during boot. Supported formats are the same as those supported by the @@ -4171,8 +5431,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INITRAMFS_IMAGE'><glossterm>INITRAMFS_IMAGE</glossterm> + <info> + INITRAMFS_IMAGE[doc] = "Causes the OpenEmbedded build system to build an additional recipe as a dependency to your root filesystem recipe (e.g. core-image-sato)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Causes the OpenEmbedded build system to build an additional recipe as a dependency to your root filesystem recipe (e.g. <filename>core-image-sato</filename>). @@ -4214,8 +5477,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INITRAMFS_IMAGE_BUNDLE'><glossterm>INITRAMFS_IMAGE_BUNDLE</glossterm> + <info> + INITRAMFS_IMAGE_BUNDLE[doc] = "Controls whether or not the image recipe specified by INITRAMFS_IMAGE is run through an extra pass during kernel compilation in order to build a single binary that contains both the kernel image and the initial RAM disk (initramfs)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Controls whether or not the image recipe specified by <link linkend='var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></link> is run through an extra pass during kernel compilation @@ -4261,8 +5527,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INITRD'><glossterm>INITRD</glossterm> + <info> + INITRD[doc] = "Indicates a list of filesystem images to concatenate and use as an initial RAM disk (initrd)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Indicates list of filesystem images to concatenate and use as an initial RAM disk (<filename>initrd</filename>). </para> @@ -4277,8 +5546,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INITRD_IMAGE'><glossterm>INITRD_IMAGE</glossterm> + <info> + INITRD_IMAGE[doc] = "When building a "live" bootable image (i.e. when IMAGE_FSTYPES contains "live"), INITRD_IMAGE specifies the image recipe that should be built to provide the initial RAM disk image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When building a "live" bootable image (i.e. when <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> contains "live"), <filename>INITRD_IMAGE</filename> @@ -4296,11 +5568,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm> + <info> + INITSCRIPT_NAME[doc] = "The filename of the initialization script as installed to ${sysconfdir}/init.d." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The filename of the initialization script as installed to <filename>${sysconfdir}/init.d</filename>. </para> + <para> This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>. The variable is mandatory. @@ -4309,11 +5585,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm> + <info> + INITSCRIPT_PACKAGES[doc] = "A list of the packages that contain initscripts. This variable is used in recipes when using update-rc.d.bbclass. The variable is optional and defaults to the PN variable." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of the packages that contain initscripts. If multiple packages are specified, you need to append the package name - to the other <filename>INITSCRIPT_*</filename> as an override.</para> + to the other <filename>INITSCRIPT_*</filename> as an override. + </para> + <para> This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>. The variable is optional and defaults to the @@ -4323,23 +5604,31 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm> + <info> + INITSCRIPT_PARAMS[doc] = "Specifies the options to pass to update-rc.d. The variable is mandatory and is used in recipes when using update-rc.d.bbclass." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the options to pass to <filename>update-rc.d</filename>. Here is an example: <literallayout class='monospaced'> INITSCRIPT_PARAMS = "start 99 5 2 . stop 20 0 1 6 ." </literallayout> + </para> + + <para> In this example, the script has a runlevel of 99, starts the script in initlevels 2 and 5, and stops the script in levels 0, 1 and 6. </para> + <para> The variable's default value is "defaults", which is set in the <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link> class. </para> + <para> The value in <filename>INITSCRIPT_PARAMS</filename> is passed through @@ -4352,8 +5641,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-INSANE_SKIP'><glossterm>INSANE_SKIP</glossterm> + <info> + INSANE_SKIP[doc] = "Specifies the QA checks to skip for a specific package within a recipe." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the QA checks to skip for a specific package within a recipe. For example, to skip the check for symbolic link @@ -4365,6 +5657,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" INSANE_SKIP_${PN} += "dev-so" </literallayout> </para> + <para> See the "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" section for a list of the valid QA checks you can @@ -4374,8 +5667,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-IPK_FEED_URIS'><glossterm>IPK_FEED_URIS</glossterm> + <info> + IPK_FEED_URIS[doc] = "List of ipkg feed records to put into generated image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When the IPK backend is in use and package management is enabled on the target, you can use this variable to set up <filename>opkg</filename> in the target image @@ -4430,8 +5726,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdiv id='var-glossary-k'><title>K</title> <glossentry id='var-KARCH'><glossterm>KARCH</glossterm> + <info> + KARCH[doc] = "Defines the kernel architecture used when assembling the configuration. You define the KARCH variable in the BSP Descriptions." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the kernel architecture used when assembling the configuration. Architectures supported for this release are: @@ -4453,13 +5752,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-KBRANCH'><glossterm>KBRANCH</glossterm> + <info> + KBRANCH[doc] = "A regular expression used by the build process to explicitly identify the kernel branch that is validated, patched and configured during a build." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A regular expression used by the build process to explicitly - identify the kernel branch that is validated, patched + identify the kernel branch that is validated, patched, and configured during a build. - The <filename>KBRANCH</filename> variable is optional. - You can use it to trigger checks to ensure the exact kernel + You must set this variable to ensure the exact kernel branch you want is being used by the build process. </para> @@ -4467,20 +5768,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Values for this variable are set in the kernel's recipe file and the kernel's append file. For example, if you are using the Yocto Project kernel that - is based on the Linux 3.10 kernel, the kernel recipe file + is based on the Linux 3.14 kernel, the kernel recipe file is the - <filename>meta/recipes-kernel/linux/linux-yocto_3.10.bb</filename> + <filename>meta/recipes-kernel/linux/linux-yocto_3.14.bb</filename> file. - Following is the default value for <filename>KBRANCH</filename> - and the default override for the architectures the Yocto - Project supports: + Following is an example for a kernel recipe file: <literallayout class='monospaced'> - KBRANCH_DEFAULT = "standard/base" - KBRANCH = "${KBRANCH_DEFAULT}" + KBRANCH ?= "standard/base" </literallayout> - This branch exists in the <filename>linux-yocto-3.10</filename> - kernel Git repository - <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.10/refs/heads'></ulink>. </para> <para> @@ -4489,48 +5784,29 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" machine or target hardware. The kernel's append file is located in the BSP layer for a given machine. - For example, the kernel append file for the Crown Bay BSP is in the + For example, the kernel append file for the Emenlow BSP is in the <filename>meta-intel</filename> Git repository and is named - <filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.10.bbappend</filename>. + <filename>meta-emenlow/recipes-kernel/linux/linux-yocto_3.14.bbappend</filename>. Here are the related statements from the append file: <literallayout class='monospaced'> - COMPATIBLE_MACHINE_crownbay = "crownbay" - KMACHINE_crownbay = "crownbay" - KBRANCH_crownbay = "standard/crownbay" - KERNEL_FEATURES_append_crownbay = " features/drm-emgd/drm-emgd-1.18 cfg/vesafb" - - COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd" - KMACHINE_crownbay-noemgd = "crownbay" - KBRANCH_crownbay-noemgd = "standard/crownbay" - KERNEL_FEATURES_append_crownbay-noemgd = " cfg/vesafb" + COMPATIBLE_MACHINE_emenlow-noemgd = "emenlow-noemgd" + KMACHINE_emenlow-noemgd = "emenlow" + KBRANCH_emenlow-noemgd = "standard/base" + KERNEL_FEATURES_append_emenlow-noemgd = " features/drm-gma500/drm-gma500.scc" </literallayout> - The <filename>KBRANCH_*</filename> statements identify - the kernel branch to use when building for the Crown - Bay BSP. - In this case there are two identical statements: one - for each type of Crown Bay machine. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KBRANCH_DEFAULT'><glossterm>KBRANCH_DEFAULT</glossterm> - <glossdef> - <para> - Defines the Linux kernel source repository's default - branch used to build the Linux kernel. - The <filename>KBRANCH_DEFAULT</filename> value is - the default value for - <link linkend='var-KBRANCH'><filename>KBRANCH</filename></link>. - Unless you specify otherwise, - <filename>KBRANCH_DEFAULT</filename> initializes to - "master". + The <filename>KBRANCH</filename> statement identifies + the kernel branch to use when building for the Emenlow + BSP. </para> </glossdef> </glossentry> <glossentry id='var-KERNEL_EXTRA_ARGS'><glossterm>KERNEL_EXTRA_ARGS</glossterm> + <info> + KERNEL_EXTRA_ARGS[doc] = "Specifies additional make command-line arguments the OpenEmbedded build system passes on when compiling the kernel." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies additional <filename>make</filename> command-line arguments the OpenEmbedded build system passes on when compiling the kernel. @@ -4539,38 +5815,51 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-KERNEL_FEATURES'><glossterm>KERNEL_FEATURES</glossterm> + <info> + KERNEL_FEATURES[doc] = "Includes additional metadata from the Yocto Project kernel Git repository. The metadata you add through this variable includes config fragments and features descriptions." + </info> <glossdef> - <para>Includes additional metadata from the Yocto Project kernel Git repository. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Includes additional metadata from the Yocto Project kernel Git repository. In the OpenEmbedded build system, the default Board Support Packages (BSPs) <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> is provided through the <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link> and <link linkend='var-KBRANCH'><filename>KBRANCH</filename></link> variables. You can use the <filename>KERNEL_FEATURES</filename> variable to further - add metadata for all BSPs.</para> - <para>The metadata you add through this variable includes config fragments and + add metadata for all BSPs. + </para> + + <para> + The metadata you add through this variable includes config fragments and features descriptions, which usually includes patches as well as config fragments. You typically override the <filename>KERNEL_FEATURES</filename> variable for a specific machine. In this way, you can provide validated, but optional, sets of kernel - configurations and features.</para> - <para>For example, the following adds <filename>netfilter</filename> to all + configurations and features. + </para> + + <para> + For example, the following adds <filename>netfilter</filename> to all the Yocto Project kernels and adds sound support to the <filename>qemux86</filename> machine: <literallayout class='monospaced'> # Add netfilter to all linux-yocto kernels - KERNEL_FEATURES="features/netfilter" + KERNEL_FEATURES="features/netfilter/netfilter.scc" # Add sound support to the qemux86 machine - KERNEL_FEATURES_append_qemux86=" cfg/sound" + KERNEL_FEATURES_append_qemux86=" cfg/sound.scc" </literallayout></para> </glossdef> </glossentry> <glossentry id='var-KERNEL_IMAGE_BASE_NAME'><glossterm>KERNEL_IMAGE_BASE_NAME</glossterm> + <info> + KERNEL_IMAGE_BASE_NAME[doc] = "The base name of the kernel image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The base name of the kernel image. This variable is set in the <link linkend='ref-classes-kernel'>kernel</link> class @@ -4578,6 +5867,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" </literallayout> + </para> + + <para> See the <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link>, <link linkend='var-PKGE'><filename>PKGE</filename></link>, @@ -4591,19 +5883,57 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-KERNEL_IMAGE_MAXSIZE'><glossterm>KERNEL_IMAGE_MAXSIZE</glossterm> + <info> + KERNEL_IMAGE_MAXSIZE[doc] = "The maximum allowable size in kilobytes of the kernel image file." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the maximum size of the kernel image file in + kilobytes. + If <filename>KERNEL_IMAGE_MAXSIZE</filename> is set, + the size of the kernel image file is checked against + the set value during the + <link linkend='ref-tasks-sizecheck'><filename>do_sizecheck</filename></link> + task. + The task fails if the kernel image file is larger than + the setting. + </para> + + <para> + <filename>KERNEL_IMAGE_MAXSIZE</filename> is useful for + target devices that have a limited amount of space in + which the kernel image must be stored. + </para> + + <para> + By default, this variable is not set, which means the + size of the kernel image is not checked. + </para> + </glossdef> + </glossentry> + <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm> + <info> + KERNEL_IMAGETYPE[doc] = "The type of kernel to build for a device, usually set by the machine configuration files and defaults to 'zImage'." + </info> <glossdef> - <para>The type of kernel to build for a device, usually set by the + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The type of kernel to build for a device, usually set by the machine configuration files and defaults to "zImage". This variable is used when building the kernel and is passed to <filename>make</filename> as the target to - build.</para> + build. + </para> </glossdef> </glossentry> <glossentry id='var-KERNEL_MODULE_AUTOLOAD'><glossterm>KERNEL_MODULE_AUTOLOAD</glossterm> + <info> + KERNEL_MODULE_AUTOLOAD[doc] = "Lists kernel modules that need to be auto-loaded during boot" + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists kernel modules that need to be auto-loaded during boot. <note> @@ -4652,8 +5982,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-KERNEL_MODULE_PROBECONF'><glossterm>KERNEL_MODULE_PROBECONF</glossterm> + <info> + KERNEL_MODULE_PROBECONF[doc] = "Lists kernel modules for which the build system expects to find module_conf_* values that specify configuration for each of the modules." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Provides a list of modules for which the OpenEmbedded build system expects to find <filename>module_conf_</filename><replaceable>modname</replaceable> @@ -4667,8 +6000,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-KERNEL_PATH'><glossterm>KERNEL_PATH</glossterm> + <info> + KERNEL_PATH[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The location of the kernel sources. This variable is set to the value of the <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link> @@ -4694,8 +6030,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-KERNEL_SRC'><glossterm>KERNEL_SRC</glossterm> + <info> + KERNEL_SRC[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The location of the kernel sources. This variable is set to the value of the <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link> @@ -4721,8 +6060,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-KFEATURE_DESCRIPTION'><glossterm>KFEATURE_DESCRIPTION</glossterm> + <info> + KFEATURE_DESCRIPTION[doc] = "Provides a short description of a configuration fragment. You use this variable in the .scc file that describes a configuration fragment file." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Provides a short description of a configuration fragment. You use this variable in the <filename>.scc</filename> file that describes a configuration fragment file. @@ -4737,101 +6079,57 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-KMACHINE'><glossterm>KMACHINE</glossterm> + <info> + KMACHINE[doc] = "The machine as known by the kernel." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The machine as known by the kernel. - Sometimes the machine name used by the kernel does not match the machine name - used by the OpenEmbedded build system. - For example, the machine name that the OpenEmbedded build system understands as - <filename>qemuarm</filename> goes by a different name in the Linux Yocto kernel. - The kernel understands that machine as <filename>arm_versatile926ejs</filename>. - For cases like these, the <filename>KMACHINE</filename> variable maps the - kernel machine name to the OpenEmbedded build system machine name. + Sometimes the machine name used by the kernel does not + match the machine name used by the OpenEmbedded build + system. + For example, the machine name that the OpenEmbedded build + system understands as + <filename>core2-32-intel-common</filename> goes by a + different name in the Linux Yocto kernel. + The kernel understands that machine as + <filename>intel-core2-32</filename>. + For cases like these, the <filename>KMACHINE</filename> + variable maps the kernel machine name to the OpenEmbedded + build system machine name. </para> <para> - Kernel machine names are initially defined in the + These mappings between different names occur in the Yocto Linux Kernel's <filename>meta</filename> branch. - From the <filename>meta</filename> branch, look in - the <filename>meta/cfg/kernel-cache/bsp/<bsp_name>/<bsp-name>-<kernel-type>.scc</filename> file. - For example, from the <filename>meta</filename> branch in the - <filename>linux-yocto-3.0</filename> kernel, the - <filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file - has the following: - <literallayout class='monospaced'> - define KMACHINE cedartrail - define KTYPE standard - define KARCH i386 - - include ktypes/standard - branch cedartrail - - include cedartrail.scc - </literallayout> - You can see that the kernel understands the machine name for - the Cedar Trail Board Support Package (BSP) as - <filename>cedartrail</filename>. - </para> - - <para> - If you look in the Cedar Trail BSP layer in the - <filename>meta-intel</filename> - <ulink url='&YOCTO_DOCS_DEV_URL;#source-repositories'>Source Repositories</ulink> - at <filename>meta-cedartrail/recipes-kernel/linux/linux-yocto_3.0.bbappend</filename>, - you will find the following statements among others: - <literallayout class='monospaced'> - COMPATIBLE_MACHINE_cedartrail = "cedartrail" - KMACHINE_cedartrail = "cedartrail" - KBRANCH_cedartrail = "yocto/standard/cedartrail" - KERNEL_FEATURES_append_cedartrail += "bsp/cedartrail/cedartrail-pvr-merge.scc" - KERNEL_FEATURES_append_cedartrail += "cfg/efi-ext.scc" - - COMPATIBLE_MACHINE_cedartrail-nopvr = "cedartrail" - KMACHINE_cedartrail-nopvr = "cedartrail" - KBRANCH_cedartrail-nopvr = "yocto/standard/cedartrail" - KERNEL_FEATURES_append_cedartrail-nopvr += " cfg/smp.scc" - </literallayout> - The <filename>KMACHINE</filename> statements in the kernel's append file make sure that - the OpenEmbedded build system and the Yocto Linux kernel understand the same machine - names. - </para> - - <para> - This append file uses two <filename>KMACHINE</filename> statements. - The first is not really necessary but does ensure that the machine known to the - OpenEmbedded build system as <filename>cedartrail</filename> maps to the machine - in the kernel also known as <filename>cedartrail</filename>: - <literallayout class='monospaced'> - KMACHINE_cedartrail = "cedartrail" - </literallayout> - </para> - - <para> - The second statement is a good example of why the <filename>KMACHINE</filename> variable - is needed. - In this example, the OpenEmbedded build system uses the <filename>cedartrail-nopvr</filename> - machine name to refer to the Cedar Trail BSP that does not support the proprietary - PowerVR driver. - The kernel, however, uses the machine name <filename>cedartrail</filename>. - Thus, the append file must map the <filename>cedartrail-nopvr</filename> machine name to - the kernel's <filename>cedartrail</filename> name: + As an example take a look in the + <filename>common/recipes-kernel/linux/linux-yocto_3.19.bbappend</filename> + file: <literallayout class='monospaced'> - KMACHINE_cedartrail-nopvr = "cedartrail" + LINUX_VERSION_core2-32-intel-common = "3.19.0" + COMPATIBLE_MACHINE_core2-32-intel-common = "${MACHINE}" + SRCREV_meta_core2-32-intel-common = "8897ef68b30e7426bc1d39895e71fb155d694974" + SRCREV_machine_core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711" + KMACHINE_core2-32-intel-common = "intel-core2-32" + KBRANCH_core2-32-intel-common = "standard/base" + KERNEL_FEATURES_append_core2-32-intel-common = "${KERNEL_FEATURES_INTEL_COMMON}" </literallayout> + The <filename>KMACHINE</filename> statement says that + the kernel understands the machine name as + "intel-core2-32". + However, the OpenEmbedded build system understands the + machine as "core2-32-intel-common". </para> - <para> - BSPs that ship with the Yocto Project release provide all mappings between the Yocto - Project kernel machine names and the OpenEmbedded machine names. - Be sure to use the <filename>KMACHINE</filename> if you create a BSP and the machine - name you use is different than that used in the kernel. - </para> </glossdef> </glossentry> <glossentry id='var-KTYPE'><glossterm>KTYPE</glossterm> + <info> + KTYPE[doc] = "Defines the kernel type to be used in assembling the configuration." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the kernel type to be used in assembling the configuration. The linux-yocto recipes define "standard", "tiny", @@ -4856,8 +6154,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdiv id='var-glossary-l'><title>L</title> <glossentry id='var-LABELS'><glossterm>LABELS</glossterm> + <info> + LABELS[doc] = "Provides a list of targets for automatic configuration." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Provides a list of targets for automatic configuration. </para> @@ -4870,8 +6171,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> + <info> + LAYERDEPENDS[doc] = "Lists the layers, separated by spaces, upon which this recipe depends. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer." + </info> <glossdef> - <para>Lists the layers that this recipe depends upon, separated by spaces. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Lists the layers that this recipe depends upon, separated by spaces. Optionally, you can specify a specific layer version for a dependency by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3" to be compared against @@ -4881,35 +6186,61 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" the version numbers do not match exactly (if specified). This variable is used in the <filename>conf/layer.conf</filename> file and must be suffixed with the name of the specific layer (e.g. - <filename>LAYERDEPENDS_mylayer</filename>).</para> + <filename>LAYERDEPENDS_mylayer</filename>). + </para> </glossdef> </glossentry> <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm> + <info> + LAYERDIR[doc] = "When used inside the layer.conf configuration file, this variable provides the path of the current layer." + </info> <glossdef> - <para>When used inside the <filename>layer.conf</filename> configuration + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + When used inside the <filename>layer.conf</filename> configuration file, this variable provides the path of the current layer. This variable is not available outside of <filename>layer.conf</filename> - and references are expanded immediately when parsing of the file completes.</para> + and references are expanded immediately when parsing of the file completes. + </para> </glossdef> </glossentry> <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm> + <info> + LAYERVERSION[doc] = "Optionally specifies the version of a layer as a single number. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer." + </info> <glossdef> - <para>Optionally specifies the version of a layer as a single number. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Optionally specifies the version of a layer as a single number. You can use this within <link linkend='var-LAYERDEPENDS'><filename>LAYERDEPENDS</filename></link> for another layer in order to depend on a specific version of the layer. This variable is used in the <filename>conf/layer.conf</filename> file and must be suffixed with the name of the specific layer (e.g. - <filename>LAYERVERSION_mylayer</filename>).</para> + <filename>LAYERVERSION_mylayer</filename>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LD'><glossterm>LD</glossterm> + <info> + LD[doc] = "Minimal command and arguments to run the linker." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments used to run the + linker. + </para> </glossdef> </glossentry> <glossentry id='var-LDFLAGS'><glossterm>LDFLAGS</glossterm> + <info> + LDFLAGS[doc] = "Specifies the flags to pass to the linker." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the linker. This variable is exported to an environment variable and thus made visible to the software being @@ -4940,8 +6271,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-LEAD_SONAME'><glossterm>LEAD_SONAME</glossterm> + <info> + LEAD_SONAME[doc] = "Specifies the lead (or primary) compiled library file (.so) that the debian class applies its naming policy to given a recipe that packages multiple libraries." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the lead (or primary) compiled library file (<filename>.so</filename>) that the <link linkend='ref-classes-debian'><filename>debian</filename></link> @@ -4957,26 +6291,36 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm> + <info> + LIC_FILES_CHKSUM[doc] = "Checksums of the license text in the recipe source code." + </info> <glossdef> <para>Checksums of the license text in the recipe source code.</para> - <para>This variable tracks changes in license text of the source + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + This variable tracks changes in license text of the source code files. If the license text is changed, it will trigger a build failure, which gives the developer an opportunity to review any - license change.</para> + license change. + </para> + <para> This variable must be defined for all recipes (unless <link linkend='var-LICENSE'><filename>LICENSE</filename></link> is set to "CLOSED").</para> <para>For more information, see the "<link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'> - Tracking License Changes</link>" section.</para> + Tracking License Changes</link>" section. + </para> </glossdef> </glossentry> <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm> + <info> + LICENSE[doc] = "The list of source licenses for the recipe. The logical operators &, '|', and parentheses can be used." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The list of source licenses for the recipe. Follow these rules: <itemizedlist> @@ -5036,8 +6380,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-LICENSE_FLAGS'><glossterm>LICENSE_FLAGS</glossterm> + <info> + LICENSE_FLAGS[doc] = "Specifies additional flags for a recipe you must whitelist through LICENSE_FLAGS_WHITELIST in order to allow the recipe to be built." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies additional flags for a recipe you must whitelist through <link linkend='var-LICENSE_FLAGS_WHITELIST'><filename>LICENSE_FLAGS_WHITELIST</filename></link> @@ -5060,8 +6407,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-LICENSE_FLAGS_WHITELIST'><glossterm>LICENSE_FLAGS_WHITELIST</glossterm> + <info> + LICENSE_FLAGS_WHITELIST[doc] = "Lists license flags that when specified in LICENSE_FLAGS within a recipe should not prevent that recipe from being built." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists license flags that when specified in <link linkend='var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></link> within a recipe should not prevent that recipe from being @@ -5076,21 +6426,29 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-LICENSE_PATH'><glossterm>LICENSE_PATH</glossterm> + <info> + LICENSE_PATH[doc] = "Path to additional licenses used during the build." + </info> <glossdef> - <para>Path to additional licenses used during the build. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Path to additional licenses used during the build. By default, the OpenEmbedded build system uses <filename>COMMON_LICENSE_DIR</filename> to define the directory that holds common license text used during the build. The <filename>LICENSE_PATH</filename> variable allows you to extend that location to other areas that have additional licenses: <literallayout class='monospaced'> LICENSE_PATH += "<replaceable>path-to-additional-common-licenses</replaceable>" - </literallayout></para> + </literallayout> + </para> </glossdef> </glossentry> <glossentry id='var-LINUX_KERNEL_TYPE'><glossterm>LINUX_KERNEL_TYPE</glossterm> + <info> + LINUX_KERNEL_TYPE[doc] = "Defines the kernel type to be used in assembling the configuration." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the kernel type to be used in assembling the configuration. The linux-yocto recipes define "standard", "tiny", and @@ -5118,8 +6476,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-LINUX_VERSION'><glossterm>LINUX_VERSION</glossterm> + <info> + LINUX_VERSION[doc] = "The Linux version from kernel.org on which the Linux kernel image being built using the OpenEmbedded build system is based. You define this variable in the kernel recipe." + </info> <glossdef> - <para>The Linux version from <filename>kernel.org</filename> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The Linux version from <filename>kernel.org</filename> on which the Linux kernel image being built using the OpenEmbedded build system is based. You define this variable in the kernel recipe. @@ -5130,18 +6492,26 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> LINUX_VERSION ?= "3.4.24" </literallayout> + </para> + + <para> The <filename>LINUX_VERSION</filename> variable is used to define <link linkend='var-PV'><filename>PV</filename></link> for the recipe: <literallayout class='monospaced'> PV = "${LINUX_VERSION}+git${SRCPV}" - </literallayout></para> + </literallayout> + </para> </glossdef> </glossentry> <glossentry id='var-LINUX_VERSION_EXTENSION'><glossterm>LINUX_VERSION_EXTENSION</glossterm> + <info> + LINUX_VERSION_EXTENSION[doc] = "A string extension compiled into the version string of the Linux kernel built with the OpenEmbedded build system. You define this variable in the kernel recipe." + </info> <glossdef> - <para>A string extension compiled into the version + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + A string extension compiled into the version string of the Linux kernel built with the OpenEmbedded build system. You define this variable in the kernel recipe. @@ -5150,6 +6520,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> LINUX_VERSION_EXTENSION ?= "-yocto-${<link linkend='var-LINUX_KERNEL_TYPE'>LINUX_KERNEL_TYPE</link>}" </literallayout> + </para> + + <para> Defining this variable essentially sets the Linux kernel configuration item <filename>CONFIG_LOCALVERSION</filename>, which is visible @@ -5165,12 +6538,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-LOG_DIR'><glossterm>LOG_DIR</glossterm> + <info> + LOG_DIR[doc] = "Specifies the directory to which the OpenEmbedded build system writes overall log files. The default directory is ${TMPDIR}/log" + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the directory to which the OpenEmbedded build system writes overall log files. The default directory is <filename>${TMPDIR}/log</filename>. </para> + <para> For the directory containing logs specific to each task, see the <link linkend='var-T'><filename>T</filename></link> @@ -5184,8 +6561,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdiv id='var-glossary-m'><title>M</title> <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm> + <info> + MACHINE[doc] = "Specifies the target device for which the image is built. You define MACHINE in the conf/local.conf file in the Build Directory." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the target device for which the image is built. You define <filename>MACHINE</filename> in the <filename>local.conf</filename> file found in the @@ -5196,6 +6576,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> MACHINE ?= "qemux86" </literallayout> + </para> + + <para> The variable corresponds to a machine configuration file of the same name, through which machine-specific configurations are set. Thus, when <filename>MACHINE</filename> is set to "qemux86" there @@ -5210,7 +6593,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" shipped include the following: <literallayout class='monospaced'> MACHINE ?= "qemuarm" + MACHINE ?= "qemuarm64" MACHINE ?= "qemumips" + MACHINE ?= "qemumips64" MACHINE ?= "qemuppc" MACHINE ?= "qemux86" MACHINE ?= "qemux86-64" @@ -5231,8 +6616,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MACHINE_ARCH'><glossterm>MACHINE_ARCH</glossterm> + <info> + MACHINE_ARCH[doc] = "Specifies the name of the machine-specific architecture. This variable is set automatically from MACHINE or TUNE_PKGARCH." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the name of the machine-specific architecture. This variable is set automatically from <link linkend='var-MACHINE'><filename>MACHINE</filename></link> @@ -5245,8 +6633,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm> + <info> + MACHINE_ESSENTIAL_EXTRA_RDEPENDS[doc] = "A list of required machine-specific packages to install as part of the image being built. Because this is a 'machine essential' variable, the list of packages are essential for the machine to boot." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of required machine-specific packages to install as part of the image being built. The build process depends on these packages being present. @@ -5256,6 +6647,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <filename>packagegroup-core-boot</filename>, including the <filename>core-image-minimal</filename> image. </para> + <para> This variable is similar to the <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename> @@ -5263,6 +6655,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" dependency on the variable's list of packages. In other words, the image will not build if a file in this list is not found. </para> + <para> As an example, suppose the machine for which you are building requires <filename>example-init</filename> to be run during boot to initialize the hardware. @@ -5276,8 +6669,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm> + <info> + MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS[doc] = "A list of recommended machine-specific packages to install as part of the image being built. Because this is a 'machine essential' variable, the list of packages are essential for the machine to boot." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of recommended machine-specific packages to install as part of the image being built. The build process does not depend on these packages being present. @@ -5287,6 +6683,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <filename>packagegroup-core-boot</filename>, including the <filename>core-image-minimal</filename> image. </para> + <para> This variable is similar to the <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link></filename> @@ -5297,6 +6694,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" functionality may be selected to be built into the kernel rather than as a module, in which case a package will not be produced. </para> + <para> Consider an example where you have a custom kernel where a specific touchscreen driver is required for the machine to be usable. @@ -5315,6 +6713,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123" </literallayout> </para> + <para> Some examples of these machine essentials are flash, screen, keyboard, mouse, or touchscreen drivers (depending on the machine). @@ -5323,19 +6722,24 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm> + <info> + MACHINE_EXTRA_RDEPENDS[doc] = "A list of machine-specific packages to install as part of the image being built that are not essential for the machine to boot. However, the build process for more fully-featured images depends on the packages being present." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of machine-specific packages to install as part of the image being built that are not essential for the machine to boot. However, the build process for more fully-featured images depends on the packages being present. </para> + <para> This variable affects all images based on <filename>packagegroup-base</filename>, which does not include the <filename>core-image-minimal</filename> or <filename>core-image-full-cmdline</filename> images. </para> + <para> The variable is similar to the <filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename> @@ -5343,6 +6747,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" dependency on the variable's list of packages. In other words, the image will not build if a file in this list is not found. </para> + <para> An example is a machine that has WiFi capability but is not essential for the machine to boot the image. @@ -5362,18 +6767,23 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm> + <info> + MACHINE_EXTRA_RRECOMMENDS[doc] = "A list of machine-specific packages to install as part of the image being built that are not essential for booting the machine. The image being built has no build dependencies on the packages in this list." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of machine-specific packages to install as part of the image being built that are not essential for booting the machine. The image being built has no build dependency on this list of packages. </para> + <para> This variable affects only images based on <filename>packagegroup-base</filename>, which does not include the <filename>core-image-minimal</filename> or <filename>core-image-full-cmdline</filename> images. </para> + <para> This variable is similar to the <filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></filename> @@ -5381,6 +6791,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" dependency on the variable's list of packages. In other words, the image will build if a file in this list is not found. </para> + <para> An example is a machine that has WiFi capability but is not essential For the machine to boot the image. @@ -5400,8 +6811,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm> + <info> + MACHINE_FEATURES[doc] = "Specifies the list of hardware features the MACHINE supports." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the list of hardware features the <link linkend='var-MACHINE'><filename>MACHINE</filename></link> is capable of supporting. @@ -5423,8 +6837,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MACHINE_FEATURES_BACKFILL'><glossterm>MACHINE_FEATURES_BACKFILL</glossterm> + <info> + MACHINE_FEATURES_BACKFILL[doc] = "Features to be added to MACHINE_FEATURES if not also present in MACHINE_FEATURES_BACKFILL_CONSIDERED. This variable is set in the meta/conf/bitbake.conf file and is not intended to be user-configurable." + </info> <glossdef> - <para>Features to be added to + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Features to be added to <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename> if not also present in <filename><link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'>MACHINE_FEATURES_BACKFILL_CONSIDERED</link></filename>. @@ -5442,21 +6860,28 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'><glossterm>MACHINE_FEATURES_BACKFILL_CONSIDERED</glossterm> + <info> + MACHINE_FEATURES_BACKFILL_CONSIDERED[doc] = "Features from MACHINE_FEATURES_BACKFILL that should not be backfilled (i.e. added to MACHINE_FEATURES) during the build." + </info> <glossdef> - <para>Features from + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Features from <filename><link linkend='var-MACHINE_FEATURES_BACKFILL'>MACHINE_FEATURES_BACKFILL</link></filename> that should not be backfilled (i.e. added to <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>) during the build. See the "<link linkend='ref-features-backfill'>Feature backfilling</link>" section for more information. - </para> + </para> </glossdef> </glossentry> <glossentry id='var-MACHINEOVERRIDES'><glossterm>MACHINEOVERRIDES</glossterm> + <info> + MACHINEOVERRIDES[doc] = "Lists overrides specific to the current machine. By default, this list includes the value of MACHINE." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists overrides specific to the current machine. By default, this list includes the value of <filename><link linkend='var-MACHINE'>MACHINE</link></filename>. @@ -5470,6 +6895,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> MACHINEOVERRIDES =. "qemuall:" </literallayout> + </para> + + <para> Applying an override like <filename>qemuall</filename> affects all QEMU emulated machines elsewhere. Here is an example from the @@ -5484,14 +6912,22 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm> + <info> + MAINTAINER[doc] = "The email address of the distribution maintainer." + </info> <glossdef> - <para>The email address of the distribution maintainer.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The email address of the distribution maintainer. + </para> </glossdef> </glossentry> <glossentry id='var-MIRRORS'><glossterm>MIRRORS</glossterm> + <info> + MIRRORS[doc] = "Specifies additional paths from which the OpenEmbedded build system gets source code." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies additional paths from which the OpenEmbedded build system gets source code. When the build system searches for source code, it first @@ -5515,8 +6951,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MLPREFIX'><glossterm>MLPREFIX</glossterm> + <info> + MLPREFIX[doc] = "Specifies a prefix has been added to PN to create a special version of a recipe or package, such as a Multilib version." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a prefix has been added to <link linkend='var-PN'><filename>PN</filename></link> to create a special version of a recipe or package, such as a Multilib version. @@ -5530,8 +6969,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-module_autoload'><glossterm>module_autoload</glossterm> + <info> + module_autoload[doc] = "This variable has been replaced by the KERNEL_MODULE_AUTOLOAD variable. You should replace all occurrences of module_autoload with additions to KERNEL_MODULE_AUTOLOAD." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> This variable has been replaced by the <filename>KERNEL_MODULE_AUTOLOAD</filename> variable. You should replace all occurrences of @@ -5540,6 +6982,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> module_autoload_rfcomm = "rfcomm" </literallayout> + </para> + + <para> should now be replaced with: <literallayout class='monospaced'> KERNEL_MODULE_AUTOLOAD += "rfcomm" @@ -5552,8 +6997,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-module_conf'><glossterm>module_conf</glossterm> + <info> + module_conf[doc] = "Specifies modprobe.d syntax lines for inclusion in the /etc/modprobe.d/modname.conf file." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies <ulink url='http://linux.die.net/man/5/modprobe.d'><filename>modprobe.d</filename></ulink> syntax lines for inclusion in the @@ -5609,8 +7057,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MODULE_IMAGE_BASE_NAME'><glossterm>MODULE_IMAGE_BASE_NAME</glossterm> + <info> + MODULE_IMAGE_BASE_NAME[doc] = "The base name of the kernel modules tarball." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The base name of the kernel modules tarball. This variable is set in the <link linkend='ref-classes-kernel'>kernel</link> class @@ -5618,6 +7069,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> MODULE_IMAGE_BASE_NAME ?= "modules-${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" </literallayout> + </para> + + <para> See the <link linkend='var-PKGE'><filename>PKGE</filename></link>, <link linkend='var-PKGV'><filename>PKGV</filename></link>, @@ -5631,8 +7085,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MODULE_TARBALL_DEPLOY'><glossterm>MODULE_TARBALL_DEPLOY</glossterm> + <info> + MODULE_TARBALL_DEPLOY[doc] = "Controls creation of the modules-*.tgz file. Set this variable to "0" to disable creation of this file, which contains all of the kernel modules resulting from a kernel build." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Controls creation of the <filename>modules-*.tgz</filename> file. Set this variable to "0" to disable creation of this @@ -5643,8 +7100,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-MULTIMACH_TARGET_SYS'><glossterm>MULTIMACH_TARGET_SYS</glossterm> + <info> + MULTIMACH_TARGET_SYS[doc] = "Separates files for different machines such that you can build for multiple target machines using the same output directories." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Separates files for different machines such that you can build for multiple target machines using the same output directories. See the <link linkend='var-STAMP'><filename>STAMP</filename></link> variable @@ -5658,8 +7118,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdiv id='var-glossary-n'><title>N</title> <glossentry id='var-NATIVELSBSTRING'><glossterm>NATIVELSBSTRING</glossterm> + <info> + NATIVELSBSTRING[doc] = "A string identifying the host distribution." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A string identifying the host distribution. Strings consist of the host distributor ID followed by the release, as reported by the @@ -5670,6 +7133,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" If this information is unable to be determined, the value resolves to "Unknown". </para> + <para> This variable is used by default to isolate native shared state packages for different distributions (e.g. to avoid @@ -5682,9 +7146,24 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-NM'><glossterm>NM</glossterm> + <info> + NM[doc] = "Minimal command and arguments to run 'nm'." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments to run + <filename>nm</filename>. + </para> + </glossdef> + </glossentry> + <glossentry id='var-NO_RECOMMENDATIONS'><glossterm>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." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Prevents installation of all "recommended-only" packages. Recommended-only packages are packages installed only through the @@ -5695,6 +7174,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> NO_RECOMMENDATIONS = "1" </literallayout> + </para> + + <para> You can set this variable globally in your <filename>local.conf</filename> file or you can attach it to a specific image recipe by using the recipe name override: @@ -5737,8 +7219,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-NOHDD'><glossterm>NOHDD</glossterm> + <info> + NOHDD[doc] = "Causes the OpenEmbedded build system to skip building the .hddimg image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Causes the OpenEmbedded build system to skip building the <filename>.hddimg</filename> image. The <filename>NOHDD</filename> variable is used with the @@ -5751,8 +7236,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-NOISO'><glossterm>NOISO</glossterm> + <info> + NOISO[doc] = "Causes the OpenEmbedded build system to skip building the ISO image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Causes the OpenEmbedded build system to skip building the ISO image. The <filename>NOISO</filename> variable is used with the @@ -5769,9 +7257,36 @@ 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>OBJCOPY</glossterm> + <info> + OBJCOPY[doc] = "Minimal command and arguments to run 'objcopy'." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments to run + <filename>objcopy</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-OBJDUMP'><glossterm>OBJDUMP</glossterm> + <info> + OBJDUMP[doc] = "Minimal command and arguments to run 'objdump'." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments to run + <filename>objdump</filename>. + </para> + </glossdef> + </glossentry> + <glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm>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." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link> class, this variable @@ -5800,8 +7315,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-OE_IMPORTS'><glossterm>OE_IMPORTS</glossterm> + <info> + OE_IMPORTS[doc] = "An internal variable used to tell the OpenEmbedded build system what Python modules to import for every Python function run by the system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> An internal variable used to tell the OpenEmbedded build system what Python modules to import for every Python function run by the system. @@ -5815,8 +7333,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm> + <info> + OE_TERMINAL[doc] = "Controls how the OpenEmbedded build system spawns interactive terminals on the host development system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Controls how the OpenEmbedded build system spawns interactive terminals on the host development system (e.g. using the BitBake command with the @@ -5846,8 +7367,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-OEROOT'><glossterm>OEROOT</glossterm> + <info> + OEROOT[doc] = "The directory from which the top-level build environment setup script is sourced." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The directory from which the top-level build environment setup script is sourced. The Yocto Project makes two top-level build environment @@ -5868,12 +7392,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-OLDEST_KERNEL'><glossterm>OLDEST_KERNEL</glossterm> + <info> + OLDEST_KERNEL[doc] = "Declares the oldest version of the Linux kernel that the produced binaries must support." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Declares the oldest version of the Linux kernel that the produced binaries must support. This variable is passed into the build of the Embedded - GNU C Library (<filename>eglibc</filename>). + GNU C Library (<filename>glibc</filename>). </para> <para> @@ -5887,8 +7414,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-OVERRIDES'><glossterm>OVERRIDES</glossterm> + <info> + OVERRIDES[doc] = "BitBake uses OVERRIDES to control what variables are overridden after BitBake parses recipes and configuration files." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> BitBake uses <filename>OVERRIDES</filename> to control what variables are overridden after BitBake parses recipes and configuration files. @@ -5904,18 +7434,26 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdiv id='var-glossary-p'><title>P</title> <glossentry id='var-P'><glossterm>P</glossterm> + <info> + P[doc] = "The recipe name and version. P is comprised of ${PN}-${PV}." + </info> <glossdef> - <para>The recipe name and version. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The recipe name and version. <filename>P</filename> is comprised of the following: <literallayout class='monospaced'> ${PN}-${PV} - </literallayout></para> + </literallayout> + </para> </glossdef> </glossentry> <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm> + <info> + PACKAGE_ARCH[doc] = "The architecture of the resulting package or packages." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The architecture of the resulting package or packages. </para> @@ -5940,8 +7478,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PACKAGE_ARCHS'><glossterm>PACKAGE_ARCHS</glossterm> + <info> + PACKAGE_ARCHS[doc] = "A list of architectures compatible with the given target in order of priority." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a list of architectures compatible with the target machine. This variable is set automatically and should not @@ -5955,21 +7496,27 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> - - <glossentry id='var-PACKAGE_BEFORE_PN'><glossterm>PACKAGE_BEFORE_PN</glossterm> + <info> + PACKAGE_BEFORE_PN[doc] = "Enables easily adding packages to PACKAGES before ${PN} so that the packages can pick up files that would normally be included in the default package." + </info> <glossdef> - <para>Enables easily adding packages to - <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> - before <filename>${<link linkend='var-PN'>PN</link>}</filename> - so that those added packages can pick up files that would normally be - included in the default package.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Enables easily adding packages to + <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> + before <filename>${<link linkend='var-PN'>PN</link>}</filename> + so that those added packages can pick up files that would normally be + included in the default package. + </para> </glossdef> </glossentry> <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm> + <info> + PACKAGE_CLASSES[doc] = "This variable specifies the package manager to use when packaging data. It is set in the conf/local.conf file in the Build Directory." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> This variable, which is set in the <filename>local.conf</filename> configuration file found in the <filename>conf</filename> folder of the @@ -5984,6 +7531,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk package_tar" </literallayout> + <note><title>Warning</title> + While it is a legal option, the + <filename>package_tar</filename> class is broken + and is not supported. + It is recommended that you do not use it. + </note> The build system uses only the first argument in the list as the package manager when creating your image or SDK. However, packages will be created using any additional @@ -5991,20 +7544,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For example, if you use the following in your <filename>local.conf</filename> file: <literallayout class='monospaced'> - PACKAGE_CLASSES ?= "package_ipk package_tar" + PACKAGE_CLASSES ?= "package_ipk" </literallayout> The OpenEmbedded build system uses the IPK package manager - to create your image or SDK as well as generating - TAR packages. - </para> - - <para> - You cannot specify the - <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link> - class first in the list. - Files using the <filename>.tar</filename> format cannot - be used as a substitute packaging format - for DEB, RPM, and IPK formatted files for your image or SDK. + to create your image or SDK. </para> <para> @@ -6017,9 +7560,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PACKAGE_DEBUG_SPLIT_STYLE'><glossterm>PACKAGE_DEBUG_SPLIT_STYLE</glossterm> + <info> + PACKAGE_DEBUG_SPLIT_STYLE[doc] = "Determines how to split up the binary and debug information when creating *-dbg packages to be used with the GNU Project Debugger (GDB)." + </info> <glossdef> - - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Determines how to split up the binary and debug information when creating <filename>*-dbg</filename> packages to be used with the GNU Project Debugger (GDB). @@ -6073,13 +7618,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PACKAGE_EXCLUDE'><glossterm>PACKAGE_EXCLUDE</glossterm> + <info> + PACKAGE_EXCLUDE[doc] = "Packages to exclude from the installation. If a listed package is required, an error is generated." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists packages that should not be installed into an image. For example: <literallayout class='monospaced'> PACKAGE_EXCLUDE = "<replaceable>package_name</replaceable> <replaceable>package_name</replaceable> <replaceable>package_name</replaceable> ..." </literallayout> + </para> + + <para> You can set this variable globally in your <filename>local.conf</filename> file or you can attach it to a specific image recipe by using the recipe name override: @@ -6118,17 +7669,24 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PACKAGE_EXTRA_ARCHS'><glossterm>PACKAGE_EXTRA_ARCHS</glossterm> + <info> + PACKAGE_EXTRA_ARCHS[doc] = "Specifies the list of architectures compatible with the device CPU. This variable is useful when you build for several different devices that use miscellaneous processors." + </info> <glossdef> - <para>Specifies the list of architectures compatible with the device CPU. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the list of architectures compatible with the device CPU. This variable is useful when you build for several different devices that use - miscellaneous processors such as XScale and ARM926-EJS).</para> + miscellaneous processors such as XScale and ARM926-EJS. + </para> </glossdef> </glossentry> <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm> + <info> + PACKAGE_GROUP[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES." + </info> <glossdef> - - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The <filename>PACKAGE_GROUP</filename> variable has been renamed to <link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link>. @@ -6145,8 +7703,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PACKAGE_INSTALL'><glossterm>PACKAGE_INSTALL</glossterm> + <info> + PACKAGE_INSTALL[doc] = "List of the packages to be installed into the image. The variable is generally not user-defined and uses IMAGE_INSTALL as part of the list." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The final list of packages passed to the package manager for installation into the image. </para> @@ -6172,9 +7733,27 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-PACKAGE_INSTALL_ATTEMPTONLY'><glossterm>PACKAGE_INSTALL_ATTEMPTONLY</glossterm> + <info> + PACKAGE_INSTALL_ATTEMPTONLY[doc] = "List of packages attempted to be installed when creating an image. 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 role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies a list of packages the OpenEmbedded build + system attempts to install when creating an image. + 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>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." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a list of functions run to pre-process the <link linkend='var-PKGD'><filename>PKGD</filename></link> directory prior to splitting the files out to individual @@ -6184,8 +7763,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PACKAGECONFIG'><glossterm>PACKAGECONFIG</glossterm> + <info> + PACKAGECONFIG[doc] = "This variable provides a means of enabling or disabling features of a recipe on a per-recipe basis." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> This variable provides a means of enabling or disabling features of a recipe on a per-recipe basis. <filename>PACKAGECONFIG</filename> blocks are defined @@ -6198,6 +7780,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2" PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3" </literallayout> + </para> + + <para> The <filename>PACKAGECONFIG</filename> variable itself specifies a space-separated list of the features to enable. @@ -6298,37 +7883,47 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> - <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> + <glossentry id='var-PACKAGEGROUP_DISABLE_COMPLEMENTARY'><glossterm>PACKAGEGROUP_DISABLE_COMPLEMENTARY</glossterm> + <info> + PACKAGEGROUP_DISABLE_COMPLEMENTARY[doc] = "Prevents automatic creation of the normal complementary packages such as -dev and -dbg in a packagegroup recipe." + </info> <glossdef> - <para>The list of packages to be created from the recipe. - The default value is the following: - <literallayout class='monospaced'> - ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN} - </literallayout></para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + For recipes inheriting the + <link linkend='ref-classes-packagegroup'><filename>packagegroup</filename></link> + class, setting + <filename>PACKAGEGROUP_DISABLE_COMPLEMENTARY</filename> to + "1" specifies that the normal complementary packages + (i.e. <filename>-dev</filename>, + <filename>-dbg</filename>, and so forth) should not be + automatically created by the + <filename>packagegroup</filename> recipe, which is the + default behavior. + </para> </glossdef> </glossentry> - <glossentry id='var-PACKAGESPLITFUNCS'><glossterm>PACKAGESPLITFUNCS</glossterm> + <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> + <info> + PACKAGES[doc] = "The list of packages to be created from the recipe." + </info> <glossdef> - <para> - Specifies a list of functions run to perform additional - splitting of files into individual packages. - Recipes can either prepend to this variable or prepend - to the <filename>populate_packages</filename> function - in order to perform additional package splitting. - In either case, the function should set - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>, - <link linkend='var-FILES'><filename>FILES</filename></link>, - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> - and other packaging variables appropriately in order to - perform the desired splitting. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The list of packages to be created from the recipe. + The default value is the following: + <literallayout class='monospaced'> + ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN} + </literallayout> </para> </glossdef> </glossentry> <glossentry id='var-PACKAGES_DYNAMIC'><glossterm>PACKAGES_DYNAMIC</glossterm> + <info> + PACKAGES_DYNAMIC[doc] = "A promise that your recipe satisfies runtime dependencies for optional modules that are found in other recipes." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A promise that your recipe satisfies runtime dependencies for optional modules that are found in other recipes. <filename>PACKAGES_DYNAMIC</filename> @@ -6346,6 +7941,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> task. </para> + <para> Typically, if there is a chance that such a situation can occur and the package that is not created is valid @@ -6364,9 +7960,33 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-PACKAGESPLITFUNCS'><glossterm>PACKAGESPLITFUNCS</glossterm> + <info> + PACKAGESPLITFUNCS[doc] = "Specifies a list of functions run to perform additional splitting of files into individual packages." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies a list of functions run to perform additional + splitting of files into individual packages. + Recipes can either prepend to this variable or prepend + to the <filename>populate_packages</filename> function + in order to perform additional package splitting. + In either case, the function should set + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>, + <link linkend='var-FILES'><filename>FILES</filename></link>, + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> + and other packaging variables appropriately in order to + perform the desired splitting. + </para> + </glossdef> + </glossentry> + <glossentry id='var-PARALLEL_MAKE'><glossterm>PARALLEL_MAKE</glossterm> + <info> + PARALLEL_MAKE[doc] = "Specifies extra options that are passed to the make command during the compile tasks. This variable is usually in the form -j 4, where the number represents the maximum number of parallel threads make can run." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Extra options passed to the <filename>make</filename> command during the <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> @@ -6378,11 +7998,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </para> <para> - If your development host supports multiple cores, a good - rule of thumb is to set this variable to twice the number - of cores on the host. - If you do not set <filename>PARALLEL_MAKE</filename>, it - defaults to the number of cores your build system has. + The OpenEmbedded build system automatically sets this + variable to be equal to the number of cores the build + system uses. <note> Individual recipes might clear out this variable if the software being built has problems running its @@ -6393,8 +8011,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PARALLEL_MAKEINST'><glossterm>PARALLEL_MAKEINST</glossterm> + <info> + PARALLEL_MAKEINST[doc] = "Extra options passed to the make install command during the do_install task in order to specify parallel installation." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Extra options passed to the <filename>make install</filename> command during the <link linkend='ref-tasks-install'><filename>do_install</filename></link> @@ -6411,8 +8032,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PATCHRESOLVE'><glossterm>PATCHRESOLVE</glossterm> + <info> + PATCHRESOLVE[doc] = "Enable or disable interactive patch resolution." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Determines the action to take when a patch fails. You can set this variable to one of two values: "noop" and "user". @@ -6435,8 +8059,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PATCHTOOL'><glossterm>PATCHTOOL</glossterm> + <info> + PATCHTOOL[doc] = "Specifies the utility used to apply patches for a recipe during do_patch." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the utility used to apply patches for a recipe during the <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> @@ -6462,8 +8089,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PE'><glossterm>PE</glossterm> + <info> + PE[doc] = "The epoch of the recipe. The default value is '0'. The field is used to make upgrades possible when the versioning scheme changes in some backwards incompatible way." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The epoch of the recipe. By default, this variable is unset. The variable is used to make upgrades possible when the @@ -6474,20 +8104,28 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PF'><glossterm>PF</glossterm> + <info> + PF[doc] = "Specifies the recipe or package name and includes all version and revision numbers. This variable is comprised of ${PN}-${EXTENDPE}${PV}-${PR}." + </info> <glossdef> - <para>Specifies the recipe or package name and includes all version and revision - numbers (i.e. <filename>eglibc-2.13-r20+svnr15508/</filename> and + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the recipe or package name and includes all version and revision + numbers (i.e. <filename>glibc-2.13-r20+svnr15508/</filename> and <filename>bash-4.2-r1/</filename>). This variable is comprised of the following: <literallayout class='monospaced'> ${<link linkend='var-PN'>PN</link>}-${<link linkend='var-EXTENDPE'>EXTENDPE</link>}${<link linkend='var-PV'>PV</link>}-${<link linkend='var-PR'>PR</link>} - </literallayout></para> + </literallayout> + </para> </glossdef> </glossentry> <glossentry id='var-PIXBUF_PACKAGES'><glossterm>PIXBUF_PACKAGES</glossterm> + <info> + PIXBUF_PACKAGES[doc] = "When a recipe inherits the pixbufcache class, this variable identifies packages that contain the pixbuf loaders used with gdk-pixbuf." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-pixbufcache'><filename>pixbufcache</filename></link> class, this variable identifies packages that contain @@ -6503,14 +8141,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PKG'><glossterm>PKG</glossterm> + <info> + PKG[doc] = "The name of the resulting package created by the OpenEmbedded build system. When you use this variable, you must use a package name override." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The name of the resulting package created by the OpenEmbedded build system. <note> When using the <filename>PKG</filename> variable, you must use a package name override. </note> + </para> + + <para> For example, when the <link linkend='ref-classes-debian'><filename>debian</filename></link> class renames the output package, it does so by setting @@ -6519,23 +8163,46 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-PKG_CONFIG_PATH'><glossterm>PKG_CONFIG_PATH</glossterm> + <info> + PKG_CONFIG_PATH[doc] = "Path to pkg-config files for the current build context." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The path to <filename>pkg-config</filename> files for the + current build context. + <filename>pkg-config</filename> reads this variable + from the environment. + </para> + </glossdef> + </glossentry> + <glossentry id='var-PKGD'><glossterm>PKGD</glossterm> + <info> + PKGD[doc] = "Points to the destination directory for files to be packaged before they are split into individual packages." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to the destination directory for files to be packaged before they are split into individual packages. This directory defaults to the following: <literallayout class='monospaced'> ${WORKDIR}/package </literallayout> + </para> + + <para> Do not change this default. </para> </glossdef> </glossentry> <glossentry id='var-PKGDATA_DIR'><glossterm>PKGDATA_DIR</glossterm> + <info> + PKGDATA_DIR[doc] = "Points to a shared, global-state directory that holds data generated during the packaging process." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to a shared, global-state directory that holds data generated during the packaging process. During the packaging process, the @@ -6546,20 +8213,29 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> ${STAGING_DIR_HOST}/pkgdata </literallayout> + </para> + + <para> Do not change this default. </para> </glossdef> </glossentry> <glossentry id='var-PKGDEST'><glossterm>PKGDEST</glossterm> + <info> + PKGDEST[doc] = "Points to the parent directory for files to be packaged after they have been split into individual packages." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to the parent directory for files to be packaged after they have been split into individual packages. This directory defaults to the following: <literallayout class='monospaced'> ${WORKDIR}/packages-split </literallayout> + </para> + + <para> Under this directory, the build system creates directories for each package specified in <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>. @@ -6569,8 +8245,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PKGDESTWORK'><glossterm>PKGDESTWORK</glossterm> + <info> + PKGDESTWORK[doc] = "Points to a temporary work area used by the do_package task to write output from the do_packagedata task." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to a temporary work area used by the <link linkend='ref-tasks-package'><filename>do_package</filename></link> task to write output from the @@ -6581,6 +8260,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> ${WORKDIR}/pkgdata </literallayout> + </para> + + <para> The <filename>do_packagedata</filename> task then packages the data in the temporary work area and installs it into a shared directory pointed to by @@ -6594,8 +8276,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PKGE'><glossterm>PKGE</glossterm> + <info> + PKGE[doc] = "The epoch of the output package built by the OpenEmbedded build system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The epoch of the output package built by the OpenEmbedded build system. By default, <filename>PKGE</filename> is set to @@ -6605,19 +8290,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PKGR'><glossterm>PKGR</glossterm> + <info> + PKGR[doc] = "The revision of the output package built by the OpenEmbedded build system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The revision of the output package built by the OpenEmbedded build system. By default, <filename>PKGR</filename> is set to <link linkend='var-PR'><filename>PR</filename></link>. - </para> + </para> </glossdef> </glossentry> <glossentry id='var-PKGV'><glossterm>PKGV</glossterm> + <info> + PKGV[doc] = "The version of the output package built by the OpenEmbedded build system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The version of the output package built by the OpenEmbedded build system. By default, <filename>PKGV</filename> is set to @@ -6627,19 +8318,31 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PN'><glossterm>PN</glossterm> + <info> + PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. It refers to a package name in the context of a file created or produced by the OpenEmbedded build system." + </info> <glossdef> - <para>This variable can have two separate functions depending on the context: a recipe - name or a resulting package name.</para> - <para><filename>PN</filename> refers to a recipe name in the context of a file used + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + This variable can have two separate functions depending on the context: a recipe + name or a resulting package name. + </para> + + <para> + <filename>PN</filename> refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. The name is normally extracted from the recipe file name. For example, if the recipe is named <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename> - will be "expat".</para> + will be "expat". + </para> + <para> The variable refers to a package name in the context of a file created or produced by the - OpenEmbedded build system.</para> - <para>If applicable, the <filename>PN</filename> variable also contains any special + OpenEmbedded build system. + </para> + + <para> + If applicable, the <filename>PN</filename> variable also contains any special suffix or prefix. For example, using <filename>bash</filename> to build packages for the native machine, <filename>PN</filename> is <filename>bash-native</filename>. @@ -6651,8 +8354,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PNBLACKLIST'><glossterm>PNBLACKLIST</glossterm> + <info> + PNBLACKLIST[doc] = "Lists recipes you do not want the OpenEmbedded build system to build." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists recipes you do not want the OpenEmbedded build system to build. This variable works in conjunction with the @@ -6675,17 +8381,23 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PR'><glossterm>PR</glossterm> + <info> + PR[doc] = "The revision of the recipe. The default value for this variable is 'r0'." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The revision of the recipe. The default value for this variable is "r0". - </para> + </para> </glossdef> </glossentry> <glossentry id='var-PREFERRED_PROVIDER'><glossterm>PREFERRED_PROVIDER</glossterm> + <info> + PREFERRED_PROVIDER[doc] = "If multiple recipes provide an item, this variable determines which recipe should be given preference." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> If multiple recipes provide an item, this variable determines which recipe should be given preference. You should always suffix the variable with the name of the @@ -6703,8 +8415,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PREFERRED_VERSION'><glossterm>PREFERRED_VERSION</glossterm> + <info> + PREFERRED_VERSION[doc] = "If there are multiple versions of recipes available, this variable determines which recipe should be given preference." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> If there are multiple versions of recipes available, this variable determines which recipe should be given preference. You must always suffix the variable with the @@ -6719,15 +8434,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Here are two examples: <literallayout class='monospaced'> PREFERRED_VERSION_python = "2.7.3" - PREFERRED_VERSION_linux-yocto = "3.10%" + PREFERRED_VERSION_linux-yocto = "3.19%" </literallayout> </para> </glossdef> </glossentry> <glossentry id='var-PREMIRRORS'><glossterm>PREMIRRORS</glossterm> + <info> + PREMIRRORS[doc] = "Specifies additional paths from which the OpenEmbedded build system gets source code." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies additional paths from which the OpenEmbedded build system gets source code. When the build system searches for source code, it first @@ -6771,9 +8489,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PRINC'><glossterm>PRINC</glossterm> + <info> + PRINC[doc] = "Causes the PR variable of .bbappend files to dynamically increment. This increment minimizes the impact of layer ordering. This variable defaults to '0'." + </info> <glossdef> - - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The <filename>PRINC</filename> variable has been deprecated and triggers a warning if detected during a build. For @@ -6816,9 +8536,37 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> - <glossentry id='var-PRIVATE_LIBS'><glossterm>PRIVATE_LIBS</glossterm> + <glossentry id='var-PRIORITY'><glossterm>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 role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Indicates the importance of a package. + </para> + + <para> + <filename>PRIORITY</filename> is considered to be part of + the distribution policy because the importance of any given + recipe depends on the purpose for which the distribution + is being produced. + Thus, <filename>PRIORITY</filename> is not normally set + within recipes. + </para> + <para> + 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>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." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies libraries installed within a recipe that should be ignored by the OpenEmbedded build system's shared library resolver. @@ -6849,8 +8597,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm> + <info> + PROVIDES[doc] = "A list of aliases that a recipe also provides. These aliases are useful for satisfying dependencies of other recipes during the build as specified by DEPENDS." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of aliases by which a particular recipe can be known. By default, a recipe's own @@ -6878,8 +8629,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PRSERV_HOST'><glossterm>PRSERV_HOST</glossterm> + <info> + PRSERV_HOST[doc] = "The network based PR service host and port." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The network based <link linkend='var-PR'><filename>PR</filename></link> service host and port. @@ -6904,8 +8658,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PTEST_ENABLED'><glossterm>PTEST_ENABLED</glossterm> + <info> + PRSERV_HOST[doc] = "Specifies whether or not Package Test (ptest) functionality is enabled when building a recipe." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies whether or not <ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Package Test</ulink> (ptest) functionality is enabled when building a recipe. @@ -6919,8 +8676,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PV'><glossterm>PV</glossterm> + <info> + PV[doc] = "The version of the recipe. The version is normally extracted from the recipe filename." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The version of the recipe. The version is normally extracted from the recipe filename. For example, if the recipe is named @@ -6934,8 +8694,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PYTHON_ABI'><glossterm>PYTHON_ABI</glossterm> + <info> + PYTHON_ABI[doc] = "When used by recipes that inherit the distutils3, setuptools3, distutils, or setuptools classes, denotes the Application Binary Interface (ABI) currently in use for Python." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When used by recipes that inherit the <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link>, <link linkend='ref-classes-setuptools3'><filename>setuptools3</filename></link>, @@ -6967,8 +8730,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-PYTHON_PN'><glossterm>PYTHON_PN</glossterm> + <info> + PYTHON_PN[doc] = "When used by recipes that inherit the distutils3, setuptools3, distutils, or setuptools classes, specifies the major Python version being built." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When used by recipes that inherit the <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link>, <link linkend='ref-classes-setuptools3'><filename>setuptools3</filename></link>, @@ -7000,8 +8766,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdiv id='var-glossary-q'><title>Q</title> <glossentry id='var-QMAKE_PROFILES'><glossterm>QMAKE_PROFILES</glossterm> + <info> + QMAKE_PROFILES[doc] = "Specifies your own subset of .pro files to be built for use with qmake." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies your own subset of <filename>.pro</filename> files to be built for use with <filename>qmake</filename>. @@ -7024,9 +8793,24 @@ 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>RANLIB</glossterm> + <info> + RANLIB[doc] = "Minimal command and arguments to run 'ranlib'." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments to run + <filename>ranlib</filename>. + </para> + </glossdef> + </glossentry> + <glossentry id='var-RCONFLICTS'><glossterm>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." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The list of packages that conflict with packages. Note that packages will not be installed if conflicting packages are not first removed. @@ -7070,8 +8854,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm> + <info> + RDEPENDS[doc] = "Lists a package's runtime dependencies (i.e. other packages) that must be installed for the package to be built. They must be the names of other packages as listed in the PACKAGES variable, not recipe names (PN)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists a package's runtime dependencies (i.e. other packages) that must be installed in order for the built package to run correctly. @@ -7202,8 +8989,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-REQUIRED_DISTRO_FEATURES'><glossterm>REQUIRED_DISTRO_FEATURES</glossterm> + <info> + REQUIRED_DISTRO_FEATURES[doc] = "When a recipe inherits the distro_features_check class, this variable identifies distribution features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link> class, this @@ -7221,8 +9011,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-RM_OLD_IMAGE'><glossterm>RM_OLD_IMAGE</glossterm> + <info> + RM_OLD_IMAGE[doc] = "Reclaims disk space by removing previously built versions of the same image from the images directory pointed to by the DEPLOY_DIR variable." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Reclaims disk space by removing previously built versions of the same image from the <filename>images</filename> directory pointed to by the @@ -7239,8 +9032,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-RM_WORK_EXCLUDE'><glossterm>RM_WORK_EXCLUDE</glossterm> + <info> + RM_WORK_EXCLUDE[doc] = "With rm_work enabled, this variable specifies a list of packages whose work directories should not be removed." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> With <filename>rm_work</filename> enabled, this variable specifies a list of recipes whose work directories should not be removed. @@ -7251,8 +9047,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-ROOT_HOME'><glossterm>ROOT_HOME</glossterm> + <info> + ROOT_HOME[doc] = "Defines the root home directory." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the root home directory. By default, this directory is set as follows in the BitBake configuration file: @@ -7284,8 +9083,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-ROOTFS'><glossterm>ROOTFS</glossterm> + <info> + ROOTFS[doc] = "Indicates a filesystem image to include as the root filesystem." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Indicates a filesystem image to include as the root filesystem. </para> @@ -7300,14 +9102,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-ROOTFS_POSTPROCESS_COMMAND'><glossterm>ROOTFS_POSTPROCESS_COMMAND</glossterm> + <info> + ROOTFS_POSTPROCESS_COMMAND[doc] = "Added by classes to run post processing commands once the OpenEmbedded build system has created the root filesystem." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Added by classes to run post processing commands once the OpenEmbedded build system has created the root filesystem. You can specify shell commands separated by semicolons: <literallayout class='monospaced'> ROOTFS_POSTPROCESS_COMMAND += "<replaceable>shell_command</replaceable>; ... " </literallayout> + </para> + + <para> If you need to pass the path to the root filesystem within the command, you can use <filename>${IMAGE_ROOTFS}</filename>, which points to @@ -7320,8 +9128,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-RPROVIDES'><glossterm>RPROVIDES</glossterm> + <info> + RPROVIDES[doc] = "A list of package name aliases that a package also provides. These aliases are useful for satisfying runtime dependencies of other packages both during the build and on the target." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of package name aliases that a package also provides. These aliases are useful for satisfying runtime dependencies of other packages both during the build and on the target @@ -7332,6 +9143,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <filename>RPROVIDES</filename> list. </note> </para> + <para> As with all package-controlling variables, you must always use the variable in conjunction with a package name override. @@ -7344,8 +9156,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm> + <info> + RRECOMMENDS[doc] = "A list of packages that extends the usability of a package being built. The package being built does not depend on this list of packages in order to successfully build, but needs them for the extended usability." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of packages that extends the usability of a package being built. The package being built does not depend on this list of @@ -7433,8 +9248,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm> + <info> + RREPLACES[doc] = "A list of packages replaced by a package. The package manager uses this variable to determine which package should be installed to replace other package(s) during an upgrade." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of packages replaced by a package. The package manager uses this variable to determine which package should be installed to replace other package(s) @@ -7444,6 +9262,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" package to the <filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link></filename> variable. </para> + <para> As with all package-controlling variables, you must use this variable in conjunction with a package name @@ -7484,13 +9303,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-RSUGGESTS'><glossterm>RSUGGESTS</glossterm> + <info> + RSUGGESTS[doc] = "A list of additional packages that you can suggest for installation by the package manager at the time a package is installed. Not all package managers support this functionality." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of additional packages that you can suggest for installation by the package manager at the time a package is installed. Not all package managers support this functionality. </para> + <para> As with all package-controlling variables, you must always use this variable in conjunction with a package name @@ -7508,8 +9331,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdiv id='var-glossary-s'><title>S</title> <glossentry id='var-S'><glossterm>S</glossterm> + <info> + S[doc] = "The location in the Build Directory where unpacked package source code resides." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> where unpacked recipe source code resides. @@ -7524,6 +9350,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> ${WORKDIR}/${PN}-${PV} </literallayout> + </para> + + <para> As an example, assume a <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level folder named <filename>poky</filename> and a @@ -7539,8 +9368,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SANITY_REQUIRED_UTILITIES'><glossterm>SANITY_REQUIRED_UTILITIES</glossterm> + <info> + SANITY_REQUIRED_UTILITIES[doc] = "Specifies a list of command-line utilities that should be checked for during the initial sanity checking process when running BitBake." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a list of command-line utilities that should be checked for during the initial sanity checking process when running BitBake. @@ -7551,8 +9383,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SANITY_TESTED_DISTROS'><glossterm>SANITY_TESTED_DISTROS</glossterm> + <info> + SANITY_TESTED_DISTROS[doc] = "A list of the host distribution identifiers that the build system has been tested against." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of the host distribution identifiers that the build system has been tested against. Identifiers consist of the host distributor ID @@ -7572,8 +9407,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm> + <info> + SDK_ARCH[doc] = "The target architecture for the SDK." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The target architecture for the SDK. Typically, you do not directly set this variable. Instead, use @@ -7583,8 +9421,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SDK_DEPLOY'><glossterm>SDK_DEPLOY</glossterm> + <info> + SDK_DEPLOY[doc] = "The directory set up and used by the populate_sdk_base to which the SDK is deployed." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The directory set up and used by the <link linkend='ref-classes-populate-sdk'><filename>populate_sdk_base</filename></link> to which the SDK is deployed. @@ -7598,8 +9439,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SDK_DIR'><glossterm>SDK_DIR</glossterm> + <info> + SDK_DIR[doc] = "The parent directory used by the OpenEmbedded build system when creating SDK output." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The parent directory used by the OpenEmbedded build system when creating SDK output. The @@ -7620,8 +9464,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm> + <info> + SDK_NAME[doc] = "The base name for SDK output files." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The base name for SDK output files. The name is derived from the <link linkend='var-DISTRO'><filename>DISTRO</filename></link>, @@ -7638,9 +9485,26 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-SDK_OS'><glossterm>SDK_OS</glossterm> + <info> + SDK_OS[doc] = "The operating system for which the SDK will be built." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the operating system for which the SDK + will be built. + The default value is the value of + <link linkend='var-BUILD_OS'><filename>BUILD_OS</filename></link>. + </para> + </glossdef> + </glossentry> + <glossentry id='var-SDK_OUTPUT'><glossterm>SDK_OUTPUT</glossterm> + <info> + SDK_OUTPUT[doc] = "The location used by the OpenEmbedded build system when creating SDK output." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The location used by the OpenEmbedded build system when creating SDK output. The @@ -7657,14 +9521,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The final output directory is <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link>. </note> - </para> </glossdef> </glossentry> <glossentry id='var-SDK_PACKAGE_ARCHS'><glossterm>SDK_PACKAGE_ARCHS</glossterm> + <info> + SDK_PACKAGE_ARCHS[doc] = "Specifies a list of architectures compatible with the SDK machine. This variable is set automatically and should not normally be hand-edited." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a list of architectures compatible with the SDK machine. This variable is set automatically and should not @@ -7678,9 +9544,63 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-SDK_PREFIX'><glossterm>SDK_PREFIX</glossterm> + <info> + SDK_PREFIX[doc] = "The toolchain binary prefix used for nativesdk recipes." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The toolchain binary prefix used for nativesdk recipes. + The OpenEmbedded build system uses the + <filename>SDK_PREFIX</filename> value to set the + <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link> + when building <filename>nativesdk</filename> recipes. + The default value is "${SDK_SYS}-". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_SYS'><glossterm>SDK_SYS</glossterm> + <info> + SDK_SYS[doc] = "Specifies the system, including the architecture and the operating system, for which the SDK will be built." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the system, including the architecture and the + operating system, for which the SDK will be built. + </para> + + <para> + The OpenEmbedded build system automatically sets this + variable based on + <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>, + <link linkend='var-SDK_VENDOR'><filename>SDK_VENDOR</filename></link>, + and + <link linkend='var-SDK_OS'><filename>SDK_OS</filename></link>. + You do not need to set the <filename>SDK_SYS</filename> + variable yourself. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_VENDOR'><glossterm>SDK_VENDOR</glossterm> + <info> + SDK_VENDOR[doc] = "Specifies the name of the SDK vendor." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the name of the SDK vendor. + </para> + </glossdef> + </glossentry> + <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm> + <info> + SDKIMAGE_FEATURES[doc] = "Equivalent to IMAGE_FEATURES. However, this variable applies to the SDK generated from an image using the command 'bitbake -c populate_sdk imagename'." + </info> <glossdef> - <para>Equivalent to + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Equivalent to <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>. However, this variable applies to the SDK generated from an image using the following command: @@ -7692,8 +9612,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SDKMACHINE'><glossterm>SDKMACHINE</glossterm> + <info> + SDKMACHINE[doc] = "Specifies the architecture (i.e. i686 or x86_64) for which to build SDK and ADT items." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The machine for which the Application Development Toolkit (ADT) or SDK is built. In other words, the SDK or ADT is built such that it @@ -7721,8 +9644,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SDKPATH'><glossterm>SDKPATH</glossterm> + <info> + SDKPATH[doc] = "Defines the path offered to the user for installation of the SDK that is generated by the OpenEmbedded build system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the path offered to the user for installation of the SDK that is generated by the OpenEmbedded build system. @@ -7734,16 +9660,38 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-SDKTARGETSYSROOT'><glossterm>SDKTARGETSYSROOT</glossterm> + <info> + SDKTARGETSYSROOT[doc] = "Full path to the sysroot used for cross-compilation within an SDK as it will be when installed into the default SDKPATH." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The full path to the sysroot used for cross-compilation + within an SDK as it will be when installed into the + default + <link linkend='var-SDKPATH'><filename>SDKPATH</filename></link>. + </para> + </glossdef> + </glossentry> + <glossentry id='var-SECTION'><glossterm>SECTION</glossterm> + <info> + SECTION[doc] = "The section in which packages should be categorized. Package management utilities can make use of this variable." + </info> <glossdef> - <para>The section in which packages should be categorized. - Package management utilities can make use of this variable.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The section in which packages should be categorized. + Package management utilities can make use of this variable. + </para> </glossdef> </glossentry> <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm> + <info> + SELECTED_OPTIMIZATION[doc] = "The variable takes the value of FULL_OPTIMIZATION unless DEBUG_BUILD = '1'. In this case, the value of DEBUG_OPTIMIZATION is used." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the optimization flags passed to the C compiler when building for the target. The flags are passed through the default value of the @@ -7763,8 +9711,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm> + <info> + SERIAL_CONSOLE[doc] = "The speed and device for the serial port used to attach the serial console. This variable is given to the kernel as the 'console' parameter. After booting occurs, getty is started on that port so remote login is possible." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines a serial console (TTY) to enable using getty. Provide a value that specifies the baud rate followed by the TTY device name separated by a space. @@ -7784,8 +9735,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SERIAL_CONSOLES'><glossterm>SERIAL_CONSOLES</glossterm> + <info> + SERIAL_CONSOLES[doc] = "Defines the serial consoles (TTYs) to enable using getty." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the serial consoles (TTYs) to enable using getty. Provide a value that specifies the baud rate followed by the TTY device name separated by a semicolon. @@ -7798,8 +9752,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SERIAL_CONSOLES_CHECK'><glossterm>SERIAL_CONSOLES_CHECK</glossterm> + <info> + SERIAL_CONSOLES_CHECK[doc] = "Similar to SERIAL_CONSOLES except the device is checked for existence before attempting to enable it. Supported only by SysVinit." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Similar to <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link> except the device is checked for existence before attempting @@ -7811,8 +9768,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS'><glossterm>SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS</glossterm> + <info> + SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS[doc] = "A list of recipe dependencies that should not be used to determine signatures of tasks from one recipe when they depend on tasks from another recipe." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of recipe dependencies that should not be used to determine signatures of tasks from one recipe when they depend on tasks from another recipe. @@ -7820,6 +9780,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2" </literallayout> + </para> + + <para> In this example, <filename>intone</filename> depends on <filename>mplayer2</filename>. </para> @@ -7839,8 +9802,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SIGGEN_EXCLUDERECIPES_ABISAFE'><glossterm>SIGGEN_EXCLUDERECIPES_ABISAFE</glossterm> + <info> + SIGGEN_EXCLUDERECIPES_ABISAFE[doc] = "A list of recipes that are completely stable and will never change." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of recipes that are completely stable and will never change. The ABI for the recipes in the list are presented by @@ -7859,8 +9825,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SITEINFO_BITS'><glossterm>SITEINFO_BITS</glossterm> + <info> + SITEINFO_BITS[doc] = "Specifies the number of bits for the target system CPU." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the number of bits for the target system CPU. The value should be either "32" or "64". </para> @@ -7868,8 +9837,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SITEINFO_ENDIANNESS'><glossterm>SITEINFO_ENDIANNESS</glossterm> + <info> + SITEINFO_ENDIANNESS[doc] = "Specifies the endian byte order of the target system. The value should be either 'le' for 'little-endian' or 'be' for 'big-endian'." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the endian byte order of the target system. The value should be either "le" for little-endian or "be" for big-endian. </para> @@ -7877,8 +9849,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SOC_FAMILY'><glossterm>SOC_FAMILY</glossterm> + <info> + SOC_FAMILY[doc] = "Groups together machines based upon the same family of SOC (System On Chip). You typically set this variable in a common .inc file that you include in the configuration files of all the machines." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Groups together machines based upon the same family of SOC (System On Chip). You typically set this variable in a common @@ -7888,15 +9863,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" You must include <filename>conf/machine/include/soc-family.inc</filename> for this variable to appear in - <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>. + <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>. </note> </para> </glossdef> </glossentry> <glossentry id='var-SOLIBS'><glossterm>SOLIBS</glossterm> + <info> + SOLIBS[doc] = "Defines the suffix for shared libraries used on the target platform." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the suffix for shared libraries used on the target platform. By default, this suffix is ".so.*" for all Linux-based @@ -7913,8 +9891,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SOLIBSDEV'><glossterm>SOLIBSDEV</glossterm> + <info> + SOLIBSDEV[doc] = "Defines the suffix for the development symbolic link (symlink) for shared libraries on the target platform." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines the suffix for the development symbolic link (symlink) for shared libraries on the target platform. By default, this suffix is ".so" for Linux-based @@ -7930,9 +9911,43 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-SOURCE_MIRROR_FETCH'><glossterm>SOURCE_MIRROR_FETCH</glossterm> + <info> + SOURCE_MIRROR_FETCH[doc] = "Set as part of a source mirror generation script to skip COMPATIBLE_MACHINE and COMPATIBLE_HOST checks." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + When you are fetching files to create a mirror of sources + (i.e. creating a source mirror), setting + <filename>SOURCE_MIRROR_FETCH</filename> to "1" in your + <filename>local.conf</filename> configuration file ensures + the source for all recipes are fetched regardless of + whether or not a recipe is compatible with the + configuration. + A recipe is considered incompatible with the currently + configured machine when either or both the + <link linkend='var-COMPATIBLE_MACHINE'><filename>COMPATIBLE_MACHINE</filename></link> + variable and + <link linkend='var-COMPATIBLE_HOST'><filename>COMPATIBLE_HOST</filename></link> + variables specify compatibility with a machine other + than that of the current machine or host. + <note><title>Warning</title> + Do not set the + <filename>SOURCE_MIRROR_FETCH</filename> variable + unless you are creating a source mirror. + In other words, do not set the variable during a + normal build. + </note> + </para> + </glossdef> + </glossentry> + <glossentry id='var-SOURCE_MIRROR_URL'><glossterm>SOURCE_MIRROR_URL</glossterm> + <info> + SOURCE_MIRROR_URL[doc] = "URL to source mirror that will be used before fetching from original SRC_URI." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Defines your own <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> from which to first fetch source before attempting to fetch @@ -7958,8 +9973,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SPDXLICENSEMAP'><glossterm>SPDXLICENSEMAP</glossterm> + <info> + SPDXLICENSEMAP[doc] = "Maps commonly used license names to their SPDX counterparts found in meta/files/common-licenses/." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Maps commonly used license names to their SPDX counterparts found in <filename>meta/files/common-licenses/</filename>. For the default <filename>SPDXLICENSEMAP</filename> @@ -7976,8 +9994,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm> + <info> + SPECIAL_PKGSUFFIX[doc] = "A list of prefixes for PN used by the OpenEmbedded build system to create variants of recipes or packages. The list specifies the prefixes to strip off during certain circumstances such as the generation of the BPN variable." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of prefixes for <link linkend='var-PN'><filename>PN</filename></link> used by the OpenEmbedded build system to create variants of recipes or packages. The list specifies the prefixes to strip off during certain circumstances @@ -7987,8 +10008,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm> + <info> + SRC_URI[doc] = "The list of source files - local or remote. This variable tells the OpenEmbedded build system what bits to pull in for the build and how to pull them in." + </info> <glossdef> - <para>The list of source files - local or remote. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The list of source files - local or remote. This variable tells the OpenEmbedded build system which bits to pull in for the build and how to pull them in. For example, if the recipe or append file only needs to @@ -7998,8 +10023,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" On the other hand, if the recipe or append file needs to fetch a tarball, apply two patches, and include a custom file, the recipe or append file would include four - instances of the variable.</para> - <para>The following list explains the available URI protocols: + instances of the variable. + </para> + + <para> + The following list explains the available URI protocols: <itemizedlist> <listitem><para><emphasis><filename>file://</filename> -</emphasis> Fetches files, which are usually files shipped with @@ -8072,7 +10100,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" a Subversion (<filename>svn</filename>) revision control repository.</para></listitem> </itemizedlist> </para> - <para>Standard and recipe-specific options for <filename>SRC_URI</filename> exist. + + <para> + Standard and recipe-specific options for <filename>SRC_URI</filename> exist. Here are standard options: <itemizedlist> <listitem><para><emphasis><filename>apply</filename> -</emphasis> Whether to apply @@ -8087,7 +10117,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </para></listitem> </itemizedlist> </para> - <para>Here are options specific to recipes building code from a revision control system: + + <para> + Here are options specific to recipes building code from a revision control system: <itemizedlist> <listitem><para><emphasis><filename>mindate</filename> -</emphasis> Apply the patch only if @@ -8116,7 +10148,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </para></listitem> </itemizedlist> </para> - <para>Here are some additional options worth mentioning: + + <para> + Here are some additional options worth mentioning: <itemizedlist> <listitem><para><emphasis><filename>unpack</filename> -</emphasis> Controls whether or not to unpack the file if it is an archive. @@ -8139,8 +10173,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm> + <info> + SRC_URI_OVERRIDES_PACKAGE_ARCH[doc] = "By default, the OpenEmbedded build system automatically detects whether SRC_URI contains files that are machine-specific. If so, the build system automatically changes PACKAGE_ARCH. Setting this variable to '0' disables this behavior." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> By default, the OpenEmbedded build system automatically detects whether <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> contains files that are machine-specific. @@ -8152,8 +10189,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SRCDATE'><glossterm>SRCDATE</glossterm> + <info> + SRCDATE[doc] = "The date of the source code used to build the package. This variable applies only if the source was fetched from a Source Code Manager (SCM)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The date of the source code used to build the package. This variable applies only if the source was fetched from a Source Code Manager (SCM). </para> @@ -8161,8 +10201,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SRCPV'><glossterm>SRCPV</glossterm> + <info> + SRCPV[doc] = "Returns the version string of the current package. This string is used to help define the value of PV." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Returns the version string of the current package. This string is used to help define the value of <link linkend='var-PV'><filename>PV</filename></link>. @@ -8195,28 +10238,48 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm> + <info> + SRCREV[doc] = "The revision of the source code used to build the package. This variable applies to Subversion, Git, Mercurial and Bazaar only." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The revision of the source code used to build the package. - This variable applies to Subversion, Git, Mercurial and Bazaar - only. - Note that if you wish to build a fixed revision and you wish - to avoid performing a query on the remote repository every time - BitBake parses your recipe, you should specify a <filename>SRCREV</filename> that is a + This variable applies to Subversion, Git, Mercurial and + Bazaar only. + Note that if you want to build a fixed revision and you + want to avoid performing a query on the remote repository + every time BitBake parses your recipe, you should specify + a <filename>SRCREV</filename> that is a full revision identifier and not just a tag. </para> + + <note> + For information on limitations when inheriting the latest + revision of software using <filename>SRCREV</filename>, + see the + <link linkend='var-AUTOREV'><filename>AUTOREV</filename></link> + variable description. + </note> </glossdef> </glossentry> <glossentry id='var-SSTATE_DIR'><glossterm>SSTATE_DIR</glossterm> + <info> + SSTATE_DIR[doc] = "The directory for the shared state cache." + </info> <glossdef> - <para>The directory for the shared state cache.</para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The directory for the shared state cache. + </para> </glossdef> </glossentry> <glossentry id='var-SSTATE_MIRROR_ALLOW_NETWORK'><glossterm>SSTATE_MIRROR_ALLOW_NETWORK</glossterm> + <info> + SSTATE_MIRROR_ALLOW_NETWORK[doc] = "If set to "1", allows fetches from mirrors that are specified in SSTATE_MIRRORS to work even when fetching from the network has been disabled by setting BB_NO_NETWORK to "1"." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> If set to "1", allows fetches from mirrors that are specified in <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> @@ -8234,8 +10297,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SSTATE_MIRRORS'><glossterm>SSTATE_MIRRORS</glossterm> + <info> + SSTATE_MIRRORS[doc] = "Configures the OpenEmbedded build system to search other mirror locations for prebuilt cache data objects before building out the data. You can specify a filesystem directory or a remote URL such as HTTP or FTP." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Configures the OpenEmbedded build system to search other mirror locations for prebuilt cache data objects before building out the data. @@ -8272,8 +10338,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_BASE_LIBDIR_NATIVE'><glossterm>STAGING_BASE_LIBDIR_NATIVE</glossterm> + <info> + STAGING_BASE_LIBDIR_NATIVE[doc] = "Specifies the path to the /lib subdirectory of the sysroot directory for the build host." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the <filename>/lib</filename> subdirectory of the sysroot directory for the build host. @@ -8282,8 +10351,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_BASELIBDIR'><glossterm>STAGING_BASELIBDIR</glossterm> + <info> + STAGING_BASELIBDIR[doc] = "Specifies the path to the /lib subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the <filename>/lib</filename> subdirectory of the sysroot directory for the target for which the current recipe is being built @@ -8293,8 +10365,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_BINDIR'><glossterm>STAGING_BINDIR</glossterm> + <info> + STAGING_BINDIR[doc] = "Specifies the path to the /usr/bin subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the <filename>/usr/bin</filename> subdirectory of the sysroot directory for the target for which the current @@ -8305,8 +10380,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_BINDIR_CROSS'><glossterm>STAGING_BINDIR_CROSS</glossterm> + <info> + STAGING_BINDIR_CROSS[doc] = "Specifies the path to the directory containing binary configuration scripts. These scripts provide configuration information for other software that wants to make use of libraries or include files provided by the software associated with the script." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the directory containing binary configuration scripts. These scripts provide configuration information for @@ -8327,8 +10405,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_BINDIR_NATIVE'><glossterm>STAGING_BINDIR_NATIVE</glossterm> + <info> + STAGING_BINDIR_NATIVE[doc] = "Specifies the path to the /usr/bin subdirectory of the sysroot directory for the build host." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the <filename>/usr/bin</filename> subdirectory of the sysroot directory for the build host. @@ -8337,8 +10418,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_DATADIR'><glossterm>STAGING_DATADIR</glossterm> + <info> + STAGING_DATADIR[doc] = "Specifies the path to the /usr/share subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the <filename>/usr/share</filename> subdirectory of the sysroot directory for the target for which the current recipe is being built @@ -8347,9 +10431,24 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-STAGING_DATADIR_NATIVE'><glossterm>STAGING_DATADIR_NATIVE</glossterm> + <info> + STAGING_DATADIR_NATIVE[doc] = "Specifies the path to the /usr/share subdirectory of the sysroot directory for the build host." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the path to the <filename>/usr/share</filename> + subdirectory of the sysroot directory for the build host. + </para> + </glossdef> + </glossentry> + <glossentry id='var-STAGING_DIR'><glossterm>STAGING_DIR</glossterm> + <info> + STAGING_DIR[doc] = "Specifies the path to the top-level sysroots directory (i.e. ${TMPDIR}/sysroots)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the top-level sysroots directory (i.e. <filename>${</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>}/sysroots</filename>). @@ -8369,8 +10468,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_DIR_HOST'><glossterm>STAGING_DIR_HOST</glossterm> + <info> + STAGING_DIR_HOST[doc] = "Specifies the path to the primary sysroot directory for which the target is being built." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the primary sysroot directory for which the target is being built. Depending on the type of recipe and the build target, the @@ -8386,7 +10488,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" the build host's own directories should be used. </para></listitem> <listitem><para>For <filename>nativesdk</filename> - recipes that Build for the SDK, the value is + recipes that build for the SDK, the value is "${STAGING_DIR}/${MULTIMACH_HOST_SYS}". </para></listitem> </itemizedlist> @@ -8394,20 +10496,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> - <glossentry id='var-STAGING_DATADIR_NATIVE'><glossterm>STAGING_DATADIR_NATIVE</glossterm> - <glossdef> - <para> - Specifies the path to the <filename>/usr/share</filename> - subdirectory of the sysroot directory for the build host. - </para> - </glossdef> - </glossentry> - - - <glossentry id='var-STAGING_DIR_NATIVE'><glossterm>STAGING_DIR_NATIVE</glossterm> + <info> + STAGING_DIR_NATIVE[doc] = "Specifies the path to the sysroot directory for the build host." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the sysroot directory for the build host. </para> @@ -8415,8 +10509,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_DIR_TARGET'><glossterm>STAGING_DIR_TARGET</glossterm> + <info> + STAGING_DIR_TARGET[doc] = "Specifies the path to the sysroot directory for the target for which the current recipe is being built." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the sysroot directory for the target for which the current recipe is being built. In most cases, this path is the @@ -8439,8 +10536,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_ETCDIR_NATIVE'><glossterm>STAGING_ETCDIR_NATIVE</glossterm> + <info> + STAGING_ETCDIR_NATIVE[doc] = "Specifies the path to the /etc subdirectory of the sysroot directory for the build host." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the <filename>/etc</filename> subdirectory of the sysroot directory for the build host. @@ -8449,8 +10549,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_EXECPREFIXDIR'><glossterm>STAGING_EXECPREFIXDIR</glossterm> + <info> + STAGING_EXECPREFIXDIR[doc] = "Specifies the path to the /usr subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the <filename>/usr</filename> subdirectory of the sysroot directory for the target for which the current recipe is being built @@ -8460,8 +10563,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_INCDIR'><glossterm>STAGING_INCDIR</glossterm> + <info> + STAGING_INCDIR[doc] = "Specifies the path to the /usr/include subdirectory of the sysroot directory for the target for which the current recipe being built (STAGING_DIR_HOST)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the <filename>/usr/include</filename> subdirectory of the sysroot directory for the target for which the current @@ -8472,17 +10578,35 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_INCDIR_NATIVE'><glossterm>STAGING_INCDIR_NATIVE</glossterm> + <info> + STAGING_INCDIR_NATIVE[doc] = "Specifies the path to the /usr/include subdirectory of the sysroot directory for the build host." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the <filename>/usr/include</filename> subdirectory of the sysroot directory for the build host. </para> </glossdef> </glossentry> + <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm> + <info> + STAGING_KERNEL_DIR[doc] = "The directory with kernel headers that are required to build out-of-tree modules." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The directory with kernel headers that are required to build out-of-tree + modules. + </para> + </glossdef> + </glossentry> + <glossentry id='var-STAGING_LIBDIR'><glossterm>STAGING_LIBDIR</glossterm> + <info> + STAGING_LIBDIR[doc] = "Specifies the path to the /usr/lib subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the <filename>/usr/lib</filename> subdirectory of the sysroot directory for the target for which the current recipe is being built @@ -8492,26 +10616,23 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAGING_LIBDIR_NATIVE'><glossterm>STAGING_LIBDIR_NATIVE</glossterm> + <info> + STAGING_LIBDIR_NATIVE[doc] = "Specifies the path to the /usr/lib subdirectory of the sysroot directory for the build host." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the path to the <filename>/usr/lib</filename> subdirectory of the sysroot directory for the build host. </para> </glossdef> </glossentry> - <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm> - <glossdef> - <para> - The directory with kernel headers that are required to build out-of-tree - modules. - </para> - </glossdef> - </glossentry> - <glossentry id='var-STAMP'><glossterm>STAMP</glossterm> + <info> + STAMP[doc] = "Specifies the base path used to create recipe stamp files. The path to an actual stamp file is constructed by evaluating this string and then appending additional information." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the base path used to create recipe stamp files. The path to an actual stamp file is constructed by evaluating this string and then appending additional information. @@ -8521,6 +10642,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> STAMP = "${STAMPS_DIR}/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}" </literallayout> + </para> + + <para> See <link linkend='var-STAMPS_DIR'><filename>STAMPS_DIR</filename></link>, <link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>, <link linkend='var-PN'><filename>PN</filename></link>, @@ -8533,8 +10657,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-STAMPS_DIR'><glossterm>STAMPS_DIR</glossterm> + <info> + STAMPS_DIR[doc] = "Specifies the base directory in which the OpenEmbedded build system places stamps." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the base directory in which the OpenEmbedded build system places stamps. The default directory is @@ -8543,9 +10670,26 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-STRIP'><glossterm>STRIP</glossterm> + <info> + STRIP[doc] = "Minimal command and arguments to run 'strip' (strip symbols)." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The minimal command and arguments to run + <filename>strip</filename>, which is used to strip + symbols. + </para> + </glossdef> + </glossentry> + <glossentry id='var-SUMMARY'><glossterm>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." + </info> <glossdef> - <para>The short (72 characters or less) summary of the binary package for packaging + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The short (72 characters or less) summary of the binary package for packaging systems such as <filename>opkg</filename>, <filename>rpm</filename> or <filename>dpkg</filename>. By default, <filename>SUMMARY</filename> is used to define @@ -8556,9 +10700,24 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-SVNDIR'><glossterm>SVNDIR</glossterm> + <info> + SVNDIR[doc] = "The directory where Subversion checkouts will be stored." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The directory in which files checked out of a Subversion + system are stored. + </para> + </glossdef> + </glossentry> + <glossentry id='var-SYSLINUX_DEFAULT_CONSOLE'><glossterm>SYSLINUX_DEFAULT_CONSOLE</glossterm> + <info> + SYSLINUX_DEFAULT_CONSOLE[doc] = "Specifies the kernel boot default console." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the kernel boot default console. If you want to use a console other than the default, set this variable in your recipe as follows where "X" is @@ -8578,8 +10737,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SYSLINUX_OPTS'><glossterm>SYSLINUX_OPTS</glossterm> + <info> + SYSLINUX_OPTS[doc] = "Lists additional options to add to the syslinux file." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Lists additional options to add to the syslinux file. You need to set this variable in your recipe. If you want to list multiple options, separate the options @@ -8595,8 +10757,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SYSLINUX_SERIAL'><glossterm>SYSLINUX_SERIAL</glossterm> + <info> + SYSLINUX_SERIAL[doc] = "Specifies the alternate serial port or turns it off." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the alternate serial port or turns it off. To turn off serial, set this variable to an empty string in your recipe. @@ -8606,13 +10771,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> SYSLINUX_SERIAL ?= "0 115200" </literallayout> - The class checks for and uses the variable as needed. </para> + </para> + + <para> + The class checks for and uses the variable as needed. + </para> </glossdef> </glossentry> <glossentry id='var-SYSLINUX_SPLASH'><glossterm>SYSLINUX_SPLASH</glossterm> + <info> + SYSLINUX_SPLASH[doc] = "An .LSS file used as the background for the VGA boot menu when you are using the boot menu." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> An <filename>.LSS</filename> file used as the background for the VGA boot menu when you are using the boot menu. You need to set this variable in your recipe. @@ -8628,8 +10800,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SYSLINUX_SERIAL_TTY'><glossterm>SYSLINUX_SERIAL_TTY</glossterm> + <info> + SYSLINUX_SERIAL_TTY[doc] = "Specifies the alternate console=tty... kernel boot argument." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the alternate console=tty... kernel boot argument. The variable's default value is set in the <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> @@ -8637,14 +10812,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200" </literallayout> + </para> + + <para> The class checks for and uses the variable as needed. </para> </glossdef> </glossentry> <glossentry id='var-SYSROOT_PREPROCESS_FUNCS'><glossterm>SYSROOT_PREPROCESS_FUNCS</glossterm> + <info> + SYSROOT_PREPROCESS_FUNCS[doc] = "A list of functions to execute after files are staged into the sysroot. These functions are usually used to apply additional processing on the staged files, or to stage additional files." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of functions to execute after files are staged into the sysroot. These functions are usually used to apply additional @@ -8655,8 +10836,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SYSTEMD_AUTO_ENABLE'><glossterm>SYSTEMD_AUTO_ENABLE</glossterm> + <info> + SYSTEMD_AUTO_ENABLE[doc] = "For recipes that inherit the systemd class, this variable specifies whether the service you have specified in SYSTEMD_SERVICE should be started automatically or not." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-systemd'><filename>systemd</filename></link> class, this variable specifies whether the service you have @@ -8671,6 +10855,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> SYSTEMD_AUTO_ENABLE ??= "enable" </literallayout> + </para> + + <para> You can disable the service by setting the variable to "disable". </para> @@ -8678,8 +10865,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SYSTEMD_PACKAGES'><glossterm>SYSTEMD_PACKAGES</glossterm> + <info> + SYSTEMD_PACKAGES[doc] = "For recipes that inherit the systemd class, this variable locates the systemd unit files when they are not found in the main recipe's package." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-systemd'><filename>systemd</filename></link> class, this variable locates the systemd unit files when @@ -8691,6 +10881,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> SYSTEMD_PACKAGES ?= "${PN}" </literallayout> + </para> + + <para> If these unit files are not in this recipe's main package, you need to use <filename>SYSTEMD_PACKAGES</filename> to list the package @@ -8701,8 +10894,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SYSTEMD_SERVICE'><glossterm>SYSTEMD_SERVICE</glossterm> + <info> + SYSTEMD_SERVICE[doc] = "For recipes that inherit the systemd class, this variable specifies the systemd service name for a package." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-systemd'><filename>systemd</filename></link> class, this variable specifies the systemd service name for @@ -8722,8 +10918,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-SYSVINIT_ENABLED_GETTYS'><glossterm>SYSVINIT_ENABLED_GETTYS</glossterm> + <info> + SYSVINIT_ENABLED_GETTYS[doc] = "Specifies which virtual terminals should be running a getty, the default is '1'." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When using <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>, specifies a space-separated list of the virtual terminals @@ -8747,14 +10946,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdiv id='var-glossary-t'><title>T</title> <glossentry id='var-T'><glossterm>T</glossterm> + <info> + T[doc] = "This variable points to a directory were BitBake places temporary files, which consist mostly of task logs and scripts, when building a particular recipe." + </info> <glossdef> - <para>This variable points to a directory were BitBake places + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + This variable points to a directory were BitBake places temporary files, which consist mostly of task logs and scripts, when building a particular recipe. The variable is typically set as follows: <literallayout class='monospaced'> T = "${WORKDIR}/temp" </literallayout> + </para> + + <para> The <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> is the directory into which BitBake unpacks and builds the recipe. @@ -8768,8 +10974,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm> + <info> + TARGET_ARCH[doc] = "The architecture of the device being built. The OpenEmbedded build system supports the following architectures: arm, mips, ppc, x86, x86-64." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The target machine's architecture. The OpenEmbedded build system supports many architectures. @@ -8785,6 +10994,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" mips mipsel </literallayout> + </para> + + <para> For additional information on machine architectures, see the <link linkend='var-TUNE_ARCH'><filename>TUNE_ARCH</filename></link> @@ -8794,8 +11006,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TARGET_AS_ARCH'><glossterm>TARGET_AS_ARCH</glossterm> + <info> + TARGET_AS_ARCH[doc] = "Specifies architecture-specific assembler flags for the target system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies architecture-specific assembler flags for the target system. <filename>TARGET_AS_ARCH</filename> is initialized from @@ -8810,8 +11025,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TARGET_CC_ARCH'><glossterm>TARGET_CC_ARCH</glossterm> + <info> + TARGET_CC_ARCH[doc] = "Specifies architecture-specific C compiler flags for the target system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies architecture-specific C compiler flags for the target system. <filename>TARGET_CC_ARCH</filename> is initialized from @@ -8830,8 +11048,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TARGET_CC_KERNEL_ARCH'><glossterm>TARGET_CC_KERNEL_ARCH</glossterm> + <info> + TARGET_CC_KERNEL_ARCH[doc] = "This is a specific kernel compiler flag for a CPU or Application Binary Interface (ABI) tune." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> This is a specific kernel compiler flag for a CPU or Application Binary Interface (ABI) tune. The flag is used rarely and only for cases where a @@ -8851,8 +11072,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm> + <info> + TARGET_CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the same as CFLAGS." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C compiler when building for the target. When building in the target context, @@ -8873,8 +11097,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TARGET_CPPFLAGS'><glossterm>TARGET_CPPFLAGS</glossterm> + <info> + TARGET_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the target." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the target. @@ -8896,8 +11123,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TARGET_CXXFLAGS'><glossterm>TARGET_CXXFLAGS</glossterm> + <info> + TARGET_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the target." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the C++ compiler when building for the target. When building in the target context, @@ -8918,17 +11148,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm> + <info> + TARGET_FPU[doc] = "Specifies the method for handling FPU code. For FPU-less targets, which include most ARM CPUs, the variable must be set to 'soft'. If not, the kernel emulation gets used, which results in a performance penalty." + </info> <glossdef> - <para>Specifies the method for handling FPU code. + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the method for handling FPU code. For FPU-less targets, which include most ARM CPUs, the variable must be set to "soft". - If not, the kernel emulation gets used, which results in a performance penalty.</para> + If not, the kernel emulation gets used, which results in a performance penalty. + </para> </glossdef> </glossentry> <glossentry id='var-TARGET_LD_ARCH'><glossterm>TARGET_LD_ARCH</glossterm> + <info> + TARGET_LD_ARCH[doc] = "Specifies architecture-specific linker flags for the target system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies architecture-specific linker flags for the target system. <filename>TARGET_LD_ARCH</filename> is initialized from @@ -8943,8 +11181,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TARGET_LDFLAGS'><glossterm>TARGET_LDFLAGS</glossterm> + <info> + TARGET_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the target." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the flags to pass to the linker when building for the target. When building in the target context, @@ -8965,25 +11206,152 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm> + <info> + TARGET_OS[doc] = "Specifies the target's operating system." + </info> <glossdef> - <para>Specifies the target's operating system. - The variable can be set to "linux" for <filename>eglibc</filename>-based systems and + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the target's operating system. + 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> + "linux-uclibc-gnueabi" values possible. + </para> </glossdef> </glossentry> - <glossentry id='var-TCLIBC'><glossterm>TCLIBC</glossterm> + <glossentry id='var-TARGET_PREFIX'><glossterm>TARGET_PREFIX</glossterm> + <info> + TARGET_PREFIX[doc] = "The prefix used for the toolchain binary target tools." + </info> <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the prefix used for the toolchain binary target + tools. + </para> + + <para> + Depending on the type of recipe and the build target, + <filename>TARGET_PREFIX</filename> is set as follows: + <itemizedlist> + <listitem><para> + For recipes building for the target machine, + the value is + "${<link linkend='var-TARGET_SYS'>TARGET_SYS</link>}-". + </para></listitem> + <listitem><para> + For <filename>native</filename> recipes, the build + system sets the variable to the value of + <filename>BUILD_PREFIX</filename>. + </para></listitem> + <listitem><para> + For <filename>nativesdk</filename> recipes, the + build system sets the variable to the value of + <filename>SDK_PREFIX</filename>. + </para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_SYS'><glossterm>TARGET_SYS</glossterm> + <info> + TARGET_SYS[doc] = "The target system is comprised of TARGET_ARCH,TARGET_VENDOR and TARGET_OS." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the system, including the architecture and the + operating system, for which the build is occurring in + the context of the current recipe. + </para> + + <para> + The OpenEmbedded build system automatically sets this + variable based on + <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> + variables. + <note> + You do not need to set the + <filename>TARGET_SYS</filename> variable yourself. + </note> + </para> + <para> + Consider these two examples: + <itemizedlist> + <listitem><para> + Given a <filename>native</filename> recipe on a + 32-bit, x86 machine running Linux, the value is + "i686-linux". + </para></listitem> + <listitem><para> + Given a recipe being built for a little-endian, + MIPS target running Linux, the value might be + "mipsel-linux". + </para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_VENDOR'><glossterm>TARGET_VENDOR</glossterm> + <info> + TARGET_VENDOR[doc] = "The name of the target vendor." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the name of the target vendor. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TCLIBCAPPEND'><glossterm>TCLIBCAPPEND</glossterm> + <info> + TCLIBCAPPEND[doc] = "Specifies a suffix appended to TMPDIR that identifies the libc variant for the build." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies a suffix to be appended onto the + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + value. + The suffix identifies the <filename>libc</filename> variant + for building. + When you are building for multiple variants with the same + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + this mechanism ensures that output for different + <filename>libc</filename> variants is kept separate to + avoid potential conflicts. + </para> + + <para> + In the <filename>defaultsetup.conf</filename> file, the + default value of <filename>TCLIBCAPPEND</filename> is + "-${TCLIBC}". + However, distros such as poky, which normally only support + one <filename>libc</filename> variant, set + <filename>TCLIBCAPPEND</filename> to "" in their distro + configuration file resulting in no suffix being applied. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TCLIBC'><glossterm>TCLIBC</glossterm> + <info> + TCLIBC[doc] = "Specifies GNU standard C library (libc) variant to use during the build process. You can select 'glibc' or 'uclibc'." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the GNU standard C library (<filename>libc</filename>) variant to use during the build process. This variable replaces <filename>POKYLIBC</filename>, which is no longer supported. </para> + <para> - You can select "eglibc" or "uclibc". + You can select "glibc" or "uclibc". <note> This release of the Yocto Project does not support the <filename>glibc</filename> implementation of <filename>libc</filename>. @@ -8993,8 +11361,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TCMODE'><glossterm>TCMODE</glossterm> + <info> + TCMODE[doc] = "Enables an external toolchain (where provided by an additional layer) if set to a value other than 'default'." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the toolchain selector. <filename>TCMODE</filename> controls the characteristics of the generated packages and images by telling the @@ -9018,41 +11389,50 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </para> <para> + The <filename>TCMODE</filename> variable is similar to + <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>, + which controls the variant of the GNU standard C library + (<filename>libc</filename>) used during the build process: + <filename>glibc</filename> or <filename>uclibc</filename>. + </para> + + <para> With additional layers, it is possible to use a pre-compiled external toolchain. One example is the Sourcery G++ Toolchain. The support for this toolchain resides in the separate + <trademark class='registered'>Mentor Graphics</trademark> <filename>meta-sourcery</filename> layer at <ulink url='http://github.com/MentorEmbedded/meta-sourcery/'></ulink>. - You can use <filename>meta-sourcery</filename> as a - template for adding support for other external toolchains. </para> <para> - The <filename>TCMODE</filename> variable points the build - system to a file in - <filename>conf/distro/include/tcmode-${TCMODE}.inc</filename>. - Thus, for <filename>meta-sourcery</filename>, - which has <filename>conf/distro/include/tcmode-external-sourcery.inc</filename>, - you would set the variable as follows: - <literallayout class='monospaced'> - TCMODE ?= "external-sourcery" - </literallayout> + The layer's <filename>README</filename> file contains + information on how to use the Sourcery G++ Toolchain as + an external toolchain. + In summary, you must be sure to add the layer to your + <filename>bblayers.conf</filename> file in front of the + <filename>meta</filename> layer and then set the + <filename>EXTERNAL_TOOLCHAIN</filename> + variable in your <filename>local.conf</filename> file + to the location in which you installed the toolchain. </para> <para> - The variable is similar to - <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>, - which controls the variant of the GNU standard C library - (<filename>libc</filename>) used during the build process: - <filename>eglibc</filename> or <filename>uclibc</filename>. + The fundamentals used for this example apply to any + external toolchain. + You can use <filename>meta-sourcery</filename> as a + template for adding support for other external toolchains. </para> </glossdef> </glossentry> <glossentry id='var-TEST_EXPORT_DIR'><glossterm>TEST_EXPORT_DIR</glossterm> + <info> + TEST_EXPORT_DIR[doc] = "The location the OpenEmbedded build system uses to export tests when the TEST_EXPORT_ONLY variable is set to "1"." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The location the OpenEmbedded build system uses to export tests when the <link linkend='var-TEST_EXPORT_ONLY'><filename>TEST_EXPORT_ONLY</filename></link> @@ -9067,8 +11447,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_EXPORT_ONLY'><glossterm>TEST_EXPORT_ONLY</glossterm> + <info> + TEST_EXPORT_ONLY[doc] = "Specifies to export the tests only. Set this variable to "1" if you do not want to run the tests but you want them to be exported in a manner that you to run them outside of the build system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies to export the tests only. Set this variable to "1" if you do not want to run the tests but you want them to be exported in a manner that @@ -9078,8 +11461,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_IMAGE'><glossterm>TEST_IMAGE</glossterm> + <info> + TEST_IMAGE[doc] = "Enables test booting of virtual machine images under the QEMU emulator after any root filesystems are created and runs tests against those images." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Automatically runs the series of automated tests for images when an image is successfully built. </para> @@ -9108,8 +11494,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_LOG_DIR'><glossterm>TEST_LOG_DIR</glossterm> + <info> + TEST_LOG_DIR[doc] = "Holds the SSH log and the boot log for QEMU machines. The <filename>TEST_LOG_DIR</filename> variable defaults to "${WORKDIR}/testimage"." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Holds the SSH log and the boot log for QEMU machines. The <filename>TEST_LOG_DIR</filename> variable defaults to <filename>"${WORKDIR}/testimage"</filename>. @@ -9123,8 +11512,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_POWERCONTROL_CMD'><glossterm>TEST_POWERCONTROL_CMD</glossterm> + <info> + TEST_POWERCONTROL_CMD[doc] = "For automated hardware testing, specifies the command to use to control the power of the target machine under test" + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> For automated hardware testing, specifies the command to use to control the power of the target machine under test. Typically, this command would point to a script that @@ -9139,8 +11531,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_POWERCONTROL_EXTRA_ARGS'><glossterm>TEST_POWERCONTROL_EXTRA_ARGS</glossterm> + <info> + TEST_POWERCONTROL_EXTRA_ARGS[doc] = "For automated hardware testing, specifies additional arguments to pass through to the command specified in TEST_POWERCONTROL_CMD" + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> For automated hardware testing, specifies additional arguments to pass through to the command specified in <link linkend='var-TEST_POWERCONTROL_CMD'><filename>TEST_POWERCONTROL_CMD</filename></link>. @@ -9154,8 +11549,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_QEMUBOOT_TIMEOUT'><glossterm>TEST_QEMUBOOT_TIMEOUT</glossterm> + <info> + TEST_QEMUBOOT_TIMEOUT[doc] = "The time in seconds allowed for an image to boot before automated runtime tests begin to run against an image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The time in seconds allowed for an image to boot before automated runtime tests begin to run against an image. @@ -9174,8 +11572,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_SERIALCONTROL_CMD'><glossterm>TEST_SERIALCONTROL_CMD</glossterm> + <info> + TEST_SERIALCONTROL_CMD[doc] = "For automated hardware testing, specifies the command to use to connect to the serial console of the target machine under test." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> For automated hardware testing, specifies the command to use to connect to the serial console of the target machine under test. @@ -9196,8 +11597,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_SERIALCONTROL_EXTRA_ARGS'><glossterm>TEST_SERIALCONTROL_EXTRA_ARGS</glossterm> + <info> + TEST_SERIALCONTROL_EXTRA_ARGS[doc] = "For automated hardware testing, specifies additional arguments to pass through to the command specified in TEST_SERIALCONTROL_CMD." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> For automated hardware testing, specifies additional arguments to pass through to the command specified in <link linkend='var-TEST_SERIALCONTROL_CMD'><filename>TEST_SERIALCONTROL_CMD</filename></link>. @@ -9211,8 +11615,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_SERVER_IP'><glossterm>TEST_SERVER_IP</glossterm> + <info> + TEST_SERVER_IP[doc] = "The IP address of the build machine (host machine). This IP address is usually automatically detected." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The IP address of the build machine (host machine). This IP address is usually automatically detected. However, if detection fails, this variable needs to be set @@ -9229,14 +11636,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_TARGET'><glossterm>TEST_TARGET</glossterm> + <info> + TEST_TARGET[doc] = "For automated runtime testing, specifies the method of deploying the image and running tests on the target machine." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the target controller to use when running tests against a test image. The default controller to use is "qemu": <literallayout class='monospaced'> TEST_TARGET = "qemu" </literallayout> + </para> + + <para> A target controller is a class that defines how an image gets deployed on a target and how a target is started. A layer can extend the controllers by adding a module @@ -9294,8 +11707,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_TARGET_IP'><glossterm>TEST_TARGET_IP</glossterm> + <info> + TEST_TARGET_IP[doc] = "The IP address of your hardware under test." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The IP address of your hardware under test. The <filename>TEST_TARGET_IP</filename> variable has no effect when @@ -9320,8 +11736,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TEST_SUITES'><glossterm>TEST_SUITES</glossterm> + <info> + TEST_SUITES[doc] = "An ordered list of tests (modules) to run against an image when performing automated runtime testing." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> An ordered list of tests (modules) to run against an image when performing automated runtime testing. </para> @@ -9375,8 +11794,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-THISDIR'><glossterm>THISDIR</glossterm> + <info> + THISDIR[doc] = "The directory in which the file BitBake is currently parsing is located." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The directory in which the file BitBake is currently parsing is located. Do not manually set this variable. @@ -9384,9 +11806,26 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-TIME'><glossterm>TIME</glossterm> + <info> + TIME[doc] = "The time the build was started using HMS format." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + The time the build was started. + Times appear using the hour, minute, and second (HMS) + format (e.g. "140159" for one minute and fifty-nine + seconds past 1400 hours). + </para> + </glossdef> + </glossentry> + <glossentry id='var-TMPDIR'><glossterm>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." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> This variable is the base directory the OpenEmbedded build system uses for all build output and intermediate files (other than the shared state cache). @@ -9423,8 +11862,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TOOLCHAIN_HOST_TASK'><glossterm>TOOLCHAIN_HOST_TASK</glossterm> + <info> + TOOLCHAIN_HOST_TASK[doc] = "This variable lists packages the OpenEmbedded build system uses when building an SDK, which contains a cross-development environment." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> This variable lists packages the OpenEmbedded build system uses when building an SDK, which contains a cross-development environment. @@ -9453,8 +11895,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TOOLCHAIN_TARGET_TASK'><glossterm>TOOLCHAIN_TARGET_TASK</glossterm> + <info> + TOOLCHAIN_TARGET_TASK[doc] = "This variable lists packages the OpenEmbedded build system uses when it creates the target part of an SDK, which includes libraries and headers." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> This variable lists packages the OpenEmbedded build system uses when it creates the target part of an SDK (i.e. the part built for the target hardware), which @@ -9475,8 +11920,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TOPDIR'><glossterm>TOPDIR</glossterm> + <info> + TOPDIR[doc] = "The Build Directory. BitBake automatically sets this variable. The OpenEmbedded build system uses the Build Directory when building images." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The top-level <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. BitBake automatically sets this variable when you @@ -9489,8 +11937,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TRANSLATED_TARGET_ARCH'><glossterm>TRANSLATED_TARGET_ARCH</glossterm> + <info> + TRANSLATED_TARGET_ARCH[doc] = "A sanitized version of TARGET_ARCH. This variable is used where the architecture is needed in a value where underscores are not allowed." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A sanitized version of <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>. This variable is used where the architecture is needed in @@ -9507,8 +11958,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TUNE_ARCH'><glossterm>TUNE_ARCH</glossterm> + <info> + TUNE_ARCH[doc] = "The GNU canonical architecture for a specific architecture (i.e. arm, armeb, mips, mips64, and so forth)." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The GNU canonical architecture for a specific architecture (i.e. <filename>arm</filename>, <filename>armeb</filename>, @@ -9562,15 +12016,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TUNE_ASARGS'><glossterm>TUNE_ASARGS</glossterm> + <info> + TUNE_ASARGS[doc] = "Specifies architecture-specific assembler flags for the target system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies architecture-specific assembler flags for the target system. The set of flags is based on the selected tune features. <filename>TUNE_ASARGS</filename> is set using the tune include files, which are typically under <filename>meta/conf/machine/include/</filename> and are - influenced through <filename>TUNE_FEATURES</filename>. + influenced through + <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>. For example, the <filename>meta/conf/machine/include/x86/arch-x86.inc</filename> file defines the flags for the x86 architecture as follows: @@ -9578,41 +12036,53 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" TUNE_ASARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}" </literallayout> <note> - Board Support Packages (BSPs) can supply their own - set of flags. + Board Support Packages (BSPs) select the tune. + The selected tune, in turn, affects the tune variables + themselves (i.e. the tune can supply its own + set of flags). </note> </para> </glossdef> </glossentry> <glossentry id='var-TUNE_CCARGS'><glossterm>TUNE_CCARGS</glossterm> + <info> + TUNE_CCARGS[doc] = "Specifies architecture-specific C compiler flags for the target system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies architecture-specific C compiler flags for the target system. The set of flags is based on the selected tune features. <filename>TUNE_CCARGS</filename> is set using the tune include files, which are typically under <filename>meta/conf/machine/include/</filename> and are - influenced through <filename>TUNE_FEATURES</filename>. + influenced through + <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>. <note> - Board Support Packages (BSPs) can supply their own - set of flags. + Board Support Packages (BSPs) select the tune. + The selected tune, in turn, affects the tune variables + themselves (i.e. the tune can supply its own + set of flags). </note> </para> </glossdef> </glossentry> <glossentry id='var-TUNE_LDARGS'><glossterm>TUNE_LDARGS</glossterm> + <info> + TUNE_LDARGS[doc] = "Specifies architecture-specific linker flags for the target system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies architecture-specific linker flags for the target system. The set of flags is based on the selected tune features. <filename>TUNE_LDARGS</filename> is set using the tune include files, which are typically under <filename>meta/conf/machine/include/</filename> and are - influenced through <filename>TUNE_FEATURES</filename>. + influenced through + <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>. For example, the <filename>meta/conf/machine/include/x86/arch-x86.inc</filename> file defines the flags for the x86 architecture as follows: @@ -9620,16 +12090,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", d)}" </literallayout> <note> - Board Support Packages (BSPs) can supply their own - set of flags. + Board Support Packages (BSPs) select the tune. + The selected tune, in turn, affects the tune variables + themselves (i.e. the tune can supply its own + set of flags). </note> </para> </glossdef> </glossentry> <glossentry id='var-TUNE_FEATURES'><glossterm>TUNE_FEATURES</glossterm> + <info> + TUNE_FEATURES[doc] = "Features used to "tune" a compiler for optimal use given a specific processor." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Features used to "tune" a compiler for optimal use given a specific processor. The features are defined within the tune files and allow @@ -9658,21 +12133,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm> + <info> + TUNE_PKGARCH[doc] = "The package architecture understood by the packaging system to define the architecture, ABI, and tuning of output packages." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The package architecture understood by the packaging system to define the architecture, ABI, and tuning of output packages. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNE_PKGARCH_tune'><glossterm>TUNE_PKGARCH_tune</glossterm> - <glossdef> - <para> - The CPU or Application Binary Interface (ABI) specific - tuning of the - <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link>. + The specific tune is defined using the "_tune" override + as follows: + <literallayout class='monospaced'> + TUNE_PKGARCH_tune-<replaceable>tune</replaceable> = "<replaceable>tune</replaceable>" + </literallayout> </para> <para> @@ -9690,8 +12163,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TUNEABI'><glossterm>TUNEABI</glossterm> + <info> + TUNEABI[doc] = "An underlying ABI used by a particular tuning in a given toolchain layer. This feature allows providers using prebuilt libraries to check compatibility of a tuning against their selection of libraries." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> An underlying Application Binary Interface (ABI) used by a particular tuning in a given toolchain layer. Providers that use prebuilt libraries can use the @@ -9714,8 +12190,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TUNEABI_OVERRIDE'><glossterm>TUNEABI_OVERRIDE</glossterm> + <info> + TUNEABI_OVERRIDE[doc] = "If set, ignores TUNEABI_WHITELIST." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> If set, the OpenEmbedded system ignores the <link linkend='var-TUNEABI_WHITELIST'><filename>TUNEABI_WHITELIST</filename></link> variable. @@ -9737,8 +12216,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TUNEABI_WHITELIST'><glossterm>TUNEABI_WHITELIST</glossterm> + <info> + TUNEABI_WHITELIST[doc] = "A whitelist of permissible TUNEABI values. If the variable is not set, all values are allowed." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A whitelist of permissible <link linkend='var-TUNEABI'><filename>TUNEABI</filename></link> values. @@ -9760,9 +12242,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> - <glossentry id='var-TUNECONFLICT'><glossterm>TUNECONFLICT[<replaceable>feature</replaceable>]</glossterm> + <glossentry id='var-TUNECONFLICTS'><glossterm>TUNECONFLICTS[<replaceable>feature</replaceable>]</glossterm> + <info> + TUNECONFLICTS[doc] = "Specifies CPU or Application Binary Interface (ABI) tuning features that conflict with specified feature." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies CPU or Application Binary Interface (ABI) tuning features that conflict with <replaceable>feature</replaceable>. </para> @@ -9783,8 +12268,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-TUNEVALID'><glossterm>TUNEVALID[<replaceable>feature</replaceable>]</glossterm> + <info> + TUNEVALID[doc] = "Descriptions, stored as flags, of valid tuning features." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a valid CPU or Application Binary Interface (ABI) tuning feature. The specified feature is stored as a flag. @@ -9794,6 +12282,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <literallayout class='monospaced'> TUNEVALID[bigendian] = "Enable big-endian mode." </literallayout> + </para> + + <para> See the machine include files in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> for these features. @@ -9806,8 +12297,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdiv id='var-glossary-u'><title>U</title> <glossentry id='var-UBOOT_CONFIG'><glossterm>UBOOT_CONFIG</glossterm> + <info> + UBOOT_CONFIG[doc] = "Configures the UBOOT_MACHINE and can also define IMAGE_FSTYPES for individual cases." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Configures the <link linkend='var-UBOOT_MACHINE'><filename>UBOOT_MACHINE</filename></link> and can also define @@ -9845,8 +12339,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-UBOOT_ENTRYPOINT'><glossterm>UBOOT_ENTRYPOINT</glossterm> + <info> + UBOOT_ENTRYPOINT[doc] = "Specifies the entry point for the U-Boot image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the entry point for the U-Boot image. During U-Boot image creation, the <filename>UBOOT_ENTRYPOINT</filename> variable is passed @@ -9857,8 +12354,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-UBOOT_LOADADDRESS'><glossterm>UBOOT_LOADADDRESS</glossterm> + <info> + UBOOT_LOADADDRESS[doc] = "Specifies the load address for the U-Boot image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the load address for the U-Boot image. During U-Boot image creation, the <filename>UBOOT_LOADADDRESS</filename> variable is passed @@ -9869,8 +12369,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-UBOOT_LOCALVERSION'><glossterm>UBOOT_LOCALVERSION</glossterm> + <info> + UBOOT_LOCALVERSION[doc] = "Appends a string to the name of the local version of the U-Boot image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Appends a string to the name of the local version of the U-Boot image. For example, assuming the version of the U-Boot image @@ -9885,8 +12388,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-UBOOT_MACHINE'><glossterm>UBOOT_MACHINE</glossterm> + <info> + UBOOT_MACHINE[doc] = "Specifies the value passed on the make command line when building a U-Boot image." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the value passed on the <filename>make</filename> command line when building a U-Boot image. @@ -9905,8 +12411,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-UBOOT_MAKE_TARGET'><glossterm>UBOOT_MAKE_TARGET</glossterm> + <info> + UBOOT_MAKE_TARGET[doc] = "Specifies the target called in the Makefile." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the target called in the <filename>Makefile</filename>. The default target is "all". @@ -9915,8 +12424,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-UBOOT_SUFFIX'><glossterm>UBOOT_SUFFIX</glossterm> + <info> + UBOOT_SUFFIX[doc] = "Points to the generated U-Boot extension." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Points to the generated U-Boot extension. For example, <filename>u-boot.sb</filename> has a <filename>.sb</filename> extension. @@ -9930,8 +12442,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-UBOOT_TARGET'><glossterm>UBOOT_TARGET</glossterm> + <info> + UBOOT_TARGET[doc] = "Specifies the target used for building U-Boot." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the target used for building U-Boot. The target is passed directly as part of the "make" command (e.g. SPL and AIS). @@ -9942,9 +12457,58 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> - <glossentry id='var-USE_VT'><glossterm>USE_VT</glossterm> + <glossentry id='var-UPDATERCPN'><glossterm>UPDATERCPN</glossterm> + <info> + UPDATERCPN[doc] = "Specifies the package that contains the initscript that is to be enabled." + </info> <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + For recipes inheriting the + <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link> + class, <filename>UPDATERCPN</filename> specifies + the package that contains the initscript that is to be + enabled. + </para> + <para> + The default value is "${PN}". + Given that almost all recipes that install initscripts + package them in the main package for the recipe, you + rarely need to set this variable in individual recipes. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-USE_DEVFS'><glossterm>USE_DEVFS</glossterm> + <info> + USE_DEVFS[doc] = "Determines if devtmpfs is used for /dev population." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Determines if <filename>devtmpfs</filename> is used for + <filename>/dev</filename> population. + The default value used for <filename>USE_DEVFS</filename> + is "1" when no value is specifically set. + Typically, you would set <filename>USE_DEVFS</filename> + to "0" for a statically populated <filename>/dev</filename> + directory. + </para> + + <para> + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#selecting-dev-manager'>Selecting a Device Manager</ulink>" + section in the Yocto Project Development Manual for + information on how to use this variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-USE_VT'><glossterm>USE_VT</glossterm> + <info> + USE_VT[doc] = "When using SysVinit, determines whether or not to run a getty on any virtual terminals in order to enable logging in through those terminals." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When using <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>, determines whether or not to run a @@ -9965,8 +12529,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-USER_CLASSES'><glossterm>USER_CLASSES</glossterm> + <info> + USER_CLASSES[doc] = "List of additional classes to use when building images that enable extra features." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A list of classes to globally inherit. These classes are used by the OpenEmbedded build system to enable extra features (e.g. @@ -9989,8 +12556,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-USERADD_ERROR_DYNAMIC'><glossterm>USERADD_ERROR_DYNAMIC</glossterm> + <info> + USERADD_ERROR_DYNAMIC[doc] = "Forces the OpenEmbedded build system to produce an error if the user identification (uid) and group identification (gid) values are not defined in files/passwd and files/group files." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Forces the OpenEmbedded build system to produce an error if the user identification (<filename>uid</filename>) and group identification (<filename>gid</filename>) values @@ -10026,8 +12596,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-USERADD_GID_TABLES'><glossterm>USERADD_GID_TABLES</glossterm> + <info> + USERADD_GID_TABLES[doc] = "Specifies a password file to use for obtaining static group identification (gid) values when the OpenEmbedded build system adds a group to the system during package installation." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies a password file to use for obtaining static group identification (<filename>gid</filename>) values when the OpenEmbedded build system adds a group to the @@ -10057,41 +12630,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> - <glossentry id='var-USERADD_UID_TABLES'><glossterm>USERADD_UID_TABLES</glossterm> - <glossdef> - <para> - Specifies a password file to use for obtaining static - user identification (<filename>uid</filename>) values - when the OpenEmbedded build system adds a user to the - system during package installation. - </para> - - <para> - When applying static user identification - (<filename>uid</filename>) values, the OpenEmbedded build - system looks in - <link linkend='var-BBPATH'><filename>BBPATH</filename></link> - for a <filename>files/passwd</filename> file and then applies - those <filename>uid</filename> values. - Set the variable as follows in your - <filename>local.conf</filename> file: - <literallayout class='monospaced'> - USERADD_UID_TABLES = "files/passwd" - </literallayout> - </para> - - <note> - Setting the - <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link> - variable to "useradd-staticids" causes the build system - to use static <filename>uid</filename> values. - </note> - </glossdef> - </glossentry> - <glossentry id='var-USERADD_PACKAGES'><glossterm>USERADD_PACKAGES</glossterm> + <info> + USERADD_PACKAGES[doc] = "When a recipe inherits the useradd class, this variable specifies the individual packages within the recipe that require users and/or groups to be added." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-useradd'><filename>useradd</filename></link> class, this variable @@ -10123,8 +12667,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-USERADD_PARAM'><glossterm>USERADD_PARAM</glossterm> + <info> + USERADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the useradd command if you wish to add a user to the system when the package is installed." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When inheriting the <link linkend='ref-classes-useradd'><filename>useradd</filename></link> class, this variable @@ -10149,9 +12696,47 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> - <glossentry id='var-USERADDEXTENSION'><glossterm>USERADDEXTENSION</glossterm> + <glossentry id='var-USERADD_UID_TABLES'><glossterm>USERADD_UID_TABLES</glossterm> + <info> + USERADD_UID_TABLES[doc] = "Specifies a password file to use for obtaining static user identification (uid) values when the OpenEmbedded build system adds a user to the system during package installation." + </info> <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies a password file to use for obtaining static + user identification (<filename>uid</filename>) values + when the OpenEmbedded build system adds a user to the + system during package installation. + </para> + <para> + When applying static user identification + (<filename>uid</filename>) values, the OpenEmbedded build + system looks in + <link linkend='var-BBPATH'><filename>BBPATH</filename></link> + for a <filename>files/passwd</filename> file and then applies + those <filename>uid</filename> values. + Set the variable as follows in your + <filename>local.conf</filename> file: + <literallayout class='monospaced'> + USERADD_UID_TABLES = "files/passwd" + </literallayout> + </para> + + <note> + Setting the + <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link> + variable to "useradd-staticids" causes the build system + to use static <filename>uid</filename> values. + </note> + </glossdef> + </glossentry> + + <glossentry id='var-USERADDEXTENSION'><glossterm>USERADDEXTENSION</glossterm> + <info> + USERADDEXTENSION[doc] = "When set to "useradd-staticids", causes the OpenEmbedded build system to base all user and group additions on a static passwd and group files found in BBPATH." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> When set to "useradd-staticids", causes the OpenEmbedded build system to base all user and group additions on a static @@ -10202,8 +12787,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdiv id='var-glossary-w'><title>W</title> <glossentry id='var-WARN_QA'><glossterm>WARN_QA</glossterm> + <info> + WARN_QA[doc] = "Specifies the quality assurance checks whose failures are reported as warnings by the OpenEmbedded build system." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> Specifies the quality assurance checks whose failures are reported as warnings by the OpenEmbedded build system. You set this variable in your distribution configuration @@ -10217,8 +12805,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossentry> <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> + <info> + WORKDIR[doc] = "The pathname of the working directory in which the OpenEmbedded build system builds a recipe. This directory is located within the TMPDIR directory structure and changes as different packages are built." + </info> <glossdef> - <para> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> The pathname of the work directory in which the OpenEmbedded build system builds a recipe. This directory is located within the @@ -10272,8 +12863,32 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdiv> -<!-- <glossdiv id='var-glossary-x'><title>X</title>--> -<!-- </glossdiv>--> + <glossdiv id='var-glossary-x'><title>X</title> + + <glossentry id='var-XSERVER'><glossterm>XSERVER</glossterm> + <info> + XSERVER[doc] = "Specifies the packages that should be installed + to provide an X server and drivers for the current machine." + </info> + <glossdef> + <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> + Specifies the packages that should be installed to + provide an X server and drivers for the current machine, + assuming your image directly includes + <filename>packagegroup-core-x11-xserver</filename> or, + perhaps indirectly, includes "x11-base" in + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. + </para> + + <para> + The default value of <filename>XSERVER</filename>, if not + specified in the machine configuration, is + "xserver-xorg xf86-video-fbdev xf86-input-evdev". + </para> + </glossdef> + </glossentry> + + </glossdiv> <!-- <glossdiv id='var-glossary-y'><title>Y</title>--> <!-- </glossdiv>--> diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 6bb3381e72..2df36521c2 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml @@ -107,11 +107,8 @@ <para> BitBake also tries to execute any dependent tasks first. So for example, before building <filename>matchbox-desktop</filename>, BitBake - would build a cross compiler and <filename>eglibc</filename> if they had not already + would build a cross compiler and <filename>glibc</filename> if they had not already been built. - <note>This release of the Yocto Project does not support the <filename>glibc</filename> - GNU version of the Unix standard C library. By default, the OpenEmbedded build system - builds with <filename>eglibc</filename>.</note> </para> <para> @@ -228,7 +225,7 @@ The chain of events that occurs when <filename>gcc-cross</filename> is bootstrapped is as follows: <literallayout class='monospaced'> - gcc -> binutils-cross -> gcc-cross-initial -> linux-libc-headers -> eglibc-initial -> eglibc -> gcc-cross -> gcc-runtime + gcc -> binutils-cross -> gcc-cross-initial -> linux-libc-headers -> glibc-initial -> glibc -> gcc-cross -> gcc-runtime </literallayout> <itemizedlist> <listitem><para><filename>gcc</filename>: @@ -251,9 +248,9 @@ <listitem><para><filename>linux-libc-headers</filename>: Headers needed for the cross-compiler. </para></listitem> - <listitem><para><filename>eglibc-initial</filename>: + <listitem><para><filename>glibc-initial</filename>: An initial version of the Embedded GLIBC needed to bootstrap - <filename>eglibc</filename>. + <filename>glibc</filename>. </para></listitem> <listitem><para><filename>gcc-cross</filename>: The final stage of the bootstrap process for the @@ -305,7 +302,7 @@ Here is the bootstrap process for the relocatable toolchain: <literallayout class='monospaced'> gcc -> binutils-crosssdk -> gcc-crosssdk-initial -> linux-libc-headers -> - eglibc-initial -> nativesdk-eglibc -> gcc-crosssdk -> gcc-cross-canadian + glibc-initial -> nativesdk-glibc -> gcc-crosssdk -> gcc-cross-canadian </literallayout> <itemizedlist> <listitem><para><filename>gcc</filename>: @@ -328,11 +325,11 @@ <listitem><para><filename>linux-libc-headers</filename>: Headers needed for the cross-compiler. </para></listitem> - <listitem><para><filename>eglibc-initial</filename>: + <listitem><para><filename>glibc-initial</filename>: An initial version of the Embedded GLIBC needed to bootstrap - <filename>nativesdk-eglibc</filename>. + <filename>nativesdk-glibc</filename>. </para></listitem> - <listitem><para><filename>nativesdk-eglibc</filename>: + <listitem><para><filename>nativesdk-glibc</filename>: The Embedded GLIBC needed to bootstrap the <filename>gcc-crosssdk</filename>. </para></listitem> diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 1a211ca78a..a7bff18b01 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml @@ -283,12 +283,12 @@ <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink> for a look at all release-related issues. <itemizedlist> - <listitem><para><emphasis><filename>eglibc-initial</filename> fails to build</emphasis>: + <listitem><para><emphasis><filename>glibc-initial</filename> fails to build</emphasis>: If your development host system has the unpatched <filename>GNU Make 3.82</filename>, the <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task fails for <filename>eglibc-initial</filename> during + task fails for <filename>glibc-initial</filename> during the build.</para> <para>Typically, every distribution that ships <filename>GNU Make 3.82</filename> as @@ -564,19 +564,22 @@ <para> The history for each package contains a text file that has name-value pairs with information about the package. - For example, <filename>buildhistory/packages/core2-poky-linux/busybox/busybox/latest</filename> + For example, <filename>buildhistory/packages/i586-poky-linux/busybox/busybox/latest</filename> contains the following: <literallayout class='monospaced'> - PV = 1.19.3 - PR = r3 - RDEPENDS = update-rc.d eglibc (>= 2.13) - RRECOMMENDS = busybox-syslog busybox-udhcpc - PKGSIZE = 564701 - FILES = /usr/bin/* /usr/sbin/* /usr/libexec/* /usr/lib/lib*.so.* \ - /etc /com /var /bin/* /sbin/* /lib/*.so.* /usr/share/busybox \ - /usr/lib/busybox/* /usr/share/pixmaps /usr/share/applications \ - /usr/share/idl /usr/share/omf /usr/share/sounds /usr/lib/bonobo/servers - FILELIST = /etc/busybox.links /etc/init.d/hwclock.sh /bin/busybox /bin/sh + PV = 1.22.1 + PR = r32 + RPROVIDES = + RDEPENDS = glibc (>= 2.20) update-alternatives-opkg + RRECOMMENDS = busybox-syslog busybox-udhcpc update-rc.d + PKGSIZE = 540168 + FILES = /usr/bin/* /usr/sbin/* /usr/lib/busybox/* /usr/lib/lib*.so.* \ + /etc /com /var /bin/* /sbin/* /lib/*.so.* /lib/udev/rules.d \ + /usr/lib/udev/rules.d /usr/share/busybox /usr/lib/busybox/* \ + /usr/share/pixmaps /usr/share/applications /usr/share/idl \ + /usr/share/omf /usr/share/sounds /usr/lib/bonobo/servers + FILELIST = /bin/busybox /bin/busybox.nosuid /bin/busybox.suid /bin/sh \ + /etc/busybox.links.nosuid /etc/busybox.links.suid </literallayout> Most of these name-value pairs correspond to variables used to produce the package. @@ -589,15 +592,16 @@ <para> There is also a file corresponding to the recipe from which the package came (e.g. - <filename>buildhistory/packages/core2-poky-linux/busybox/latest</filename>): + <filename>buildhistory/packages/i586-poky-linux/busybox/latest</filename>): <literallayout class='monospaced'> - PV = 1.19.3 - PR = r3 - DEPENDS = virtual/i586-poky-linux-gcc virtual/i586-poky-linux-compilerlibs \ - virtual/libc update-rc.d-native - PACKAGES = busybox-httpd busybox-udhcpd busybox-udhcpc busybox-syslog \ - busybox-mdev busybox-dbg busybox busybox-doc busybox-dev \ - busybox-staticdev busybox-locale + PV = 1.22.1 + PR = r32 + DEPENDS = initscripts kern-tools-native update-rc.d-native \ + virtual/i586-poky-linux-compilerlibs virtual/i586-poky-linux-gcc \ + virtual/libc virtual/update-alternatives + PACKAGES = busybox-ptest busybox-httpd busybox-udhcpd busybox-udhcpc \ + busybox-syslog busybox-mdev busybox-hwclock busybox-dbg \ + busybox-staticdev busybox-dev busybox-doc busybox-locale busybox </literallayout> </para> @@ -611,31 +615,44 @@ is set to <filename>${<link linkend='var-AUTOREV'>AUTOREV</link>}</filename>. Here is an example assuming - <filename>buildhistory/packages/emenlow-poky-linux/linux-yocto/latest_srcrev</filename>): + <filename>buildhistory/packages/qemux86-poky-linux/linux-yocto/latest_srcrev</filename>): <literallayout class='monospaced'> - # SRCREV_machine = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf" - SRCREV_machine = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf" - # SRCREV_emgd = "caea08c988e0f41103bbe18eafca20348f95da02" - SRCREV_emgd = "caea08c988e0f41103bbe18eafca20348f95da02" - # SRCREV_meta = "c2ed0f16fdec628242a682897d5d86df4547cf24" - SRCREV_meta = "c2ed0f16fdec628242a682897d5d86df4547cf24" + # SRCREV_machine = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" + SRCREV_machine = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" + # SRCREV_meta = "a227f20eff056e511d504b2e490f3774ab260d6f" + SRCREV_meta = "a227f20eff056e511d504b2e490f3774ab260d6f" </literallayout> You can use the <filename>buildhistory-collect-srcrevs</filename> - command to collect the stored <filename>SRCREV</filename> values - from build history and report them in a format suitable for use in - global configuration (e.g., <filename>local.conf</filename> - or a distro include file) to override floating - <filename>AUTOREV</filename> values to a fixed set of revisions. + command with the <filename>-a</filename> option to + collect the stored <filename>SRCREV</filename> values + from build history and report them in a format suitable for + use in global configuration (e.g., + <filename>local.conf</filename> or a distro include file) to + override floating <filename>AUTOREV</filename> values to a + fixed set of revisions. Here is some example output from this command: <literallayout class='monospaced'> - # emenlow-poky-linux - SRCREV_machine_pn-linux-yocto = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf" - SRCREV_emgd_pn-linux-yocto = "caea08c988e0f41103bbe18eafca20348f95da02" - SRCREV_meta_pn-linux-yocto = "c2ed0f16fdec628242a682897d5d86df4547cf24" - # core2-poky-linux - SRCREV_pn-kmod = "62081c0f68905b22f375156d4532fd37fa5c8d33" - SRCREV_pn-blktrace = "d6918c8832793b4205ed3bfede78c2f915c23385" - SRCREV_pn-opkg = "649" + $ buildhistory-collect-srcrevs -a + # i586-poky-linux + SRCREV_pn-glibc = "b8079dd0d360648e4e8de48656c5c38972621072" + SRCREV_pn-glibc-initial = "b8079dd0d360648e4e8de48656c5c38972621072" + SRCREV_pn-opkg-utils = "53274f087565fd45d8452c5367997ba6a682a37a" + SRCREV_pn-kmod = "fd56638aed3fe147015bfa10ed4a5f7491303cb4" + # x86_64-linux + SRCREV_pn-gtk-doc-stub-native = "1dea266593edb766d6d898c79451ef193eb17cfa" + SRCREV_pn-dtc-native = "65cc4d2748a2c2e6f27f1cf39e07a5dbabd80ebf" + SRCREV_pn-update-rc.d-native = "eca680ddf28d024954895f59a241a622dd575c11" + SRCREV_glibc_pn-cross-localedef-native = "b8079dd0d360648e4e8de48656c5c38972621072" + SRCREV_localedef_pn-cross-localedef-native = "c833367348d39dad7ba018990bfdaffaec8e9ed3" + SRCREV_pn-prelink-native = "faa069deec99bf61418d0bab831c83d7c1b797ca" + SRCREV_pn-opkg-utils-native = "53274f087565fd45d8452c5367997ba6a682a37a" + SRCREV_pn-kern-tools-native = "23345b8846fe4bd167efdf1bd8a1224b2ba9a5ff" + SRCREV_pn-kmod-native = "fd56638aed3fe147015bfa10ed4a5f7491303cb4" + # qemux86-poky-linux + SRCREV_machine_pn-linux-yocto = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" + SRCREV_meta_pn-linux-yocto = "a227f20eff056e511d504b2e490f3774ab260d6f" + # all-poky-linux + SRCREV_pn-update-rc.d = "eca680ddf28d024954895f59a241a622dd575c11" </literallayout> <note> Here are some notes on using the @@ -660,7 +677,7 @@ However, the script does place a comment before each set of values that specifies which triplet to which they belong as shown above - (e.g., <filename>emenlow-poky-linux</filename>). + (e.g., <filename>i586-poky-linux</filename>). </para></listitem> </itemizedlist> </note> @@ -717,17 +734,21 @@ Here is an example of <filename>image-info.txt</filename>: <literallayout class='monospaced'> DISTRO = poky - DISTRO_VERSION = 1.1+snapshot-20120207 - USER_CLASSES = image-mklibs image-prelink + DISTRO_VERSION = 1.7 + USER_CLASSES = buildstats image-mklibs image-prelink IMAGE_CLASSES = image_types - IMAGE_FEATURES = debug-tweaks x11-base apps-x11-core \ - package-management ssh-server-dropbear package-management - IMAGE_LINGUAS = en-us en-gb - IMAGE_INSTALL = packagegroup-core-boot packagegroup-base-extended + IMAGE_FEATURES = debug-tweaks + IMAGE_LINGUAS = + IMAGE_INSTALL = packagegroup-core-boot run-postinsts BAD_RECOMMENDATIONS = - ROOTFS_POSTPROCESS_COMMAND = buildhistory_get_image_installed ; rootfs_update_timestamp ; - IMAGE_POSTPROCESS_COMMAND = buildhistory_get_imageinfo ; - IMAGESIZE = 171816 + NO_RECOMMENDATIONS = + PACKAGE_EXCLUDE = + ROOTFS_POSTPROCESS_COMMAND = write_package_manifest; license_create_manifest; \ + write_image_manifest ; buildhistory_list_installed_image ; \ + buildhistory_get_image_installed ; ssh_allow_empty_password; \ + postinst_enable_logging; rootfs_update_timestamp ; ssh_disable_dns_lookup ; + IMAGE_POSTPROCESS_COMMAND = buildhistory_get_imageinfo ; + IMAGESIZE = 6900 </literallayout> Other than <filename>IMAGESIZE</filename>, which is the total size of the files in the image in Kbytes, the @@ -811,7 +832,7 @@ <literallayout class='monospaced'> DISTRO = poky DISTRO_VERSION = 1.3+snapshot-20130327 - SDK_NAME = poky-eglibc-i686-arm + SDK_NAME = poky-glibc-i686-arm SDK_VERSION = 1.3+snapshot SDKMACHINE = SDKIMAGE_FEATURES = dev-pkgs dbg-pkgs @@ -858,12 +879,12 @@ Here is an example: <literallayout class='monospaced'> $ ~/poky/poky/scripts/buildhistory-diff . HEAD^ - Changes to images/qemux86_64/eglibc/core-image-minimal (files-in-image.txt): + Changes to images/qemux86_64/glibc/core-image-minimal (files-in-image.txt): /etc/anotherpkg.conf was added /sbin/anotherpkg was added * (installed-package-names.txt): * anotherpkg was added - Changes to images/qemux86_64/eglibc/core-image-minimal (installed-package-names.txt): + Changes to images/qemux86_64/glibc/core-image-minimal (installed-package-names.txt): anotherpkg was added packages/qemux86_64-poky-linux/v86d: PACKAGES: added "v86d-extras" * PR changed from "r0" to "r1" @@ -888,6 +909,149 @@ </section> </section> +<section id='speeding-up-the-build'> + <title>Speeding Up the Build</title> + + <para> + Build time can be an issue. + By default, the build system uses three simple controls to try and + maximize build efficiency: + <itemizedlist> + <listitem><para> + <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> + </para></listitem> + <listitem><para> + <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> + </para></listitem> + <listitem><para> + <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> + </para></listitem> + </itemizedlist> + These three variables all scale to the number of processor cores + available on the build system. + This auto-scaling ensures that the build system fundamentally takes + advantage of potential parallel operations during the build + based on the build machine's capabilities. + </para> + + <para> + If you need to achieve even faster builds than what the build system + produces by default, you can consider and implement some of the + following: + <itemizedlist> + <listitem><para> + <filename>BB_NUMBER_THREADS</filename>, + <filename>BB_NUMBER_PARSE_THREADS</filename>, and + <filename>PARALLEL_MAKE</filename>: + As previously mentioned, the build system scales the values + for these variables so you should probably not override + these to try to speed up a build. + However, for completeness regarding this list, it is worth + mentioning that you can manually override these variables + by setting them in your <filename>local.conf</filename> file. + </para></listitem> + <listitem><para> + File system type: + The file system type that the build is being performed on can + also influence performance. + Using <filename>ext4</filename> is recommended as compared + to <filename>ext2</filename> and <filename>ext3</filename> + due to <filename>ext4</filename> improved features + such as extents. + </para></listitem> + <listitem><para> + Disabling the updating of access time using + <filename>noatime</filename>: + The <filename>noatime</filename> mount option prevents the + build system from updating file and directory access times. + </para></listitem> + <listitem><para> + Setting a longer commit: + Using the "commit=" mount option increases the interval + in seconds between disk cache writes. + Changing this interval from the five second default to + something longer increases the risk of data loss but decreases + the need to write to the disk, thus increasing the build + performance. + </para></listitem> + <listitem><para> + Choosing the packaging backend: + Of the available packaging backends, IPK is the fastest. + Additionally, selecting a singular packaging backend also + helps. + </para></listitem> + <listitem><para> + Using <filename>/tmp</filename> as a temporary file system: + While this can help speed up the build, the benefits are + limited due to the compiler using + <filename>-pipe</filename>. + The build system goes to some lengths to avoid + <filename>sync()</filename> calls into the + file system on the principle that if there was a significant + failure, the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + contents could easily be rebuilt. + </para></listitem> + <listitem><para> + Inheriting the + <link linkend='ref-classes-rm-work'><filename>rm_work</filename></link> + class: + Inheriting this class has shown to speed up builds due to + significantly lower amounts of data stored in the data + cache as well as on disk. + Inheriting this class also makes cleanup of + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + faster, at the expense of being easily able to dive into the + source code. + File system maintainers have recommended that the fastest way + to clean up large numbers of files is to reformat partitions + rather than delete files due to the linear nature of partitions. + This, of course, assumes you structure the disk partitions and + file systems in a way that this is practical. + </para></listitem> + </itemizedlist> + Aside from the previous list, you should keep some trade offs in + mind that can help you speed up the build: + <itemizedlist> + <listitem><para> + Exclude debug symbols and other debug information: + If you do not need these symbols and other debug information, + disabling the <filename>*-dbg</filename> package generation + can speed up the build. + You can disable this generation by setting the + <link linkend='var-INHIBIT_PACKAGE_DEBUG_SPLIT'><filename>INHIBIT_PACKAGE_DEBUG_SPLIT</filename></link> + variable to "1". + </para></listitem> + <listitem><para> + Disable static library generation for recipes derived from + <filename>autoconf</filename> or <filename>libtool</filename>: + Following is an example showing how to disable static + libraries and still provide an override to handle exceptions: + <literallayout class='monospaced'> + STATICLIBCONF = "--disable-static" + STATICLIBCONF_sqlite3-native = "" + EXTRA_OECONF += "${STATICLIBCONF}" + </literallayout> + <note><title>Notes</title> + <itemizedlist> + <listitem><para> + Some recipes need static libraries in order to work + correctly (e.g. <filename>pseudo-native</filename> + needs <filename>sqlite3-native</filename>). + Overrides, as in the previous example, account for + these kinds of exceptions. + </para></listitem> + <listitem><para> + Some packages have packaging code that assumes the + presence of the static libraries. + If so, you might need to exclude them as well. + </para></listitem> + </itemizedlist> + </note> + </para></listitem> + </itemizedlist> + </para> +</section> </chapter> <!-- vim: expandtab tw=80 ts=4 |
