summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/ref-variables.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/poky-ref-manual/ref-variables.xml')
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml87
1 files changed, 43 insertions, 44 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 8663cc463c..ac068228cf 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -93,8 +93,8 @@
93 <glossentry id='var-B'><glossterm>B</glossterm> 93 <glossentry id='var-B'><glossterm>B</glossterm>
94 <glossdef> 94 <glossdef>
95 <para> 95 <para>
96 The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 96 The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
97 The OpenEmbedded build system places generated objects into the build directory 97 The OpenEmbedded build system places generated objects into the Build Directory
98 during a recipe's build process. 98 during a recipe's build process.
99 By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link> 99 By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
100 directory: 100 directory:
@@ -165,7 +165,7 @@
165 </literallayout></para> 165 </literallayout></para>
166 <para>Use the <filename>BBMASK</filename> variable from within the 166 <para>Use the <filename>BBMASK</filename> variable from within the
167 <filename>conf/local.conf</filename> file found 167 <filename>conf/local.conf</filename> file found
168 in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.</para> 168 in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.</para>
169 </glossdef> 169 </glossdef>
170 </glossentry> 170 </glossentry>
171 171
@@ -250,7 +250,7 @@
250 <glossdef> 250 <glossdef>
251 <para>Lists the layers to enable during the build. 251 <para>Lists the layers to enable during the build.
252 This variable is defined in the <filename>bblayers.conf</filename> configuration 252 This variable is defined in the <filename>bblayers.conf</filename> configuration
253 file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 253 file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
254 Here is an example: 254 Here is an example:
255 <literallayout class='monospaced'> 255 <literallayout class='monospaced'>
256 BBLAYERS = " \ 256 BBLAYERS = " \
@@ -362,7 +362,7 @@
362 than <filename>/usr/bin</filename>. 362 than <filename>/usr/bin</filename>.
363 You can find a list of these variables at the top of the 363 You can find a list of these variables at the top of the
364 <filename>/meta/conf/bitbake.conf</filename> file in the 364 <filename>/meta/conf/bitbake.conf</filename> file in the
365 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 365 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
366 </note> 366 </note>
367 </glossdef> 367 </glossdef>
368 </glossentry> 368 </glossentry>
@@ -384,7 +384,7 @@
384 Specifies the list of packages to be added to the image. 384 Specifies the list of packages to be added to the image.
385 This variable should only be set in the <filename>local.conf</filename> 385 This variable should only be set in the <filename>local.conf</filename>
386 configuration file found in the 386 configuration file found in the
387 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 387 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
388 </para> 388 </para>
389 389
390 <para> 390 <para>
@@ -581,7 +581,7 @@
581 This directory is self-maintaining and you should not have 581 This directory is self-maintaining and you should not have
582 to touch it. 582 to touch it.
583 By default, the directory is <filename>downloads</filename> in the 583 By default, the directory is <filename>downloads</filename> in the
584 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 584 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
585 <literallayout class='monospaced'> 585 <literallayout class='monospaced'>
586 #DL_DIR ?= "${TOPDIR}/downloads" 586 #DL_DIR ?= "${TOPDIR}/downloads"
587 </literallayout> 587 </literallayout>
@@ -755,7 +755,7 @@
755 than <filename>/usr/bin</filename>. 755 than <filename>/usr/bin</filename>.
756 You can find a list of these variables at the top of the 756 You can find a list of these variables at the top of the
757 <filename>/meta/conf/bitbake.conf</filename> file in the 757 <filename>/meta/conf/bitbake.conf</filename> file in the
758 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 758 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
759 </note> 759 </note>
760 760
761 <para> 761 <para>
@@ -821,7 +821,7 @@
821 The default value for the <filename>FILESPATH</filename> variable is defined 821 The default value for the <filename>FILESPATH</filename> variable is defined
822 in the <filename>base.bbclass</filename> class found in 822 in the <filename>base.bbclass</filename> class found in
823 <filename>meta/classes</filename> in the 823 <filename>meta/classes</filename> in the
824 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>: 824 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
825 <literallayout class='monospaced'> 825 <literallayout class='monospaced'>
826FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ 826FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
827 "${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \ 827 "${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \
@@ -848,14 +848,14 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
848 <para> 848 <para>
849 By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which 849 By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which
850 is located in the <filename>meta/files</filename> folder in the 850 is located in the <filename>meta/files</filename> folder in the
851 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 851 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
852 If you create your own file permissions setting table, you should place it in your 852 If you create your own file permissions setting table, you should place it in your
853 layer or the distros layer. 853 layer or the distros layer.
854 </para> 854 </para>
855 <para> 855 <para>
856 You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the 856 You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the
857 <filename>conf/local.conf</filename> file, which is found in the 857 <filename>conf/local.conf</filename> file, which is found in the
858 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>, to 858 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to
859 point to your custom <filename>fs-perms.txt</filename>. 859 point to your custom <filename>fs-perms.txt</filename>.
860 You can specify more than a single file permissions setting table. 860 You can specify more than a single file permissions setting table.
861 The paths you specify to these files must be defined within the 861 The paths you specify to these files must be defined within the
@@ -1200,20 +1200,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1200 Values for this variable are set in the kernel's recipe file and the kernel's 1200 Values for this variable are set in the kernel's recipe file and the kernel's
1201 append file. 1201 append file.
1202 For example, if you are using the Yocto Project kernel that is based on the 1202 For example, if you are using the Yocto Project kernel that is based on the
1203 Linux 3.2 kernel, the kernel recipe file is the 1203 Linux 3.4 kernel, the kernel recipe file is the
1204 <filename>meta/recipes-kernel/linux/linux-yocto_3.2.bb</filename> file. 1204 <filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename> file.
1205 Following is the default value for <filename>KBRANCH</filename> and the five overrides 1205 Following is the default value for <filename>KBRANCH</filename> and the default
1206 for the architectures the Yocto Project supports: 1206 override for the architectures the Yocto Project supports:
1207 <literallayout class='monospaced'> 1207 <literallayout class='monospaced'>
1208 KBRANCH = "standard/default/base" 1208 KBRANCH_DEFAULT = "standard/base"
1209 KBRANCH_qemux86 = "standard/default/common-pc/base" 1209 KBRANCH = "${KBRANCH_DEFAULT}"
1210 KBRANCH_qemux86-64 = "standard/default/common-pc-64/base"
1211 KBRANCH_qemuppc = "standard/default/qemu-ppc32"
1212 KBRANCH_qemumips = "standard/default/mti-malta32-be"
1213 KBRANCH_qemuarm = "standard/default/arm-versatile-926ejs"
1214 </literallayout> 1210 </literallayout>
1215 Each of the above branches exist in the <filename>linux-yocto-3.2</filename> kernel Git 1211 This branch exists in the <filename>linux-yocto-3.4</filename> kernel Git
1216 repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.2/refs/heads'></ulink>. 1212 repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.4/refs/heads'></ulink>.
1217 </para> 1213 </para>
1218 1214
1219 <para> 1215 <para>
@@ -1222,16 +1218,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1222 The kernel's append file is located in the BSP layer for a given machine. 1218 The kernel's append file is located in the BSP layer for a given machine.
1223 For example, the kernel append file for the Crown Bay BSP is in the 1219 For example, the kernel append file for the Crown Bay BSP is in the
1224 <filename>meta-intel</filename> Git repository and is named 1220 <filename>meta-intel</filename> Git repository and is named
1225 <filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.2.bbappend</filename>. 1221 <filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.4.bbappend</filename>.
1226 Here are the related statements from the append file: 1222 Here are the related statements from the append file:
1227 <literallayout class='monospaced'> 1223 <literallayout class='monospaced'>
1228 COMPATIBLE_MACHINE_crownbay = "crownbay" 1224 COMPATIBLE_MACHINE_crownbay = "crownbay"
1229 KMACHINE_crownbay = "crownbay" 1225 KMACHINE_crownbay = "crownbay"
1230 KBRANCH_crownbay = "standard/default/crownbay" 1226 KBRANCH_crownbay = "standard/crownbay"
1231 1227
1232 COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd" 1228 COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd"
1233 KMACHINE_crownbay-noemgd = "crownbay" 1229 KMACHINE_crownbay-noemgd = "crownbay"
1234 KBRANCH_crownbay-noemgd = "standard/default/crownbay" 1230 KBRANCH_crownbay-noemgd = "standard/crownbay"
1235 </literallayout> 1231 </literallayout>
1236 The <filename>KBRANCH_*</filename> statements identify the kernel branch to 1232 The <filename>KBRANCH_*</filename> statements identify the kernel branch to
1237 use when building for the Crown Bay BSP. 1233 use when building for the Crown Bay BSP.
@@ -1294,10 +1290,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1294 1290
1295 <para> 1291 <para>
1296 Kernel machine names are initially defined in the 1292 Kernel machine names are initially defined in the
1297 <ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Yocto Project Kernel</ulink> in 1293 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>Yocto Linux Kernel</ulink> in
1294 the <filename>meta</filename> branch.
1295 From the <filename>meta</filename> branch, look in
1298 the <filename>meta/cfg/kernel-cache/bsp/&lt;bsp_name&gt;/&lt;bsp-name&gt;-&lt;kernel-type&gt;.scc</filename> file. 1296 the <filename>meta/cfg/kernel-cache/bsp/&lt;bsp_name&gt;/&lt;bsp-name&gt;-&lt;kernel-type&gt;.scc</filename> file.
1299 For example, in the <filename>linux-yocto-3.4</filename> kernel in the 1297 For example, from the <filename>meta</filename> branch in the
1300 <filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file, 1298 <filename>linux-yocto-3.0</filename> kernel, the
1299 <filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file
1301 has the following: 1300 has the following:
1302 <literallayout class='monospaced'> 1301 <literallayout class='monospaced'>
1303 define KMACHINE cedartrail 1302 define KMACHINE cedartrail
@@ -1307,7 +1306,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1307 include ktypes/standard 1306 include ktypes/standard
1308 branch cedartrail 1307 branch cedartrail
1309 1308
1310 include cedartrail.scc 1309 include cedartrail.scc
1311 </literallayout> 1310 </literallayout>
1312 You can see that the kernel understands the machine name for the Cedar Trail BSP as 1311 You can see that the kernel understands the machine name for the Cedar Trail BSP as
1313 <filename>cedartrail</filename>. 1312 <filename>cedartrail</filename>.
@@ -1795,7 +1794,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1795 <glossdef> 1794 <glossdef>
1796 <para>This variable, which is set in the <filename>local.conf</filename> configuration 1795 <para>This variable, which is set in the <filename>local.conf</filename> configuration
1797 file found in the <filename>conf</filename> folder of the 1796 file found in the <filename>conf</filename> folder of the
1798 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>, 1797 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
1799 specifies the package manager to use when packaging data. 1798 specifies the package manager to use when packaging data.
1800 You can provide one or more arguments for the variable with the first 1799 You can provide one or more arguments for the variable with the first
1801 argument being the package manager used to create images: 1800 argument being the package manager used to create images:
@@ -2134,7 +2133,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2134 <glossentry id='var-S'><glossterm>S</glossterm> 2133 <glossentry id='var-S'><glossterm>S</glossterm>
2135 <glossdef> 2134 <glossdef>
2136 <para> 2135 <para>
2137 The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> 2136 The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
2138 where unpacked package source code resides. 2137 where unpacked package source code resides.
2139 This location is within the working directory 2138 This location is within the working directory
2140 (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which 2139 (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which
@@ -2147,9 +2146,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2147 ${WORKDIR}/${PN}-${PV} 2146 ${WORKDIR}/${PN}-${PV}
2148 </literallayout> 2147 </literallayout>
2149 As an example, assume a 2148 As an example, assume a
2150 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> top-level 2149 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level
2151 folder named <filename>poky</filename> 2150 folder named <filename>poky</filename>
2152 and a default <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> 2151 and a default <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
2153 at <filename>poky/build</filename>. 2152 at <filename>poky/build</filename>.
2154 In this case, the working directory the build system uses to build 2153 In this case, the working directory the build system uses to build
2155 the <filename>db</filename> package is the following: 2154 the <filename>db</filename> package is the following:
@@ -2578,7 +2577,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2578 the upstream GCC or CodeSourcery Labs toolchain. 2577 the upstream GCC or CodeSourcery Labs toolchain.
2579 The variable identifies the <filename>tcmode-*</filename> files used in 2578 The variable identifies the <filename>tcmode-*</filename> files used in
2580 the <filename>meta/conf/distro/include</filename> directory, which is found in the 2579 the <filename>meta/conf/distro/include</filename> directory, which is found in the
2581 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 2580 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
2582 </para> 2581 </para>
2583 <para> 2582 <para>
2584 By default, <filename>TCMODE</filename> is set to "default", which 2583 By default, <filename>TCMODE</filename> is set to "default", which
@@ -2598,14 +2597,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2598 uses when it does its work building images. 2597 uses when it does its work building images.
2599 By default, the <filename>TMPDIR</filename> variable is named 2598 By default, the <filename>TMPDIR</filename> variable is named
2600 <filename>tmp</filename> within the 2599 <filename>tmp</filename> within the
2601 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 2600 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
2602 </para> 2601 </para>
2603 2602
2604 <para> 2603 <para>
2605 If you want to establish this directory in a location other than the 2604 If you want to establish this directory in a location other than the
2606 default, you can uncomment the following statement in the 2605 default, you can uncomment the following statement in the
2607 <filename>conf/local.conf</filename> file in the 2606 <filename>conf/local.conf</filename> file in the
2608 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>: 2607 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
2609 <literallayout class='monospaced'> 2608 <literallayout class='monospaced'>
2610 #TMPDIR = "${TOPDIR}/tmp" 2609 #TMPDIR = "${TOPDIR}/tmp"
2611 </literallayout> 2610 </literallayout>
@@ -2617,9 +2616,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2617 <glossdef> 2616 <glossdef>
2618 <para> 2617 <para>
2619 This variable is the 2618 This variable is the
2620 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 2619 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
2621 BitBake automatically sets this variable. 2620 BitBake automatically sets this variable.
2622 The OpenEmbedded build system uses the build directory when building images. 2621 The OpenEmbedded build system uses the Build Directory when building images.
2623 </para> 2622 </para>
2624 </glossdef> 2623 </glossdef>
2625 </glossentry> 2624 </glossentry>
@@ -2664,9 +2663,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2664 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 2663 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
2665 </literallayout> 2664 </literallayout>
2666 As an example, assume a 2665 As an example, assume a
2667 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> top-level 2666 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level
2668 folder name <filename>poky</filename> and a default 2667 folder name <filename>poky</filename> and a default
2669 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> 2668 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
2670 at <filename>poky/build</filename>. 2669 at <filename>poky/build</filename>.
2671 In this case, the working directory the build system uses to build 2670 In this case, the working directory the build system uses to build
2672 the <filename>v86d</filename> package is the following: 2671 the <filename>v86d</filename> package is the following:
@@ -2681,8 +2680,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2681 <literallayout class='monospaced'> 2680 <literallayout class='monospaced'>
2682 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 2681 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
2683 </literallayout> 2682 </literallayout>
2684 As an example, again assume a source directory top-level folder 2683 As an example, again assume a Source Directory top-level folder
2685 named <filename>poky</filename> and a default build directory 2684 named <filename>poky</filename> and a default Build Directory
2686 at <filename>poky/build</filename>. 2685 at <filename>poky/build</filename>.
2687 In this case, the working directory the build system uses to build 2686 In this case, the working directory the build system uses to build
2688 the <filename>acl</filename> recipe, which is being built for a 2687 the <filename>acl</filename> recipe, which is being built for a