From e856eed4e3539cce803425ec7b0edfdc1265e3fa Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Wed, 22 Feb 2012 16:13:29 -0600
Subject: documentation/bsp-guide/bsp.xml: Edits to HW Configuration Options
 Section

Made some minor edits.  I also discovered that the information
describing where tuning files reside was not real helpful.
In particular, tuning files are not limited to the
meta/conf/machine/include directory.  For example, the Crown Bay
BSP layer includes a tuning file from the meta-intel Layer.

(From yocto-docs rev: 3a76ccc4f645f03a6e888b7eb53fa9bc7bfb255e)

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

(limited to 'documentation/bsp-guide/bsp.xml')

diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index a957409ec8..019a78f0a0 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -355,19 +355,20 @@
                 If the BSP supports multiple machines, multiple machine configuration files
                 can be present. 
                 These filenames correspond to the values to which users have set the 
-                <filename>MACHINE</filename> variable.
+                <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE'><filename>MACHINE</filename></ulink> variable.
             </para>
 
             <para>
                 These files define things such as the kernel package to use
-                (<filename>PREFERRED_PROVIDER</filename> of virtual/kernel), the hardware drivers to
+                (<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PREFERRED_PROVIDER'><filename>PREFERRED_PROVIDER</filename></ulink>
+                of virtual/kernel), the hardware drivers to
                 include in different types of images, any special software components
                 that are needed, any bootloader information, and also any special image
                 format requirements.
             </para>
 
             <para>
-                At least one machine file is required for a BSP layer.
+                Each BSP Layer requires at least one machine file.
                 However, you can supply more than one file.
                 For example, in the Crown Bay BSP shown earlier in this section, the 
                 <filename>conf/machine</filename> directory contains two configuration files:
@@ -383,19 +384,27 @@
             <para>
                 This <filename>crownbay.conf</filename> file could also include
                 a hardware "tuning" file that is commonly used to
-                define the the package architecture and specify 
+                define the package architecture and specify 
                 optimization flags, which are carefully chosen to give best
                 performance on a given processor.
             </para>
 
             <para>
                 Tuning files are found in the <filename>meta/conf/machine/include</filename>
-                directory.
-                To use them, you simply include them in the machine configuration file. 
+                directory of the 
+                <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'>Yocto Project Files</ulink>.
+                Tuning files can also reside in the BSP Layer itself.  
+                For example, the <filename>ia32-base.inc</filename> file resides in the 
+                <filename>meta-intel</filename> BSP Layer in <filename>conf/machine/include</filename>.
+            </para>
+
+            <para>
+                To use an include file, you simply include them in the machine configuration file. 
                 For example, the Crown Bay BSP <filename>crownbay.conf</filename> has the 
-                following statement:
+                following statements:
                 <literallayout class='monospaced'>
      include conf/machine/include/tune-atom.inc
+     include conf/machine/include/ia32-base.inc
                 </literallayout>
             </para>
             </section>
-- 
cgit v1.2.3-54-g00ecf