summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-02-15 10:24:34 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2019-02-16 08:19:55 +0000
commit554379870fab3552fad774c065c02fa295f02b08 (patch)
tree65d4f326eeeec1dff6dbce4945b4480ffbe1dc76 /documentation/ref-manual
parent04e8023f7e964e81dda4fa2fbad4d6019c4defb4 (diff)
downloadpoky-554379870fab3552fad774c065c02fa295f02b08.tar.gz
ref-manual: Updates to FILESPATH and FILESOVERRIDES.
Fixes [YOCTO #13112] Did some paragraph re-ordering based on reviewer feedback. Also, added a bit in the FILESOVERRIDES variable description about out it uses overrides to help with automatic overriding of the FILESPATH variable. Added some better links into the BitBake User Manual as well. (From yocto-docs rev: 6ad5c6f030501cda9bc8ea648d9d7c0e991f55cf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml57
1 files changed, 31 insertions, 26 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 84551cc23a..7b44685546 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -5012,9 +5012,14 @@
5012 A subset of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> 5012 A subset of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
5013 used by the OpenEmbedded build system for creating 5013 used by the OpenEmbedded build system for creating
5014 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>. 5014 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>.
5015 The <filename>FILESOVERRIDES</filename> variable uses
5016 overrides to automatically extend the
5017 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
5018 variable.
5015 You can find more information on how overrides are handled 5019 You can find more information on how overrides are handled
5016 in the 5020 in the
5017 <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>. 5021 "<ulink url='&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides'>Conditional Syntax (Overrides)</ulink>"
5022 section of the BitBake User Manual.
5018 </para> 5023 </para>
5019 5024
5020 <para> 5025 <para>
@@ -5055,31 +5060,6 @@
5055 </para> 5060 </para>
5056 5061
5057 <para> 5062 <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>
5083 The default value for the <filename>FILESPATH</filename> 5063 The default value for the <filename>FILESPATH</filename>
5084 variable is defined in the <filename>base.bbclass</filename> 5064 variable is defined in the <filename>base.bbclass</filename>
5085 class found in <filename>meta/classes</filename> in the 5065 class found in <filename>meta/classes</filename> in the
@@ -5122,6 +5102,31 @@
5122 </para> 5102 </para>
5123 5103
5124 <para> 5104 <para>
5105 You can take advantage of this searching behavior in
5106 useful ways.
5107 For example, consider a case where the following
5108 directory structure exists for general and machine-specific
5109 configurations:
5110 <literallayout class='monospaced'>
5111 files/defconfig
5112 files/MACHINEA/defconfig
5113 files/MACHINEB/defconfig
5114 </literallayout>
5115 Also in the example, the <filename>SRC_URI</filename>
5116 statement contains "file://defconfig".
5117 Given this scenario, you can set
5118 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
5119 to "MACHINEA" and cause the build system to use files
5120 from <filename>files/MACHINEA</filename>.
5121 Set <filename>MACHINE</filename> to "MACHINEB" and the
5122 build system uses files from
5123 <filename>files/MACHINEB</filename>.
5124 Finally, for any machine other than "MACHINEA" and
5125 "MACHINEB", the build system uses files from
5126 <filename>files/defconfig</filename>.
5127 </para>
5128
5129 <para>
5125 You can find out more about the patching process in the 5130 You can find out more about the patching process in the
5126 "<ulink url='&YOCTO_DOCS_OM_URL;#patching-dev-environment'>Patching</ulink>" 5131 "<ulink url='&YOCTO_DOCS_OM_URL;#patching-dev-environment'>Patching</ulink>"
5127 section in the Yocto Project Overview and Concepts Manual 5132 section in the Yocto Project Overview and Concepts Manual