summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-05-29 11:45:12 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-05-31 08:19:25 +0100
commita0f4706d238d84380f2fffcea869096bcd643556 (patch)
tree127bf3200c7c82be5663171d36bbeb02960ff6ca
parentef038a793ab82797268e8156a9e7ef66bf029e73 (diff)
downloadpoky-a0f4706d238d84380f2fffcea869096bcd643556.tar.gz
ref-manual: Updated note for FILESEXTRAPATHS variable.
Added a bit more clarification (different wording) on why to use the immediate expansion operator and on why to include the trailing separating colon character. (From yocto-docs rev: 1ca951af9bc3b9a60bb7503d21a7ef94bb46454a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Conflicts: documentation/ref-manual/ref-variables.xml Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-variables.xml307
1 files changed, 161 insertions, 146 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index ac4686f4da..b075f54c7e 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,28 @@ 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 <para>When extending <filename>FILESEXTRAPATHS</filename>,
1180 be sure to use the immediate expansion
1181 (<filename>:=</filename>) operator.
1182 Immediate expansion makes sure that BitBake evaluates
1183 <filename>THISDIR</filename> at the time the directive
1184 is encountered rather than at some later time when
1185 expansion might result in a directory that does not
1186 contain the files you need.</para>
1187 <para>Also, include the trailing separating colon
1188 character if you are prepending.
1189 The trailing colon character is necessary because you
1190 are directing BitBake to extend the path by prepending
1191 directories to the search path.</para>
1192 </note>
1178 Here is another common use: 1193 Here is another common use:
1179 <literallayout class='monospaced'> 1194 <literallayout class='monospaced'>
1180 FILESEXTRAPATHS_prepend := "${THISDIR}/files:" 1195 FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
1181 </literallayout> 1196 </literallayout>
1182 In this example, the build system extends the 1197 In this example, the build system extends the
1183 <filename>FILESPATH</filename> variable to include a 1198 <filename>FILESPATH</filename> variable to include a
1184 directory named <filename>files</filename> that is in the 1199 directory named <filename>files</filename> that is in the
1185 same directory as the corresponding append file. 1200 same directory as the corresponding append file.
1186 </para> 1201 </para>
1187 1202
@@ -1195,11 +1210,11 @@ Core layer for images cannot be removed
1195 <para> 1210 <para>
1196 By prepending paths in <filename>.bbappend</filename> 1211 By prepending paths in <filename>.bbappend</filename>
1197 files, you allow multiple append files that reside in 1212 files, you allow multiple append files that reside in
1198 different layers but are used for the same recipe to 1213 different layers but are used for the same recipe to
1199 correctly extend the path. 1214 correctly extend the path.
1200 <note> 1215 <note>
1201 Be sure to use the immediate expansion 1216 Be sure to use the immediate expansion
1202 (<filename>:=</filename>) operator and include 1217 (<filename>:=</filename>) operator and include
1203 the trailing separating colon character. 1218 the trailing separating colon character.
1204 </note> 1219 </note>
1205 </para> 1220 </para>
@@ -1209,17 +1224,17 @@ Core layer for images cannot be removed
1209 <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm> 1224 <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm>
1210 <glossdef> 1225 <glossdef>
1211 <para> 1226 <para>
1212 The default set of directories the OpenEmbedded build system 1227 The default set of directories the OpenEmbedded build system
1213 uses when searching for patches and files. 1228 uses when searching for patches and files.
1214 During the build process, BitBake searches each directory in 1229 During the build process, BitBake searches each directory in
1215 <filename>FILESPATH</filename> in the specified order when 1230 <filename>FILESPATH</filename> in the specified order when
1216 looking for files and patches specified by each 1231 looking for files and patches specified by each
1217 <filename>file://</filename> URI in a recipe. 1232 <filename>file://</filename> URI in a recipe.
1218 </para> 1233 </para>
1219 1234
1220 <para> 1235 <para>
1221 The default value for the <filename>FILESPATH</filename> 1236 The default value for the <filename>FILESPATH</filename>
1222 variable is defined in the <filename>base.bbclass</filename> 1237 variable is defined in the <filename>base.bbclass</filename>
1223 class found in <filename>meta/classes</filename> in the 1238 class found in <filename>meta/classes</filename> in the
1224 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: 1239 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
1225 <literallayout class='monospaced'> 1240 <literallayout class='monospaced'>
@@ -1227,18 +1242,18 @@ Core layer for images cannot be removed
1227 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" 1242 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
1228 </literallayout> 1243 </literallayout>
1229 <note> 1244 <note>
1230 Do not hand-edit the <filename>FILESPATH</filename> 1245 Do not hand-edit the <filename>FILESPATH</filename>
1231 variable. 1246 variable.
1232 </note> 1247 </note>
1233 Be aware that the default <filename>FILESPATH</filename> 1248 Be aware that the default <filename>FILESPATH</filename>
1234 directories do not map to directories in custom layers 1249 directories do not map to directories in custom layers
1235 where append files (<filename>.bbappend</filename>) 1250 where append files (<filename>.bbappend</filename>)
1236 are used. 1251 are used.
1237 If you want the build system to find patches or files 1252 If you want the build system to find patches or files
1238 that reside with your append files, you need to extend 1253 that reside with your append files, you need to extend
1239 the <filename>FILESPATH</filename> variable by using 1254 the <filename>FILESPATH</filename> variable by using
1240 the 1255 the
1241 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> 1256 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
1242 variable. 1257 variable.
1243 </para> 1258 </para>
1244 </glossdef> 1259 </glossdef>
@@ -1306,10 +1321,10 @@ Core layer for images cannot be removed
1306 <glossentry id='var-HOST_SYS'><glossterm>HOST_SYS</glossterm> 1321 <glossentry id='var-HOST_SYS'><glossterm>HOST_SYS</glossterm>
1307 <glossdef> 1322 <glossdef>
1308 <para> 1323 <para>
1309 Specifies the system, including the architecture and the 1324 Specifies the system, including the architecture and the
1310 operating system, for with the build is occurring 1325 operating system, for with the build is occurring
1311 in the context of the current 1326 in the context of the current
1312 recipe. 1327 recipe.
1313 The OpenEmbedded build system automatically sets this 1328 The OpenEmbedded build system automatically sets this
1314 variable. 1329 variable.
1315 You do not need to set the variable yourself. 1330 You do not need to set the variable yourself.
@@ -1319,12 +1334,12 @@ Core layer for images cannot be removed
1319 Here are two examples: 1334 Here are two examples:
1320 <itemizedlist> 1335 <itemizedlist>
1321 <listitem><para>Given a native recipe on a 32-bit 1336 <listitem><para>Given a native recipe on a 32-bit
1322 x86 machine running Linux, the value is 1337 x86 machine running Linux, the value is
1323 "i686-linux". 1338 "i686-linux".
1324 </para></listitem> 1339 </para></listitem>
1325 <listitem><para>Given a recipe being built for a 1340 <listitem><para>Given a recipe being built for a
1326 little-endian MIPS target running Linux, 1341 little-endian MIPS target running Linux,
1327 the value might be "mipsel-linux". 1342 the value might be "mipsel-linux".
1328 </para></listitem> 1343 </para></listitem>
1329 </itemizedlist> 1344 </itemizedlist>
1330 </para> 1345 </para>
@@ -1419,24 +1434,24 @@ Core layer for images cannot be removed
1419 <para> 1434 <para>
1420 Specifies the list of locales to install into the image 1435 Specifies the list of locales to install into the image
1421 during the root filesystem construction process. 1436 during the root filesystem construction process.
1422 The OpenEmbedded build system automatically splits locale 1437 The OpenEmbedded build system automatically splits locale
1423 files, which are used for localization, into separate 1438 files, which are used for localization, into separate
1424 packages. 1439 packages.
1425 Setting the <filename>IMAGE_LINGUAS</filename> variable 1440 Setting the <filename>IMAGE_LINGUAS</filename> variable
1426 ensures that any locale packages that correspond to packages 1441 ensures that any locale packages that correspond to packages
1427 already selected for installation into the image are also 1442 already selected for installation into the image are also
1428 installed. 1443 installed.
1429 Here is an example: 1444 Here is an example:
1430 <literallayout class='monospaced'> 1445 <literallayout class='monospaced'>
1431 IMAGE_LINGUAS = "pt-br de-de" 1446 IMAGE_LINGUAS = "pt-br de-de"
1432 </literallayout> 1447 </literallayout>
1433 In this example, the build system ensures any Brazilian 1448 In this example, the build system ensures any Brazilian
1434 Portuguese and German locale files that correspond to 1449 Portuguese and German locale files that correspond to
1435 packages in the image are installed (i.e. 1450 packages in the image are installed (i.e.
1436 <filename>*-locale-pt-br</filename> 1451 <filename>*-locale-pt-br</filename>
1437 and <filename>*-locale-de-de</filename> as well as 1452 and <filename>*-locale-de-de</filename> as well as
1438 <filename>*-locale-pt</filename> 1453 <filename>*-locale-pt</filename>
1439 and <filename>*-locale-de</filename>, since some software 1454 and <filename>*-locale-de</filename>, since some software
1440 packages only provide locale files by language and not by 1455 packages only provide locale files by language and not by
1441 country-specific language). 1456 country-specific language).
1442 </para> 1457 </para>
@@ -1672,12 +1687,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> 1687 <glossentry id='var-INSANE_SKIP'><glossterm>INSANE_SKIP</glossterm>
1673 <glossdef> 1688 <glossdef>
1674 <para> 1689 <para>
1675 Specifies the QA checks to skip for a specific package 1690 Specifies the QA checks to skip for a specific package
1676 within a recipe. 1691 within a recipe.
1677 For example, to skip the check for symbolic link 1692 For example, to skip the check for symbolic link
1678 <filename>.so</filename> files in the main package of a 1693 <filename>.so</filename> files in the main package of a
1679 recipe, add the following to the recipe. 1694 recipe, add the following to the recipe.
1680 The package name override must be used, which in this 1695 The package name override must be used, which in this
1681 example is <filename>${PN}</filename>: 1696 example is <filename>${PN}</filename>:
1682 <literallayout class='monospaced'> 1697 <literallayout class='monospaced'>
1683 INSANE_SKIP_${PN} += "dev-so" 1698 INSANE_SKIP_${PN} += "dev-so"
@@ -1685,7 +1700,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1685 </para> 1700 </para>
1686 <para> 1701 <para>
1687 See the "<link linkend='ref-classes-insane'>Generated Output Quality Assurance Checks - <filename>insane.bbclass</filename></link>" 1702 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 1703 section for a list of the valid QA checks you can
1689 specify using this variable. 1704 specify using this variable.
1690 </para> 1705 </para>
1691 </glossdef> 1706 </glossdef>
@@ -2199,7 +2214,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> 2214 <glossentry id='var-LOG_DIR'><glossterm>LOG_DIR</glossterm>
2200 <glossdef> 2215 <glossdef>
2201 <para> 2216 <para>
2202 Specifies the directory to which the OpenEmbedded build 2217 Specifies the directory to which the OpenEmbedded build
2203 system writes overall log files. 2218 system writes overall log files.
2204 The default directory is <filename>${TMPDIR}/log</filename>. 2219 The default directory is <filename>${TMPDIR}/log</filename>.
2205 </para> 2220 </para>
@@ -2474,22 +2489,22 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2474 <glossentry id='var-MACHINEOVERRIDES'><glossterm>MACHINEOVERRIDES</glossterm> 2489 <glossentry id='var-MACHINEOVERRIDES'><glossterm>MACHINEOVERRIDES</glossterm>
2475 <glossdef> 2490 <glossdef>
2476 <para> 2491 <para>
2477 Lists overrides specific to the current machine. 2492 Lists overrides specific to the current machine.
2478 By default, this list includes the value 2493 By default, this list includes the value
2479 of <filename><link linkend='var-MACHINE'>MACHINE</link></filename>. 2494 of <filename><link linkend='var-MACHINE'>MACHINE</link></filename>.
2480 You can extend the list to apply variable overrides for 2495 You can extend the list to apply variable overrides for
2481 classes of machines. 2496 classes of machines.
2482 For example, all QEMU emulated machines (e.g. qemuarm, 2497 For example, all QEMU emulated machines (e.g. qemuarm,
2483 qemux86, and so forth) include a common file named 2498 qemux86, and so forth) include a common file named
2484 <filename>meta/conf/machine/include/qemu.inc</filename> 2499 <filename>meta/conf/machine/include/qemu.inc</filename>
2485 that prepends <filename>MACHINEOVERRIDES</filename> with 2500 that prepends <filename>MACHINEOVERRIDES</filename> with
2486 the following variable override: 2501 the following variable override:
2487 <literallayout class='monospaced'> 2502 <literallayout class='monospaced'>
2488 MACHINEOVERRIDES =. "qemuall:" 2503 MACHINEOVERRIDES =. "qemuall:"
2489 </literallayout> 2504 </literallayout>
2490 Applying an override like <filename>qemuall</filename> 2505 Applying an override like <filename>qemuall</filename>
2491 affects all QEMU emulated machines elsewhere. 2506 affects all QEMU emulated machines elsewhere.
2492 Here is an example from the 2507 Here is an example from the
2493 <filename>connman-conf</filename> recipe: 2508 <filename>connman-conf</filename> recipe:
2494 <literallayout class='monospaced'> 2509 <literallayout class='monospaced'>
2495 SRC_URI_append_qemuall = "file://wired.config \ 2510 SRC_URI_append_qemuall = "file://wired.config \
@@ -2578,18 +2593,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2578 <para> 2593 <para>
2579 A string identifying the host distribution. 2594 A string identifying the host distribution.
2580 Strings consist of the host distributor ID 2595 Strings consist of the host distributor ID
2581 followed by the release, as reported by the 2596 followed by the release, as reported by the
2582 <filename>lsb_release</filename> tool 2597 <filename>lsb_release</filename> tool
2583 or as read from <filename>/etc/lsb-release</filename>. 2598 or as read from <filename>/etc/lsb-release</filename>.
2584 For example, when running a build on Ubuntu 12.10, the value 2599 For example, when running a build on Ubuntu 12.10, the value
2585 is "Ubuntu-12.10". 2600 is "Ubuntu-12.10".
2586 If this information is unable to be determined, the value 2601 If this information is unable to be determined, the value
2587 resolves to "Unknown". 2602 resolves to "Unknown".
2588 </para> 2603 </para>
2589 <para> 2604 <para>
2590 This variable is used by default to isolate native shared 2605 This variable is used by default to isolate native shared
2591 state packages for different distributions (e.g. to avoid 2606 state packages for different distributions (e.g. to avoid
2592 problems with <filename>glibc</filename> version 2607 problems with <filename>glibc</filename> version
2593 incompatibilities). 2608 incompatibilities).
2594 Additionally, the variable is checked against 2609 Additionally, the variable is checked against
2595 <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link> 2610 <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link>
@@ -2920,15 +2935,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2920 <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm> 2935 <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm>
2921 <glossdef> 2936 <glossdef>
2922 <para> 2937 <para>
2923 A list of aliases that a recipe also provides. 2938 A list of aliases that a recipe also provides.
2924 These aliases are useful for satisfying dependencies of 2939 These aliases are useful for satisfying dependencies of
2925 other recipes during the build (as specified by 2940 other recipes during the build (as specified by
2926 <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>). 2941 <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>).
2927 <note> 2942 <note>
2928 A recipe's own 2943 A recipe's own
2929 <filename><link linkend='var-PN'>PN</link></filename> 2944 <filename><link linkend='var-PN'>PN</link></filename>
2930 is implicitly already in its 2945 is implicitly already in its
2931 <filename>PROVIDES</filename> list. 2946 <filename>PROVIDES</filename> list.
2932 </note> 2947 </note>
2933 </para> 2948 </para>
2934 </glossdef> 2949 </glossdef>
@@ -3090,8 +3105,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> 3105 <glossentry id='var-RM_WORK_EXCLUDE'><glossterm>RM_WORK_EXCLUDE</glossterm>
3091 <glossdef> 3106 <glossdef>
3092 <para> 3107 <para>
3093 With <filename>rm_work</filename> enabled, this 3108 With <filename>rm_work</filename> enabled, this
3094 variable specifies a list of packages whose work directories 3109 variable specifies a list of packages whose work directories
3095 should not be removed. 3110 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>" 3111 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. 3112 section for more details.
@@ -3102,9 +3117,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3102 <glossentry id='var-RPROVIDES'><glossterm>RPROVIDES</glossterm> 3117 <glossentry id='var-RPROVIDES'><glossterm>RPROVIDES</glossterm>
3103 <glossdef> 3118 <glossdef>
3104 <para> 3119 <para>
3105 A list of package name aliases that a package also provides. 3120 A list of package name aliases that a package also provides.
3106 These aliases are useful for satisfying runtime dependencies 3121 These aliases are useful for satisfying runtime dependencies
3107 of other packages both during the build and on the target 3122 of other packages both during the build and on the target
3108 (as specified by 3123 (as specified by
3109 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>). 3124 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>).
3110 <note> 3125 <note>
@@ -3113,7 +3128,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3113 </note> 3128 </note>
3114 </para> 3129 </para>
3115 <para> 3130 <para>
3116 As with all package-controlling variables, you must always 3131 As with all package-controlling variables, you must always
3117 use the variable in conjunction with a package name override. 3132 use the variable in conjunction with a package name override.
3118 Here is an example: 3133 Here is an example:
3119 <literallayout class='monospaced'> 3134 <literallayout class='monospaced'>
@@ -3163,18 +3178,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3163 <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm> 3178 <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm>
3164 <glossdef> 3179 <glossdef>
3165 <para> 3180 <para>
3166 A list of packages replaced by a package. 3181 A list of packages replaced by a package.
3167 The package manager uses this variable to determine which 3182 The package manager uses this variable to determine which
3168 package should be installed to replace other package(s) 3183 package should be installed to replace other package(s)
3169 during an upgrade. 3184 during an upgrade.
3170 In order to also have the other package(s) removed at the 3185 In order to also have the other package(s) removed at the
3171 same time, you must add the name of the other 3186 same time, you must add the name of the other
3172 package to the 3187 package to the
3173 <filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link></filename> variable. 3188 <filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link></filename> variable.
3174 </para> 3189 </para>
3175 <para> 3190 <para>
3176 As with all package-controlling variables, you must use 3191 As with all package-controlling variables, you must use
3177 this variable in conjunction with a package name 3192 this variable in conjunction with a package name
3178 override. 3193 override.
3179 Here is an example: 3194 Here is an example:
3180 <literallayout class='monospaced'> 3195 <literallayout class='monospaced'>
@@ -3187,14 +3202,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3187 <glossentry id='var-RSUGGESTS'><glossterm>RSUGGESTS</glossterm> 3202 <glossentry id='var-RSUGGESTS'><glossterm>RSUGGESTS</glossterm>
3188 <glossdef> 3203 <glossdef>
3189 <para> 3204 <para>
3190 A list of additional packages that you can suggest for 3205 A list of additional packages that you can suggest for
3191 installation by the package manager at the time a package 3206 installation by the package manager at the time a package
3192 is installed. 3207 is installed.
3193 Not all package managers support this functionality. 3208 Not all package managers support this functionality.
3194 </para> 3209 </para>
3195 <para> 3210 <para>
3196 As with all package-controlling variables, you must always 3211 As with all package-controlling variables, you must always
3197 use this variable in conjunction with a package name 3212 use this variable in conjunction with a package name
3198 override. 3213 override.
3199 Here is an example: 3214 Here is an example:
3200 <literallayout class='monospaced'> 3215 <literallayout class='monospaced'>
@@ -3239,19 +3254,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> 3254 <glossentry id='var-SANITY_TESTED_DISTROS'><glossterm>SANITY_TESTED_DISTROS</glossterm>
3240 <glossdef> 3255 <glossdef>
3241 <para> 3256 <para>
3242 A list of the host distribution identifiers that the 3257 A list of the host distribution identifiers that the
3243 build system has been tested against. 3258 build system has been tested against.
3244 Identifiers consist of the host distributor ID 3259 Identifiers consist of the host distributor ID
3245 followed by the release, 3260 followed by the release,
3246 as reported by the <filename>lsb_release</filename> tool 3261 as reported by the <filename>lsb_release</filename> tool
3247 or as read from <filename>/etc/lsb-release</filename>. 3262 or as read from <filename>/etc/lsb-release</filename>.
3248 Separate the list items with explicit newline 3263 Separate the list items with explicit newline
3249 characters (<filename>\n</filename>). 3264 characters (<filename>\n</filename>).
3250 If <filename>SANITY_TESTED_DISTROS</filename> is not empty 3265 If <filename>SANITY_TESTED_DISTROS</filename> is not empty
3251 and the current value of 3266 and the current value of
3252 <link linkend='var-NATIVELSBSTRING'><filename>NATIVELSBSTRING</filename></link> 3267 <link linkend='var-NATIVELSBSTRING'><filename>NATIVELSBSTRING</filename></link>
3253 does not appear in the list, then the build system reports 3268 does not appear in the list, then the build system reports
3254 a warning that indicates the current host distribution has 3269 a warning that indicates the current host distribution has
3255 not been tested as a build host. 3270 not been tested as a build host.
3256 </para> 3271 </para>
3257 </glossdef> 3272 </glossdef>
@@ -3302,17 +3317,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> 3317 <glossentry id='var-SIGGEN_EXCLUDERECIPES_ABISAFE'><glossterm>SIGGEN_EXCLUDERECIPES_ABISAFE</glossterm>
3303 <glossdef> 3318 <glossdef>
3304 <para> 3319 <para>
3305 A list of recipes that are completely stable and will 3320 A list of recipes that are completely stable and will
3306 never change. 3321 never change.
3307 The ABI for the recipes in the list are presented by 3322 The ABI for the recipes in the list are presented by
3308 output from the tasks run to build the recipe. 3323 output from the tasks run to build the recipe.
3309 Use of this variable is one way to remove dependencies from 3324 Use of this variable is one way to remove dependencies from
3310 one recipe on another that affect task signatures and 3325 one recipe on another that affect task signatures and
3311 thus force rebuilds when the recipe changes. 3326 thus force rebuilds when the recipe changes.
3312 <caution> 3327 <caution>
3313 If you add an inappropriate variable to this list, 3328 If you add an inappropriate variable to this list,
3314 the software might break at runtime if the 3329 the software might break at runtime if the
3315 interface of the recipe was changed after the other 3330 interface of the recipe was changed after the other
3316 had been built. 3331 had been built.
3317 </caution> 3332 </caution>
3318 </para> 3333 </para>
@@ -3322,25 +3337,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> 3337 <glossentry id='var-SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS'><glossterm>SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS</glossterm>
3323 <glossdef> 3338 <glossdef>
3324 <para> 3339 <para>
3325 A list of recipe dependencies that should not be used to 3340 A list of recipe dependencies that should not be used to
3326 determine signatures of tasks from one recipe when they 3341 determine signatures of tasks from one recipe when they
3327 depend on tasks from another recipe. 3342 depend on tasks from another recipe.
3328 For example: 3343 For example:
3329 <literallayout class='monospaced'> 3344 <literallayout class='monospaced'>
3330 SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2" 3345 SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2"
3331 </literallayout> 3346 </literallayout>
3332 In this example, <filename>intone</filename> depends on 3347 In this example, <filename>intone</filename> depends on
3333 <filename>mplayer2</filename>. 3348 <filename>mplayer2</filename>.
3334 </para> 3349 </para>
3335 3350
3336 <para> 3351 <para>
3337 Use of this variable is one mechanism to remove dependencies 3352 Use of this variable is one mechanism to remove dependencies
3338 that affect task signatures and thus force rebuilds when a 3353 that affect task signatures and thus force rebuilds when a
3339 recipe changes. 3354 recipe changes.
3340 <caution> 3355 <caution>
3341 If you add an inappropriate dependency for a recipe 3356 If you add an inappropriate dependency for a recipe
3342 relationship, the software might break during 3357 relationship, the software might break during
3343 runtime if the interface of the second recipe was 3358 runtime if the interface of the second recipe was
3344 changed after the first recipe had been built. 3359 changed after the first recipe had been built.
3345 </caution> 3360 </caution>
3346 </para> 3361 </para>
@@ -3369,12 +3384,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3369 <glossdef> 3384 <glossdef>
3370 <para> 3385 <para>
3371 Groups together machines based upon the same family 3386 Groups together machines based upon the same family
3372 of SOC (System On Chip). 3387 of SOC (System On Chip).
3373 You typically set this variable in a common 3388 You typically set this variable in a common
3374 <filename>.inc</filename> file that you include in the 3389 <filename>.inc</filename> file that you include in the
3375 configuration files of all the machines. 3390 configuration files of all the machines.
3376 <note> 3391 <note>
3377 You must include 3392 You must include
3378 <filename>conf/machine/include/soc-family.inc</filename> 3393 <filename>conf/machine/include/soc-family.inc</filename>
3379 for this variable to appear in 3394 for this variable to appear in
3380 <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>. 3395 <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>.
@@ -3397,56 +3412,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> 3412 <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm>
3398 <glossdef> 3413 <glossdef>
3399 <para>The list of source files - local or remote. 3414 <para>The list of source files - local or remote.
3400 This variable tells the OpenEmbedded build system which bits 3415 This variable tells the OpenEmbedded build system which bits
3401 to pull in for the build and how to pull them in. 3416 to pull in for the build and how to pull them in.
3402 For example, if the recipe or append file only needs to 3417 For example, if the recipe or append file only needs to
3403 fetch a tarball from the Internet, the recipe or 3418 fetch a tarball from the Internet, the recipe or
3404 append file uses a single <filename>SRC_URI</filename> 3419 append file uses a single <filename>SRC_URI</filename>
3405 entry. 3420 entry.
3406 On the other hand, if the recipe or append file needs to 3421 On the other hand, if the recipe or append file needs to
3407 fetch a tarball, apply two patches, and include a custom 3422 fetch a tarball, apply two patches, and include a custom
3408 file, the recipe or append file would include four 3423 file, the recipe or append file would include four
3409 instances of the variable.</para> 3424 instances of the variable.</para>
3410 <para>The following list explains the available URI protocols: 3425 <para>The following list explains the available URI protocols:
3411 <itemizedlist> 3426 <itemizedlist>
3412 <listitem><para><emphasis><filename>file://</filename> -</emphasis> 3427 <listitem><para><emphasis><filename>file://</filename> -</emphasis>
3413 Fetches files, which are usually files shipped with 3428 Fetches files, which are usually files shipped with
3414 the 3429 the
3415 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>, 3430 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>,
3416 from the local machine. 3431 from the local machine.
3417 The path is relative to the 3432 The path is relative to the
3418 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> 3433 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
3419 variable. 3434 variable.
3420 Thus, the build system searches, in order, from the 3435 Thus, the build system searches, in order, from the
3421 following directories, which are assumed to be a 3436 following directories, which are assumed to be a
3422 subdirectories of the directory in which the 3437 subdirectories of the directory in which the
3423 recipe file (<filename>.bb</filename>) or 3438 recipe file (<filename>.bb</filename>) or
3424 append file (<filename>.bbappend</filename>) 3439 append file (<filename>.bbappend</filename>)
3425 resides: 3440 resides:
3426 <itemizedlist> 3441 <itemizedlist>
3427 <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> 3442 <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis>
3428 The base recipe name without any special 3443 The base recipe name without any special
3429 suffix or version numbers. 3444 suffix or version numbers.
3430 </para></listitem> 3445 </para></listitem>
3431 <listitem><para><emphasis><filename>${BP}</filename> -</emphasis> 3446 <listitem><para><emphasis><filename>${BP}</filename> -</emphasis>
3432 <filename>${<link linkend='var-BPN'>BPN</link>}-${PV}</filename>. 3447 <filename>${<link linkend='var-BPN'>BPN</link>}-${PV}</filename>.
3433 The base recipe name and version but without 3448 The base recipe name and version but without
3434 any special package name suffix. 3449 any special package name suffix.
3435 </para></listitem> 3450 </para></listitem>
3436 <listitem><para><emphasis>files -</emphasis> 3451 <listitem><para><emphasis>files -</emphasis>
3437 Files within a directory, which is named 3452 Files within a directory, which is named
3438 <filename>files</filename> and is also 3453 <filename>files</filename> and is also
3439 alongside the recipe or append file. 3454 alongside the recipe or append file.
3440 </para></listitem> 3455 </para></listitem>
3441 </itemizedlist> 3456 </itemizedlist>
3442 <note> 3457 <note>
3443 If you want the build system to pick up files 3458 If you want the build system to pick up files
3444 specified through a 3459 specified through a
3445 <filename>SRC_URI</filename> 3460 <filename>SRC_URI</filename>
3446 statement from your append file, you need to be 3461 statement from your append file, you need to be
3447 sure to extend the 3462 sure to extend the
3448 <filename>FILESPATH</filename> 3463 <filename>FILESPATH</filename>
3449 variable by also using the 3464 variable by also using the
3450 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> 3465 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
3451 variable from within your append file. 3466 variable from within your append file.
3452 </note> 3467 </note>
@@ -3691,9 +3706,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> 3706 <glossentry id='var-STAMPS_DIR'><glossterm>STAMPS_DIR</glossterm>
3692 <glossdef> 3707 <glossdef>
3693 <para> 3708 <para>
3694 Specifies the base directory in which the OpenEmbedded 3709 Specifies the base directory in which the OpenEmbedded
3695 build system places stamps. 3710 build system places stamps.
3696 The default directory is 3711 The default directory is
3697 <filename>${TMPDIR}/stamps</filename>. 3712 <filename>${TMPDIR}/stamps</filename>.
3698 </para> 3713 </para>
3699 </glossdef> 3714 </glossdef>
@@ -3715,10 +3730,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> 3730 <glossentry id='var-SYSROOT_PREPROCESS_FUNCS'><glossterm>SYSROOT_PREPROCESS_FUNCS</glossterm>
3716 <glossdef> 3731 <glossdef>
3717 <para> 3732 <para>
3718 A list of functions to execute after files are staged into 3733 A list of functions to execute after files are staged into
3719 the sysroot. 3734 the sysroot.
3720 These functions are usually used to apply additional 3735 These functions are usually used to apply additional
3721 processing on the staged files, or to stage additional 3736 processing on the staged files, or to stage additional
3722 files. 3737 files.
3723 </para> 3738 </para>
3724 </glossdef> 3739 </glossdef>
@@ -3730,15 +3745,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3730 3745
3731 <glossentry id='var-T'><glossterm>T</glossterm> 3746 <glossentry id='var-T'><glossterm>T</glossterm>
3732 <glossdef> 3747 <glossdef>
3733 <para>This variable points to a directory were BitBake places 3748 <para>This variable points to a directory were BitBake places
3734 temporary files, which consist mostly of task logs and 3749 temporary files, which consist mostly of task logs and
3735 scripts, when building a particular recipe. 3750 scripts, when building a particular recipe.
3736 The variable is typically set as follows: 3751 The variable is typically set as follows:
3737 <literallayout class='monospaced'> 3752 <literallayout class='monospaced'>
3738 T = "${WORKDIR}/temp" 3753 T = "${WORKDIR}/temp"
3739 </literallayout> 3754 </literallayout>
3740 The <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> 3755 The <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
3741 is the directory into which BitBake unpacks and builds the 3756 is the directory into which BitBake unpacks and builds the
3742 recipe. 3757 recipe.
3743 The default <filename>bitbake.conf</filename> file sets this variable.</para> 3758 The default <filename>bitbake.conf</filename> file sets this variable.</para>
3744 <para>The <filename>T</filename> variable is not to be confused with 3759 <para>The <filename>T</filename> variable is not to be confused with