summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-05-13 10:44:45 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-05-22 17:23:41 +0100
commitb47c993ca0f585dd677427bee6e6274b2b41b6e3 (patch)
treed170b8736ed6db69ff8c92cbb5a94f3905cfaa5f /documentation/ref-manual
parent97c48dbc6c78c8f4cee9ccd276be6926560bf504 (diff)
downloadpoky-b47c993ca0f585dd677427bee6e6274b2b41b6e3.tar.gz
ref-manual: Added more detail to note for FILESEXTRAPATHS use.
Some discussion about this variable indicated that the importance of the immediate expansion operator was not being called out enough. I added further information to the existing note that states to be sure to use ":=" when using the variable. (From yocto-docs rev: b97d3fa714a7c71356cd00548d3d01280034afc2) 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')
-rw-r--r--documentation/ref-manual/ref-variables.xml309
1 files changed, 159 insertions, 150 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index ac4686f4da..778587f7d2 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -600,31 +600,31 @@ Core layer for images cannot be removed
600 600
601 <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm> 601 <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm>
602 <glossdef> 602 <glossdef>
603 <para>A regular expression that resolves to one or more hosts 603 <para>A regular expression that resolves to one or more hosts
604 (when the recipe is native) or one or more targets (when 604 (when the recipe is native) or one or more targets (when
605 the recipe is non-native) with which a recipe is compatible. 605 the recipe is non-native) with which a recipe is compatible.
606 The regular expression is matched against 606 The regular expression is matched against
607 <link linkend="var-HOST_SYS"><filename>HOST_SYS</filename></link>. 607 <link linkend="var-HOST_SYS"><filename>HOST_SYS</filename></link>.
608 You can use the variable to stop recipes from being built 608 You can use the variable to stop recipes from being built
609 for classes of systems with which the recipes are not 609 for classes of systems with which the recipes are not
610 compatible. 610 compatible.
611 Stopping these builds is particularly useful with kernels. 611 Stopping these builds is particularly useful with kernels.
612 The variable also helps to increase parsing speed 612 The variable also helps to increase parsing speed
613 since the build system skips parsing recipes not 613 since the build system skips parsing recipes not
614 compatible with the current system.</para> 614 compatible with the current system.</para>
615 </glossdef> 615 </glossdef>
616 </glossentry> 616 </glossentry>
617 617
618 <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> 618 <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm>
619 <glossdef> 619 <glossdef>
620 <para>A regular expression that resolves to one or more 620 <para>A regular expression that resolves to one or more
621 target machines with which a recipe is compatible. 621 target machines with which a recipe is compatible.
622 The regular expression is matched against 622 The regular expression is matched against
623 <link linkend="var-MACHINEOVERRIDES"><filename>MACHINEOVERRIDES</filename></link>. 623 <link linkend="var-MACHINEOVERRIDES"><filename>MACHINEOVERRIDES</filename></link>.
624 You can use the variable to stop recipes from being built 624 You can use the variable to stop recipes from being built
625 for machines with which the recipes are not compatible. 625 for machines with which the recipes are not compatible.
626 Stopping these builds is particularly useful with kernels. 626 Stopping these builds is particularly useful with kernels.
627 The variable also helps to increase parsing speed 627 The variable also helps to increase parsing speed
628 since the build system skips parsing recipes not 628 since the build system skips parsing recipes not
629 compatible with the current machine.</para> 629 compatible with the current machine.</para>
630 </glossdef> 630 </glossdef>
@@ -746,8 +746,8 @@ Core layer for images cannot be removed
746 Specifies a weak bias for recipe selection priority. 746 Specifies a weak bias for recipe selection priority.
747 </para> 747 </para>
748 <para> 748 <para>
749 The most common usage of this is variable is to set 749 The most common usage of this is variable is to set
750 it to "-1" within a recipe for a development version of a 750 it to "-1" within a recipe for a development version of a
751 piece of software. 751 piece of software.
752 Using the variable in this way causes the stable version 752 Using the variable in this way causes the stable version
753 of the recipe to build by default in the absence of 753 of the recipe to build by default in the absence of
@@ -755,10 +755,10 @@ Core layer for images cannot be removed
755 being used to build the development version. 755 being used to build the development version.
756 </para> 756 </para>
757 <note> 757 <note>
758 The bias provided by <filename>DEFAULT_PREFERENCE</filename> 758 The bias provided by <filename>DEFAULT_PREFERENCE</filename>
759 is weak and is overridden by 759 is weak and is overridden by
760 <filename><link linkend='var-BBFILE_PRIORITY'>BBFILE_PRIORITY</link></filename> 760 <filename><link linkend='var-BBFILE_PRIORITY'>BBFILE_PRIORITY</link></filename>
761 if the that variable is different between two layers 761 if the that variable is different between two layers
762 that contain different versions of the same recipe. 762 that contain different versions of the same recipe.
763 </note> 763 </note>
764 </glossdef> 764 </glossdef>
@@ -909,12 +909,12 @@ Core layer for images cannot be removed
909 <glossentry id='var-DISTROOVERRIDES'><glossterm>DISTROOVERRIDES</glossterm> 909 <glossentry id='var-DISTROOVERRIDES'><glossterm>DISTROOVERRIDES</glossterm>
910 <glossdef> 910 <glossdef>
911 <para> 911 <para>
912 This variable lists overrides specific to the current 912 This variable lists overrides specific to the current
913 distribution. 913 distribution.
914 By default, the variable list includes the value of the 914 By default, the variable list includes the value of the
915 <filename><link linkend='var-DISTRO'>DISTRO</link></filename> 915 <filename><link linkend='var-DISTRO'>DISTRO</link></filename>
916 variable. 916 variable.
917 You can extend the variable to apply any variable overrides 917 You can extend the variable to apply any variable overrides
918 you want as part of the distribution and are not 918 you want as part of the distribution and are not
919 already in <filename>OVERRIDES</filename> through 919 already in <filename>OVERRIDES</filename> through
920 some other means. 920 some other means.
@@ -1158,16 +1158,16 @@ Core layer for images cannot be removed
1158 Extends the search path the OpenEmbedded build system uses 1158 Extends the search path the OpenEmbedded build system uses
1159 when looking for files and patches as it processes recipes 1159 when looking for files and patches as it processes recipes
1160 and append files. 1160 and append files.
1161 The directories BitBake uses when it processes recipes 1161 The directories BitBake uses when it processes recipes
1162 are defined by the 1162 are defined by the
1163 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> 1163 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
1164 variable, and can be extended using 1164 variable, and can be extended using
1165 <filename>FILESEXTRAPATHS</filename>. 1165 <filename>FILESEXTRAPATHS</filename>.
1166 </para> 1166 </para>
1167 1167
1168 <para> 1168 <para>
1169 Best practices dictate that you accomplish this by using the 1169 Best practices dictate that you accomplish this by using the
1170 variable from within a <filename>.bbappend</filename> file 1170 variable from within a <filename>.bbappend</filename> file
1171 and that you prepend paths as follows: 1171 and that you prepend paths as follows:
1172 <literallayout class='monospaced'> 1172 <literallayout class='monospaced'>
1173 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 1173 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
@@ -1175,13 +1175,27 @@ Core layer for images cannot be removed
1175 In the above example, the build system looks for files in 1175 In the above example, the build system looks for files in
1176 a directory that has the same name as the corresponding 1176 a directory that has the same name as the corresponding
1177 append file. 1177 append file.
1178 <note>
1179 When using the <filename>FILESEXTRAPATHS</filename>,
1180 be sure to use the immediate expansion
1181 (<filename>:=</filename>) operator and include
1182 the trailing separating colon character.
1183 Immediate expansion makes sure that BitBake evaluates
1184 <filename>THISDIR</filename> at the time the directive
1185 is encountered rather than at some later time when
1186 expansion might result in a directory that does not
1187 contain the files you need.
1188 The trailing colon character is necessary because you
1189 are directing BitBake to extend the path by prepending
1190 directories to the search path.
1191 </note>
1178 Here is another common use: 1192 Here is another common use:
1179 <literallayout class='monospaced'> 1193 <literallayout class='monospaced'>
1180 FILESEXTRAPATHS_prepend := "${THISDIR}/files:" 1194 FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
1181 </literallayout> 1195 </literallayout>
1182 In this example, the build system extends the 1196 In this example, the build system extends the
1183 <filename>FILESPATH</filename> variable to include a 1197 <filename>FILESPATH</filename> variable to include a
1184 directory named <filename>files</filename> that is in the 1198 directory named <filename>files</filename> that is in the
1185 same directory as the corresponding append file. 1199 same directory as the corresponding append file.
1186 </para> 1200 </para>
1187 1201
@@ -1195,13 +1209,8 @@ Core layer for images cannot be removed
1195 <para> 1209 <para>
1196 By prepending paths in <filename>.bbappend</filename> 1210 By prepending paths in <filename>.bbappend</filename>
1197 files, you allow multiple append files that reside in 1211 files, you allow multiple append files that reside in
1198 different layers but are used for the same recipe to 1212 different layers but are used for the same recipe to
1199 correctly extend the path. 1213 correctly extend the path.
1200 <note>
1201 Be sure to use the immediate expansion
1202 (<filename>:=</filename>) operator and include
1203 the trailing separating colon character.
1204 </note>
1205 </para> 1214 </para>
1206 </glossdef> 1215 </glossdef>
1207 </glossentry> 1216 </glossentry>
@@ -1209,17 +1218,17 @@ Core layer for images cannot be removed
1209 <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm> 1218 <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm>
1210 <glossdef> 1219 <glossdef>
1211 <para> 1220 <para>
1212 The default set of directories the OpenEmbedded build system 1221 The default set of directories the OpenEmbedded build system
1213 uses when searching for patches and files. 1222 uses when searching for patches and files.
1214 During the build process, BitBake searches each directory in 1223 During the build process, BitBake searches each directory in
1215 <filename>FILESPATH</filename> in the specified order when 1224 <filename>FILESPATH</filename> in the specified order when
1216 looking for files and patches specified by each 1225 looking for files and patches specified by each
1217 <filename>file://</filename> URI in a recipe. 1226 <filename>file://</filename> URI in a recipe.
1218 </para> 1227 </para>
1219 1228
1220 <para> 1229 <para>
1221 The default value for the <filename>FILESPATH</filename> 1230 The default value for the <filename>FILESPATH</filename>
1222 variable is defined in the <filename>base.bbclass</filename> 1231 variable is defined in the <filename>base.bbclass</filename>
1223 class found in <filename>meta/classes</filename> in the 1232 class found in <filename>meta/classes</filename> in the
1224 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: 1233 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
1225 <literallayout class='monospaced'> 1234 <literallayout class='monospaced'>
@@ -1227,18 +1236,18 @@ Core layer for images cannot be removed
1227 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" 1236 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
1228 </literallayout> 1237 </literallayout>
1229 <note> 1238 <note>
1230 Do not hand-edit the <filename>FILESPATH</filename> 1239 Do not hand-edit the <filename>FILESPATH</filename>
1231 variable. 1240 variable.
1232 </note> 1241 </note>
1233 Be aware that the default <filename>FILESPATH</filename> 1242 Be aware that the default <filename>FILESPATH</filename>
1234 directories do not map to directories in custom layers 1243 directories do not map to directories in custom layers
1235 where append files (<filename>.bbappend</filename>) 1244 where append files (<filename>.bbappend</filename>)
1236 are used. 1245 are used.
1237 If you want the build system to find patches or files 1246 If you want the build system to find patches or files
1238 that reside with your append files, you need to extend 1247 that reside with your append files, you need to extend
1239 the <filename>FILESPATH</filename> variable by using 1248 the <filename>FILESPATH</filename> variable by using
1240 the 1249 the
1241 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> 1250 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
1242 variable. 1251 variable.
1243 </para> 1252 </para>
1244 </glossdef> 1253 </glossdef>
@@ -1306,10 +1315,10 @@ Core layer for images cannot be removed
1306 <glossentry id='var-HOST_SYS'><glossterm>HOST_SYS</glossterm> 1315 <glossentry id='var-HOST_SYS'><glossterm>HOST_SYS</glossterm>
1307 <glossdef> 1316 <glossdef>
1308 <para> 1317 <para>
1309 Specifies the system, including the architecture and the 1318 Specifies the system, including the architecture and the
1310 operating system, for with the build is occurring 1319 operating system, for with the build is occurring
1311 in the context of the current 1320 in the context of the current
1312 recipe. 1321 recipe.
1313 The OpenEmbedded build system automatically sets this 1322 The OpenEmbedded build system automatically sets this
1314 variable. 1323 variable.
1315 You do not need to set the variable yourself. 1324 You do not need to set the variable yourself.
@@ -1319,12 +1328,12 @@ Core layer for images cannot be removed
1319 Here are two examples: 1328 Here are two examples:
1320 <itemizedlist> 1329 <itemizedlist>
1321 <listitem><para>Given a native recipe on a 32-bit 1330 <listitem><para>Given a native recipe on a 32-bit
1322 x86 machine running Linux, the value is 1331 x86 machine running Linux, the value is
1323 "i686-linux". 1332 "i686-linux".
1324 </para></listitem> 1333 </para></listitem>
1325 <listitem><para>Given a recipe being built for a 1334 <listitem><para>Given a recipe being built for a
1326 little-endian MIPS target running Linux, 1335 little-endian MIPS target running Linux,
1327 the value might be "mipsel-linux". 1336 the value might be "mipsel-linux".
1328 </para></listitem> 1337 </para></listitem>
1329 </itemizedlist> 1338 </itemizedlist>
1330 </para> 1339 </para>
@@ -1419,24 +1428,24 @@ Core layer for images cannot be removed
1419 <para> 1428 <para>
1420 Specifies the list of locales to install into the image 1429 Specifies the list of locales to install into the image
1421 during the root filesystem construction process. 1430 during the root filesystem construction process.
1422 The OpenEmbedded build system automatically splits locale 1431 The OpenEmbedded build system automatically splits locale
1423 files, which are used for localization, into separate 1432 files, which are used for localization, into separate
1424 packages. 1433 packages.
1425 Setting the <filename>IMAGE_LINGUAS</filename> variable 1434 Setting the <filename>IMAGE_LINGUAS</filename> variable
1426 ensures that any locale packages that correspond to packages 1435 ensures that any locale packages that correspond to packages
1427 already selected for installation into the image are also 1436 already selected for installation into the image are also
1428 installed. 1437 installed.
1429 Here is an example: 1438 Here is an example:
1430 <literallayout class='monospaced'> 1439 <literallayout class='monospaced'>
1431 IMAGE_LINGUAS = "pt-br de-de" 1440 IMAGE_LINGUAS = "pt-br de-de"
1432 </literallayout> 1441 </literallayout>
1433 In this example, the build system ensures any Brazilian 1442 In this example, the build system ensures any Brazilian
1434 Portuguese and German locale files that correspond to 1443 Portuguese and German locale files that correspond to
1435 packages in the image are installed (i.e. 1444 packages in the image are installed (i.e.
1436 <filename>*-locale-pt-br</filename> 1445 <filename>*-locale-pt-br</filename>
1437 and <filename>*-locale-de-de</filename> as well as 1446 and <filename>*-locale-de-de</filename> as well as
1438 <filename>*-locale-pt</filename> 1447 <filename>*-locale-pt</filename>
1439 and <filename>*-locale-de</filename>, since some software 1448 and <filename>*-locale-de</filename>, since some software
1440 packages only provide locale files by language and not by 1449 packages only provide locale files by language and not by
1441 country-specific language). 1450 country-specific language).
1442 </para> 1451 </para>
@@ -1672,12 +1681,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1672 <glossentry id='var-INSANE_SKIP'><glossterm>INSANE_SKIP</glossterm> 1681 <glossentry id='var-INSANE_SKIP'><glossterm>INSANE_SKIP</glossterm>
1673 <glossdef> 1682 <glossdef>
1674 <para> 1683 <para>
1675 Specifies the QA checks to skip for a specific package 1684 Specifies the QA checks to skip for a specific package
1676 within a recipe. 1685 within a recipe.
1677 For example, to skip the check for symbolic link 1686 For example, to skip the check for symbolic link
1678 <filename>.so</filename> files in the main package of a 1687 <filename>.so</filename> files in the main package of a
1679 recipe, add the following to the recipe. 1688 recipe, add the following to the recipe.
1680 The package name override must be used, which in this 1689 The package name override must be used, which in this
1681 example is <filename>${PN}</filename>: 1690 example is <filename>${PN}</filename>:
1682 <literallayout class='monospaced'> 1691 <literallayout class='monospaced'>
1683 INSANE_SKIP_${PN} += "dev-so" 1692 INSANE_SKIP_${PN} += "dev-so"
@@ -1685,7 +1694,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1685 </para> 1694 </para>
1686 <para> 1695 <para>
1687 See the "<link linkend='ref-classes-insane'>Generated Output Quality Assurance Checks - <filename>insane.bbclass</filename></link>" 1696 See the "<link linkend='ref-classes-insane'>Generated Output Quality Assurance Checks - <filename>insane.bbclass</filename></link>"
1688 section for a list of the valid QA checks you can 1697 section for a list of the valid QA checks you can
1689 specify using this variable. 1698 specify using this variable.
1690 </para> 1699 </para>
1691 </glossdef> 1700 </glossdef>
@@ -2199,7 +2208,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2199 <glossentry id='var-LOG_DIR'><glossterm>LOG_DIR</glossterm> 2208 <glossentry id='var-LOG_DIR'><glossterm>LOG_DIR</glossterm>
2200 <glossdef> 2209 <glossdef>
2201 <para> 2210 <para>
2202 Specifies the directory to which the OpenEmbedded build 2211 Specifies the directory to which the OpenEmbedded build
2203 system writes overall log files. 2212 system writes overall log files.
2204 The default directory is <filename>${TMPDIR}/log</filename>. 2213 The default directory is <filename>${TMPDIR}/log</filename>.
2205 </para> 2214 </para>
@@ -2474,22 +2483,22 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2474 <glossentry id='var-MACHINEOVERRIDES'><glossterm>MACHINEOVERRIDES</glossterm> 2483 <glossentry id='var-MACHINEOVERRIDES'><glossterm>MACHINEOVERRIDES</glossterm>
2475 <glossdef> 2484 <glossdef>
2476 <para> 2485 <para>
2477 Lists overrides specific to the current machine. 2486 Lists overrides specific to the current machine.
2478 By default, this list includes the value 2487 By default, this list includes the value
2479 of <filename><link linkend='var-MACHINE'>MACHINE</link></filename>. 2488 of <filename><link linkend='var-MACHINE'>MACHINE</link></filename>.
2480 You can extend the list to apply variable overrides for 2489 You can extend the list to apply variable overrides for
2481 classes of machines. 2490 classes of machines.
2482 For example, all QEMU emulated machines (e.g. qemuarm, 2491 For example, all QEMU emulated machines (e.g. qemuarm,
2483 qemux86, and so forth) include a common file named 2492 qemux86, and so forth) include a common file named
2484 <filename>meta/conf/machine/include/qemu.inc</filename> 2493 <filename>meta/conf/machine/include/qemu.inc</filename>
2485 that prepends <filename>MACHINEOVERRIDES</filename> with 2494 that prepends <filename>MACHINEOVERRIDES</filename> with
2486 the following variable override: 2495 the following variable override:
2487 <literallayout class='monospaced'> 2496 <literallayout class='monospaced'>
2488 MACHINEOVERRIDES =. "qemuall:" 2497 MACHINEOVERRIDES =. "qemuall:"
2489 </literallayout> 2498 </literallayout>
2490 Applying an override like <filename>qemuall</filename> 2499 Applying an override like <filename>qemuall</filename>
2491 affects all QEMU emulated machines elsewhere. 2500 affects all QEMU emulated machines elsewhere.
2492 Here is an example from the 2501 Here is an example from the
2493 <filename>connman-conf</filename> recipe: 2502 <filename>connman-conf</filename> recipe:
2494 <literallayout class='monospaced'> 2503 <literallayout class='monospaced'>
2495 SRC_URI_append_qemuall = "file://wired.config \ 2504 SRC_URI_append_qemuall = "file://wired.config \
@@ -2578,18 +2587,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2578 <para> 2587 <para>
2579 A string identifying the host distribution. 2588 A string identifying the host distribution.
2580 Strings consist of the host distributor ID 2589 Strings consist of the host distributor ID
2581 followed by the release, as reported by the 2590 followed by the release, as reported by the
2582 <filename>lsb_release</filename> tool 2591 <filename>lsb_release</filename> tool
2583 or as read from <filename>/etc/lsb-release</filename>. 2592 or as read from <filename>/etc/lsb-release</filename>.
2584 For example, when running a build on Ubuntu 12.10, the value 2593 For example, when running a build on Ubuntu 12.10, the value
2585 is "Ubuntu-12.10". 2594 is "Ubuntu-12.10".
2586 If this information is unable to be determined, the value 2595 If this information is unable to be determined, the value
2587 resolves to "Unknown". 2596 resolves to "Unknown".
2588 </para> 2597 </para>
2589 <para> 2598 <para>
2590 This variable is used by default to isolate native shared 2599 This variable is used by default to isolate native shared
2591 state packages for different distributions (e.g. to avoid 2600 state packages for different distributions (e.g. to avoid
2592 problems with <filename>glibc</filename> version 2601 problems with <filename>glibc</filename> version
2593 incompatibilities). 2602 incompatibilities).
2594 Additionally, the variable is checked against 2603 Additionally, the variable is checked against
2595 <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link> 2604 <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link>
@@ -2920,15 +2929,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2920 <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm> 2929 <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm>
2921 <glossdef> 2930 <glossdef>
2922 <para> 2931 <para>
2923 A list of aliases that a recipe also provides. 2932 A list of aliases that a recipe also provides.
2924 These aliases are useful for satisfying dependencies of 2933 These aliases are useful for satisfying dependencies of
2925 other recipes during the build (as specified by 2934 other recipes during the build (as specified by
2926 <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>). 2935 <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>).
2927 <note> 2936 <note>
2928 A recipe's own 2937 A recipe's own
2929 <filename><link linkend='var-PN'>PN</link></filename> 2938 <filename><link linkend='var-PN'>PN</link></filename>
2930 is implicitly already in its 2939 is implicitly already in its
2931 <filename>PROVIDES</filename> list. 2940 <filename>PROVIDES</filename> list.
2932 </note> 2941 </note>
2933 </para> 2942 </para>
2934 </glossdef> 2943 </glossdef>
@@ -3090,8 +3099,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3090 <glossentry id='var-RM_WORK_EXCLUDE'><glossterm>RM_WORK_EXCLUDE</glossterm> 3099 <glossentry id='var-RM_WORK_EXCLUDE'><glossterm>RM_WORK_EXCLUDE</glossterm>
3091 <glossdef> 3100 <glossdef>
3092 <para> 3101 <para>
3093 With <filename>rm_work</filename> enabled, this 3102 With <filename>rm_work</filename> enabled, this
3094 variable specifies a list of packages whose work directories 3103 variable specifies a list of packages whose work directories
3095 should not be removed. 3104 should not be removed.
3096 See the "<link linkend='ref-classes-rm-work'>Removing Work Files During the Build - <filename>rm_work.bbclass</filename></link>" 3105 See the "<link linkend='ref-classes-rm-work'>Removing Work Files During the Build - <filename>rm_work.bbclass</filename></link>"
3097 section for more details. 3106 section for more details.
@@ -3102,9 +3111,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3102 <glossentry id='var-RPROVIDES'><glossterm>RPROVIDES</glossterm> 3111 <glossentry id='var-RPROVIDES'><glossterm>RPROVIDES</glossterm>
3103 <glossdef> 3112 <glossdef>
3104 <para> 3113 <para>
3105 A list of package name aliases that a package also provides. 3114 A list of package name aliases that a package also provides.
3106 These aliases are useful for satisfying runtime dependencies 3115 These aliases are useful for satisfying runtime dependencies
3107 of other packages both during the build and on the target 3116 of other packages both during the build and on the target
3108 (as specified by 3117 (as specified by
3109 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>). 3118 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>).
3110 <note> 3119 <note>
@@ -3113,7 +3122,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3113 </note> 3122 </note>
3114 </para> 3123 </para>
3115 <para> 3124 <para>
3116 As with all package-controlling variables, you must always 3125 As with all package-controlling variables, you must always
3117 use the variable in conjunction with a package name override. 3126 use the variable in conjunction with a package name override.
3118 Here is an example: 3127 Here is an example:
3119 <literallayout class='monospaced'> 3128 <literallayout class='monospaced'>
@@ -3163,18 +3172,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3163 <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm> 3172 <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm>
3164 <glossdef> 3173 <glossdef>
3165 <para> 3174 <para>
3166 A list of packages replaced by a package. 3175 A list of packages replaced by a package.
3167 The package manager uses this variable to determine which 3176 The package manager uses this variable to determine which
3168 package should be installed to replace other package(s) 3177 package should be installed to replace other package(s)
3169 during an upgrade. 3178 during an upgrade.
3170 In order to also have the other package(s) removed at the 3179 In order to also have the other package(s) removed at the
3171 same time, you must add the name of the other 3180 same time, you must add the name of the other
3172 package to the 3181 package to the
3173 <filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link></filename> variable. 3182 <filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link></filename> variable.
3174 </para> 3183 </para>
3175 <para> 3184 <para>
3176 As with all package-controlling variables, you must use 3185 As with all package-controlling variables, you must use
3177 this variable in conjunction with a package name 3186 this variable in conjunction with a package name
3178 override. 3187 override.
3179 Here is an example: 3188 Here is an example:
3180 <literallayout class='monospaced'> 3189 <literallayout class='monospaced'>
@@ -3187,14 +3196,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3187 <glossentry id='var-RSUGGESTS'><glossterm>RSUGGESTS</glossterm> 3196 <glossentry id='var-RSUGGESTS'><glossterm>RSUGGESTS</glossterm>
3188 <glossdef> 3197 <glossdef>
3189 <para> 3198 <para>
3190 A list of additional packages that you can suggest for 3199 A list of additional packages that you can suggest for
3191 installation by the package manager at the time a package 3200 installation by the package manager at the time a package
3192 is installed. 3201 is installed.
3193 Not all package managers support this functionality. 3202 Not all package managers support this functionality.
3194 </para> 3203 </para>
3195 <para> 3204 <para>
3196 As with all package-controlling variables, you must always 3205 As with all package-controlling variables, you must always
3197 use this variable in conjunction with a package name 3206 use this variable in conjunction with a package name
3198 override. 3207 override.
3199 Here is an example: 3208 Here is an example:
3200 <literallayout class='monospaced'> 3209 <literallayout class='monospaced'>
@@ -3239,19 +3248,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3239 <glossentry id='var-SANITY_TESTED_DISTROS'><glossterm>SANITY_TESTED_DISTROS</glossterm> 3248 <glossentry id='var-SANITY_TESTED_DISTROS'><glossterm>SANITY_TESTED_DISTROS</glossterm>
3240 <glossdef> 3249 <glossdef>
3241 <para> 3250 <para>
3242 A list of the host distribution identifiers that the 3251 A list of the host distribution identifiers that the
3243 build system has been tested against. 3252 build system has been tested against.
3244 Identifiers consist of the host distributor ID 3253 Identifiers consist of the host distributor ID
3245 followed by the release, 3254 followed by the release,
3246 as reported by the <filename>lsb_release</filename> tool 3255 as reported by the <filename>lsb_release</filename> tool
3247 or as read from <filename>/etc/lsb-release</filename>. 3256 or as read from <filename>/etc/lsb-release</filename>.
3248 Separate the list items with explicit newline 3257 Separate the list items with explicit newline
3249 characters (<filename>\n</filename>). 3258 characters (<filename>\n</filename>).
3250 If <filename>SANITY_TESTED_DISTROS</filename> is not empty 3259 If <filename>SANITY_TESTED_DISTROS</filename> is not empty
3251 and the current value of 3260 and the current value of
3252 <link linkend='var-NATIVELSBSTRING'><filename>NATIVELSBSTRING</filename></link> 3261 <link linkend='var-NATIVELSBSTRING'><filename>NATIVELSBSTRING</filename></link>
3253 does not appear in the list, then the build system reports 3262 does not appear in the list, then the build system reports
3254 a warning that indicates the current host distribution has 3263 a warning that indicates the current host distribution has
3255 not been tested as a build host. 3264 not been tested as a build host.
3256 </para> 3265 </para>
3257 </glossdef> 3266 </glossdef>
@@ -3302,17 +3311,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3302 <glossentry id='var-SIGGEN_EXCLUDERECIPES_ABISAFE'><glossterm>SIGGEN_EXCLUDERECIPES_ABISAFE</glossterm> 3311 <glossentry id='var-SIGGEN_EXCLUDERECIPES_ABISAFE'><glossterm>SIGGEN_EXCLUDERECIPES_ABISAFE</glossterm>
3303 <glossdef> 3312 <glossdef>
3304 <para> 3313 <para>
3305 A list of recipes that are completely stable and will 3314 A list of recipes that are completely stable and will
3306 never change. 3315 never change.
3307 The ABI for the recipes in the list are presented by 3316 The ABI for the recipes in the list are presented by
3308 output from the tasks run to build the recipe. 3317 output from the tasks run to build the recipe.
3309 Use of this variable is one way to remove dependencies from 3318 Use of this variable is one way to remove dependencies from
3310 one recipe on another that affect task signatures and 3319 one recipe on another that affect task signatures and
3311 thus force rebuilds when the recipe changes. 3320 thus force rebuilds when the recipe changes.
3312 <caution> 3321 <caution>
3313 If you add an inappropriate variable to this list, 3322 If you add an inappropriate variable to this list,
3314 the software might break at runtime if the 3323 the software might break at runtime if the
3315 interface of the recipe was changed after the other 3324 interface of the recipe was changed after the other
3316 had been built. 3325 had been built.
3317 </caution> 3326 </caution>
3318 </para> 3327 </para>
@@ -3322,25 +3331,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3322 <glossentry id='var-SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS'><glossterm>SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS</glossterm> 3331 <glossentry id='var-SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS'><glossterm>SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS</glossterm>
3323 <glossdef> 3332 <glossdef>
3324 <para> 3333 <para>
3325 A list of recipe dependencies that should not be used to 3334 A list of recipe dependencies that should not be used to
3326 determine signatures of tasks from one recipe when they 3335 determine signatures of tasks from one recipe when they
3327 depend on tasks from another recipe. 3336 depend on tasks from another recipe.
3328 For example: 3337 For example:
3329 <literallayout class='monospaced'> 3338 <literallayout class='monospaced'>
3330 SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2" 3339 SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2"
3331 </literallayout> 3340 </literallayout>
3332 In this example, <filename>intone</filename> depends on 3341 In this example, <filename>intone</filename> depends on
3333 <filename>mplayer2</filename>. 3342 <filename>mplayer2</filename>.
3334 </para> 3343 </para>
3335 3344
3336 <para> 3345 <para>
3337 Use of this variable is one mechanism to remove dependencies 3346 Use of this variable is one mechanism to remove dependencies
3338 that affect task signatures and thus force rebuilds when a 3347 that affect task signatures and thus force rebuilds when a
3339 recipe changes. 3348 recipe changes.
3340 <caution> 3349 <caution>
3341 If you add an inappropriate dependency for a recipe 3350 If you add an inappropriate dependency for a recipe
3342 relationship, the software might break during 3351 relationship, the software might break during
3343 runtime if the interface of the second recipe was 3352 runtime if the interface of the second recipe was
3344 changed after the first recipe had been built. 3353 changed after the first recipe had been built.
3345 </caution> 3354 </caution>
3346 </para> 3355 </para>
@@ -3369,12 +3378,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3369 <glossdef> 3378 <glossdef>
3370 <para> 3379 <para>
3371 Groups together machines based upon the same family 3380 Groups together machines based upon the same family
3372 of SOC (System On Chip). 3381 of SOC (System On Chip).
3373 You typically set this variable in a common 3382 You typically set this variable in a common
3374 <filename>.inc</filename> file that you include in the 3383 <filename>.inc</filename> file that you include in the
3375 configuration files of all the machines. 3384 configuration files of all the machines.
3376 <note> 3385 <note>
3377 You must include 3386 You must include
3378 <filename>conf/machine/include/soc-family.inc</filename> 3387 <filename>conf/machine/include/soc-family.inc</filename>
3379 for this variable to appear in 3388 for this variable to appear in
3380 <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>. 3389 <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>.
@@ -3397,56 +3406,56 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3397 <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm> 3406 <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm>
3398 <glossdef> 3407 <glossdef>
3399 <para>The list of source files - local or remote. 3408 <para>The list of source files - local or remote.
3400 This variable tells the OpenEmbedded build system which bits 3409 This variable tells the OpenEmbedded build system which bits
3401 to pull in for the build and how to pull them in. 3410 to pull in for the build and how to pull them in.
3402 For example, if the recipe or append file only needs to 3411 For example, if the recipe or append file only needs to
3403 fetch a tarball from the Internet, the recipe or 3412 fetch a tarball from the Internet, the recipe or
3404 append file uses a single <filename>SRC_URI</filename> 3413 append file uses a single <filename>SRC_URI</filename>
3405 entry. 3414 entry.
3406 On the other hand, if the recipe or append file needs to 3415 On the other hand, if the recipe or append file needs to
3407 fetch a tarball, apply two patches, and include a custom 3416 fetch a tarball, apply two patches, and include a custom
3408 file, the recipe or append file would include four 3417 file, the recipe or append file would include four
3409 instances of the variable.</para> 3418 instances of the variable.</para>
3410 <para>The following list explains the available URI protocols: 3419 <para>The following list explains the available URI protocols:
3411 <itemizedlist> 3420 <itemizedlist>
3412 <listitem><para><emphasis><filename>file://</filename> -</emphasis> 3421 <listitem><para><emphasis><filename>file://</filename> -</emphasis>
3413 Fetches files, which are usually files shipped with 3422 Fetches files, which are usually files shipped with
3414 the 3423 the
3415 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>, 3424 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>,
3416 from the local machine. 3425 from the local machine.
3417 The path is relative to the 3426 The path is relative to the
3418 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> 3427 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
3419 variable. 3428 variable.
3420 Thus, the build system searches, in order, from the 3429 Thus, the build system searches, in order, from the
3421 following directories, which are assumed to be a 3430 following directories, which are assumed to be a
3422 subdirectories of the directory in which the 3431 subdirectories of the directory in which the
3423 recipe file (<filename>.bb</filename>) or 3432 recipe file (<filename>.bb</filename>) or
3424 append file (<filename>.bbappend</filename>) 3433 append file (<filename>.bbappend</filename>)
3425 resides: 3434 resides:
3426 <itemizedlist> 3435 <itemizedlist>
3427 <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> 3436 <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis>
3428 The base recipe name without any special 3437 The base recipe name without any special
3429 suffix or version numbers. 3438 suffix or version numbers.
3430 </para></listitem> 3439 </para></listitem>
3431 <listitem><para><emphasis><filename>${BP}</filename> -</emphasis> 3440 <listitem><para><emphasis><filename>${BP}</filename> -</emphasis>
3432 <filename>${<link linkend='var-BPN'>BPN</link>}-${PV}</filename>. 3441 <filename>${<link linkend='var-BPN'>BPN</link>}-${PV}</filename>.
3433 The base recipe name and version but without 3442 The base recipe name and version but without
3434 any special package name suffix. 3443 any special package name suffix.
3435 </para></listitem> 3444 </para></listitem>
3436 <listitem><para><emphasis>files -</emphasis> 3445 <listitem><para><emphasis>files -</emphasis>
3437 Files within a directory, which is named 3446 Files within a directory, which is named
3438 <filename>files</filename> and is also 3447 <filename>files</filename> and is also
3439 alongside the recipe or append file. 3448 alongside the recipe or append file.
3440 </para></listitem> 3449 </para></listitem>
3441 </itemizedlist> 3450 </itemizedlist>
3442 <note> 3451 <note>
3443 If you want the build system to pick up files 3452 If you want the build system to pick up files
3444 specified through a 3453 specified through a
3445 <filename>SRC_URI</filename> 3454 <filename>SRC_URI</filename>
3446 statement from your append file, you need to be 3455 statement from your append file, you need to be
3447 sure to extend the 3456 sure to extend the
3448 <filename>FILESPATH</filename> 3457 <filename>FILESPATH</filename>
3449 variable by also using the 3458 variable by also using the
3450 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> 3459 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
3451 variable from within your append file. 3460 variable from within your append file.
3452 </note> 3461 </note>
@@ -3691,9 +3700,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3691 <glossentry id='var-STAMPS_DIR'><glossterm>STAMPS_DIR</glossterm> 3700 <glossentry id='var-STAMPS_DIR'><glossterm>STAMPS_DIR</glossterm>
3692 <glossdef> 3701 <glossdef>
3693 <para> 3702 <para>
3694 Specifies the base directory in which the OpenEmbedded 3703 Specifies the base directory in which the OpenEmbedded
3695 build system places stamps. 3704 build system places stamps.
3696 The default directory is 3705 The default directory is
3697 <filename>${TMPDIR}/stamps</filename>. 3706 <filename>${TMPDIR}/stamps</filename>.
3698 </para> 3707 </para>
3699 </glossdef> 3708 </glossdef>
@@ -3715,10 +3724,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3715 <glossentry id='var-SYSROOT_PREPROCESS_FUNCS'><glossterm>SYSROOT_PREPROCESS_FUNCS</glossterm> 3724 <glossentry id='var-SYSROOT_PREPROCESS_FUNCS'><glossterm>SYSROOT_PREPROCESS_FUNCS</glossterm>
3716 <glossdef> 3725 <glossdef>
3717 <para> 3726 <para>
3718 A list of functions to execute after files are staged into 3727 A list of functions to execute after files are staged into
3719 the sysroot. 3728 the sysroot.
3720 These functions are usually used to apply additional 3729 These functions are usually used to apply additional
3721 processing on the staged files, or to stage additional 3730 processing on the staged files, or to stage additional
3722 files. 3731 files.
3723 </para> 3732 </para>
3724 </glossdef> 3733 </glossdef>
@@ -3730,15 +3739,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3730 3739
3731 <glossentry id='var-T'><glossterm>T</glossterm> 3740 <glossentry id='var-T'><glossterm>T</glossterm>
3732 <glossdef> 3741 <glossdef>
3733 <para>This variable points to a directory were BitBake places 3742 <para>This variable points to a directory were BitBake places
3734 temporary files, which consist mostly of task logs and 3743 temporary files, which consist mostly of task logs and
3735 scripts, when building a particular recipe. 3744 scripts, when building a particular recipe.
3736 The variable is typically set as follows: 3745 The variable is typically set as follows:
3737 <literallayout class='monospaced'> 3746 <literallayout class='monospaced'>
3738 T = "${WORKDIR}/temp" 3747 T = "${WORKDIR}/temp"
3739 </literallayout> 3748 </literallayout>
3740 The <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> 3749 The <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
3741 is the directory into which BitBake unpacks and builds the 3750 is the directory into which BitBake unpacks and builds the
3742 recipe. 3751 recipe.
3743 The default <filename>bitbake.conf</filename> file sets this variable.</para> 3752 The default <filename>bitbake.conf</filename> file sets this variable.</para>
3744 <para>The <filename>T</filename> variable is not to be confused with 3753 <para>The <filename>T</filename> variable is not to be confused with