summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-02-09 14:52:33 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-02-17 15:16:59 +0000
commit8e8d9615273632102c16230e5dbf8fdc93d77127 (patch)
tree1680bdb869ae092f473d9c298c397da34f7e61dd /documentation/ref-manual/ref-variables.xml
parent21fcd57042ef82d570f7cd74ef224e5b46a9f15d (diff)
downloadpoky-8e8d9615273632102c16230e5dbf8fdc93d77127.tar.gz
ref-manual: Updated the following variables based on review comments:
ASSUME_SHLIBS BBINCLUDELOGS_LINES BUILD_ARCH BUILD_OS CACHE DATE PACKAGE_INSTALL_ATTEMPTONLY PRIORITY SOURCE_MIRROR_FETCH TARGET_PREFIX TARGET_SYS TIME CROSS_COMPILE (From yocto-docs rev: c55ab3cb5ef9d517ea5f29d2be8999cc1dc7e085) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml179
1 files changed, 151 insertions, 28 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 1d0feb9463..2ac4a0acda 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -309,16 +309,27 @@
309 309
310 <glossentry id='var-ASSUME_SHLIBS'><glossterm><imagedata fileref="figures/define-generic.png" />ASSUME_SHLIBS</glossterm> 310 <glossentry id='var-ASSUME_SHLIBS'><glossterm><imagedata fileref="figures/define-generic.png" />ASSUME_SHLIBS</glossterm>
311 <info> 311 <info>
312 ASSUME_SHLIBS[doc] = "List of shlib:package[_version] mappings. Useful for lib packages in ASSUME_PROVIDED, for which automatic shlib dependency tracking does not work." 312 ASSUME_SHLIBS[doc] = Provides additional shlibs provider mapping information, which adds to or overwrites the information provided automatically by the system."
313 </info> 313 </info>
314 <glossdef> 314 <glossdef>
315 <para> 315 <para>
316 List of <filename>shlib:package[_version]</filename> 316 Provides additional <filename>shlibs</filename> provider
317 mappings. 317 mapping information, which adds to or overwrites the
318 This variable is useful for library packages in 318 information provided automatically by the system.
319 <link linkend='var-ASSUME_PROVIDED'><filename>ASSUME_PROVIDED</filename></link>, 319 </para>
320 for which automatic <filename>shlib</filename> dependency 320
321 tracking does not work. 321 <para>
322 As an example, use the following form to add an
323 <filename>shlib</filename> provider of
324 <replaceable>shlibname</replaceable> in
325 <replaceable>packagename</replaceable> with the optional
326 <replaceable>version</replaceable>:
327 <literallayout class='monospaced'>
328 <replaceable>shlibname:packagename</replaceable>[_<replaceable>version</replaceable>]
329 </literallayout>
330 <note>
331 Separate multiple entries using spaces.
332 </note>
322 </para> 333 </para>
323 </glossdef> 334 </glossdef>
324 </glossentry> 335 </glossentry>
@@ -902,8 +913,12 @@ meta/conf/machine/include/<architecture>/arch-<architecture>.inc
902 </info> 913 </info>
903 <glossdef> 914 <glossdef>
904 <para> 915 <para>
905 The number of log lines the OpenEmbedded build system 916 If
906 prints upon failure. 917 <link linkend='var-BBINCLUDELOGS'><filename>BBINCLUDELOGS</filename></link>
918 is set, specifies the maximum number of lines from the
919 task log file to print when reporting a failed task.
920 If you do not set <filename>BBINCLUDELOGS_LINES</filename>,
921 the entire log is printed.
907 </para> 922 </para>
908 </glossdef> 923 </glossdef>
909 </glossentry> 924 </glossentry>
@@ -1198,6 +1213,9 @@ meta/conf/machine/include/<architecture>/arch-<architecture>.inc
1198 <para> 1213 <para>
1199 Specifies the architecture of the build system 1214 Specifies the architecture of the build system
1200 (e.g. <filename>i686</filename>). 1215 (e.g. <filename>i686</filename>).
1216 The <filename>uname</filename> command, as reported by the
1217 machine name, sets the value of
1218 <filename>BUILD_ARCH</filename>.
1201 </para> 1219 </para>
1202 </glossdef> 1220 </glossdef>
1203 </glossentry> 1221 </glossentry>
@@ -1293,7 +1311,12 @@ meta/conf/machine/include/<architecture>/arch-<architecture>.inc
1293 <glossdef> 1311 <glossdef>
1294 <para> 1312 <para>
1295 Specifies the operating system in use on the build 1313 Specifies the operating system in use on the build
1296 system (e.g. Linux). 1314 host (e.g. Linux).
1315 The operating system, as reported by the
1316 <filename>uname</filename> command, sets
1317 <filename>BUILD_OS</filename>.
1318 When set, the first word of the value converts to
1319 lower-case characters.
1297 </para> 1320 </para>
1298 </glossdef> 1321 </glossdef>
1299 </glossentry> 1322 </glossentry>
@@ -1628,11 +1651,15 @@ meta/conf/machine/include/<architecture>/arch-<architecture>.inc
1628 1651
1629 <glossentry id='var-CACHE'><glossterm><imagedata fileref="figures/define-generic.png" />CACHE</glossterm> 1652 <glossentry id='var-CACHE'><glossterm><imagedata fileref="figures/define-generic.png" />CACHE</glossterm>
1630 <info> 1653 <info>
1631 CACHE[doc] = "The directory holding the cache of the metadata." 1654 CACHE[doc] = "The directory BitBake uses to store a cache of the metadata."
1632 </info> 1655 </info>
1633 <glossdef> 1656 <glossdef>
1634 <para> 1657 <para>
1635 The directory that contains the cache for the Metadata. 1658 Specifies the directory BitBake uses to store a cache
1659 of the
1660 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
1661 so it does not need to be parsed every time BitBake is
1662 started.
1636 </para> 1663 </para>
1637 </glossdef> 1664 </glossdef>
1638 </glossentry> 1665 </glossentry>
@@ -2126,6 +2153,12 @@ meta/conf/machine/include/<architecture>/arch-<architecture>.inc
2126 same as the 2153 same as the
2127 <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link> 2154 <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link>
2128 variable. 2155 variable.
2156 <note>
2157 The OpenEmbedded build system sets the
2158 <filename>CROSS_COMPILE</filename> variable only in
2159 certain contexts (e.g. when building for kernel
2160 and kernel module recipes).
2161 </note>
2129 </para> 2162 </para>
2130 </glossdef> 2163 </glossdef>
2131 </glossentry> 2164 </glossentry>
@@ -2219,7 +2252,8 @@ meta/conf/machine/include/<architecture>/arch-<architecture>.inc
2219 <glossdef> 2252 <glossdef>
2220 <para> 2253 <para>
2221 The date the build was started. 2254 The date the build was started.
2222 Dates appear using the year, month, and day (YMD) format. 2255 Dates appear using the year, month, and day (YMD) format
2256 (e.g. "20150209" for February 9th and 2015).
2223 </para> 2257 </para>
2224 </glossdef> 2258 </glossdef>
2225 </glossentry> 2259 </glossentry>
@@ -4079,13 +4113,23 @@ meta/conf/machine/include/<architecture>/arch-<architecture>.inc
4079 Specifies the system, including the architecture and the 4113 Specifies the system, including the architecture and the
4080 operating system, for which the build is occurring 4114 operating system, for which the build is occurring
4081 in the context of the current recipe. 4115 in the context of the current recipe.
4116 </para>
4117
4118 <para>
4082 The OpenEmbedded build system automatically sets this 4119 The OpenEmbedded build system automatically sets this
4083 variable. 4120 variable based on
4084 You do not need to set the variable yourself. 4121 <link linkend='var-HOST_ARCH'><filename>HOST_ARCH</filename></link>,
4122 <link linkend='var-HOST_VENDOR'><filename>HOST_VENDOR</filename></link>,
4123 and
4124 <link linkend='var-HOST_OS'><filename>HOST_OS</filename></link>
4125 variables.
4126 <note>
4127 You do not need to set the variable yourself.
4128 </note>
4085 </para> 4129 </para>
4086 4130
4087 <para> 4131 <para>
4088 Here are two examples: 4132 Consider these two examples:
4089 <itemizedlist> 4133 <itemizedlist>
4090 <listitem><para>Given a native recipe on a 32-bit 4134 <listitem><para>Given a native recipe on a 32-bit
4091 x86 machine running Linux, the value is 4135 x86 machine running Linux, the value is
@@ -7472,12 +7516,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7472 7516
7473 <glossentry id='var-PACKAGE_INSTALL_ATTEMPTONLY'><glossterm><imagedata fileref="figures/define-generic.png" />PACKAGE_INSTALL_ATTEMPTONLY</glossterm> 7517 <glossentry id='var-PACKAGE_INSTALL_ATTEMPTONLY'><glossterm><imagedata fileref="figures/define-generic.png" />PACKAGE_INSTALL_ATTEMPTONLY</glossterm>
7474 <info> 7518 <info>
7475 PACKAGE_INSTALL_ATTEMPTONLY[doc] = "List of packages attempted to be installed. If a listed package fails to install, the build system does not generate an error. This variable is generally not user-defined." 7519 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."
7476 </info> 7520 </info>
7477 <glossdef> 7521 <glossdef>
7478 <para> 7522 <para>
7479 Specifies a list of packages the OpenEmbedded build 7523 Specifies a list of packages the OpenEmbedded build
7480 system attempts to install. 7524 system attempts to install when creating an image.
7481 If a listed package fails to install, the build system 7525 If a listed package fails to install, the build system
7482 does not generate an error. 7526 does not generate an error.
7483 This variable is generally not user-defined. 7527 This variable is generally not user-defined.
@@ -8250,10 +8294,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8250 8294
8251 <para> 8295 <para>
8252 Indicates the importance of a package. 8296 Indicates the importance of a package.
8297 </para>
8298
8299 <para>
8300 <filename>PRIORITY</filename> is considered to be part of
8301 the distribution policy because the importance of any given
8302 recipe depends on the purpose for which the distribution
8303 is being produced.
8304 Thus, <filename>PRIORITY</filename> is not normally set
8305 within recipes.
8306 </para>
8307
8308 <para>
8253 You can set <filename>PRIORITY</filename> to "required", 8309 You can set <filename>PRIORITY</filename> to "required",
8254 "standard", "extra", and "optional", which is the default. 8310 "standard", "extra", and "optional", which is the default.
8255 </para> 8311 </para>
8256-->
8257 </glossdef> 8312 </glossdef>
8258 </glossentry> 8313 </glossentry>
8259 8314
@@ -9535,12 +9590,27 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9535 </info> 9590 </info>
9536 <glossdef> 9591 <glossdef>
9537 <para> 9592 <para>
9538 Setting this variable within a source mirror generation 9593 When you are creating a source mirror, setting
9539 script causes the OpenEmbedded build system to skip 9594 <filename>SOURCE_MIRROR_FETCH</filename> to "1" in your
9540 <link linkend='var-COMPATIBLE_MACHINE'><filename>COMPATIBLE_MACHINE</filename></link> 9595 <filename>local.conf</filename> configuration file ensures
9541 and 9596 the source for all recipes are fetched regardless of
9542 <link linkend='var-COMPATIBLE_HOST'><filename>COMPATIBLE_HOST</filename></link> 9597 whether or not source is marked for exclusion.
9543 checks. 9598 <note>
9599 When source files are incompatible with the currently
9600 configured
9601 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
9602 via the
9603 <link linkend='var-COMPATIBLE_MACHINE'><filename>COMPATIBLE_MACHINE</filename></link>
9604 variable and via the
9605 <link linkend='var-COMPATIBLE_HOST'><filename>COMPATIBLE_HOST</filename></link>
9606 variable, they are marked for exclusion.
9607 </note>
9608
9609 <note><title>Warning</title>
9610 Do not set the
9611 <filename>SOURCE_MIRROR_FETCH</filename> variable
9612 during a normal build.
9613 </note>
9544 </para> 9614 </para>
9545 </glossdef> 9615 </glossdef>
9546 </glossentry> 9616 </glossentry>
@@ -10783,6 +10853,29 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10783 <para> 10853 <para>
10784 The toolchain binary prefix for the target tools. 10854 The toolchain binary prefix for the target tools.
10785 </para> 10855 </para>
10856
10857 <para>
10858 Depending on what you are building your image for, the
10859 OpenEmbedded build system sets
10860 <filename>TARGET_PREFIX</filename> as follows:
10861 <itemizedlist>
10862 <listitem><para>
10863 For targets, which is the default, the build
10864 system sets the variable to
10865 "${<link linkend='var-TARGET_SYS'>TARGET_SYS</link>}-".
10866 </para></listitem>
10867 <listitem><para>
10868 For a <filename>native</filename> recipe, the build
10869 system sets the variable to the value of
10870 <filename>BUILD_PREFIX</filename>.
10871 </para></listitem>
10872 <listitem><para>
10873 For a <filename>nativesdk</filename> recipe, the
10874 build system sets the variable to the value of
10875 <filename>SDK_PREFIX</filename>.
10876 </para></listitem>
10877 </itemizedlist>
10878 </para>
10786 </glossdef> 10879 </glossdef>
10787 </glossentry> 10880 </glossentry>
10788 10881
@@ -10792,11 +10885,39 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10792 </info> 10885 </info>
10793 <glossdef> 10886 <glossdef>
10794 <para> 10887 <para>
10795 The target system, which is comprised of 10888 Specifies the system, including the architecture and the
10889 operating system, for which the build is occurring in
10890 the context of the current recipe.
10891 </para>
10892
10893 <para>
10894 The OpenEmbedded build system automatically sets this
10895 variable based on
10796 <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>, 10896 <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>,
10797 <link linkend='var-TARGET_VENDOR'><filename>TARGET_VENDOR</filename></link>, 10897 <link linkend='var-TARGET_VENDOR'><filename>TARGET_VENDOR</filename></link>,
10798 and 10898 and
10799 <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link>. 10899 <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link>
10900 variables.
10901 <note>
10902 You do not need to set the
10903 <filename>TARGET_SYS</filename> variable yourself.
10904 </note>
10905 </para>
10906
10907 <para>
10908 Consider these two examples:
10909 <itemizedlist>
10910 <listitem><para>
10911 Given a <filename>native</filename> recipe on a
10912 32-bit, x86 machine running Linux, the value is
10913 "i686-linux".
10914 </para></listitem>
10915 <listitem><para>
10916 Given a recipe being built for a little-endian,
10917 MIPS target running Linux, the value might be
10918 "mipsel-linux".
10919 </para></listitem>
10920 </itemizedlist>
10800 </para> 10921 </para>
10801 </glossdef> 10922 </glossdef>
10802 </glossentry> 10923 </glossentry>
@@ -11307,7 +11428,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
11307 <glossdef> 11428 <glossdef>
11308 <para> 11429 <para>
11309 The time the build was started. 11430 The time the build was started.
11310 Times appear using the hour, minute, and second (HMS) format. 11431 Times appear using the hour, minute, and second (HMS)
11432 format (e.g. "140159" for one minute and fifty-nine
11433 seconds past 1400 hours).
11311 </para> 11434 </para>
11312 </glossdef> 11435 </glossdef>
11313 </glossentry> 11436 </glossentry>