summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-06-03 12:37:06 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-06-14 17:33:30 +0100
commit5e32769597fd4961a04f7a437b7878f1a4147c52 (patch)
tree3e851fd76886ffb47b6ea38ea91400014864dabf
parenta8e62dd04157c823e156087356ad9d856d5116e2 (diff)
downloadpoky-5e32769597fd4961a04f7a437b7878f1a4147c52.tar.gz
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>
-rw-r--r--documentation/ref-manual/ref-variables.xml33
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
1158 Extends the search path the OpenEmbedded build system uses 1158 Extends the search path the OpenEmbedded build system uses
1159 when looking for files and patches as it processes recipes 1159 when looking for files and patches as it processes recipes
1160 and append files. 1160 and append files.
1161 The directories BitBake uses when it processes recipes 1161 The default directories BitBake uses when it processes
1162 are defined by the 1162 recipes are initially defined by the
1163 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> 1163 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
1164 variable, and can be extended using 1164 variable.
1165 <filename>FILESEXTRAPATHS</filename>. 1165 You can extend <filename>FILESPATH</filename> variable
1166 by using <filename>FILESEXTRAPATHS</filename>.
1166 </para> 1167 </para>
1167 1168
1168 <para> 1169 <para>
1169 Best practices dictate that you accomplish this by using the 1170 Best practices dictate that you accomplish this by using
1170 variable from within a <filename>.bbappend</filename> file 1171 <filename>FILESEXTRAPATHS</filename> from within a
1171 and that you prepend paths as follows: 1172 <filename>.bbappend</filename> file and that you prepend
1173 paths as follows:
1172 <literallayout class='monospaced'> 1174 <literallayout class='monospaced'>
1173 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 1175 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
1174 </literallayout> 1176 </literallayout>
1175 In the above example, the build system looks for files in 1177 In the above example, the build system first looks for files
1176 a directory that has the same name as the corresponding 1178 in a directory that has the same name as the corresponding
1177 append file. 1179 append file.
1178 <note> 1180 <note>
1179 <para>When extending <filename>FILESEXTRAPATHS</filename>, 1181 <para>When extending <filename>FILESEXTRAPATHS</filename>,
@@ -1181,10 +1183,10 @@ Core layer for images cannot be removed
1181 (<filename>:=</filename>) operator. 1183 (<filename>:=</filename>) operator.
1182 Immediate expansion makes sure that BitBake evaluates 1184 Immediate expansion makes sure that BitBake evaluates
1183 <link linkend='var-THISDIR'><filename>THISDIR</filename></link> 1185 <link linkend='var-THISDIR'><filename>THISDIR</filename></link>
1184 at the time the directive 1186 at the time the directive is encountered rather than at
1185 is encountered rather than at some later time when 1187 some later time when expansion might result in a
1186 expansion might result in a directory that does not 1188 directory that does not contain the files you need.
1187 contain the files you need.</para> 1189 </para>
1188 <para>Also, include the trailing separating colon 1190 <para>Also, include the trailing separating colon
1189 character if you are prepending. 1191 character if you are prepending.
1190 The trailing colon character is necessary because you 1192 The trailing colon character is necessary because you
@@ -1240,6 +1242,11 @@ Core layer for images cannot be removed
1240 <note> 1242 <note>
1241 Do not hand-edit the <filename>FILESPATH</filename> 1243 Do not hand-edit the <filename>FILESPATH</filename>
1242 variable. 1244 variable.
1245 If you want the build system to look in directories
1246 other than the defaults, extend the
1247 <filename>FILESPATH</filename> variable by using the
1248 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
1249 variable.
1243 </note> 1250 </note>
1244 Be aware that the default <filename>FILESPATH</filename> 1251 Be aware that the default <filename>FILESPATH</filename>
1245 directories do not map to directories in custom layers 1252 directories do not map to directories in custom layers