diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-11-04 19:53:41 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-11-21 11:07:01 +0000 |
commit | ed2880fbda4b475756525ea5ca23979496615e1a (patch) | |
tree | 7a53c8d1cc4dd015ecbd1f5f1ec75f21d620d63f | |
parent | ea0bc63dec1e75dd7fe8231732b7f51fbf423b84 (diff) | |
download | poky-ed2880fbda4b475756525ea5ca23979496615e1a.tar.gz |
ref-manual: simplify SRC_URI reference
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>
-rw-r--r-- | documentation/ref-manual/variables.rst | 125 |
1 files changed, 9 insertions, 116 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 964bdd605c..26b56e145c 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -7018,91 +7018,13 @@ system and gives an overview of their function and contents. | |||
7018 | for additional information. | 7018 | for additional information. |
7019 | 7019 | ||
7020 | :term:`SRC_URI` | 7020 | :term:`SRC_URI` |
7021 | The list of source files - local or remote. This variable tells the | ||
7022 | OpenEmbedded build system which bits to pull in for the build and how | ||
7023 | to pull them in. For example, if the recipe or append file only needs | ||
7024 | to fetch a tarball from the Internet, the recipe or append file uses | ||
7025 | a single :term:`SRC_URI` entry. On the other hand, if the recipe or | ||
7026 | append file needs to fetch a tarball, apply two patches, and include | ||
7027 | a custom file, the recipe or append file would include four instances | ||
7028 | of the variable. | ||
7029 | |||
7030 | The following list explains the available URI protocols. URI | ||
7031 | protocols are highly dependent on particular BitBake Fetcher | ||
7032 | submodules. Depending on the fetcher BitBake uses, various URL | ||
7033 | parameters are employed. For specifics on the supported Fetchers, see | ||
7034 | the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers`" section in the | ||
7035 | BitBake User Manual. | ||
7036 | |||
7037 | - ``file://`` - Fetches files, which are usually files shipped | ||
7038 | with the :term:`Metadata`, from the local machine (e.g. | ||
7039 | :ref:`patch <overview-manual/concepts:patching>` files). | ||
7040 | The path is relative to the :term:`FILESPATH` | ||
7041 | variable. Thus, the build system searches, in order, from the | ||
7042 | following directories, which are assumed to be a subdirectories of | ||
7043 | the directory in which the recipe file (``.bb``) or append file | ||
7044 | (``.bbappend``) resides: | ||
7045 | |||
7046 | - ``${BPN}`` - The base recipe name without any special suffix | ||
7047 | or version numbers. | ||
7048 | |||
7049 | - ``${BP}`` - ``${BPN}-${PV}``. The base recipe name and | ||
7050 | version but without any special package name suffix. | ||
7051 | |||
7052 | - *files -* Files within a directory, which is named ``files`` | ||
7053 | and is also alongside the recipe or append file. | ||
7054 | 7021 | ||
7055 | .. note:: | 7022 | See the BitBake manual for the initial description for this variable: |
7056 | 7023 | :term:`bitbake:SRC_URI`. | |
7057 | If you want the build system to pick up files specified through | ||
7058 | a | ||
7059 | SRC_URI | ||
7060 | statement from your append file, you need to be sure to extend | ||
7061 | the | ||
7062 | FILESPATH | ||
7063 | variable by also using the | ||
7064 | FILESEXTRAPATHS | ||
7065 | variable from within your append file. | ||
7066 | |||
7067 | - ``bzr://`` - Fetches files from a Bazaar revision control | ||
7068 | repository. | ||
7069 | |||
7070 | - ``git://`` - Fetches files from a Git revision control | ||
7071 | repository. | ||
7072 | |||
7073 | - ``osc://`` - Fetches files from an OSC (openSUSE Build service) | ||
7074 | revision control repository. | ||
7075 | |||
7076 | - ``repo://`` - Fetches files from a repo (Git) repository. | ||
7077 | |||
7078 | - ``ccrc://`` - Fetches files from a ClearCase repository. | ||
7079 | |||
7080 | - ``http://`` - Fetches files from the Internet using ``http``. | ||
7081 | |||
7082 | - ``https://`` - Fetches files from the Internet using ``https``. | ||
7083 | |||
7084 | - ``ftp://`` - Fetches files from the Internet using ``ftp``. | ||
7085 | |||
7086 | - ``cvs://`` - Fetches files from a CVS revision control | ||
7087 | repository. | ||
7088 | |||
7089 | - ``hg://`` - Fetches files from a Mercurial (``hg``) revision | ||
7090 | control repository. | ||
7091 | |||
7092 | - ``p4://`` - Fetches files from a Perforce (``p4``) revision | ||
7093 | control repository. | ||
7094 | 7024 | ||
7095 | - ``ssh://`` - Fetches files from a secure shell. | 7025 | The following features are added by OpenEmbedded and the Yocto Project. |
7096 | 7026 | ||
7097 | - ``svn://`` - Fetches files from a Subversion (``svn``) revision | 7027 | There are standard and recipe-specific options. Here are standard ones: |
7098 | control repository. | ||
7099 | |||
7100 | - ``npm://`` - Fetches JavaScript modules from a registry. | ||
7101 | |||
7102 | - ``az://`` - Fetches files from an Azure Storage account. | ||
7103 | |||
7104 | There are standard and recipe-specific options for :term:`SRC_URI`. Here are | ||
7105 | standard ones: | ||
7106 | 7028 | ||
7107 | - ``apply`` - Whether to apply the patch or not. The default | 7029 | - ``apply`` - Whether to apply the patch or not. The default |
7108 | action is to apply the patch. | 7030 | action is to apply the patch. |
@@ -7135,41 +7057,12 @@ system and gives an overview of their function and contents. | |||
7135 | - ``notrev`` - Apply the patch only if :term:`SRCREV` is not equal to | 7057 | - ``notrev`` - Apply the patch only if :term:`SRCREV` is not equal to |
7136 | ``rev``. | 7058 | ``rev``. |
7137 | 7059 | ||
7138 | Here are some additional options worth mentioning: | 7060 | .. note:: |
7139 | |||
7140 | - ``unpack`` - Controls whether or not to unpack the file if it is | ||
7141 | an archive. The default action is to unpack the file. | ||
7142 | |||
7143 | - ``destsuffix`` - Places the file (or extracts its contents) into | ||
7144 | the specified subdirectory of :term:`WORKDIR` when | ||
7145 | the Git fetcher is used. | ||
7146 | |||
7147 | - ``subdir`` - Places the file (or extracts its contents) into the | ||
7148 | specified subdirectory of :term:`WORKDIR` when the local (``file://``) | ||
7149 | fetcher is used. | ||
7150 | |||
7151 | - ``localdir`` - Places the file (or extracts its contents) into | ||
7152 | the specified subdirectory of :term:`WORKDIR` when the CVS fetcher is | ||
7153 | used. | ||
7154 | |||
7155 | - ``subpath`` - Limits the checkout to a specific subpath of the | ||
7156 | tree when using the Git fetcher is used. | ||
7157 | |||
7158 | - ``name`` - Specifies a name to be used for association with | ||
7159 | :term:`SRC_URI` checksums or :term:`SRCREV` when you have more than one | ||
7160 | file or git repository specified in :term:`SRC_URI`. For example:: | ||
7161 | |||
7162 | SRC_URI = "git://example.com/foo.git;name=first \ | ||
7163 | git://example.com/bar.git;name=second \ | ||
7164 | http://example.com/file.tar.gz;name=third" | ||
7165 | |||
7166 | SRCREV_first = "f1d2d2f924e986ac86fdf7b36c94bcdf32beec15" | ||
7167 | SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f" | ||
7168 | SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de" | ||
7169 | |||
7170 | 7061 | ||
7171 | - ``downloadfilename`` - Specifies the filename used when storing | 7062 | If you want the build system to pick up files specified through |
7172 | the downloaded file. | 7063 | a :term:`SRC_URI` statement from your append file, you need to be |
7064 | sure to extend the :term:`FILESPATH` variable by also using the | ||
7065 | :term:`FILESEXTRAPATHS` variable from within your append file. | ||
7173 | 7066 | ||
7174 | :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` | 7067 | :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` |
7175 | By default, the OpenEmbedded build system automatically detects | 7068 | By default, the OpenEmbedded build system automatically detects |