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>
This commit is contained in:
parent
eedd602e3b
commit
4bb60daf5a
|
@ -1156,21 +1156,43 @@ Core layer for images cannot be removed
|
||||||
<glossdef>
|
<glossdef>
|
||||||
<para>
|
<para>
|
||||||
Extends the search path the OpenEmbedded build system uses
|
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
|
||||||
|
<link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
|
||||||
|
variable, and can be extended using
|
||||||
|
<filename>FILESEXTRAPATHS</filename>.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
Best practices dictate that you accomplish this by using the
|
Best practices dictate that you accomplish this by using the
|
||||||
variable from within a <filename>.bbappend</filename> file
|
variable from within a <filename>.bbappend</filename> file
|
||||||
and that you prepend paths as follows:
|
and that you prepend paths as follows:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
|
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
|
||||||
</literallayout>
|
</literallayout>
|
||||||
|
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:
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
|
||||||
|
</literallayout>
|
||||||
|
In this example, the build system extends the
|
||||||
|
<filename>FILESPATH</filename> variable to include a
|
||||||
|
directory named <filename>files</filename> that is in the
|
||||||
|
same directory as the corresponding append file.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Here is a final example that specifically adds three paths:
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
|
||||||
|
</literallayout>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The directories BitBake uses when it processes recipes
|
|
||||||
are defined by the
|
|
||||||
<link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
|
|
||||||
variable, and can be extended using
|
|
||||||
<filename>FILESEXTRAPATHS</filename>.
|
|
||||||
By prepending paths in <filename>.bbappend</filename>
|
By prepending paths in <filename>.bbappend</filename>
|
||||||
files, you allow multiple append files that reside in
|
files, you allow multiple append files that reside in
|
||||||
different layers but are used for the same recipe to
|
different layers but are used for the same recipe to
|
||||||
|
@ -1180,10 +1202,6 @@ Core layer for images cannot be removed
|
||||||
(<filename>:=</filename>) operator and include
|
(<filename>:=</filename>) operator and include
|
||||||
the trailing separating colon character.
|
the trailing separating colon character.
|
||||||
</note>
|
</note>
|
||||||
Here is another example that specifically adds three paths:
|
|
||||||
<literallayout class='monospaced'>
|
|
||||||
FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
|
|
||||||
</literallayout>
|
|
||||||
</para>
|
</para>
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
@ -1208,10 +1226,10 @@ Core layer for images cannot be removed
|
||||||
FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
|
FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
|
||||||
"${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
|
"${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
|
||||||
</literallayout>
|
</literallayout>
|
||||||
<warning>
|
<note>
|
||||||
Do not hand-edit the <filename>FILESPATH</filename>
|
Do not hand-edit the <filename>FILESPATH</filename>
|
||||||
variable.
|
variable.
|
||||||
</warning>
|
</note>
|
||||||
Be aware that the default <filename>FILESPATH</filename>
|
Be aware that the default <filename>FILESPATH</filename>
|
||||||
directories do not map to directories in custom layers
|
directories do not map to directories in custom layers
|
||||||
where append files (<filename>.bbappend</filename>)
|
where append files (<filename>.bbappend</filename>)
|
||||||
|
@ -3405,17 +3423,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
|
||||||
recipe file (<filename>.bb</filename>) or
|
recipe file (<filename>.bb</filename>) or
|
||||||
append file (<filename>.bbappend</filename>)
|
append file (<filename>.bbappend</filename>)
|
||||||
resides:
|
resides:
|
||||||
<note>
|
|
||||||
If you want the build system to pick up files
|
|
||||||
specified through a
|
|
||||||
<filename>SRC_URI</filename>
|
|
||||||
statement from your append file, you need to be
|
|
||||||
sure to extend the
|
|
||||||
<filename>FILESPATH</filename>
|
|
||||||
variable by also using the
|
|
||||||
<link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
|
|
||||||
variable from within your append file.
|
|
||||||
</note>
|
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem><para><emphasis><filename>${BPN}</filename> -</emphasis>
|
<listitem><para><emphasis><filename>${BPN}</filename> -</emphasis>
|
||||||
The base recipe name without any special
|
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"
|
||||||
<filename>files</filename> and is also
|
<filename>files</filename> and is also
|
||||||
alongside the recipe or append file.
|
alongside the recipe or append file.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</itemizedlist></para></listitem>
|
</itemizedlist>
|
||||||
|
<note>
|
||||||
|
If you want the build system to pick up files
|
||||||
|
specified through a
|
||||||
|
<filename>SRC_URI</filename>
|
||||||
|
statement from your append file, you need to be
|
||||||
|
sure to extend the
|
||||||
|
<filename>FILESPATH</filename>
|
||||||
|
variable by also using the
|
||||||
|
<link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
|
||||||
|
variable from within your append file.
|
||||||
|
</note>
|
||||||
|
</para></listitem>
|
||||||
<listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a
|
<listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a
|
||||||
Bazaar revision control repository.</para></listitem>
|
Bazaar revision control repository.</para></listitem>
|
||||||
<listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a
|
<listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a
|
||||||
|
|
Loading…
Reference in New Issue