From: Kristi Rifenbark Date: Tue, 9 Jan 2018 22:10:26 +0000 (-0800) Subject: ref-manual: Variable Descriptions for documentation.conf X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=bb6a218b6f309582af2cf62c14501c57b3662ed8;p=thirdparty%2Fopenembedded%2Fopenembedded-core-contrib.git ref-manual: Variable Descriptions for documentation.conf Fixes [YOCTO #5600] Grammar scrub on all variable description for documentation.conf (From yocto-docs rev: 3054b1e4649d232f08f1065bad96b90eed57d517) Signed-off-by: Kristi Rifenbark Signed-off-by: Richard Purdie --- diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 8baa0c0f076..3142b3f9e6a 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -72,12 +72,13 @@ ALLOW_EMPTY - ALLOW_EMPTY[doc] = "Specifies if an output package should still be produced if it is empty." + ALLOW_EMPTY[doc] = "Specifies whether to produce an output package even if it is empty." - Specifies if an output package should still be produced if it is empty. + Specifies whether to produce an output package even if it is + empty. By default, BitBake does not produce empty packages. This default behavior can cause issues when there is an RDEPENDS or @@ -1005,7 +1006,7 @@ BBCLASSEXTEND - 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." + 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." @@ -1593,12 +1594,12 @@ BUILD_CPPFLAGS - 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." + 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." - Specifies the flags to pass to the C pre-processor + 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. When building in the -native context, @@ -3308,13 +3309,13 @@ DEPLOY_DIR - 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." + 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." Points to the general area that the OpenEmbedded build - system uses to place images, packages, SDKs and other output + system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system. By default, this directory resides within the Build Directory @@ -3340,7 +3341,7 @@ DEPLOY_DIR_DEB - 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." + 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." @@ -3412,7 +3413,7 @@ DEPLOY_DIR_IPK - 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." + 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." @@ -3451,7 +3452,7 @@ DEPLOY_DIR_RPM - 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." + 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." @@ -3490,7 +3491,7 @@ DEPLOY_DIR_TAR - 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." + 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." @@ -5131,13 +5132,13 @@ GLIBC_GENERATE_LOCALES - 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." + 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." Specifies the list of GLIBC locales to generate should you - not wish generate all LIBC locals, which can be time + not wish to generate all LIBC locals, which can be time consuming. If you specifically remove the locale @@ -5407,7 +5408,7 @@ HOST_SYS - 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." + 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." @@ -5720,7 +5721,7 @@ IMAGE_BOOT_FILES - 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)." + 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)." @@ -5940,15 +5941,17 @@ IMAGE_INSTALL - 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." + IMAGE_INSTALL[doc] = "Used by recipes to specify the packages to install into an image through image.bbclass." - Specifies the packages to install into an image. - The IMAGE_INSTALL variable is a - mechanism for an image recipe and you should use it - with care to avoid ordering issues. + Used by recipes to specify the packages to install into an + image through the + image + class. + You should use the IMAGE_INSTALL + variable with care to avoid ordering issues. When working with an core-image-minimal-initramfs