From 38c853a83df6bfc721b563044a72f78466fa1f81 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 22 Oct 2014 10:30:58 -0700 Subject: ref-manual: Applied review edits for new classes and variables. These edits were minor with the addition of some descriptions that had to be fleshed out. All comments from Paul Eggleton. (From yocto-docs rev: 4ae7c5a5e5aa23307e28de0832d379145c4ef8f1) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-classes.xml | 19 +++--- documentation/ref-manual/ref-variables.xml | 99 +++++++++++++++++++++--------- 2 files changed, 80 insertions(+), 38 deletions(-) diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 11961a7..fed25b2 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -239,8 +239,8 @@ An alternative version of the binconfig class, which disables binary configuration scripts by making them - return an error in favor of installing them using - pkg-config. + return an error in favor of using pkg-config + to query the information. The scripts to be disabled should be specified using the BINCONFIG variable within the recipe inheriting the class. @@ -465,7 +465,7 @@ <filename>compress_doc.bbclass</filename> - Enables compression for man pages and information pages. + Enables compression for man pages and info pages. This class is intended to be inherited globally. The default compression mechanism is gz (gzip) but you can select an alternative mechanism by setting the @@ -492,10 +492,13 @@ <filename>copyleft_filter.bbclass</filename> - A class used by the archiver and the + A class used by the + archiver + and copyleft_compliance - class for filtering licenses. - This is an internal class and is not intended to be used directly. + classes for filtering licenses. + The copyleft_filter class is an internal class + and is not intended to be used directly. @@ -1059,7 +1062,7 @@ You can also see the - Gummiboot documentation + Gummiboot documentation for more information. @@ -2620,7 +2623,7 @@ Enables package tests (ptests) specifically for GNOME packages, which have tests intended to be executed with - gnome-desktop-testing. + gnome-desktop-testing. diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index cc5382f..09d01cb 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -242,7 +242,19 @@ ASSUME_PROVIDED - I need a description here. + Lists recipe names + (PN + values) BitBake does not attempt to build. + Instead, BitBake assumes these recipes have already been + built. + + + + In OpenEmbedded Core, ASSUME_PROVIDED + mostly specifies native tools that should not be built. + An example is git-native, which when + specified, allows for the Git binary from the host to be + used rather than building git-native. @@ -898,11 +910,23 @@ BINCONFIG - Specifies binary configuration scripts to disable - rather than installing them using - pkg-config. - The OpenEmbedded build system returns an error for the - disabled scripts. + When inheriting the + binconfig-disabled + class, this variable specifies binary configuration + scripts to disable in favor of using + pkg-config to query the information. + The binconfig-disabled class will + modify the specified scripts to return an error so that + calls to them can be easily found and replaced. + + + + To add multiple scripts, separate them by spaces. + Here is an example from the libpng + recipe: + + BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config" + @@ -2216,14 +2240,17 @@ DOC_COMPRESS - Sets the compression policy used when the OpenEmbedded - build system compresses man pages and info pages. - By default, the compression method used is gs (gzip). + When inheriting compress_doc.bbclass + from a recipe, this variable sets the compression policy + used when the OpenEmbedded build system compresses man + pages and info pages. + By default, the compression method used is gz (gzip). + Other policies available are xz and bz2. - For information on how to use this variable, see the - comments in the + For information on policies and on how to use this + variable, see the comments in the compress_doc.bbclass file. @@ -2235,10 +2262,15 @@ EFI_PROVIDER - - Setting this variable to "gummiboot" causes the - OpenEmbedded build system to use the Gummiboot bootloader. + When building bootable images (i.e. where + hddimg or vmdk + is in + IMAGE_FSTYPES), + The EFI_PROVIDER variable specifies + the EFI bootloader to use. + The default is "grub-efi", but "gummiboot" can be used + instead. @@ -2246,11 +2278,6 @@ gummiboot class for more information. - - - For information on Gummiboot, see the - Gummiboot documentation. - @@ -3069,7 +3096,11 @@ GUMMIBOOT_CFG - Specifies the configuration file that should be used. + When + EFI_PROVIDER + is set to "gummiboot", the + GUMMIBOOT_CFG variable specifies the + configuration file that should be used. By default, the gummiboot class sets the GUMMIBOOT_CFG as @@ -3081,7 +3112,7 @@ For information on Gummiboot, see the - Gummiboot documentation. + Gummiboot documentation. @@ -3089,7 +3120,11 @@ GUMMIBOOT_ENTRIES - Specifies a list of entry files + When + EFI_PROVIDER + is set to "gummiboot", the + GUMMIBOOT_ENTRIES variable specifies + a list of entry files (*.conf) to be installed containing one boot entry per file. By default, the @@ -3103,7 +3138,7 @@ For information on Gummiboot, see the - Gummiboot documentation. + Gummiboot documentation. @@ -3111,7 +3146,11 @@ GUMMIBOOT_TIMEOUT - Specifies the boot menu timeout in seconds. + When + EFI_PROVIDER + is set to "gummiboot", the + GUMMIBOOT_TIMEOUT variable specifies + the boot menu timeout in seconds. By default, the gummiboot class sets the GUMMIBOOT_TIMEOUT as @@ -3123,7 +3162,7 @@ For information on Gummiboot, see the - Gummiboot documentation. + Gummiboot documentation. @@ -5197,7 +5236,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" MACHINE_ESSENTIAL_EXTRA_RDEPENDS - A list of required machine-specific packages to install as part of the image being built. @@ -5229,7 +5267,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS - A list of recommended machine-specific packages to install as part of the image being built. @@ -5316,7 +5353,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" MACHINE_EXTRA_RRECOMMENDS - A list of machine-specific packages to install as part of the image being built that are not essential for booting the machine. @@ -7493,7 +7529,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SANITY_REQUIRED_UTILITIES - Need a description here. + Specifies a list of command-line utilities that should be + checked for during the initial sanity checking process when + running BitBake. + If any of the utilities are not installed on the build host, + then BitBake immediately exits with an error. @@ -8088,7 +8128,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SRC_URI_OVERRIDES_PACKAGE_ARCH - By default, the OpenEmbedded build system automatically detects whether SRC_URI -- cgit v1.1