mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-04-20 00:32:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: simplify SRC_URI reference

Browse Source 
After some features that also apply to BitBake
were moved to the BitBake manual.

(From yocto-docs rev: 1415521656427f351ab2d3f8bc498130c4653396)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2021-11-04 19:53:41 +01:00
committed by Richard Purdie
parent ea0bc63dec
commit ed2880fbda
1 changed files with 9 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files

125
documentation/ref-manual/variables.rst
View File

@@ -7018,91 +7018,13 @@ system and gives an overview of their function and contents.
for additional information.
:term:`SRC_URI`
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 or append file only needs
to fetch a tarball from the Internet, the recipe or append file uses
a single :term:`SRC_URI` 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.
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 ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers`" section in the
BitBake User Manual.
See the BitBake manual for the initial description for this variable:
:term:`bitbake:SRC_URI`.
- ``file://`` - Fetches files, which are usually files shipped
with the :term:`Metadata`, from the local machine (e.g.
:ref:`patch <overview-manual/concepts:patching>` files).
The path is relative to the :term:`FILESPATH`
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 (``.bb``) or append file
(``.bbappend``) resides:
The following features are added by OpenEmbedded and the Yocto Project.
- ``${BPN}`` - The base recipe name without any special suffix
or version numbers.
- ``${BP}`` - ``${BPN}-${PV}``. The base recipe name and
version but without any special package name suffix.
- *files -* Files within a directory, which is named ``files``
and is also alongside the recipe or append file.
.. note::
If you want the build system to pick up files specified through
a
SRC_URI
statement from your append file, you need to be sure to extend
the
FILESPATH
variable by also using the
FILESEXTRAPATHS
variable from within your append file.
- ``bzr://`` - Fetches files from a Bazaar revision control
repository.
- ``git://`` - Fetches files from a Git revision control
repository.
- ``osc://`` - Fetches files from an OSC (openSUSE Build service)
revision control repository.
- ``repo://`` - Fetches files from a repo (Git) repository.
- ``ccrc://`` - Fetches files from a ClearCase repository.
- ``http://`` - Fetches files from the Internet using ``http``.
- ``https://`` - Fetches files from the Internet using ``https``.
- ``ftp://`` - Fetches files from the Internet using ``ftp``.
- ``cvs://`` - Fetches files from a CVS revision control
repository.
- ``hg://`` - Fetches files from a Mercurial (``hg``) revision
control repository.
- ``p4://`` - Fetches files from a Perforce (``p4``) revision
control repository.
- ``ssh://`` - Fetches files from a secure shell.
- ``svn://`` - Fetches files from a Subversion (``svn``) revision
control repository.
- ``npm://`` - Fetches JavaScript modules from a registry.
- ``az://`` - Fetches files from an Azure Storage account.
There are standard and recipe-specific options for :term:`SRC_URI`. Here are
standard ones:
There are standard and recipe-specific options. Here are standard ones:
- ``apply`` - Whether to apply the patch or not. The default
action is to apply the patch.
@@ -7135,41 +7057,12 @@ system and gives an overview of their function and contents.
- ``notrev`` - Apply the patch only if :term:`SRCREV` is not equal to
``rev``.
Here are some additional options worth mentioning:
.. note::
- ``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 :term:`WORKDIR` when
the Git fetcher is used.
- ``subdir`` - Places the file (or extracts its contents) into the
specified subdirectory of :term:`WORKDIR` when the local (``file://``)
fetcher is used.
- ``localdir`` - Places the file (or extracts its contents) into
the specified subdirectory of :term:`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
:term:`SRC_URI` checksums or :term:`SRCREV` when you have more than one
file or git repository specified in :term:`SRC_URI`. For example::
SRC_URI = "git://example.com/foo.git;name=first \
git://example.com/bar.git;name=second \
http://example.com/file.tar.gz;name=third"
SRCREV_first = "f1d2d2f924e986ac86fdf7b36c94bcdf32beec15"
SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f"
SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de"
- ``downloadfilename`` - Specifies the filename used when storing
the downloaded file.
If you want the build system to pick up files specified through
a :term:`SRC_URI` statement from your append file, you need to be
sure to extend the :term:`FILESPATH` variable by also using the
:term:`FILESEXTRAPATHS` variable from within your append file.
:term:`SRC_URI_OVERRIDES_PACKAGE_ARCH`
By default, the OpenEmbedded build system automatically detects