diff options
| author |   Scott Rifenbark <srifenbark@gmail.com> | 2017-05-11 12:03:48 -0700 |
|---|---|---|
| committer |   Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-05-21 12:24:44 +0100 |
| commit | 362f6044fcaafe51ab4377af8f2606165b112717 (patch) | |
| tree | cc63da6293cc7675a920679cd8b8c567e720121e /doc | |
| parent | 6eb56624e6d8dc1944e559b4f6584bfe66f566ba (diff) | |
| download | bitbake-362f6044fcaafe51ab4377af8f2606165b112717.tar.gz | |
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@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/bitbake-user-manual/bitbake-user-manual-metadata.xml | 3 | ||||
| -rw-r--r-- | doc/bitbake-user-manual/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 1d1e5b35f..b32fa3392 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 0e89bf239..07bda982f 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> |