summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-04-17 10:22:47 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-17 22:34:23 +0100
commiteedd602e3be7bbb52d393ca17c9ab643300fdcdd (patch)
tree8572304c94560a3ab21442feb58cf6002f7ab086 /documentation
parentef04b1da28b71f36d9394db7ac6318ff36ca5d9b (diff)
downloadpoky-eedd602e3be7bbb52d393ca17c9ab643300fdcdd.tar.gz
ref-manual: Updates to the FILESPATH variable.
Added some more clarity about how this variable works and the implications for using the default setting from the base.bbclass file. Namely, if you are going to have the build system look for files in your layer and your layer uses an append file, then you need to also use the FILESEXTRAPATHS variable to extend FILESPATHS. (From yocto-docs rev: 2826fa6f9286efb1d5ca6cf85f65266a35bb8cfc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml33
1 files changed, 22 insertions, 11 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 1a751a9758..be15a447e6 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1191,26 +1191,37 @@ Core layer for images cannot be removed
1191 <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm> 1191 <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm>
1192 <glossdef> 1192 <glossdef>
1193 <para> 1193 <para>
1194 The default set of directories the OpenEmbedded build system uses 1194 The default set of directories the OpenEmbedded build system
1195 when searching for patches and files. 1195 uses when searching for patches and files.
1196 During the build process, BitBake searches each directory in 1196 During the build process, BitBake searches each directory in
1197 <filename>FILESPATH</filename> in the specified order when looking for 1197 <filename>FILESPATH</filename> in the specified order when
1198 files and patches specified by each <filename>file://</filename> URI in a recipe. 1198 looking for files and patches specified by each
1199 <filename>file://</filename> URI in a recipe.
1199 </para> 1200 </para>
1200 1201
1201 <para> 1202 <para>
1202 The default value for the <filename>FILESPATH</filename> variable is defined 1203 The default value for the <filename>FILESPATH</filename>
1203 in the <filename>base.bbclass</filename> class found in 1204 variable is defined in the <filename>base.bbclass</filename>
1204 <filename>meta/classes</filename> in the 1205 class found in <filename>meta/classes</filename> in the
1205 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: 1206 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
1206 <literallayout class='monospaced'> 1207 <literallayout class='monospaced'>
1207 FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ 1208 FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
1208 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" 1209 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
1209 </literallayout> 1210 </literallayout>
1210 Do not hand-edit the <filename>FILESPATH</filename> variable. 1211 <warning>
1211 If you want to extend the set of pathnames that BitBake uses when searching for 1212 Do not hand-edit the <filename>FILESPATH</filename>
1212 files and patches, use the 1213 variable.
1213 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> variable. 1214 </warning>
1215 Be aware that the default <filename>FILESPATH</filename>
1216 directories do not map to directories in custom layers
1217 where append files (<filename>.bbappend</filename>)
1218 are used.
1219 If you want the build system to find patches or files
1220 that reside with your append files, you need to extend
1221 the <filename>FILESPATH</filename> variable by using
1222 the
1223 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
1224 variable.
1214 </para> 1225 </para>
1215 </glossdef> 1226 </glossdef>
1216 </glossentry> 1227 </glossentry>