diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-09-17 19:29:50 +0200 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2023-09-23 05:26:16 -1000 |
commit | 90e943b8d1b76dac3b6d6822119ac6650efc90ba (patch) | |
tree | 783bddd9fed240b38738663be46896ce4389d650 | |
parent | 2be874d5b401d271e9ae5eef46bbb0f64546f86b (diff) | |
download | poky-90e943b8d1b76dac3b6d6822119ac6650efc90ba.tar.gz |
ref-manual: add new variables
Backported from "master" and used in dev-manual
documents to be synchronized with master.
(From yocto-docs rev: 1938d6017a1c9acc2c5f57c4cc6a87b918609381)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r-- | documentation/ref-manual/variables.rst | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 1cc489a7ea..78cad25ca3 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -1156,6 +1156,26 @@ system and gives an overview of their function and contents. | |||
1156 | optional at the distribution level, in case the hardware supports | 1156 | optional at the distribution level, in case the hardware supports |
1157 | Bluetooth but you do not ever intend to use it. | 1157 | Bluetooth but you do not ever intend to use it. |
1158 | 1158 | ||
1159 | :term:`COMMERCIAL_AUDIO_PLUGINS` | ||
1160 | This variable is specific to the :yocto_git:`GStreamer recipes | ||
1161 | </poky/tree/meta/recipes-multimedia/gstreamer/gstreamer1.0-meta-base.bb>`. | ||
1162 | It allows to build the GStreamer `"ugly" | ||
1163 | <https://github.com/GStreamer/gst-plugins-ugly>`__ and | ||
1164 | `"bad" <https://github.com/GStreamer/gst-plugins-bad>`__ audio plugins. | ||
1165 | |||
1166 | See the :ref:`dev-manual/licenses:other variables related to commercial licenses` | ||
1167 | section for usage details. | ||
1168 | |||
1169 | :term:`COMMERCIAL_VIDEO_PLUGINS` | ||
1170 | This variable is specific to the :yocto_git:`GStreamer recipes | ||
1171 | </poky/tree/meta/recipes-multimedia/gstreamer/gstreamer1.0-meta-base.bb>`. | ||
1172 | It allows to build the GStreamer `"ugly" | ||
1173 | <https://github.com/GStreamer/gst-plugins-ugly>`__ and | ||
1174 | `"bad" <https://github.com/GStreamer/gst-plugins-bad>`__ video plugins. | ||
1175 | |||
1176 | See the :ref:`dev-manual/licenses:other variables related to commercial licenses` | ||
1177 | section for usage details. | ||
1178 | |||
1159 | :term:`COMMON_LICENSE_DIR` | 1179 | :term:`COMMON_LICENSE_DIR` |
1160 | Points to ``meta/files/common-licenses`` in the | 1180 | Points to ``meta/files/common-licenses`` in the |
1161 | :term:`Source Directory`, which is where generic license | 1181 | :term:`Source Directory`, which is where generic license |
@@ -2223,6 +2243,12 @@ system and gives an overview of their function and contents. | |||
2223 | :ref:`kernel-yocto <ref-classes-kernel-yocto>` class in | 2243 | :ref:`kernel-yocto <ref-classes-kernel-yocto>` class in |
2224 | ``meta/classes`` to see how the variable is used. | 2244 | ``meta/classes`` to see how the variable is used. |
2225 | 2245 | ||
2246 | :term:`EXTERNAL_TOOLCHAIN` | ||
2247 | When you intend to use an | ||
2248 | :ref:`external toolchain <dev-manual/external-toolchain:optionally using an external toolchain>`, | ||
2249 | this variable allows to specify the directory where this toolchain was | ||
2250 | installed. | ||
2251 | |||
2226 | :term:`EXTERNALSRC` | 2252 | :term:`EXTERNALSRC` |
2227 | When inheriting the :ref:`externalsrc <ref-classes-externalsrc>` | 2253 | When inheriting the :ref:`externalsrc <ref-classes-externalsrc>` |
2228 | class, this variable points to the source tree, which is outside of | 2254 | class, this variable points to the source tree, which is outside of |
@@ -7251,6 +7277,38 @@ system and gives an overview of their function and contents. | |||
7251 | section in the Yocto Project Board Support Package Developer's Guide | 7277 | section in the Yocto Project Board Support Package Developer's Guide |
7252 | for additional information. | 7278 | for additional information. |
7253 | 7279 | ||
7280 | :term:`SPLASH_IMAGES` | ||
7281 | This variable, used by the ``psplash`` recipe, allows to customize | ||
7282 | the default splashscreen image. | ||
7283 | |||
7284 | Specified images in PNG format are converted to ``.h`` files by the recipe, | ||
7285 | and are included in the ``psplash`` binary, so you won't find them in | ||
7286 | the root filesystem. | ||
7287 | |||
7288 | To make such a change, it is recommended to customize the | ||
7289 | ``psplash`` recipe in a custom layer. Here is an example structure for | ||
7290 | an ``ACME`` board:: | ||
7291 | |||
7292 | meta-acme/recipes-core/psplash | ||
7293 | ├── files | ||
7294 | │ └── logo-acme.png | ||
7295 | └── psplash_%.bbappend | ||
7296 | |||
7297 | And here are the contents of the ``psplash_%.bbappend`` file in | ||
7298 | this example:: | ||
7299 | |||
7300 | SPLASH_IMAGES = "file://logo-acme.png;outsuffix=default" | ||
7301 | FILESEXTRAPATHS:prepend := "${THISDIR}/files:" | ||
7302 | |||
7303 | You could even add specific configuration options for ``psplash``, | ||
7304 | for example:: | ||
7305 | |||
7306 | EXTRA_OECONF += "--disable-startup-msg --enable-img-fullscreen" | ||
7307 | |||
7308 | For information on append files, see the | ||
7309 | ":ref:`dev-manual/layers:appending other layers metadata with your layer`" | ||
7310 | section. | ||
7311 | |||
7254 | :term:`SRC_URI` | 7312 | :term:`SRC_URI` |
7255 | 7313 | ||
7256 | See the BitBake manual for the initial description for this variable: | 7314 | See the BitBake manual for the initial description for this variable: |
@@ -8930,6 +8988,19 @@ system and gives an overview of their function and contents. | |||
8930 | previous example, some-native-tool would be replaced with an actual | 8988 | previous example, some-native-tool would be replaced with an actual |
8931 | native tool on which the build would depend. | 8989 | native tool on which the build would depend. |
8932 | 8990 | ||
8991 | :term:`WKS_FILES` | ||
8992 | Specifies a list of candidate Wic kickstart files to be used by the | ||
8993 | OpenEmbedded build system to create a partitioned image. Only the | ||
8994 | first one that is found, from left to right, will be used. | ||
8995 | |||
8996 | This is only useful when there are multiple ``.wks`` files that can be | ||
8997 | used to produce an image. A typical case is when multiple layers are | ||
8998 | used for different hardware platforms, each supplying a different | ||
8999 | ``.wks`` file. In this case, you specify all possible ones through | ||
9000 | :term:`WKS_FILES`. | ||
9001 | |||
9002 | If only one ``.wks`` file is used, set :term:`WKS_FILE` instead. | ||
9003 | |||
8933 | :term:`WORKDIR` | 9004 | :term:`WORKDIR` |
8934 | The pathname of the work directory in which the OpenEmbedded build | 9005 | The pathname of the work directory in which the OpenEmbedded build |
8935 | system builds a recipe. This directory is located within the | 9006 | system builds a recipe. This directory is located within the |