aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-19 18:01:53 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-07-03 13:57:08 +0100
commit81a065bfe8b0d509aa7d9692f304bc34e5b30630 (patch)
tree552f57386cdc587aa1d88ea37f99a7c78ee1ca38 /documentation
parente2f04f4ffc2c9ec227638bf644065af110fefc97 (diff)
downloadopenembedded-core-contrib-81a065bfe8b0d509aa7d9692f304bc34e5b30630.tar.gz
ref-manual: Added three new tuning variables to glossary.
Fixes [YOCTO #5463] New entries for: TUNE_FEATURES AVAILTUNES DEFAULTTUNES (From yocto-docs rev: e56d0027b06171cb547e24a51839cb7f8051e6f2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml79
1 files changed, 79 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index ae61d29d29..2004a91bec 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -251,6 +251,34 @@
</glossdef>
</glossentry>
+ <glossentry id='var-AVAILTUNES'><glossterm>AVAILTUNES</glossterm>
+ <glossdef>
+ <para>
+ The list of defined CPU and Application Binary Interface
+ (ABI) tunings (i.e. "tunes") available for use by the
+ OpenEmbedded build system.
+ </para>
+
+ <para>
+ The list simply presents the tunes that are available.
+ Not all tunes may be compatible with a particular
+ machine configuration, or with each other in a
+ <ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Multilib</ulink>
+ configuration.
+ </para>
+
+ <para>
+ To add a tune to the list, be sure to append it with
+ spaces using the "+=" BitBake operator.
+ Do not simply replace the list by using the "=" operator.
+ See the
+ "<ulink url='&YOCTO_DOCS_BB_URL;#basic-syntax'>Basic Syntax</ulink>"
+ section in the BitBake User Manual for more information.
+ </para>
+ </glossdef>
+ </glossentry>
+
+
</glossdiv>
<glossdiv id='var-glossary-b'><title>B</title>
@@ -1704,6 +1732,27 @@
</glossdef>
</glossentry>
+ <glossentry id='var-DEFAULTTUNE'><glossterm>DEFAULTTUNE</glossterm>
+ <glossdef>
+ <para>
+ The default CPU and Application Binary Interface (ABI)
+ tunings (i.e. the "tune") used by the OpenEmbedded build
+ system.
+ The <filename>DEFAULTTUNE</filename> helps define
+ <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>.
+ </para>
+
+ <para>
+ The default tune is either implicitly or explicitly set
+ by the machine
+ (<link linkend='var-MACHINE'><filename>MACHINE</filename></link>).
+ However, you can override the setting using available tunes
+ as defined with
+ <link linkend='var-AVAILTUNES'><filename>AVAILTUNES</filename></link>.
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm>
<glossdef>
<para>
@@ -8953,6 +9002,36 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
+ <glossentry id='var-TUNE_FEATURES'><glossterm>TUNE_FEATURES</glossterm>
+ <glossdef>
+ <para>
+ Features used to "tune" a compiler for optimal use
+ given a specific processor.
+ The features are defined within the tune files and allow
+ arguments (i.e. <filename>TUNE_*ARGS</filename>) to be
+ dynamically generated based on the features.
+ </para>
+
+ <para>
+ The OpenEmbedded build system verifies the features
+ to be sure they are not conflicting and that they are
+ supported.
+ </para>
+
+ <para>
+ The BitBake configuration file
+ (<filename>meta/conf/bitbake.conf</filename>) defines
+ <filename>TUNE_FEATURES</filename> as follows:
+ <literallayout class='monospaced'>
+ TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}"
+ </literallayout>
+ See the
+ <link linkend='var-DEFAULTTUNE'><filename>DEFAULTTUNE</filename></link>
+ variable for more information.
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm>
<glossdef>
<para>