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>
This commit is contained in:
Scott Rifenbark 2013-06-03 12:37:06 +03:00 committed by Richard Purdie
parent a8e62dd041
commit 5e32769597
1 changed files with 20 additions and 13 deletions

View File

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