diff options
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 57 |
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" | |||
3368 | <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm> | 3368 | <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm> |
3369 | <glossdef> | 3369 | <glossdef> |
3370 | <para>The list of source files - local or remote. | 3370 | <para>The list of source files - local or remote. |
3371 | This variable tells the OpenEmbedded build system which bits to pull | 3371 | This variable tells the OpenEmbedded build system which bits |
3372 | in for the build and how to pull them in. | 3372 | to pull in for the build and how to pull them in. |
3373 | For example, if the recipe only needs to fetch a tarball from the | 3373 | For example, if the recipe or append file only needs to |
3374 | Internet, the recipe uses a single <filename>SRC_URI</filename> entry. | 3374 | fetch a tarball from the Internet, the recipe or |
3375 | On the other hand, if the recipe needs to fetch a tarball, apply | 3375 | append file uses a single <filename>SRC_URI</filename> |
3376 | two patches, and include a custom file, the recipe would include four | 3376 | entry. |
3377 | On the other hand, if the recipe or append file needs to | ||
3378 | fetch a tarball, apply two patches, and include a custom | ||
3379 | file, the recipe or append file would include four | ||
3377 | instances of the variable.</para> | 3380 | instances of the variable.</para> |
3378 | <para>The following list explains the available URI protocols: | 3381 | <para>The following list explains the available URI protocols: |
3379 | <itemizedlist> | 3382 | <itemizedlist> |
3380 | <listitem><para><emphasis><filename>file://</filename> -</emphasis> Fetches files, which is usually | 3383 | <listitem><para><emphasis><filename>file://</filename> -</emphasis> |
3381 | a file shipped with the | 3384 | Fetches files, which are usually files shipped with |
3385 | the | ||
3382 | <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>, | 3386 | <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>, |
3383 | from the local machine. | 3387 | from the local machine. |
3384 | The path is relative to the | 3388 | The path is relative to the |
3385 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> | 3389 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> |
3386 | variable. | 3390 | variable. |
3387 | Thus, the build system searches, in order, from the following directories, | 3391 | Thus, the build system searches, in order, from the |
3388 | which are assumed to be a subdirectories of the directory in which the | 3392 | following directories, which are assumed to be a |
3389 | recipe file resides: | 3393 | subdirectories of the directory in which the |
3394 | recipe file (<filename>.bb</filename>) or | ||
3395 | append file (<filename>.bbappend</filename>) | ||
3396 | resides: | ||
3397 | <note> | ||
3398 | If you want the build system to pick up files | ||
3399 | specified through a | ||
3400 | <filename>SRC_URI</filename> | ||
3401 | statement from your append file, you need to be | ||
3402 | sure to extend the | ||
3403 | <filename>FILESPATH</filename> | ||
3404 | variable by also using the | ||
3405 | <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> | ||
3406 | variable from within your append file. | ||
3407 | </note> | ||
3390 | <itemizedlist> | 3408 | <itemizedlist> |
3391 | <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> The | 3409 | <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> |
3392 | base recipe name without any special suffix or version numbers. | 3410 | The base recipe name without any special |
3411 | suffix or version numbers. | ||
3393 | </para></listitem> | 3412 | </para></listitem> |
3394 | <listitem><para><emphasis><filename>${BP}</filename> -</emphasis> | 3413 | <listitem><para><emphasis><filename>${BP}</filename> -</emphasis> |
3395 | <filename>${<link linkend='var-BPN'>BPN</link>}-${PV}</filename>. | 3414 | <filename>${<link linkend='var-BPN'>BPN</link>}-${PV}</filename>. |
3396 | The base recipe name and version but without any special | 3415 | The base recipe name and version but without |
3397 | package name suffix.</para></listitem> | 3416 | any special package name suffix. |
3398 | <listitem><para><emphasis>files -</emphasis> Files within a | 3417 | </para></listitem> |
3399 | directory, which is named <filename>files</filename> | 3418 | <listitem><para><emphasis>files -</emphasis> |
3400 | and is also alongside the recipe. | 3419 | Files within a directory, which is named |
3420 | <filename>files</filename> and is also | ||
3421 | alongside the recipe or append file. | ||
3401 | </para></listitem> | 3422 | </para></listitem> |
3402 | </itemizedlist></para></listitem> | 3423 | </itemizedlist></para></listitem> |
3403 | <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a | 3424 | <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a |