ref-manual: edits to FILESPATH and FILESEXTRAPATHS variables.

I updated some of the explanation to be more specific about
the default paths the build system uses and just exactly how
a user should use FILESEXTRAPATHS.

(From yocto-docs rev: 5eba1437fb07300d0b42011eb82200215201c8ac)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 20 insertions, 13 deletions

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 7953aa78a8..615ce4ad47 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1158,22 +1158,24 @@ Core layer for images cannot be removed
                     Extends the search path the OpenEmbedded build system uses
                     when looking for files and patches as it processes recipes
                     and append files.
-                    The directories BitBake uses when it processes recipes
-                    are defined by the
+                    The default directories BitBake uses when it processes
+                    recipes are initially defined by the
                     <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
-                    variable, and can be extended using
-                    <filename>FILESEXTRAPATHS</filename>.
+                    variable.
+                    You can extend <filename>FILESPATH</filename> variable
+                    by using <filename>FILESEXTRAPATHS</filename>.
                 </para>
 
                 <para>
-                    Best practices dictate that you accomplish this by using the
-                    variable from within a <filename>.bbappend</filename> file
-                    and that you prepend paths as follows:
+                    Best practices dictate that you accomplish this by using
+                    <filename>FILESEXTRAPATHS</filename> from within a
+                    <filename>.bbappend</filename> file and that you prepend
+                    paths as follows:
                     <literallayout class='monospaced'>
      FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
                     </literallayout>
-                    In the above example, the build system looks for files in
-                    a directory that has the same name as the corresponding
+                    In the above example, the build system first looks for files
+                    in a directory that has the same name as the corresponding
                     append file.
                     <note>
                         <para>When extending <filename>FILESEXTRAPATHS</filename>,
@@ -1181,10 +1183,10 @@ Core layer for images cannot be removed
                         (<filename>:=</filename>) operator.
                         Immediate expansion makes sure that BitBake evaluates
                         <link linkend='var-THISDIR'><filename>THISDIR</filename></link>
-                        at the time the directive
-                        is encountered rather than at some later time when
-                        expansion might result in a directory that does not
-                        contain the files you need.</para>
+                        at the time the directive is encountered rather than at
+                        some later time when expansion might result in a
+                        directory that does not contain the files you need.
+                        </para>
                         <para>Also, include the trailing separating colon
                         character if you are prepending.
                         The trailing colon character is necessary because you
@@ -1240,6 +1242,11 @@ Core layer for images cannot be removed
                     <note>
                         Do not hand-edit the <filename>FILESPATH</filename>
                         variable.
+                        If you want the build system to look in directories
+                        other than the defaults, extend the
+                        <filename>FILESPATH</filename> variable by using the
+                        <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
+                        variable.
                     </note>
                     Be aware that the default <filename>FILESPATH</filename>
                     directories do not map to directories in custom layers