summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml95
1 files changed, 69 insertions, 26 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 9e51b7591c..ed65727fc7 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -5041,17 +5041,45 @@
5041 <glossdef> 5041 <glossdef>
5042 <para role="glossdeffirst"> 5042 <para role="glossdeffirst">
5043<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 5043<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
5044 The default set of directories the OpenEmbedded build system 5044 The default set of directories the OpenEmbedded build
5045 uses when searching for patches and files. 5045 system uses when searching for patches and files.
5046 During the build process, BitBake searches each directory in 5046 </para>
5047 <filename>FILESPATH</filename> in the specified order when 5047
5048 looking for files and patches specified by each 5048 <para>
5049 During the build process, BitBake searches each directory
5050 in <filename>FILESPATH</filename> in the specified order
5051 when looking for files and patches specified by each
5049 <filename>file://</filename> URI in a recipe's 5052 <filename>file://</filename> URI in a recipe's
5050 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> 5053 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
5051 statements. 5054 statements.
5052 </para> 5055 </para>
5053 5056
5054 <para> 5057 <para>
5058 You can take advantage of this searching behavior in
5059 useful ways.
5060 For example, consider a case where the following
5061 directory structure exists for general and machine-specific
5062 configurations:
5063 <literallayout class='monospaced'>
5064 files/defconfig
5065 files/MACHINEA/defconfig
5066 files/MACHINEB/defconfig
5067 </literallayout>
5068 Also in the example, the <filename>SRC_URI</filename>
5069 statement contains "file://defconfig".
5070 Given this scenario, you can set
5071 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
5072 to "MACHINEA" and cause the build system to use files
5073 from <filename>files/MACHINEA</filename>.
5074 Set <filename>MACHINE</filename> to "MACHINEB" and the
5075 build system uses files from
5076 <filename>files/MACHINEB</filename>.
5077 Finally, for any machine other than "MACHINEA" and
5078 "MACHINEB", the build system uses files from
5079 <filename>files/defconfig</filename>.
5080 </para>
5081
5082 <para>
5055 The default value for the <filename>FILESPATH</filename> 5083 The default value for the <filename>FILESPATH</filename>
5056 variable is defined in the <filename>base.bbclass</filename> 5084 variable is defined in the <filename>base.bbclass</filename>
5057 class found in <filename>meta/classes</filename> in the 5085 class found in <filename>meta/classes</filename> in the
@@ -5060,23 +5088,37 @@
5060 FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ 5088 FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
5061 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" 5089 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
5062 </literallayout> 5090 </literallayout>
5063 <note> 5091 The <filename>FILESPATH</filename> variable is automatically
5064 Do not hand-edit the <filename>FILESPATH</filename> 5092 extended using the overrides from the
5065 variable. 5093 <link linkend='var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></link>
5066 If you want the build system to look in directories 5094 variable.
5067 other than the defaults, extend the 5095 <note><title>Notes</title>
5068 <filename>FILESPATH</filename> variable by using the 5096 <itemizedlist>
5069 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> 5097 <listitem><para>
5070 variable. 5098 Do not hand-edit the
5099 <filename>FILESPATH</filename> variable.
5100 If you want the build system to look in
5101 directories other than the defaults, extend the
5102 <filename>FILESPATH</filename> variable by
5103 using the
5104 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
5105 variable.
5106 </para></listitem>
5107 <listitem><para>
5108 Be aware that the default
5109 <filename>FILESPATH</filename> directories do
5110 not map to directories in custom layers
5111 where append files
5112 (<filename>.bbappend</filename>) are used.
5113 If you want the build system to find patches
5114 or files that reside with your append files,
5115 you need to extend the
5116 <filename>FILESPATH</filename> variable by
5117 using the <filename>FILESEXTRAPATHS</filename>
5118 variable.
5119 </para></listitem>
5120 </itemizedlist>
5071 </note> 5121 </note>
5072 Be aware that the default <filename>FILESPATH</filename>
5073 directories do not map to directories in custom layers
5074 where append files (<filename>.bbappend</filename>)
5075 are used.
5076 If you want the build system to find patches or files
5077 that reside with your append files, you need to extend
5078 the <filename>FILESPATH</filename> variable by using
5079 the <filename>FILESEXTRAPATHS</filename> variable.
5080 </para> 5122 </para>
5081 5123
5082 <para> 5124 <para>
@@ -6076,11 +6118,12 @@
6076 <note><title>Notes</title> 6118 <note><title>Notes</title>
6077 <itemizedlist> 6119 <itemizedlist>
6078 <listitem><para> 6120 <listitem><para>
6079 If you add "live" to 6121 If an image recipe uses the "inherit image" line
6080 <filename>IMAGE_FSTYPES</filename> inside an image 6122 and you are setting
6081 recipe, be sure that you do so prior to the 6123 <filename>IMAGE_FSTYPES</filename> inside the
6082 "inherit image" line of the recipe or the live 6124 recipe, you must set
6083 image will not build. 6125 <filename>IMAGE_FSTYPES</filename> prior to
6126 using the "inherit image" line.
6084 </para></listitem> 6127 </para></listitem>
6085 <listitem><para> 6128 <listitem><para>
6086 Due to the way the OpenEmbedded build system 6129 Due to the way the OpenEmbedded build system