summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-04-17 11:06:35 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-17 22:34:23 +0100
commit4bb60daf5acc46fd3ad8df99eb88f71bff399d26 (patch)
tree9d927a7aa9f07fa382ea1b11475e4b817d4d90e8 /documentation/ref-manual
parenteedd602e3be7bbb52d393ca17c9ab643300fdcdd (diff)
downloadpoky-4bb60daf5acc46fd3ad8df99eb88f71bff399d26.tar.gz
ref-manual: Edits to SRC_URI, FILESPATH, and FILESEXTRAPATHS.
Applied some review comments from Paul. Took the warning formatting out because it sucks. (From yocto-docs rev: 6c4162777cb686c8b24b15ded2594f4f4a6acba6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml67
1 files changed, 43 insertions, 24 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index be15a447e6..ac4686f4da 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1156,21 +1156,43 @@ Core layer for images cannot be removed
1156 <glossdef> 1156 <glossdef>
1157 <para> 1157 <para>
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.
1161 The directories BitBake uses when it processes recipes
1162 are defined by the
1163 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
1164 variable, and can be extended using
1165 <filename>FILESEXTRAPATHS</filename>.
1166 </para>
1167
1168 <para>
1160 Best practices dictate that you accomplish this by using the 1169 Best practices dictate that you accomplish this by using the
1161 variable from within a <filename>.bbappend</filename> file 1170 variable from within a <filename>.bbappend</filename> file
1162 and that you prepend paths as follows: 1171 and that you prepend paths as follows:
1163 <literallayout class='monospaced'> 1172 <literallayout class='monospaced'>
1164 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 1173 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
1165 </literallayout> 1174 </literallayout>
1175 In the above example, the build system looks for files in
1176 a directory that has the same name as the corresponding
1177 append file.
1178 Here is another common use:
1179 <literallayout class='monospaced'>
1180 FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
1181 </literallayout>
1182 In this example, the build system extends the
1183 <filename>FILESPATH</filename> variable to include a
1184 directory named <filename>files</filename> that is in the
1185 same directory as the corresponding append file.
1186 </para>
1187
1188 <para>
1189 Here is a final example that specifically adds three paths:
1190 <literallayout class='monospaced'>
1191 FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
1192 </literallayout>
1166 </para> 1193 </para>
1167 1194
1168 <para> 1195 <para>
1169 The directories BitBake uses when it processes recipes
1170 are defined by the
1171 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
1172 variable, and can be extended using
1173 <filename>FILESEXTRAPATHS</filename>.
1174 By prepending paths in <filename>.bbappend</filename> 1196 By prepending paths in <filename>.bbappend</filename>
1175 files, you allow multiple append files that reside in 1197 files, you allow multiple append files that reside in
1176 different layers but are used for the same recipe to 1198 different layers but are used for the same recipe to
@@ -1180,10 +1202,6 @@ Core layer for images cannot be removed
1180 (<filename>:=</filename>) operator and include 1202 (<filename>:=</filename>) operator and include
1181 the trailing separating colon character. 1203 the trailing separating colon character.
1182 </note> 1204 </note>
1183 Here is another example that specifically adds three paths:
1184 <literallayout class='monospaced'>
1185 FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
1186 </literallayout>
1187 </para> 1205 </para>
1188 </glossdef> 1206 </glossdef>
1189 </glossentry> 1207 </glossentry>
@@ -1208,10 +1226,10 @@ Core layer for images cannot be removed
1208 FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ 1226 FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
1209 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" 1227 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
1210 </literallayout> 1228 </literallayout>
1211 <warning> 1229 <note>
1212 Do not hand-edit the <filename>FILESPATH</filename> 1230 Do not hand-edit the <filename>FILESPATH</filename>
1213 variable. 1231 variable.
1214 </warning> 1232 </note>
1215 Be aware that the default <filename>FILESPATH</filename> 1233 Be aware that the default <filename>FILESPATH</filename>
1216 directories do not map to directories in custom layers 1234 directories do not map to directories in custom layers
1217 where append files (<filename>.bbappend</filename>) 1235 where append files (<filename>.bbappend</filename>)
@@ -3405,17 +3423,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3405 recipe file (<filename>.bb</filename>) or 3423 recipe file (<filename>.bb</filename>) or
3406 append file (<filename>.bbappend</filename>) 3424 append file (<filename>.bbappend</filename>)
3407 resides: 3425 resides:
3408 <note>
3409 If you want the build system to pick up files
3410 specified through a
3411 <filename>SRC_URI</filename>
3412 statement from your append file, you need to be
3413 sure to extend the
3414 <filename>FILESPATH</filename>
3415 variable by also using the
3416 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
3417 variable from within your append file.
3418 </note>
3419 <itemizedlist> 3426 <itemizedlist>
3420 <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> 3427 <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis>
3421 The base recipe name without any special 3428 The base recipe name without any special
@@ -3431,7 +3438,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3431 <filename>files</filename> and is also 3438 <filename>files</filename> and is also
3432 alongside the recipe or append file. 3439 alongside the recipe or append file.
3433 </para></listitem> 3440 </para></listitem>
3434 </itemizedlist></para></listitem> 3441 </itemizedlist>
3442 <note>
3443 If you want the build system to pick up files
3444 specified through a
3445 <filename>SRC_URI</filename>
3446 statement from your append file, you need to be
3447 sure to extend the
3448 <filename>FILESPATH</filename>
3449 variable by also using the
3450 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
3451 variable from within your append file.
3452 </note>
3453 </para></listitem>
3435 <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a 3454 <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a
3436 Bazaar revision control repository.</para></listitem> 3455 Bazaar revision control repository.</para></listitem>
3437 <listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a 3456 <listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a