summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-09-01 11:35:36 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-09-23 15:27:32 +0100
commit44b0b07a6f06a96af1ff8c2ebefe20ce2f031736 (patch)
tree6b4ceb6cc227cc36515b95440bbd8aa7151ad45c /documentation
parent43b9962cdd3d79aaae2b141673cd46b81ac0f2bb (diff)
downloadpoky-44b0b07a6f06a96af1ff8c2ebefe20ce2f031736.tar.gz
ref-manual: Rewrite of the CLASSOVERRIDE variable in the glossary
Fixes [YOCTO #10174] I applied a more descriptive explanation of this varialbe. (From yocto-docs rev: 7c6c2645b7e74e1c7de0d43b35307c8917648959) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml31
1 files changed, 22 insertions, 9 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 2ded2ef0d6..64fd94c9a2 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1992,22 +1992,35 @@
1992 An internal variable specifying the special class override 1992 An internal variable specifying the special class override
1993 that should currently apply (e.g. "class-target", 1993 that should currently apply (e.g. "class-target",
1994 "class-native", and so forth). 1994 "class-native", and so forth).
1995 The classes that use this variable set it to 1995 The classes that use this variable (e.g.
1996 appropriate values. 1996 <link linkend='ref-classes-native'><filename>native</filename></link>,
1997 <link linkend='ref-classes-nativesdk'><filename>nativesdk</filename></link>,
1998 and so forth) set the variable to appropriate values.
1999 <note>
2000 <filename>CLASSOVERRIDE</filename> gets its default
2001 "class-target" value from the
2002 <filename>bitbake.conf</filename> file.
2003 </note>
1997 </para> 2004 </para>
1998 2005
1999 <para> 2006 <para>
2000 You do not normally directly interact with this variable. 2007 As an example, the following override allows you to install
2001 The value for the <filename>CLASSOVERRIDE</filename> 2008 extra files, but only when building for the target:
2002 variable goes into 2009 <literallayout class='monospaced'>
2003 <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> 2010 do_install_append_class-target() {
2004 and then can be used as an override. 2011 install my-extra-file ${D}${sysconfdir}
2012 }
2013 </literallayout>
2005 Here is an example where "python-native" is added to 2014 Here is an example where "python-native" is added to
2006 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> 2015 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>,
2007 only when building for the <filename>-native</filename> case: 2016 but only when building for the build host:
2008 <literallayout class='monospaced'> 2017 <literallayout class='monospaced'>
2009 DEPENDS_append_class-native = " python-native" 2018 DEPENDS_append_class-native = " python-native"
2010 </literallayout> 2019 </literallayout>
2020 The underlying mechanism behind
2021 <filename>CLASSOVERRIDE</filename> is simply that it is
2022 included in the default value of
2023 <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>.
2011 </para> 2024 </para>
2012 </glossdef> 2025 </glossdef>
2013 </glossentry> 2026 </glossentry>