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 @@ use for this class. For RPMs and other packages that do not contain a subdirectory, - you should specify a "subdir" parameter. + you should specify an appropriate fetcher parameter to point to + the subdirectory. + For example, if BitBake is using the Git fetcher + (git://), the "subpath" parameter limits + the checkout to a specific subpath of the tree. Here is an example where ${BP} is used so that the files are extracted into the subdirectory expected by the default value of S: - SRC_URI = "http://example.com/downloads/somepackage.rpm;subdir=${BP}" + SRC_URI = "git://example.com/downloads/somepackage.rpm;subpath=${BP}" + See the + "Fetchers" + section in the BitBake User Manual for more information on + supported BitBake Fetchers. 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" - The following list explains the available URI protocols: + The following list explains the available URI protocols. + URI protocols are highly dependent on particular BitBake + Fetcher submodules. + Depending on the fetcher BitBake uses, various URL + parameters are employed. + For specifics on the supported Fetchers, see the + "Fetchers" + section in the BitBake User Manual. file:// - 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" unpack - Controls whether or not to unpack the file if it is an archive. The default action is to unpack the file. + destsuffix - Places the file + (or extracts its contents) into the specified + subdirectory of WORKDIR + when the Git fetcher is used. + subdir - Places the file (or extracts its contents) into the specified - subdirectory of WORKDIR. - This option is useful for unusual tarballs or other archives that - do not have their files already in a subdirectory within the archive. + subdirectory of WORKDIR + when the local (file://) + fetcher is used. + + localdir - Places the file + (or extracts its contents) into the specified + subdirectory of WORKDIR + when the CVS fetcher is used. + + subpath - + Limits the checkout to a specific subpath of the + tree when using the Git fetcher is used. name - Specifies a name to be used for association with SRC_URI checksums