summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml90
1 files changed, 47 insertions, 43 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 7025041f23..a5d5ea2ab9 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -714,7 +714,7 @@ Core layer for images cannot be removed
714 <glossdef> 714 <glossdef>
715 <para> 715 <para>
716 Points to the server that runs memory-resident BitBake. 716 Points to the server that runs memory-resident BitBake.
717 This variable is set by the 717 This variable is set by the
718 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> 718 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>
719 setup script and should not be hand-edited. 719 setup script and should not be hand-edited.
720 The variable is only used when you employ memory-resident 720 The variable is only used when you employ memory-resident
@@ -723,10 +723,10 @@ Core layer for images cannot be removed
723 <literallayout class='monospaced'> 723 <literallayout class='monospaced'>
724 export BBSERVER=localhost:$port 724 export BBSERVER=localhost:$port
725 </literallayout> 725 </literallayout>
726 For more information on how the 726 For more information on how the
727 <filename>BBSERVER</filename> is used, see the 727 <filename>BBSERVER</filename> is used, see the
728 <filename>oe-init-build-env-memres</filename> script, which 728 <filename>oe-init-build-env-memres</filename> script, which
729 is located in the 729 is located in the
730 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. 730 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
731 </para> 731 </para>
732 </glossdef> 732 </glossdef>
@@ -789,9 +789,9 @@ Core layer for images cannot be removed
789 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 789 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
790 You can define this directory indirectly through the 790 You can define this directory indirectly through the
791 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 791 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
792 and 792 and
793 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> 793 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>
794 scripts by passing in a Build Directory path when you run 794 scripts by passing in a Build Directory path when you run
795 the scripts. 795 the scripts.
796 If you run the scripts and do not provide a Build Directory 796 If you run the scripts and do not provide a Build Directory
797 path, the <filename>BUILDDIR</filename> defaults to 797 path, the <filename>BUILDDIR</filename> defaults to
@@ -1230,39 +1230,39 @@ Core layer for images cannot be removed
1230 <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> 1230 <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm>
1231 <glossdef> 1231 <glossdef>
1232 <para> 1232 <para>
1233 The central download directory used by the build process to 1233 The central download directory used by the build process to
1234 store downloads. 1234 store downloads.
1235 You can set this directory by defining the 1235 You can set this directory by defining the
1236 <filename>DL_DIR</filename> variable in the 1236 <filename>DL_DIR</filename> variable in the
1237 <filename>/conf/local.conf</filename> file. 1237 <filename>/conf/local.conf</filename> file.
1238 This directory is self-maintaining and you should not have 1238 This directory is self-maintaining and you should not have
1239 to touch it. 1239 to touch it.
1240 By default, the directory is <filename>downloads</filename> 1240 By default, the directory is <filename>downloads</filename>
1241 in the 1241 in the
1242 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 1242 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
1243 <literallayout class='monospaced'> 1243 <literallayout class='monospaced'>
1244 #DL_DIR ?= "${TOPDIR}/downloads" 1244 #DL_DIR ?= "${TOPDIR}/downloads"
1245 </literallayout> 1245 </literallayout>
1246 To specify a different download directory, simply remove 1246 To specify a different download directory, simply remove
1247 the comment from the line and provide your directory. 1247 the comment from the line and provide your directory.
1248 </para> 1248 </para>
1249 1249
1250 <para> 1250 <para>
1251 During a first build, the system downloads many different 1251 During a first build, the system downloads many different
1252 source code tarballs from various upstream projects. 1252 source code tarballs from various upstream projects.
1253 Downloading can take a while, particularly if your network 1253 Downloading can take a while, particularly if your network
1254 connection is slow. 1254 connection is slow.
1255 Tarballs are all stored in the directory defined by 1255 Tarballs are all stored in the directory defined by
1256 <filename>DL_DIR</filename> and the build system looks there 1256 <filename>DL_DIR</filename> and the build system looks there
1257 first to find source tarballs. 1257 first to find source tarballs.
1258 <note> 1258 <note>
1259 When wiping and rebuilding, you can preserve this 1259 When wiping and rebuilding, you can preserve this
1260 directory to speed up this part of subsequent builds. 1260 directory to speed up this part of subsequent builds.
1261 </note> 1261 </note>
1262 </para> 1262 </para>
1263 1263
1264 <para> 1264 <para>
1265 You can safely share this directory between multiple builds 1265 You can safely share this directory between multiple builds
1266 on the same development machine. 1266 on the same development machine.
1267 For additional information on how the build process gets 1267 For additional information on how the build process gets
1268 source files when working behind a firewall or proxy server, 1268 source files when working behind a firewall or proxy server,
@@ -1801,25 +1801,25 @@ Core layer for images cannot be removed
1801 <glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm> 1801 <glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm>
1802 <glossdef> 1802 <glossdef>
1803 <para> 1803 <para>
1804 A list of classes that all images should inherit. 1804 A list of classes that all images should inherit.
1805 You typically use this variable to specify the list of 1805 You typically use this variable to specify the list of
1806 classes that register the different types of images 1806 classes that register the different types of images
1807 the OpenEmbedded build system creates. 1807 the OpenEmbedded build system creates.
1808 </para> 1808 </para>
1809 1809
1810 <para> 1810 <para>
1811 The default value for <filename>IMAGE_CLASSES</filename> is 1811 The default value for <filename>IMAGE_CLASSES</filename> is
1812 <filename>image_types.bbclass</filename>. 1812 <filename>image_types.bbclass</filename>.
1813 You can set this variable in your 1813 You can set this variable in your
1814 <filename>local.conf</filename> or in a distribution 1814 <filename>local.conf</filename> or in a distribution
1815 configuration file. 1815 configuration file.
1816 </para> 1816 </para>
1817 1817
1818 <para> 1818 <para>
1819 For more information, see 1819 For more information, see
1820 <filename>meta/classes/image_types.bbclass</filename> in the 1820 <filename>meta/classes/image_types.bbclass</filename> in the
1821 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. 1821 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
1822 </para> 1822 </para>
1823 </glossdef> 1823 </glossdef>
1824 </glossentry> 1824 </glossentry>
1825 1825
@@ -1982,7 +1982,7 @@ Core layer for images cannot be removed
1982 <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm> 1982 <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm>
1983 <glossdef> 1983 <glossdef>
1984 <para> 1984 <para>
1985 Added by classes to run post processing commands once the 1985 Added by classes to run post processing commands once the
1986 OpenEmbedded build system has created the image. 1986 OpenEmbedded build system has created the image.
1987 You can specify shell commands and, if necessary, the path 1987 You can specify shell commands and, if necessary, the path
1988 to the root filesystem image: 1988 to the root filesystem image:
@@ -1996,8 +1996,8 @@ Core layer for images cannot be removed
1996 <glossentry id='var-IMAGE_ROOTFS'><glossterm>IMAGE_ROOTFS</glossterm> 1996 <glossentry id='var-IMAGE_ROOTFS'><glossterm>IMAGE_ROOTFS</glossterm>
1997 <glossdef> 1997 <glossdef>
1998 <para> 1998 <para>
1999 The location of the root filesystem. 1999 The location of the root filesystem.
2000 This variable is not configurable. 2000 This variable is not configurable.
2001 Do not change it. 2001 Do not change it.
2002 </para> 2002 </para>
2003 </glossdef> 2003 </glossdef>
@@ -3411,17 +3411,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3411 The directory from which the top-level build environment 3411 The directory from which the top-level build environment
3412 setup script is sourced. 3412 setup script is sourced.
3413 The Yocto Project makes two top-level build environment 3413 The Yocto Project makes two top-level build environment
3414 setup scripts available: 3414 setup scripts available:
3415 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 3415 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
3416 and 3416 and
3417 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>. 3417 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>.
3418 When you run one of these scripts, the 3418 When you run one of these scripts, the
3419 <filename>OEROOT</filename> variable resolves to the 3419 <filename>OEROOT</filename> variable resolves to the
3420 directory that holds the script. 3420 directory that holds the script.
3421 </para> 3421 </para>
3422 3422
3423 <para> 3423 <para>
3424 For additional information on how this variable is used, 3424 For additional information on how this variable is used,
3425 see the initialization scripts. 3425 see the initialization scripts.
3426 </para> 3426 </para>
3427 </glossdef> 3427 </glossdef>
@@ -3710,15 +3710,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3710 3710
3711 <para> 3711 <para>
3712 The default value of "noop" causes the build to simply fail 3712 The default value of "noop" causes the build to simply fail
3713 when the OpenEmbedded build system cannot successfully 3713 when the OpenEmbedded build system cannot successfully
3714 apply a patch. 3714 apply a patch.
3715 Setting the value to "user" causes the build system to 3715 Setting the value to "user" causes the build system to
3716 launch a shell and places you in the right location so that 3716 launch a shell and places you in the right location so that
3717 you can manually resolve the conflicts. 3717 you can manually resolve the conflicts.
3718 </para> 3718 </para>
3719 3719
3720 <para> 3720 <para>
3721 Set this variable in your 3721 Set this variable in your
3722 <filename>local.conf</filename> file. 3722 <filename>local.conf</filename> file.
3723 </para> 3723 </para>
3724 </glossdef> 3724 </glossdef>
@@ -4169,13 +4169,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4169 <glossentry id='var-ROOTFS_POSTPROCESS_COMMAND'><glossterm>ROOTFS_POSTPROCESS_COMMAND</glossterm> 4169 <glossentry id='var-ROOTFS_POSTPROCESS_COMMAND'><glossterm>ROOTFS_POSTPROCESS_COMMAND</glossterm>
4170 <glossdef> 4170 <glossdef>
4171 <para> 4171 <para>
4172 Added by classes to run post processing commands once the 4172 Added by classes to run post processing commands once the
4173 OpenEmbedded build system has created the root filesystem. 4173 OpenEmbedded build system has created the root filesystem.
4174 You can specify shell commands and, if necessary, the path 4174 You can specify shell commands and, if necessary, the path
4175 to the root filesystem image: 4175 to the root filesystem image:
4176 <literallayout class='monospaced'> 4176 <literallayout class='monospaced'>
4177 ROOTFS_POSTPROCESS_COMMAND += "${IMAGE_ROOTFS}&lt;shell_command&gt;; ... " 4177 ROOTFS_POSTPROCESS_COMMAND += "&lt;shell_command&gt;; ... "
4178 </literallayout> 4178 </literallayout>
4179 If you need to pass the path to the root filesystem within
4180 the command, you can use
4181 <filename>${IMAGE_ROOTFS}</filename>, which points to
4182 the root filesystem image.
4179 </para> 4183 </para>
4180 </glossdef> 4184 </glossdef>
4181 </glossentry> 4185 </glossentry>
@@ -5167,22 +5171,22 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5167 <glossentry id='var-USER_CLASSES'><glossterm>USER_CLASSES</glossterm> 5171 <glossentry id='var-USER_CLASSES'><glossterm>USER_CLASSES</glossterm>
5168 <glossdef> 5172 <glossdef>
5169 <para> 5173 <para>
5170 A list of classes to globally inherit. 5174 A list of classes to globally inherit.
5171 These classes are used by the OpenEmbedded build system 5175 These classes are used by the OpenEmbedded build system
5172 to enable extra features (e.g. 5176 to enable extra features (e.g.
5173 <filename>buildstats</filename>, 5177 <filename>buildstats</filename>,
5174 <filename>image-mklibs</filename>, and so forth). 5178 <filename>image-mklibs</filename>, and so forth).
5175 </para> 5179 </para>
5176 5180
5177 <para> 5181 <para>
5178 The default list is set in your 5182 The default list is set in your
5179 <filename>local.conf</filename> file: 5183 <filename>local.conf</filename> file:
5180 <literallayout class='monospaced'> 5184 <literallayout class='monospaced'>
5181 USER_CLASSES ?= "buildstats image-mklibs image-prelink" 5185 USER_CLASSES ?= "buildstats image-mklibs image-prelink"
5182 </literallayout> 5186 </literallayout>
5183 For more information, see 5187 For more information, see
5184 <filename>meta-yocto/conf/local.conf.sample</filename> in 5188 <filename>meta-yocto/conf/local.conf.sample</filename> in
5185 the 5189 the
5186 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. 5190 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
5187 </para> 5191 </para>
5188 </glossdef> 5192 </glossdef>