diff options
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 12 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 29 |
2 files changed, 35 insertions, 6 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index ba7c3f79f6..30d0e5de06 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -211,14 +211,22 @@ | |||
211 | use for this class. | 211 | use for this class. |
212 | <note> | 212 | <note> |
213 | For RPMs and other packages that do not contain a subdirectory, | 213 | For RPMs and other packages that do not contain a subdirectory, |
214 | you should specify a "subdir" parameter. | 214 | you should specify an appropriate fetcher parameter to point to |
215 | the subdirectory. | ||
216 | For example, if BitBake is using the Git fetcher | ||
217 | (<filename>git://</filename>), the "subpath" parameter limits | ||
218 | the checkout to a specific subpath of the tree. | ||
215 | Here is an example where <filename>${BP}</filename> is used so that | 219 | Here is an example where <filename>${BP}</filename> is used so that |
216 | the files are extracted into the subdirectory expected by the | 220 | the files are extracted into the subdirectory expected by the |
217 | default value of | 221 | default value of |
218 | <link linkend='var-S'><filename>S</filename></link>: | 222 | <link linkend='var-S'><filename>S</filename></link>: |
219 | <literallayout class='monospaced'> | 223 | <literallayout class='monospaced'> |
220 | SRC_URI = "http://example.com/downloads/somepackage.rpm;subdir=${BP}" | 224 | SRC_URI = "git://example.com/downloads/somepackage.rpm;subpath=${BP}" |
221 | </literallayout> | 225 | </literallayout> |
226 | See the | ||
227 | "<ulink url='&YOCTO_DOCS_BB_URL;#bb-fetchers'>Fetchers</ulink>" | ||
228 | section in the BitBake User Manual for more information on | ||
229 | supported BitBake Fetchers. | ||
222 | </note> | 230 | </note> |
223 | </para> | 231 | </para> |
224 | </section> | 232 | </section> |
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 |