ref-manual: Updates to the FILESEXTRAPATHS variable.

Fixed YOCTO #3662

Updates to the description so _prepend is used to add paths
to the front of the search order and use of the variable
without _prepend just adds paths to the end of the
FILESPATH order.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 44c98058c1a75a9e6c95e4f33dbe1696e23d97d0)

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-01-30 14:10:25 -06:00 committed by Richard Purdie
parent 58f61cf79e
commit 6a926df682
1 changed files with 20 additions and 12 deletions

View File

@ -1012,31 +1012,39 @@ Core layer for images cannot be removed
<glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm> <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm>
<glossdef> <glossdef>
<para> <para>
Extends the search path the OpenEmbedded build system uses when Extends the search path the OpenEmbedded build system uses
looking for files and patches as it processes recipes. when looking for files and patches as it processes recipes.
The directories BitBake uses when it processes recipes is defined by the The directories BitBake uses when it processes recipes are
defined by the
<link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> variable. <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> variable.
You can add directories to the search path by defining the You can add directories to the search path by defining the
<filename>FILESEXTRAPATHS</filename> variable. <filename>FILESEXTRAPATHS</filename> variable.
</para> </para>
<para> <para>
To add paths to the search order, provide a list of directories and separate To add paths to the front of the search order, prepend
them and use the immediate expansion
(<filename>:=</filename>) operator.
Provide a list of directories and separate
each path using a colon character as follows: each path using a colon character as follows:
<literallayout class='monospaced'> <literallayout class='monospaced'>
FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
</literallayout> </literallayout>
Typically, you want your directories searched first. You can add paths to the end of the search order by simply
To make sure that happens, use <filename>_prepend</filename> and adding them as follows:
the immediate expansion (<filename>:=</filename>) operator as shown in the <literallayout class='monospaced'>
previous example. FILESEXTRAPATHS := "path_1:path_2:path_3:"
Finally, to maintain the integrity of the <filename>FILESPATH</filename> variable, </literallayout>
you must include the appropriate beginning or ending (as needed) colon character. To maintain the integrity of the
<filename>FILESPATH</filename> variable, you must include
the appropriate beginning or ending (as needed) colon
character.
</para> </para>
<para> <para>
The <filename>FILESEXTRAPATHS</filename> variable is intended for use in The <filename>FILESEXTRAPATHS</filename> variable is
<filename>.bbappend</filename> files to include any additional files provided in that layer. intended for use in <filename>.bbappend</filename> files
to include any additional files provided in that layer.
You typically accomplish this with the following: You typically accomplish this with the following:
<literallayout class='monospaced'> <literallayout class='monospaced'>
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"