summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
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/ref-manual/ref-variables.xml
parente2f04f4ffc2c9ec227638bf644065af110fefc97 (diff)
downloadpoky-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/ref-manual/ref-variables.xml')
-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 @@
251 </glossdef> 251 </glossdef>
252 </glossentry> 252 </glossentry>
253 253
254 <glossentry id='var-AVAILTUNES'><glossterm>AVAILTUNES</glossterm>
255 <glossdef>
256 <para>
257 The list of defined CPU and Application Binary Interface
258 (ABI) tunings (i.e. "tunes") available for use by the
259 OpenEmbedded build system.
260 </para>
261
262 <para>
263 The list simply presents the tunes that are available.
264 Not all tunes may be compatible with a particular
265 machine configuration, or with each other in a
266 <ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Multilib</ulink>
267 configuration.
268 </para>
269
270 <para>
271 To add a tune to the list, be sure to append it with
272 spaces using the "+=" BitBake operator.
273 Do not simply replace the list by using the "=" operator.
274 See the
275 "<ulink url='&YOCTO_DOCS_BB_URL;#basic-syntax'>Basic Syntax</ulink>"
276 section in the BitBake User Manual for more information.
277 </para>
278 </glossdef>
279 </glossentry>
280
281
254 </glossdiv> 282 </glossdiv>
255 283
256 <glossdiv id='var-glossary-b'><title>B</title> 284 <glossdiv id='var-glossary-b'><title>B</title>
@@ -1704,6 +1732,27 @@
1704 </glossdef> 1732 </glossdef>
1705 </glossentry> 1733 </glossentry>
1706 1734
1735 <glossentry id='var-DEFAULTTUNE'><glossterm>DEFAULTTUNE</glossterm>
1736 <glossdef>
1737 <para>
1738 The default CPU and Application Binary Interface (ABI)
1739 tunings (i.e. the "tune") used by the OpenEmbedded build
1740 system.
1741 The <filename>DEFAULTTUNE</filename> helps define
1742 <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>.
1743 </para>
1744
1745 <para>
1746 The default tune is either implicitly or explicitly set
1747 by the machine
1748 (<link linkend='var-MACHINE'><filename>MACHINE</filename></link>).
1749 However, you can override the setting using available tunes
1750 as defined with
1751 <link linkend='var-AVAILTUNES'><filename>AVAILTUNES</filename></link>.
1752 </para>
1753 </glossdef>
1754 </glossentry>
1755
1707 <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm> 1756 <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm>
1708 <glossdef> 1757 <glossdef>
1709 <para> 1758 <para>
@@ -8953,6 +9002,36 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8953 </glossdef> 9002 </glossdef>
8954 </glossentry> 9003 </glossentry>
8955 9004
9005 <glossentry id='var-TUNE_FEATURES'><glossterm>TUNE_FEATURES</glossterm>
9006 <glossdef>
9007 <para>
9008 Features used to "tune" a compiler for optimal use
9009 given a specific processor.
9010 The features are defined within the tune files and allow
9011 arguments (i.e. <filename>TUNE_*ARGS</filename>) to be
9012 dynamically generated based on the features.
9013 </para>
9014
9015 <para>
9016 The OpenEmbedded build system verifies the features
9017 to be sure they are not conflicting and that they are
9018 supported.
9019 </para>
9020
9021 <para>
9022 The BitBake configuration file
9023 (<filename>meta/conf/bitbake.conf</filename>) defines
9024 <filename>TUNE_FEATURES</filename> as follows:
9025 <literallayout class='monospaced'>
9026 TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}"
9027 </literallayout>
9028 See the
9029 <link linkend='var-DEFAULTTUNE'><filename>DEFAULTTUNE</filename></link>
9030 variable for more information.
9031 </para>
9032 </glossdef>
9033 </glossentry>
9034
8956 <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm> 9035 <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm>
8957 <glossdef> 9036 <glossdef>
8958 <para> 9037 <para>