summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml56
1 files changed, 29 insertions, 27 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index bd9e517246..da4da8550d 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -536,7 +536,7 @@
536 <para role="glossdeffirst"> 536 <para role="glossdeffirst">
537<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 537<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
538 The directory within the 538 The directory within the
539 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 539 <link linkend='build-directory'>Build Directory</link>
540 in which the OpenEmbedded build system places generated 540 in which the OpenEmbedded build system places generated
541 objects during a recipe's build process. 541 objects during a recipe's build process.
542 By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link> 542 By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
@@ -734,7 +734,7 @@
734 variable to "1", "yes", or "true" 734 variable to "1", "yes", or "true"
735 in your <filename>local.conf</filename> file, which is 735 in your <filename>local.conf</filename> file, which is
736 located in the 736 located in the
737 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: 737 <link linkend='build-directory'>Build Directory</link>:
738 Here is an example: 738 Here is an example:
739 <literallayout class='monospaced'> 739 <literallayout class='monospaced'>
740 BB_DANGLINGAPPENDS_WARNONLY = "1" 740 BB_DANGLINGAPPENDS_WARNONLY = "1"
@@ -759,7 +759,7 @@
759 Disk space monitoring is disabled by default. 759 Disk space monitoring is disabled by default.
760 To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename> 760 To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename>
761 variable to your <filename>conf/local.conf</filename> file found in the 761 variable to your <filename>conf/local.conf</filename> file found in the
762 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 762 <link linkend='build-directory'>Build Directory</link>.
763 Use the following form: 763 Use the following form:
764 <literallayout class='monospaced'> 764 <literallayout class='monospaced'>
765 BB_DISKMON_DIRS = "<replaceable>action</replaceable>,<replaceable>dir</replaceable>,<replaceable>threshold</replaceable> [...]" 765 BB_DISKMON_DIRS = "<replaceable>action</replaceable>,<replaceable>dir</replaceable>,<replaceable>threshold</replaceable> [...]"
@@ -852,7 +852,7 @@
852 Defines the disk space and free inode warning intervals. 852 Defines the disk space and free inode warning intervals.
853 To set these intervals, define the variable in your 853 To set these intervals, define the variable in your
854 <filename>conf/local.conf</filename> file in the 854 <filename>conf/local.conf</filename> file in the
855 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 855 <link linkend='build-directory'>Build Directory</link>.
856 </para> 856 </para>
857 857
858 <para> 858 <para>
@@ -936,7 +936,7 @@
936 </literallayout> 936 </literallayout>
937 Set this variable in your <filename>local.conf</filename> 937 Set this variable in your <filename>local.conf</filename>
938 file in the 938 file in the
939 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 939 <link linkend='build-directory'>Build Directory</link>.
940 </para> 940 </para>
941 </glossdef> 941 </glossdef>
942 </glossentry> 942 </glossentry>
@@ -1154,7 +1154,8 @@
1154<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 1154<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
1155 Lists the layers to enable during the build. 1155 Lists the layers to enable during the build.
1156 This variable is defined in the <filename>bblayers.conf</filename> configuration 1156 This variable is defined in the <filename>bblayers.conf</filename> configuration
1157 file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 1157 file in the
1158 <link linkend='build-directory'>Build Directory</link>.
1158 Here is an example: 1159 Here is an example:
1159 <literallayout class='monospaced'> 1160 <literallayout class='monospaced'>
1160 BBLAYERS = " \ 1161 BBLAYERS = " \
@@ -1250,7 +1251,7 @@
1250 BBMULTIFONFIG = "configA configB configC" 1251 BBMULTIFONFIG = "configA configB configC"
1251 </literallayout> 1252 </literallayout>
1252 Each configuration file you use must reside in the 1253 Each configuration file you use must reside in the
1253 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory's</ulink> 1254 <link linkend='build-directory'>Build Directory</link>
1254 <filename>conf/multiconfig</filename> directory 1255 <filename>conf/multiconfig</filename> directory
1255 (e.g. 1256 (e.g.
1256 <replaceable>build_directory</replaceable><filename>/conf/multiconfig/configA.conf</filename>). 1257 <replaceable>build_directory</replaceable><filename>/conf/multiconfig/configA.conf</filename>).
@@ -1280,7 +1281,7 @@
1280 <filename>PATH</filename> variable. 1281 <filename>PATH</filename> variable.
1281 <note> 1282 <note>
1282 If you run BitBake from a directory outside of the 1283 If you run BitBake from a directory outside of the
1283 <ulink url='&YOCTO_DOCS_DEV_URL;build-directory'>Build Directory</ulink>, 1284 <link linkend='build-directory'>Build Directory</link>,
1284 you must be sure to set 1285 you must be sure to set
1285 <filename>BBPATH</filename> to point to the 1286 <filename>BBPATH</filename> to point to the
1286 Build Directory. 1287 Build Directory.
@@ -1626,7 +1627,7 @@
1626 <para role="glossdeffirst"> 1627 <para role="glossdeffirst">
1627<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 1628<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
1628 Points to the location of the 1629 Points to the location of the
1629 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 1630 <link linkend='build-directory'>Build Directory</link>.
1630 You can define this directory indirectly through the 1631 You can define this directory indirectly through the
1631 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 1632 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
1632 and 1633 and
@@ -2595,7 +2596,7 @@
2595 You should only set this variable in the 2596 You should only set this variable in the
2596 <filename>local.conf</filename> configuration file found 2597 <filename>local.conf</filename> configuration file found
2597 in the 2598 in the
2598 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 2599 <link linkend='build-directory'>Build Directory</link>.
2599 </para> 2600 </para>
2600 2601
2601 <para> 2602 <para>
@@ -2805,7 +2806,8 @@
2805 <para role="glossdeffirst"> 2806 <para role="glossdeffirst">
2806<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 2807<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
2807 The destination directory. 2808 The destination directory.
2808 The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 2809 The location in the
2810 <link linkend='build-directory'>Build Directory</link>
2809 where components are installed by the 2811 where components are installed by the
2810 <link linkend='ref-tasks-install'><filename>do_install</filename></link> 2812 <link linkend='ref-tasks-install'><filename>do_install</filename></link>
2811 task. 2813 task.
@@ -3116,7 +3118,7 @@
3116 system uses to place images, packages, SDKs and other output 3118 system uses to place images, packages, SDKs and other output
3117 files that are ready to be used outside of the build system. 3119 files that are ready to be used outside of the build system.
3118 By default, this directory resides within the 3120 By default, this directory resides within the
3119 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 3121 <link linkend='build-directory'>Build Directory</link>
3120 as <filename>${TMPDIR}/deploy</filename>. 3122 as <filename>${TMPDIR}/deploy</filename>.
3121 </para> 3123 </para>
3122 3124
@@ -3189,7 +3191,7 @@
3189 The directory is machine-specific as it contains the 3191 The directory is machine-specific as it contains the
3190 <filename>${MACHINE}</filename> name. 3192 <filename>${MACHINE}</filename> name.
3191 By default, this directory resides within the 3193 By default, this directory resides within the
3192 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 3194 <link linkend='build-directory'>Build Directory</link>
3193 as <filename>${DEPLOY_DIR}/images/${MACHINE}/</filename>. 3195 as <filename>${DEPLOY_DIR}/images/${MACHINE}/</filename>.
3194 </para> 3196 </para>
3195 3197
@@ -3794,7 +3796,7 @@
3794 to touch it. 3796 to touch it.
3795 By default, the directory is <filename>downloads</filename> 3797 By default, the directory is <filename>downloads</filename>
3796 in the 3798 in the
3797 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 3799 <link linkend='build-directory'>Build Directory</link>.
3798 <literallayout class='monospaced'> 3800 <literallayout class='monospaced'>
3799 #DL_DIR ?= "${TOPDIR}/downloads" 3801 #DL_DIR ?= "${TOPDIR}/downloads"
3800 </literallayout> 3802 </literallayout>
@@ -4191,7 +4193,7 @@
4191 <para> 4193 <para>
4192 Typically, you configure this variable in your 4194 Typically, you configure this variable in your
4193 <filename>local.conf</filename> file, which is found in the 4195 <filename>local.conf</filename> file, which is found in the
4194 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 4196 <link linkend='build-directory'>Build Directory</link>.
4195 Although you can use this variable from within a recipe, 4197 Although you can use this variable from within a recipe,
4196 best practices dictate that you do not. 4198 best practices dictate that you do not.
4197 <note> 4199 <note>
@@ -4761,7 +4763,7 @@
4761 <para> 4763 <para>
4762 You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the 4764 You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the
4763 <filename>conf/local.conf</filename> file, which is found in the 4765 <filename>conf/local.conf</filename> file, which is found in the
4764 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to 4766 <link linkend='build-directory'>Build Directory</link>, to
4765 point to your custom <filename>fs-perms.txt</filename>. 4767 point to your custom <filename>fs-perms.txt</filename>.
4766 You can specify more than a single file permissions setting table. 4768 You can specify more than a single file permissions setting table.
4767 The paths you specify to these files must be defined within the 4769 The paths you specify to these files must be defined within the
@@ -5613,7 +5615,7 @@
5613 Typically, you configure this variable in an image recipe. 5615 Typically, you configure this variable in an image recipe.
5614 Although you can use this variable from your 5616 Although you can use this variable from your
5615 <filename>local.conf</filename> file, which is found in the 5617 <filename>local.conf</filename> file, which is found in the
5616 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, 5618 <link linkend='build-directory'>Build Directory</link>,
5617 best practices dictate that you do not. 5619 best practices dictate that you do not.
5618 <note> 5620 <note>
5619 To enable extra features from outside the image recipe, 5621 To enable extra features from outside the image recipe,
@@ -6562,7 +6564,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6562 The combined binary is deposited into the 6564 The combined binary is deposited into the
6563 <filename>tmp/deploy</filename> directory, which is part 6565 <filename>tmp/deploy</filename> directory, which is part
6564 of the 6566 of the
6565 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 6567 <link linkend='build-directory'>Build Directory</link>.
6566 </para> 6568 </para>
6567 6569
6568 <para> 6570 <para>
@@ -7941,7 +7943,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7941 Specifies the target device for which the image is built. 7943 Specifies the target device for which the image is built.
7942 You define <filename>MACHINE</filename> in the 7944 You define <filename>MACHINE</filename> in the
7943 <filename>local.conf</filename> file found in the 7945 <filename>local.conf</filename> file found in the
7944 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 7946 <link linkend='build-directory'>Build Directory</link>.
7945 By default, <filename>MACHINE</filename> is set to 7947 By default, <filename>MACHINE</filename> is set to
7946 "qemux86", which is an x86-based architecture machine to 7948 "qemux86", which is an x86-based architecture machine to
7947 be emulated using QEMU: 7949 be emulated using QEMU:
@@ -9085,7 +9087,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9085 This variable, which is set in the 9087 This variable, which is set in the
9086 <filename>local.conf</filename> configuration file found in 9088 <filename>local.conf</filename> configuration file found in
9087 the <filename>conf</filename> folder of the 9089 the <filename>conf</filename> folder of the
9088 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, 9090 <link linkend='build-directory'>Build Directory</link>,
9089 specifies the package manager the OpenEmbedded build system 9091 specifies the package manager the OpenEmbedded build system
9090 uses when packaging data. 9092 uses when packaging data.
9091 </para> 9093 </para>
@@ -10531,7 +10533,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10531 build system to attempt before any others by adding 10533 build system to attempt before any others by adding
10532 something like the following to the 10534 something like the following to the
10533 <filename>local.conf</filename> configuration file in the 10535 <filename>local.conf</filename> configuration file in the
10534 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: 10536 <link linkend='build-directory'>Build Directory</link>:
10535 <literallayout class='monospaced'> 10537 <literallayout class='monospaced'>
10536 PREMIRRORS_prepend = "\ 10538 PREMIRRORS_prepend = "\
10537 git://.*/.* http://www.yoctoproject.org/sources/ \n \ 10539 git://.*/.* http://www.yoctoproject.org/sources/ \n \
@@ -11493,7 +11495,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
11493 <para role="glossdeffirst"> 11495 <para role="glossdeffirst">
11494<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 11496<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
11495 The location in the 11497 The location in the
11496 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 11498 <link linkend='build-directory'>Build Directory</link>
11497 where unpacked recipe source code resides. 11499 where unpacked recipe source code resides.
11498 By default, this directory is 11500 By default, this directory is
11499 <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/${</filename><link linkend='var-BPN'><filename>BPN</filename></link><filename>}-${</filename><link linkend='var-PV'><filename>PV</filename></link><filename>}</filename>, 11501 <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/${</filename><link linkend='var-BPN'><filename>BPN</filename></link><filename>}-${</filename><link linkend='var-PV'><filename>PV</filename></link><filename>}</filename>,
@@ -12411,7 +12413,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
12411 To enable file removal, set the variable to "1" in your 12413 To enable file removal, set the variable to "1" in your
12412 <filename>conf/local.conf</filename> configuration file 12414 <filename>conf/local.conf</filename> configuration file
12413 in your: 12415 in your:
12414 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 12416 <link linkend='build-directory'>Build Directory</link>.
12415 <literallayout class='monospaced'> 12417 <literallayout class='monospaced'>
12416 SKIP_FILEDEPS = "1" 12418 SKIP_FILEDEPS = "1"
12417 </literallayout> 12419 </literallayout>
@@ -14263,7 +14265,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14263 The suffix identifies the <filename>libc</filename> variant 14265 The suffix identifies the <filename>libc</filename> variant
14264 for building. 14266 for building.
14265 When you are building for multiple variants with the same 14267 When you are building for multiple variants with the same
14266 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, 14268 <link linkend='build-directory'>Build Directory</link>,
14267 this mechanism ensures that output for different 14269 this mechanism ensures that output for different
14268 <filename>libc</filename> variants is kept separate to 14270 <filename>libc</filename> variants is kept separate to
14269 avoid potential conflicts. 14271 avoid potential conflicts.
@@ -14421,7 +14423,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14421 <filename>ssh</filename>. 14423 <filename>ssh</filename>.
14422 You can set this variable to "1" in your 14424 You can set this variable to "1" in your
14423 <filename>local.conf</filename> file in the 14425 <filename>local.conf</filename> file in the
14424 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 14426 <link linkend='build-directory'>Build Directory</link>
14425 to have the OpenEmbedded build system automatically run 14427 to have the OpenEmbedded build system automatically run
14426 these tests after an image successfully builds: 14428 these tests after an image successfully builds:
14427 <literallayout class='monospaced'> 14429 <literallayout class='monospaced'>
@@ -14789,7 +14791,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14789 files (other than the shared state cache). 14791 files (other than the shared state cache).
14790 By default, the <filename>TMPDIR</filename> variable points 14792 By default, the <filename>TMPDIR</filename> variable points
14791 to <filename>tmp</filename> within the 14793 to <filename>tmp</filename> within the
14792 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 14794 <link linkend='build-directory'>Build Directory</link>.
14793 </para> 14795 </para>
14794 14796
14795 <para> 14797 <para>
@@ -14924,7 +14926,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14924 <para role="glossdeffirst"> 14926 <para role="glossdeffirst">
14925<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 14927<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
14926 The top-level 14928 The top-level
14927 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 14929 <link linkend='build-directory'>Build Directory</link>.
14928 BitBake automatically sets this variable when you 14930 BitBake automatically sets this variable when you
14929 initialize your build environment using either 14931 initialize your build environment using either
14930 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 14932 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>