summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml43
1 files changed, 23 insertions, 20 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 8baa0c0f07..3142b3f9e6 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -72,12 +72,13 @@
72 72
73 <glossentry id='var-ALLOW_EMPTY'><glossterm>ALLOW_EMPTY</glossterm> 73 <glossentry id='var-ALLOW_EMPTY'><glossterm>ALLOW_EMPTY</glossterm>
74 <info> 74 <info>
75 ALLOW_EMPTY[doc] = "Specifies if an output package should still be produced if it is empty." 75 ALLOW_EMPTY[doc] = "Specifies whether to produce an output package even if it is empty."
76 </info> 76 </info>
77 <glossdef> 77 <glossdef>
78 <para role="glossdeffirst"> 78 <para role="glossdeffirst">
79<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 79<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
80 Specifies if an output package should still be produced if it is empty. 80 Specifies whether to produce an output package even if it is
81 empty.
81 By default, BitBake does not produce empty packages. 82 By default, BitBake does not produce empty packages.
82 This default behavior can cause issues when there is an 83 This default behavior can cause issues when there is an
83 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> or 84 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> or
@@ -1005,7 +1006,7 @@
1005 1006
1006 <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm> 1007 <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm>
1007 <info> 1008 <info>
1008 BBCLASSEXTEND[doc] = "Allows you to extend a recipe so that it builds variants of the software. Common variants for recipes are 'native', 'cross', 'nativesdk' and multilibs." 1009 BBCLASSEXTEND[doc] = "Allows you to extend a recipe so that it builds variants of the software. Common variants for recipes are 'native', 'cross', 'nativesdk', and multilibs."
1009 </info> 1010 </info>
1010 <glossdef> 1011 <glossdef>
1011 <para role="glossdeffirst"> 1012 <para role="glossdeffirst">
@@ -1593,12 +1594,12 @@
1593 1594
1594 <glossentry id='var-BUILD_CPPFLAGS'><glossterm>BUILD_CPPFLAGS</glossterm> 1595 <glossentry id='var-BUILD_CPPFLAGS'><glossterm>BUILD_CPPFLAGS</glossterm>
1595 <info> 1596 <info>
1596 BUILD_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the build host." 1597 BUILD_CPPFLAGS[doc] = "Specifies the flags to pass to the C preprocessor (i.e. to both the C and the C++ compilers) when building for the build host."
1597 </info> 1598 </info>
1598 <glossdef> 1599 <glossdef>
1599 <para role="glossdeffirst"> 1600 <para role="glossdeffirst">
1600<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 1601<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
1601 Specifies the flags to pass to the C pre-processor 1602 Specifies the flags to pass to the C preprocessor
1602 (i.e. to both the C and the C++ compilers) when building 1603 (i.e. to both the C and the C++ compilers) when building
1603 for the build host. 1604 for the build host.
1604 When building in the <filename>-native</filename> context, 1605 When building in the <filename>-native</filename> context,
@@ -3308,13 +3309,13 @@
3308 3309
3309 <glossentry id='var-DEPLOY_DIR'><glossterm>DEPLOY_DIR</glossterm> 3310 <glossentry id='var-DEPLOY_DIR'><glossterm>DEPLOY_DIR</glossterm>
3310 <info> 3311 <info>
3311 DEPLOY_DIR[doc] = "Points to the general area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." 3312 DEPLOY_DIR[doc] = "Points to the general area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system."
3312 </info> 3313 </info>
3313 <glossdef> 3314 <glossdef>
3314 <para role="glossdeffirst"> 3315 <para role="glossdeffirst">
3315<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 3316<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
3316 Points to the general area that the OpenEmbedded build 3317 Points to the general area that the OpenEmbedded build
3317 system uses to place images, packages, SDKs and other output 3318 system uses to place images, packages, SDKs, and other output
3318 files that are ready to be used outside of the build system. 3319 files that are ready to be used outside of the build system.
3319 By default, this directory resides within the 3320 By default, this directory resides within the
3320 <link linkend='build-directory'>Build Directory</link> 3321 <link linkend='build-directory'>Build Directory</link>
@@ -3340,7 +3341,7 @@
3340 3341
3341 <glossentry id='var-DEPLOY_DIR_DEB'><glossterm>DEPLOY_DIR_DEB</glossterm> 3342 <glossentry id='var-DEPLOY_DIR_DEB'><glossterm>DEPLOY_DIR_DEB</glossterm>
3342 <info> 3343 <info>
3343 DEPLOY_DIR_DEB[doc] = "Points to a Debian-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." 3344 DEPLOY_DIR_DEB[doc] = "Points to a Debian-specific area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system."
3344 </info> 3345 </info>
3345 <glossdef> 3346 <glossdef>
3346 <para role="glossdeffirst"> 3347 <para role="glossdeffirst">
@@ -3412,7 +3413,7 @@
3412 3413
3413 <glossentry id='var-DEPLOY_DIR_IPK'><glossterm>DEPLOY_DIR_IPK</glossterm> 3414 <glossentry id='var-DEPLOY_DIR_IPK'><glossterm>DEPLOY_DIR_IPK</glossterm>
3414 <info> 3415 <info>
3415 DEPLOY_DIR_IPK[doc] = "Points to a IPK-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." 3416 DEPLOY_DIR_IPK[doc] = "Points to a IPK-specific area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system."
3416 </info> 3417 </info>
3417 <glossdef> 3418 <glossdef>
3418 <para role="glossdeffirst"> 3419 <para role="glossdeffirst">
@@ -3451,7 +3452,7 @@
3451 3452
3452 <glossentry id='var-DEPLOY_DIR_RPM'><glossterm>DEPLOY_DIR_RPM</glossterm> 3453 <glossentry id='var-DEPLOY_DIR_RPM'><glossterm>DEPLOY_DIR_RPM</glossterm>
3453 <info> 3454 <info>
3454 DEPLOY_DIR_RPM[doc] = "Points to a RPM-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." 3455 DEPLOY_DIR_RPM[doc] = "Points to a RPM-specific area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system."
3455 </info> 3456 </info>
3456 <glossdef> 3457 <glossdef>
3457 <para role="glossdeffirst"> 3458 <para role="glossdeffirst">
@@ -3490,7 +3491,7 @@
3490 3491
3491 <glossentry id='var-DEPLOY_DIR_TAR'><glossterm>DEPLOY_DIR_TAR</glossterm> 3492 <glossentry id='var-DEPLOY_DIR_TAR'><glossterm>DEPLOY_DIR_TAR</glossterm>
3492 <info> 3493 <info>
3493 DEPLOY_DIR_TAR[doc] = "Points to a tarball area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." 3494 DEPLOY_DIR_TAR[doc] = "Points to a tarball area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system."
3494 </info> 3495 </info>
3495 <glossdef> 3496 <glossdef>
3496 <para role="glossdeffirst"> 3497 <para role="glossdeffirst">
@@ -5131,13 +5132,13 @@
5131 5132
5132 <glossentry id='var-GLIBC_GENERATE_LOCALES'><glossterm>GLIBC_GENERATE_LOCALES</glossterm> 5133 <glossentry id='var-GLIBC_GENERATE_LOCALES'><glossterm>GLIBC_GENERATE_LOCALES</glossterm>
5133 <info> 5134 <info>
5134 GLIBC_GENERATE_LOCALES[doc]= "Specifies the list of GLIBC locales to generate should you not wish generate all LIBC locals, which can be time consuming." 5135 GLIBC_GENERATE_LOCALES[doc]= "Specifies the list of GLIBC locales to generate should you not wish to generate all LIBC locals, which can be time consuming."
5135 </info> 5136 </info>
5136 <glossdef> 5137 <glossdef>
5137 <para role="glossdeffirst"> 5138 <para role="glossdeffirst">
5138<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 5139<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
5139 Specifies the list of GLIBC locales to generate should you 5140 Specifies the list of GLIBC locales to generate should you
5140 not wish generate all LIBC locals, which can be time 5141 not wish to generate all LIBC locals, which can be time
5141 consuming. 5142 consuming.
5142 <note> 5143 <note>
5143 If you specifically remove the locale 5144 If you specifically remove the locale
@@ -5407,7 +5408,7 @@
5407 5408
5408 <glossentry id='var-HOST_SYS'><glossterm>HOST_SYS</glossterm> 5409 <glossentry id='var-HOST_SYS'><glossterm>HOST_SYS</glossterm>
5409 <info> 5410 <info>
5410 HOST_SYS[doc] = "Specifies the system, including the architecture and the operating system, for with the build is occurring in the context of the current recipe." 5411 HOST_SYS[doc] = "Specifies the system, including the architecture and the operating system, for which the build is occurring in the context of the current recipe."
5411 </info> 5412 </info>
5412 <glossdef> 5413 <glossdef>
5413 <para role="glossdeffirst"> 5414 <para role="glossdeffirst">
@@ -5720,7 +5721,7 @@
5720 5721
5721 <glossentry id='var-IMAGE_BOOT_FILES'><glossterm>IMAGE_BOOT_FILES</glossterm> 5722 <glossentry id='var-IMAGE_BOOT_FILES'><glossterm>IMAGE_BOOT_FILES</glossterm>
5722 <info> 5723 <info>
5723 IMAGE_BOOT_FILES[doc] = "Whitespace separated list of files from ${DEPLOY_DIR_IMAGE} to place in boot partition. Entries will be installed under a same name as the source file. To change the destination file name, pass a desired name after a semicolon (eg. u-boot.img;uboot)." 5724 IMAGE_BOOT_FILES[doc] = "A space-separated list of files from ${DEPLOY_DIR_IMAGE} to place in boot partition. Entries will be installed under a same name as the source file. To change the destination file name, pass a desired name after a semicolon (eg. u-boot.img;uboot)."
5724 </info> 5725 </info>
5725 <glossdef> 5726 <glossdef>
5726 <para role="glossdeffirst"> 5727 <para role="glossdeffirst">
@@ -5940,15 +5941,17 @@
5940 5941
5941 <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm> 5942 <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm>
5942 <info> 5943 <info>
5943 IMAGE_INSTALL[doc] = "Specifies the packages to install into an image. Image recipes set IMAGE_INSTALL to specify the packages to install into an image through image.bbclass." 5944 IMAGE_INSTALL[doc] = "Used by recipes to specify the packages to install into an image through image.bbclass."
5944 </info> 5945 </info>
5945 <glossdef> 5946 <glossdef>
5946 <para role="glossdeffirst"> 5947 <para role="glossdeffirst">
5947<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 5948<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
5948 Specifies the packages to install into an image. 5949 Used by recipes to specify the packages to install into an
5949 The <filename>IMAGE_INSTALL</filename> variable is a 5950 image through the
5950 mechanism for an image recipe and you should use it 5951 <link linkend='ref-classes-image'><filename>image</filename></link>
5951 with care to avoid ordering issues. 5952 class.
5953 You should use the <filename>IMAGE_INSTALL</filename>
5954 variable with care to avoid ordering issues.
5952 <note> 5955 <note>
5953 When working with an 5956 When working with an
5954 <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link> 5957 <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link>