aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-04-17 10:09:10 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-17 22:34:23 +0100
commitef04b1da28b71f36d9394db7ac6318ff36ca5d9b (patch)
treea3da6463efbd70fdd9e344506236ddf8fb69b93f /documentation
parentf418e7f5a1e76fc70fe6f1accddc653949d2e2b1 (diff)
downloadopenembedded-core-contrib-ef04b1da28b71f36d9394db7ac6318ff36ca5d9b.tar.gz
ref-manual: Edits to clear up the SRC_URI variable description.
I found it confusing due to not specifically accounting for .bb and .bbappend files. I added some wording to clearly specify use given the two types of "recipes". Specifically, if you are going to use a SRC_URI statment from an append file, the user really should be aware that they will need to extend the FILESPATH variable by also using FILESEXTRAPATHS from within that append file. (From yocto-docs rev: 8fd0047bd5c4598532afc6f0803f6ae23fa213b2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml57
1 files changed, 39 insertions, 18 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index e4bcb56aed..1a751a9758 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -3368,36 +3368,57 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm>
<glossdef>
<para>The list of source files - local or remote.
- This variable tells the OpenEmbedded build system which bits to pull
- in for the build and how to pull them in.
- For example, if the recipe only needs to fetch a tarball from the
- Internet, the recipe uses a single <filename>SRC_URI</filename> entry.
- On the other hand, if the recipe needs to fetch a tarball, apply
- two patches, and include a custom file, the recipe would include four
+ This variable tells the OpenEmbedded build system which bits
+ to pull in for the build and how to pull them in.
+ For example, if the recipe or append file only needs to
+ fetch a tarball from the Internet, the recipe or
+ append file uses a single <filename>SRC_URI</filename>
+ entry.
+ On the other hand, if the recipe or append file needs to
+ fetch a tarball, apply two patches, and include a custom
+ file, the recipe or append file would include four
instances of the variable.</para>
<para>The following list explains the available URI protocols:
<itemizedlist>
- <listitem><para><emphasis><filename>file://</filename> -</emphasis> Fetches files, which is usually
- a file shipped with the
+ <listitem><para><emphasis><filename>file://</filename> -</emphasis>
+ Fetches files, which are usually files shipped with
+ the
<ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>,
from the local machine.
The path is relative to the
<link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
variable.
- Thus, the build system searches, in order, from the following directories,
- which are assumed to be a subdirectories of the directory in which the
- recipe file resides:
+ Thus, the build system searches, in order, from the
+ following directories, which are assumed to be a
+ subdirectories of the directory in which the
+ recipe file (<filename>.bb</filename>) or
+ append file (<filename>.bbappend</filename>)
+ 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>
- <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> The
- base recipe name without any special suffix or version numbers.
+ <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis>
+ The base recipe name without any special
+ suffix or version numbers.
</para></listitem>
<listitem><para><emphasis><filename>${BP}</filename> -</emphasis>
<filename>${<link linkend='var-BPN'>BPN</link>}-${PV}</filename>.
- The base recipe name and version but without any special
- package name suffix.</para></listitem>
- <listitem><para><emphasis>files -</emphasis> Files within a
- directory, which is named <filename>files</filename>
- and is also alongside the recipe.
+ The base recipe name and version but without
+ any special package name suffix.
+ </para></listitem>
+ <listitem><para><emphasis>files -</emphasis>
+ Files within a directory, which is named
+ <filename>files</filename> and is also
+ alongside the recipe or append file.
</para></listitem>
</itemizedlist></para></listitem>
<listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a