summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2015-09-30 12:55:13 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-10-21 23:06:33 +0100
commit2e7d650a2ab3ced7688fb550f55798dd55381367 (patch)
tree580a30f7a07c647d0c80a559a084bc5ea5a7b895 /documentation/ref-manual/ref-variables.xml
parent7facee681a07f3a9e39e958dc156ecae52d4880d (diff)
downloadpoky-2e7d650a2ab3ced7688fb550f55798dd55381367.tar.gz
ref-manual: Updates to clarify Fetcher URL directory parameters
Updated the SRC_URI variable description to cross-reference the "Fetchers" section in the BitBake User Manual and added some more Fetcher URL parameters specific to certain fetchers. This was done to help clarify how to put fetched code into specific directories. Also updated the bin_packages.bbclass description to have a better example. Used a git:// fetcher example and provided some specific URL parameters. (From yocto-docs rev: 7133b49092096c253ffce99f39d4fa6db7810061) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml29
1 files changed, 25 insertions, 4 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 7cc01c64ef..0bc7a82b48 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -11240,7 +11240,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
11240 </para> 11240 </para>
11241 11241
11242 <para> 11242 <para>
11243 The following list explains the available URI protocols: 11243 The following list explains the available URI protocols.
11244 URI protocols are highly dependent on particular BitBake
11245 Fetcher submodules.
11246 Depending on the fetcher BitBake uses, various URL
11247 parameters are employed.
11248 For specifics on the supported Fetchers, see the
11249 "<ulink url='&YOCTO_DOCS_BB_URL;#bb-fetchers'>Fetchers</ulink>"
11250 section in the BitBake User Manual.
11244 <itemizedlist> 11251 <itemizedlist>
11245 <listitem><para><emphasis><filename>file://</filename> -</emphasis> 11252 <listitem><para><emphasis><filename>file://</filename> -</emphasis>
11246 Fetches files, which are usually files shipped with 11253 Fetches files, which are usually files shipped with
@@ -11368,11 +11375,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
11368 <listitem><para><emphasis><filename>unpack</filename> -</emphasis> Controls 11375 <listitem><para><emphasis><filename>unpack</filename> -</emphasis> Controls
11369 whether or not to unpack the file if it is an archive. 11376 whether or not to unpack the file if it is an archive.
11370 The default action is to unpack the file.</para></listitem> 11377 The default action is to unpack the file.</para></listitem>
11378 <listitem><para><emphasis><filename>destsuffix</filename> -</emphasis> Places the file
11379 (or extracts its contents) into the specified
11380 subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
11381 when the Git fetcher is used.
11382 </para></listitem>
11371 <listitem><para><emphasis><filename>subdir</filename> -</emphasis> Places the file 11383 <listitem><para><emphasis><filename>subdir</filename> -</emphasis> Places the file
11372 (or extracts its contents) into the specified 11384 (or extracts its contents) into the specified
11373 subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>. 11385 subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
11374 This option is useful for unusual tarballs or other archives that 11386 when the local (<filename>file://</filename>)
11375 do not have their files already in a subdirectory within the archive. 11387 fetcher is used.
11388 </para></listitem>
11389 <listitem><para><emphasis><filename>localdir</filename> -</emphasis> Places the file
11390 (or extracts its contents) into the specified
11391 subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
11392 when the CVS fetcher is used.
11393 </para></listitem>
11394 <listitem><para><emphasis><filename>subpath</filename> -</emphasis>
11395 Limits the checkout to a specific subpath of the
11396 tree when using the Git fetcher is used.
11376 </para></listitem> 11397 </para></listitem>
11377 <listitem><para><emphasis><filename>name</filename> -</emphasis> Specifies a 11398 <listitem><para><emphasis><filename>name</filename> -</emphasis> Specifies a
11378 name to be used for association with <filename>SRC_URI</filename> checksums 11399 name to be used for association with <filename>SRC_URI</filename> checksums