summaryrefslogtreecommitdiffstats
path: root/bitbake
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-05-11 12:03:48 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-05-23 17:45:37 +0100
commit31ec7fa01df21cb43051686d02b52f1a6463feb4 (patch)
tree3652b90247b016baa89ba88e8ee57f5cb849fa0a /bitbake
parent35c3e57686f6a29d9690c68dd43fc4d35dc1c43b (diff)
downloadopenembedded-core-contrib-31ec7fa01df21cb43051686d02b52f1a6463feb4.tar.gz
bitbake: bitbake-user-manual: Updated INHERIT descriptions
Fixes [YOCTO #11498] Enhanced the glossary description for the INHERIT variable to give more detail and to cross-reference the reader back into the Chapter 3 section describing its use. (Bitbake rev: 362f6044fcaafe51ab4377af8f2606165b112717) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml3
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml16
2 files changed, 15 insertions, 4 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
index 1d1e5b35f0..b32fa33926 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
@@ -1072,7 +1072,8 @@
<note>
Because <filename>.conf</filename> files are parsed
first during BitBake's execution, using
- <filename>INHERIT</filename> to inherit a class effectively
+ <link linkend='var-INHERIT'><filename>INHERIT</filename></link>
+ to inherit a class effectively
inherits the class globally (i.e. for all recipes).
</note>
If you want to use the directive to inherit
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
index 0e89bf2396..07bda982f3 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
@@ -1596,9 +1596,19 @@
<glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm>
<glossdef>
<para>
- Causes the named class to be inherited at
- this point during parsing.
- The variable is only valid in configuration files.
+ Causes the named class or classes to be inherited globally.
+ Anonymous functions in the class or classes
+ are not executed for the
+ base configuration and in each individual recipe.
+ The OpenEmbedded build system ignores changes to
+ <filename>INHERIT</filename> in individual recipes.
+ </para>
+
+ <para>
+ For more information on <filename>INHERIT</filename>, see
+ the
+ "<link linkend="inherit-configuration-directive"><filename>INHERIT</filename> Configuration Directive</link>"
+ section.
</para>
</glossdef>
</glossentry>