From 78c5c175ae173fc30db39f5e78aaf55b490f3e2a Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 23 Oct 2014 07:05:25 -0700 Subject: ref-manual: Cleaned up wording in glossary for "inheriting" For consistency, I changed the introductory sentence to the variables that function when inherited. (From yocto-docs rev: 6ba4fe635c45abf7692f4be0a09ede89a89ec9fa) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-variables.xml | 102 ++++++++++++++++------------- 1 file changed, 58 insertions(+), 44 deletions(-) (limited to 'documentation/ref-manual/ref-variables.xml') diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 09d01cb478..b69bea6e58 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -934,8 +934,9 @@ BINCONFIG_GLOB - When inheriting binconfig.bbclass - from a recipe, this variable specifies a wildcard for + When inheriting the + binconfig + class, this variable specifies a wildcard for configuration scripts that need editing. The scripts are edited to correct any paths that have been set up during compilation so that they are correct for @@ -1085,8 +1086,8 @@ When inheriting the buildhistory - class, specifies whether or not to commit the build - history output in a local Git repository. + class, this variable specifies whether or not to commit the + build history output in a local Git repository. If set to "1", this local repository will be maintained automatically by the buildhistory @@ -1113,7 +1114,8 @@ When inheriting the buildhistory - class, specifies the author to use for each Git commit. + class, this variable specifies the author to use for each + Git commit. In order for the BUILDHISTORY_COMMIT_AUTHOR variable to work, the BUILDHISTORY_COMMIT @@ -1143,8 +1145,8 @@ When inheriting the buildhistory - class, specifies the directory in which build history - information is kept. + class, this variable specifies the directory in which + build history information is kept. For more information on how the variable works, see the buildhistory.class. @@ -1164,7 +1166,8 @@ When inheriting the buildhistory - class, specifies the build history features to be enabled. + class, this variable specifies the build history features + to be enabled. For more information on how build history works, see the "Maintaining Build Output Quality" section. @@ -1204,7 +1207,8 @@ When inheriting the buildhistory - class, specifies a list of paths to files copied from the + class, this variable specifies a list of paths to files + copied from the image contents into the build history directory under an "image-files" directory in the directory for the image, so that you can track the contents of each file. @@ -1232,8 +1236,8 @@ When inheriting the buildhistory - class, optionally specifies a remote repository - to which build history pushes Git changes. + class, this variable optionally specifies a remote + repository to which build history pushes Git changes. In order for BUILDHISTORY_PUSH_REPO to work, BUILDHISTORY_COMMIT @@ -1598,8 +1602,9 @@ CONFLICT_DISTRO_FEATURES - When a recipe inherits the - distro_features_check class, this + When inheriting the + distro_features_check + class, this variable identifies distribution features that would be in conflict should the recipe be built. @@ -1929,7 +1934,7 @@ DEPLOYDIR - For recipes that inherit the + When inheriting the deploy class, the DEPLOYDIR points to a temporary work area for deployed files that is set in the @@ -2240,10 +2245,11 @@ DOC_COMPRESS - 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. + When inheriting the + compress_doc + class, 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. @@ -2398,8 +2404,9 @@ EXTERNALSRC - If externalsrc.bbclass is inherited, - this variable points to the source tree, which is + When inheriting the + externalsrc + class, this variable points to the source tree, which is outside of the OpenEmbedded build system. When set, this variable sets the S @@ -2423,10 +2430,11 @@ EXTERNALSRC_BUILD - If externalsrc.bbclass is inherited, - this variable points to the directory in which the recipe's - source code is built, - which is outside of the OpenEmbedded build system. + When inheriting the + externalsrc + class, this variable points to the directory in which the + recipe's source code is built, which is outside of the + OpenEmbedded build system. When set, this variable sets the B variable, which is what the OpenEmbedded build system uses @@ -2575,7 +2583,7 @@ EXTRA_OESCONS - When a recipe inherits the + When inheriting the scons class, this variable specifies additional configuration options you want to pass to the @@ -2623,7 +2631,7 @@ EXTRA_USERS_PARAMS - When a recipe inherits the + When inheriting the extrausers class, this variable provides image level user and group operations. @@ -2933,7 +2941,7 @@ FONT_PACKAGES - When a recipe inherits the + When inheriting the fontcache class, this variable identifies packages containing font files that need to be cached by Fontconfig. @@ -2987,8 +2995,9 @@ GROUPADD_PARAM - When a recipe inherits the - useradd class, this variable + When inheriting the + useradd + class, this variable specifies for a package what parameters should be passed to the groupadd command if you wish to add a group to the system when the package @@ -3011,8 +3020,9 @@ GROUPMEMS_PARAM - When a recipe inherits the - useradd class, this variable + When inheriting the + useradd + class, this variable specifies for a package what parameters should be passed to the groupmems command if you wish to modify the members of a group when the @@ -3084,7 +3094,7 @@ GTKIMMODULES_PACKAGES - For recipes that inherit the + When inheriting the gtk-immodules-cache class, this variable specifies the packages that contain the GTK+ input method modules being installed when the modules @@ -5762,8 +5772,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" OE_BINCONFIG_EXTRA_MANGLE - When a recipe inherits the - binconfig.bbclass class, this variable + When inheriting the + binconfig + class, this variable specifies additional arguments passed to the "sed" command. The sed command alters any paths in configuration scripts that have been set up during compilation. @@ -6477,7 +6488,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" PIXBUF_PACKAGES - When a recipe inherits the + When inheriting the pixbufcache class, this variable identifies packages that contain the pixbuf loaders used with @@ -7193,8 +7204,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" REQUIRED_DISTRO_FEATURES - When a recipe inherits the - distro_features_check class, this + When inheriting the + distro_features_check + class, this variable identifies distribution features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe. @@ -8645,7 +8657,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SYSTEMD_AUTO_ENABLE - For recipes that inherit the + When inheriting the systemd class, this variable specifies whether the service you have specified in @@ -8668,7 +8680,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SYSTEMD_PACKAGES - For recipes that inherit the + When inheriting the systemd class, this variable locates the systemd unit files when they are not found in the main recipe's package. @@ -8691,7 +8703,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SYSTEMD_SERVICE - For recipes that inherit the + When inheriting the systemd class, this variable specifies the systemd service name for a package. @@ -10012,8 +10024,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" USERADD_PACKAGES - When a recipe inherits the - useradd class, this variable + When inheriting the + useradd + class, this variable specifies the individual packages within the recipe that require users and/or groups to be added. @@ -10044,8 +10057,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" USERADD_PARAM - When a recipe inherits the - useradd class, this variable + When inheriting 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 -- cgit v1.2.3-54-g00ecf