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
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.
+ The directories BitBake uses when it processes recipes
+ are defined by the
+ FILESPATH
+ variable, and can be extended using
+ FILESEXTRAPATHS.
+
+
+
Best practices dictate that you accomplish this by using the
variable from within a .bbappend file
and that you prepend paths as follows:
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
+ In the above example, the build system looks for files in
+ a directory that has the same name as the corresponding
+ append file.
+ Here is another common use:
+
+ FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
+
+ In this example, the build system extends the
+ FILESPATH variable to include a
+ directory named files that is in the
+ same directory as the corresponding append file.
+
+
+
+ Here is a final example that specifically adds three paths:
+
+ FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
+
- The directories BitBake uses when it processes recipes
- are defined by the
- FILESPATH
- variable, and can be extended using
- FILESEXTRAPATHS.
By prepending paths in .bbappend
files, you allow multiple append files that reside in
different layers but are used for the same recipe to
@@ -1180,10 +1202,6 @@ Core layer for images cannot be removed
(:=) operator and include
the trailing separating colon character.
- Here is another example that specifically adds three paths:
-
- FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
-
@@ -1208,10 +1226,10 @@ Core layer for images cannot be removed
FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
"${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
-
+
Do not hand-edit the FILESPATH
variable.
-
+
Be aware that the default FILESPATH
directories do not map to directories in custom layers
where append files (.bbappend)
@@ -3405,17 +3423,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
recipe file (.bb) or
append file (.bbappend)
resides:
-
- If you want the build system to pick up files
- specified through a
- SRC_URI
- statement from your append file, you need to be
- sure to extend the
- FILESPATH
- variable by also using the
- FILESEXTRAPATHS
- variable from within your append file.
- ${BPN} -
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"
files and is also
alongside the recipe or append file.
-
+
+
+ If you want the build system to pick up files
+ specified through a
+ SRC_URI
+ statement from your append file, you need to be
+ sure to extend the
+ FILESPATH
+ variable by also using the
+ FILESEXTRAPATHS
+ variable from within your append file.
+
+
bzr:// - Fetches files from a
Bazaar revision control repository.git:// - Fetches files from a