ref-manual: Updates to FILESPATH and FILESOVERRIDES.

Fixes [YOCTO #13112]

Did some paragraph re-ordering based on reviewer feedback.
Also, added a bit in the FILESOVERRIDES variable description
about out it uses overrides to help with automatic overriding
of the FILESPATH variable.  Added some better links into the
BitBake User Manual as well.

(From yocto-docs rev: 6ad5c6f030501cda9bc8ea648d9d7c0e991f55cf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 31 insertions, 26 deletions

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 84551cc23a..7b44685546 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -5012,9 +5012,14 @@
                     A subset of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
                     used by the OpenEmbedded build system for creating
                     <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>.
+                    The <filename>FILESOVERRIDES</filename> variable uses
+                    overrides to automatically extend the
+                    <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
+                    variable.
                     You can find more information on how overrides are handled
                     in the
-                    <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>.
+                    "<ulink url='&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides'>Conditional Syntax (Overrides)</ulink>"
+                    section of the BitBake User Manual.
                 </para>
 
                 <para>
@@ -5055,31 +5060,6 @@
                 </para>
 
                 <para>
-                    You can take advantage of this searching behavior in
-                    useful ways.
-                    For example, consider a case where the following
-                    directory structure exists for general and machine-specific
-                    configurations:
-                    <literallayout class='monospaced'>
-     files/defconfig
-     files/MACHINEA/defconfig
-     files/MACHINEB/defconfig
-                    </literallayout>
-                    Also in the example, the <filename>SRC_URI</filename>
-                    statement contains "file://defconfig".
-                    Given this scenario, you can set
-                    <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
-                    to "MACHINEA" and cause the build system to use files
-                    from <filename>files/MACHINEA</filename>.
-                    Set <filename>MACHINE</filename> to "MACHINEB" and the
-                    build system uses files from
-                    <filename>files/MACHINEB</filename>.
-                    Finally, for any machine other than "MACHINEA" and
-                    "MACHINEB", the build system uses files from
-                    <filename>files/defconfig</filename>.
-                </para>
-
-                <para>
                     The default value for the <filename>FILESPATH</filename>
                     variable is defined in the <filename>base.bbclass</filename>
                     class found in <filename>meta/classes</filename> in the
@@ -5122,6 +5102,31 @@
                 </para>
 
                 <para>
+                    You can take advantage of this searching behavior in
+                    useful ways.
+                    For example, consider a case where the following
+                    directory structure exists for general and machine-specific
+                    configurations:
+                    <literallayout class='monospaced'>
+     files/defconfig
+     files/MACHINEA/defconfig
+     files/MACHINEB/defconfig
+                    </literallayout>
+                    Also in the example, the <filename>SRC_URI</filename>
+                    statement contains "file://defconfig".
+                    Given this scenario, you can set
+                    <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
+                    to "MACHINEA" and cause the build system to use files
+                    from <filename>files/MACHINEA</filename>.
+                    Set <filename>MACHINE</filename> to "MACHINEB" and the
+                    build system uses files from
+                    <filename>files/MACHINEB</filename>.
+                    Finally, for any machine other than "MACHINEA" and
+                    "MACHINEB", the build system uses files from
+                    <filename>files/defconfig</filename>.
+                </para>
+
+                <para>
                     You can find out more about the patching process in the
                     "<ulink url='&YOCTO_DOCS_OM_URL;#patching-dev-environment'>Patching</ulink>"
                     section in the Yocto Project Overview and Concepts Manual