From 99bd2c41c681c1214a191f9eca4373fbffcf11f9 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Fri, 19 Dec 2014 15:01:25 -0600
Subject: ref-manual: Updates to some tuning variables in the glossary:

Fixes [YOCTO #5463]

Updated the notes in the TUNE_ASARGS, TUNE_CCARGS, and
TUNE_LDARGS to indicate that the BSPs select the tune and then
selected tun affects the tun variables themselves.

Also combined the TUNE_PKGARCH and the TUNE_PKGARCH_tune variable.
We really don't need the TUNE_PKGARCH_tune variable as it is simply
the TUNE_PKGARCH variable with the override.

(From yocto-docs rev: dabc624272a9bb4cf5e62dee664ba729a9887208)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/ref-manual/ref-variables.xml | 45 +++++++++++++++---------------
 1 file changed, 23 insertions(+), 22 deletions(-)

(limited to 'documentation/ref-manual')

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 0bae35a3f6..16f703dc42 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -10749,7 +10749,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     <filename>TUNE_ASARGS</filename> is set using
                     the tune include files, which are typically under
                     <filename>meta/conf/machine/include/</filename> and are
-                    influenced through <filename>TUNE_FEATURES</filename>.
+                    influenced through
+                    <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>.
                     For example, the
                     <filename>meta/conf/machine/include/x86/arch-x86.inc</filename>
                     file defines the flags for the x86 architecture as follows:
@@ -10757,8 +10758,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
      TUNE_ASARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}"
                     </literallayout>
                     <note>
-                        Board Support Packages (BSPs) can supply their own
-                        set of flags.
+                        Board Support Packages (BSPs) select the tune.
+                        The selected tune, in turn, affects the tune variables
+                        themselves (i.e. the tune can supply its own
+                        set of flags).
                     </note>
                 </para>
             </glossdef>
@@ -10776,10 +10779,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     <filename>TUNE_CCARGS</filename> is set using
                     the tune include files, which are typically under
                     <filename>meta/conf/machine/include/</filename> and are
-                    influenced through <filename>TUNE_FEATURES</filename>.
+                    influenced through
+                    <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>.
                     <note>
-                        Board Support Packages (BSPs) can supply their own
-                        set of flags.
+                        Board Support Packages (BSPs) select the tune.
+                        The selected tune, in turn, affects the tune variables
+                        themselves (i.e. the tune can supply its own
+                        set of flags).
                     </note>
                 </para>
             </glossdef>
@@ -10797,7 +10803,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     <filename>TUNE_LDARGS</filename> is set using
                     the tune include files, which are typically under
                     <filename>meta/conf/machine/include/</filename> and are
-                    influenced through <filename>TUNE_FEATURES</filename>.
+                    influenced through
+                    <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>.
                     For example, the
                     <filename>meta/conf/machine/include/x86/arch-x86.inc</filename>
                     file defines the flags for the x86 architecture as follows:
@@ -10805,8 +10812,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
      TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", d)}"
                     </literallayout>
                     <note>
-                        Board Support Packages (BSPs) can supply their own
-                        set of flags.
+                        Board Support Packages (BSPs) select the tune.
+                        The selected tune, in turn, affects the tune variables
+                        themselves (i.e. the tune can supply its own
+                        set of flags).
                     </note>
                 </para>
             </glossdef>
@@ -10854,19 +10863,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     The package architecture understood by the packaging
                     system to define the architecture, ABI, and tuning of
                     output packages.
-                </para>
-            </glossdef>
-        </glossentry>
-
-        <glossentry id='var-TUNE_PKGARCH_tune'><glossterm><imagedata fileref="figures/define-generic.png" />TUNE_PKGARCH_tune</glossterm>
-            <info>
-                TUNE_PKGARCH_tune[doc] = "The CPU or Application Binary Interface (ABI) specific tuning of the TUNE_PKGARCH."
-            </info>
-            <glossdef>
-                <para>
-                    The CPU or Application Binary Interface (ABI) specific
-                    tuning of the
-                    <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link>.
+                    The specific tune is defined using the "_tune" override
+                    as follows:
+                    <literallayout class='monospaced'>
+     TUNE_PKGARCH_tune-<replaceable>tune</replaceable> = "<replaceable>tune</replaceable>"
+                    </literallayout>
                 </para>
 
                 <para>
-- 
cgit v1.2.3-54-g00ecf