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 <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2014-10-23 07:05:25 -07:00
committed by Richard Purdie
parent 38c853a83d
commit 78c5c175ae

View File

@@ -934,8 +934,9 @@
<glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm>
<glossdef>
<para>
When inheriting <filename>binconfig.bbclass</filename>
from a recipe, this variable specifies a wildcard for
When inheriting the
<link linkend='ref-classes-binconfig'><filename>binconfig</filename></link>
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 @@
<para>
When inheriting the
<link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
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
<filename>buildhistory</filename>
@@ -1113,7 +1114,8 @@
<para>
When inheriting the
<link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
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 <filename>BUILDHISTORY_COMMIT_AUTHOR</filename>
variable to work, the
<link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link>
@@ -1143,8 +1145,8 @@
<para>
When inheriting the
<link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
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
<filename>buildhistory.class</filename>.
</para>
@@ -1164,7 +1166,8 @@
<para>
When inheriting the
<link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
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
"<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>"
section.
@@ -1204,7 +1207,8 @@
<para>
When inheriting the
<link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
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 @@
<para>
When inheriting the
<link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
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 <filename>BUILDHISTORY_PUSH_REPO</filename>
to work,
<link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link>
@@ -1598,8 +1602,9 @@
<glossentry id='var-CONFLICT_DISTRO_FEATURES'><glossterm>CONFLICT_DISTRO_FEATURES</glossterm>
<glossdef>
<para>
When a recipe inherits the
<filename>distro_features_check</filename> class, this
When inheriting the
<link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link>
class, this
variable identifies distribution features that would
be in conflict should the recipe
be built.
@@ -1929,7 +1934,7 @@
<glossentry id='var-DEPLOYDIR'><glossterm>DEPLOYDIR</glossterm>
<glossdef>
<para>
For recipes that inherit the
When inheriting the
<link linkend='ref-classes-deploy'><filename>deploy</filename></link>
class, the <filename>DEPLOYDIR</filename> points to a
temporary work area for deployed files that is set in the
@@ -2240,10 +2245,11 @@
<glossentry id='var-DOC_COMPRESS'><glossterm>DOC_COMPRESS</glossterm>
<glossdef>
<para>
When inheriting <filename>compress_doc.bbclass</filename>
from a recipe, this variable sets the compression policy
used when the OpenEmbedded build system compresses man
pages and info pages.
When inheriting the
<link linkend='ref-classes-compress_doc'><filename>compress_doc</filename></link>
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.
</para>
@@ -2398,8 +2404,9 @@
<glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm>
<glossdef>
<para>
If <filename>externalsrc.bbclass</filename> is inherited,
this variable points to the source tree, which is
When inheriting the
<link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link>
class, this variable points to the source tree, which is
outside of the OpenEmbedded build system.
When set, this variable sets the
<link linkend='var-S'><filename>S</filename></link>
@@ -2423,10 +2430,11 @@
<glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm>
<glossdef>
<para>
If <filename>externalsrc.bbclass</filename> 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
<link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link>
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
<link linkend='var-B'><filename>B</filename></link>
variable, which is what the OpenEmbedded build system uses
@@ -2575,7 +2583,7 @@
<glossentry id='var-EXTRA_OESCONS'><glossterm>EXTRA_OESCONS</glossterm>
<glossdef>
<para>
When a recipe inherits the
When inheriting the
<link linkend='ref-classes-scons'><filename>scons</filename></link>
class, this variable specifies additional configuration
options you want to pass to the
@@ -2623,7 +2631,7 @@
<glossentry id='var-EXTRA_USERS_PARAMS'><glossterm>EXTRA_USERS_PARAMS</glossterm>
<glossdef>
<para>
When a recipe inherits the
When inheriting the
<link linkend='ref-classes-extrausers'><filename>extrausers</filename></link>
class, this variable provides image level user and group
operations.
@@ -2933,7 +2941,7 @@
<glossentry id='var-FONT_PACKAGES'><glossterm>FONT_PACKAGES</glossterm>
<glossdef>
<para>
When a recipe inherits the
When inheriting the
<link linkend='ref-classes-fontcache'><filename>fontcache</filename></link>
class, this variable identifies packages containing font
files that need to be cached by Fontconfig.
@@ -2987,8 +2995,9 @@
<glossentry id='var-GROUPADD_PARAM'><glossterm>GROUPADD_PARAM</glossterm>
<glossdef>
<para>
When a recipe inherits the
<filename>useradd</filename> class, this variable
When inheriting the
<link linkend='ref-classes-useradd'><filename>useradd</filename></link>
class, this variable
specifies for a package what parameters should be passed
to the <filename>groupadd</filename> command
if you wish to add a group to the system when the package
@@ -3011,8 +3020,9 @@
<glossentry id='var-GROUPMEMS_PARAM'><glossterm>GROUPMEMS_PARAM</glossterm>
<glossdef>
<para>
When a recipe inherits the
<filename>useradd</filename> class, this variable
When inheriting the
<link linkend='ref-classes-useradd'><filename>useradd</filename></link>
class, this variable
specifies for a package what parameters should be passed
to the <filename>groupmems</filename> command
if you wish to modify the members of a group when the
@@ -3084,7 +3094,7 @@
<glossentry id='var-GTKIMMODULES_PACKAGES'><glossterm>GTKIMMODULES_PACKAGES</glossterm>
<glossdef>
<para>
For recipes that inherit the
When inheriting the
<link linkend='ref-classes-gtk-immodules-cache'><filename>gtk-immodules-cache</filename></link>
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"
<glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm>OE_BINCONFIG_EXTRA_MANGLE</glossterm>
<glossdef>
<para>
When a recipe inherits the
<filename>binconfig.bbclass</filename> class, this variable
When inheriting the
<link linkend='ref-classes-binconfig'><filename>binconfig</filename></link>
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"
<glossentry id='var-PIXBUF_PACKAGES'><glossterm>PIXBUF_PACKAGES</glossterm>
<glossdef>
<para>
When a recipe inherits the
When inheriting the
<link linkend='ref-classes-pixbufcache'><filename>pixbufcache</filename></link>
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"
<glossentry id='var-REQUIRED_DISTRO_FEATURES'><glossterm>REQUIRED_DISTRO_FEATURES</glossterm>
<glossdef>
<para>
When a recipe inherits the
<filename>distro_features_check</filename> class, this
When inheriting the
<link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link>
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"
<glossentry id='var-SYSTEMD_AUTO_ENABLE'><glossterm>SYSTEMD_AUTO_ENABLE</glossterm>
<glossdef>
<para>
For recipes that inherit the
When inheriting the
<link linkend='ref-classes-systemd'><filename>systemd</filename></link>
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"
<glossentry id='var-SYSTEMD_PACKAGES'><glossterm>SYSTEMD_PACKAGES</glossterm>
<glossdef>
<para>
For recipes that inherit the
When inheriting the
<link linkend='ref-classes-systemd'><filename>systemd</filename></link>
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"
<glossentry id='var-SYSTEMD_SERVICE'><glossterm>SYSTEMD_SERVICE</glossterm>
<glossdef>
<para>
For recipes that inherit the
When inheriting the
<link linkend='ref-classes-systemd'><filename>systemd</filename></link>
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"
<glossentry id='var-USERADD_PACKAGES'><glossterm>USERADD_PACKAGES</glossterm>
<glossdef>
<para>
When a recipe inherits the
<filename>useradd</filename> class, this variable
When inheriting the
<link linkend='ref-classes-useradd'><filename>useradd</filename></link>
class, this variable
specifies the individual packages within the recipe that
require users and/or groups to be added.
</para>
@@ -10044,8 +10057,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-USERADD_PARAM'><glossterm>USERADD_PARAM</glossterm>
<glossdef>
<para>
When a recipe inherits the
<filename>useradd</filename> class, this variable
When inheriting the
<link linkend='ref-classes-useradd'><filename>useradd</filename></link>
class, this variable
specifies for a package what parameters should be passed
to the <filename>useradd</filename> command
if you wish to add a user to the system when the package