[oe-commits] [bitbake] branch master updated: bitbake-user-manual: Updated INHERIT descriptions

[git at git.openembedded.org]

This is an automated email from the git hooks/post-receive script.

rpurdie pushed a commit to branch master
in repository bitbake.

The following commit(s) were added to refs/heads/master by this push:
     new 362f604  bitbake-user-manual: Updated INHERIT descriptions
362f604 is described below

commit 362f6044fcaafe51ab4377af8f2606165b112717
Author: Scott Rifenbark <srifenbark at gmail.com>
AuthorDate: Thu May 11 12:03:48 2017 -0700

    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.
    
    Signed-off-by: Scott Rifenbark <srifenbark at gmail.com>
    Signed-off-by: Richard Purdie <richard.purdie at linuxfoundation.org>
---
 doc/bitbake-user-manual/bitbake-user-manual-metadata.xml |  3 ++-
 .../bitbake-user-manual-ref-variables.xml                | 16 +++++++++++++---
 2 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
index 1d1e5b3..b32fa33 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
+++ b/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/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
index 0e89bf2..07bda98 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
+++ b/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>

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.