From a59c06833cff0ae020b796ce81aee84e45a31e64 Mon Sep 17 00:00:00 2001 From: Kristi Rifenbark Date: Thu, 11 Jan 2018 15:56:12 -0800 Subject: ref-manual: Variable Definition Edits for documentation.conf Fixes [YOCTO #5600] Grammar scrub of variable definitions in documentation.conf (From yocto-docs rev: 199fdc55aae4f34d95988ee2e43f3524fe82714a) Signed-off-by: Kristi Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-variables.xml | 99 +++++++++++++++--------------- 1 file changed, 49 insertions(+), 50 deletions(-) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 3142b3f9e6..29f227e58c 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -6159,12 +6159,12 @@ IMAGE_PKGTYPE - IMAGE_PKGTYPE[doc] = "Defines the package type (DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system." + IMAGE_PKGTYPE[doc] = "Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system." - Defines the package type (DEB, RPM, IPK, or TAR) used + Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system. The variable is defined appropriately by the package_deb, @@ -6211,13 +6211,13 @@ IMAGE_POSTPROCESS_COMMAND - IMAGE_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created the final image output files." + IMAGE_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system creates the final image output files." Specifies a list of functions to call once the - OpenEmbedded build system has created the final image + OpenEmbedded build system creates the final image output files. You can specify functions separated by semicolons: @@ -6239,13 +6239,13 @@ IMAGE_PREPROCESS_COMMAND - IMAGE_PREPROCESS_COMMAND[doc] = "Specifies a list of functions to call before the OpenEmbedded build system has created the final image output files." + IMAGE_PREPROCESS_COMMAND[doc] = "Specifies a list of functions to call before the OpenEmbedded build system creates the final image output files." Specifies a list of functions to call before the - OpenEmbedded build system has created the final image + OpenEmbedded build system creates the final image output files. You can specify functions separated by semicolons: @@ -7111,7 +7111,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" KBRANCH - KBRANCH[doc] = "A regular expression used by the build process to explicitly identify the kernel branch that is validated, patched and configured during a build." + KBRANCH[doc] = "A regular expression used by the build process to explicitly identify the kernel branch that is validated, patched, and configured during a build." @@ -7258,7 +7258,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" KERNEL_DEVICETREE - KERNEL_DEVICETREE[doc] = "Specifies the name of the generated Linux kernel device tree (i.e. the .dtb) file." + KERNEL_DEVICETREE[doc] = "Specifies the name of the generated Linux kernel device tree (i.e. the .dtb) file." @@ -7869,13 +7869,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" LEAD_SONAME - LEAD_SONAME[doc] = "Specifies the lead (or primary) compiled library file (.so) that the debian class applies its naming policy to given a recipe that packages multiple libraries." + LEAD_SONAME[doc] = "Specifies the lead (or primary) compiled library file (i.e. .so) that the debian class applies its naming policy to given a recipe that packages multiple libraries." Specifies the lead (or primary) compiled library file - (.so) that the + (i.e. .so) that the debian class applies its naming policy to given a recipe that packages multiple libraries. @@ -8289,7 +8289,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" MACHINE_ESSENTIAL_EXTRA_RDEPENDS - MACHINE_ESSENTIAL_EXTRA_RDEPENDS[doc] = "A list of required machine-specific packages to install as part of the image being built. Because this is a 'machine essential' variable, the list of packages are essential for the machine to boot." + MACHINE_ESSENTIAL_EXTRA_RDEPENDS[doc] = "A list of required machine-specific packages to install as part of the image being built. Because this is a 'machine-essential' variable, the list of packages are essential for the machine to boot." @@ -8297,7 +8297,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" A list of required machine-specific packages to install as part of the image being built. The build process depends on these packages being present. - Furthermore, because this is a "machine essential" variable, the list of + Furthermore, because this is a "machine-essential" variable, the list of packages are essential for the machine to boot. The impact of this variable affects images based on packagegroup-core-boot, @@ -8326,7 +8326,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS - MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS[doc] = "A list of recommended machine-specific packages to install as part of the image being built. Because this is a 'machine essential' variable, the list of packages are essential for the machine to boot." + MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS[doc] = "A list of recommended machine-specific packages to install as part of the image being built. Because this is a 'machine-essential' variable, the list of packages are essential for the machine to boot." @@ -8334,7 +8334,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" A list of recommended machine-specific packages to install as part of the image being built. The build process does not depend on these packages being present. - However, because this is a "machine essential" variable, the list of + However, because this is a "machine-essential" variable, the list of packages are essential for the machine to boot. The impact of this variable affects images based on packagegroup-core-boot, @@ -8632,14 +8632,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" MLPREFIX - MLPREFIX[doc] = "Specifies a prefix has been added to PN to create a special version of a recipe or package, such as a Multilib version." + MLPREFIX[doc] = "Specifies a prefix has been added to PN to create a special version of a recipe or package (i.e. a Multilib version)." Specifies a prefix has been added to PN to create a special version - of a recipe or package, such as a Multilib version. + of a recipe or package (i.e. a Multilib version). The variable is used in places where the prefix needs to be added to or removed from a the name (e.g. the BPN variable). @@ -8930,7 +8930,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" NO_RECOMMENDATIONS - NO_RECOMMENDATIONS[doc] = "When set to '1', no recommended packages will be installed. Realize that some recommended packages might be required for certain system functionality, such as kernel-modules. It is up to the user to add packages to IMAGE_INSTALL as needed." + NO_RECOMMENDATIONS[doc] = "When set to '1', no recommended packages will be installed. Some recommended packages might be required for certain system functionality, such as kernel-modules. It is up to the user to add packages to IMAGE_INSTALL as needed." @@ -10014,12 +10014,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" PACKAGES - PACKAGES[doc] = "The list of packages to be created from the recipe." + PACKAGES[doc] = "The list of packages the recipe creates." - The list of packages to be created from the recipe. + The list of packages the recipe creates. The default value is the following: ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN} @@ -10517,7 +10517,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" PN - PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. It refers to a package name in the context of a file created or produced by the OpenEmbedded build system." + PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. @@ -10858,7 +10858,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" PRIORITY - PRIORITY[doc] = "Indicates the importance of a package. The default value is 'optional'. Other standard values are 'required', 'standard' and 'extra'." + PRIORITY[doc] = "Indicates the importance of a package. The default value is 'optional'. Other standard values are 'required', 'standard', and 'extra'." @@ -12200,13 +12200,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SDK_POSTPROCESS_COMMAND - SDK_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created the SDK." + SDK_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system creates the SDK." Specifies a list of functions to call once the - OpenEmbedded build system has created the SDK. + OpenEmbedded build system creates the SDK. You can specify functions separated by semicolons: SDK_POSTPROCESS_COMMAND += "function; ... " @@ -13150,13 +13150,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SRCREV - SRCREV[doc] = "The revision of the source code used to build the package. This variable applies to Subversion, Git, Mercurial and Bazaar only." + SRCREV[doc] = "The revision of the source code used to build the package. This variable applies to Subversion, Git, Mercurial, and Bazaar only." The revision of the source code used to build the package. - This variable applies to Subversion, Git, Mercurial and + This variable applies to Subversion, Git, Mercurial, and Bazaar only. Note that if you want to build a fixed revision and you want to avoid performing a query on the remote repository @@ -13192,7 +13192,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SSTATE_MIRROR_ALLOW_NETWORK - SSTATE_MIRROR_ALLOW_NETWORK[doc] = "If set to "1", allows fetches from mirrors that are specified in SSTATE_MIRRORS to work even when fetching from the network has been disabled by setting BB_NO_NETWORK to "1"." + SSTATE_MIRROR_ALLOW_NETWORK[doc] = "If set to "1", allows fetches from mirrors that are specified in SSTATE_MIRRORS to work even when fetching from the network is disabled by setting BB_NO_NETWORK to "1"." @@ -13200,7 +13200,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" If set to "1", allows fetches from mirrors that are specified in SSTATE_MIRRORS - to work even when fetching from the network has been + to work even when fetching from the network is disabled by setting BB_NO_NETWORK to "1". Using the @@ -13741,13 +13741,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SUMMARY - SUMMARY[doc] = "The short (80 characters or less) summary of the binary package for packaging systems such as opkg, rpm or dpkg. By default, SUMMARY is used to define the DESCRIPTION variable if DESCRIPTION is not set in the recipe." + SUMMARY[doc] = "The short (80 characters or less) summary of the binary package for packaging systems such as opkg, rpm, or dpkg. By default, SUMMARY is used to define the DESCRIPTION variable if DESCRIPTION is not set in the recipe." The short (72 characters or less) summary of the binary package for packaging - systems such as opkg, rpm or + systems such as opkg, rpm, or dpkg. By default, SUMMARY is used to define the DESCRIPTION @@ -13759,7 +13759,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SVNDIR - SVNDIR[doc] = "The directory where Subversion checkouts will be stored." + SVNDIR[doc] = "The directory where Subversion checkouts are stored." @@ -13842,13 +13842,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SYSLINUX_SPLASH - SYSLINUX_SPLASH[doc] = "An .LSS file used as the background for the VGA boot menu when you are using the boot menu." + SYSLINUX_SPLASH[doc] = "An .LSS file used as the background for the VGA boot menu when you use the boot menu." An .LSS file used as the background - for the VGA boot menu when you are using the boot menu. + for the VGA boot menu when you use the boot menu. You need to set this variable in your recipe. @@ -13885,7 +13885,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SYSROOT_DESTDIR - SYSROOT_DESTDIR[doc] = "Points to the temporary work directory (default ${WORKDIR}/sysroot-destdir) where the files that will be populated into the sysroot are assembled during the do_populate_sysroot task." + SYSROOT_DESTDIR[doc] = "Points to the temporary work directory (default ${WORKDIR}/sysroot-destdir) where the files populated into the sysroot are assembled during the do_populate_sysroot task." @@ -13893,8 +13893,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Points to the temporary directory under the work directory (default "${WORKDIR}/sysroot-destdir") - where the files - that will be populated into the sysroot are assembled + where the files populated into the sysroot are assembled during the do_populate_sysroot task. @@ -14009,17 +14008,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SYSTEMD_AUTO_ENABLE - SYSTEMD_AUTO_ENABLE[doc] = "For recipes that inherit the systemd class, this variable specifies whether the service you have specified in SYSTEMD_SERVICE should be started automatically or not." + SYSTEMD_AUTO_ENABLE[doc] = "For recipes that inherit the systemd class, this variable specifies whether the specified service in SYSTEMD_SERVICE should start automatically or not." When inheriting the systemd - class, this variable specifies whether the service you have - specified in + class, this variable specifies whether the specified service + in SYSTEMD_SERVICE - should be started automatically or not. + should start automatically or not. By default, the service is enabled to automatically start at boot time. The default setting is in the @@ -14067,7 +14066,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SYSTEMD_BOOT_ENTRIES - SYSTEMD_BOOT_ENTRIES[doc] = "When EFI_PROVIDER is set to "systemd-boot", the SYSTEMD_BOOT_ENTRIES variable specifies a list of entry files (*.conf) to be installed containing one boot entry per file." + SYSTEMD_BOOT_ENTRIES[doc] = "When EFI_PROVIDER is set to "systemd-boot", the SYSTEMD_BOOT_ENTRIES variable specifies a list of entry files (*.conf) to install that contain one boot entry per file." @@ -14077,8 +14076,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" is set to "systemd-boot", the SYSTEMD_BOOT_ENTRIES variable specifies a list of entry files - (*.conf) to be installed - containing one boot entry per file. + (*.conf) to install that contain + one boot entry per file. By default, the systemd-boot class sets the SYSTEMD_BOOT_ENTRIES as @@ -14180,7 +14179,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SYSVINIT_ENABLED_GETTYS - SYSVINIT_ENABLED_GETTYS[doc] = "Specifies which virtual terminals should be running a getty, the default is '1'." + SYSVINIT_ENABLED_GETTYS[doc] = "Specifies which virtual terminals should run a getty, the default is '1'." @@ -14188,7 +14187,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" When using SysVinit, specifies a space-separated list of the virtual terminals - that should be running a + that should run a getty (allowing login), assuming USE_VT @@ -14775,7 +14774,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" TEST_LOG_DIR - TEST_LOG_DIR[doc] = "Holds the SSH log and the boot log for QEMU machines. The TEST_LOG_DIR variable defaults to "${WORKDIR}/testimage"." + TEST_LOG_DIR[doc] = "Holds the SSH log and the boot log for QEMU machines. The TEST_LOG_DIR variable defaults to "${WORKDIR}/testimage"." @@ -15853,7 +15852,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" UPDATERCPN - UPDATERCPN[doc] = "Specifies the package that contains the initscript that is to be enabled." + UPDATERCPN[doc] = "Specifies the package that contains the initscript that is enabled." @@ -15861,7 +15860,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For recipes inheriting the update-rc.d class, UPDATERCPN specifies - the package that contains the initscript that is to be + the package that contains the initscript that is enabled. @@ -16149,7 +16148,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" USERADD_PARAM - USERADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the useradd command if you wish to add a user to the system when the package is installed." + USERADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should pass to the useradd command if you add a user to the system when the package is installed." @@ -16157,9 +16156,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" When inheriting the useradd class, this variable - specifies for a package what parameters should be passed + specifies for a package what parameters should pass to the useradd command - if you wish to add a user to the system when the package + if you add a user to the system when the package is installed. -- cgit v1.2.3-54-g00ecf