diff options
| -rw-r--r-- | documentation/ref-manual/ref-variables.rst | 170 |
1 files changed, 85 insertions, 85 deletions
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index e238b12474..3a4a5551e1 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst | |||
| @@ -7592,14 +7592,6 @@ system and gives an overview of their function and contents. | |||
| 7592 | 7592 | ||
| 7593 | The class checks for and uses the variable as needed. | 7593 | The class checks for and uses the variable as needed. |
| 7594 | 7594 | ||
| 7595 | SYSLINUX_SPLASH | ||
| 7596 | An ``.LSS`` file used as the background for the VGA boot menu when | ||
| 7597 | you use the boot menu. You need to set this variable in your recipe. | ||
| 7598 | |||
| 7599 | The :ref:`syslinux <ref-classes-syslinux>` class checks for this | ||
| 7600 | variable and if found, the OpenEmbedded build system installs the | ||
| 7601 | splash screen. | ||
| 7602 | |||
| 7603 | SYSLINUX_SERIAL_TTY | 7595 | SYSLINUX_SERIAL_TTY |
| 7604 | Specifies the alternate console=tty... kernel boot argument. The | 7596 | Specifies the alternate console=tty... kernel boot argument. The |
| 7605 | variable's default value is set in the | 7597 | variable's default value is set in the |
| @@ -7610,6 +7602,14 @@ system and gives an overview of their function and contents. | |||
| 7610 | 7602 | ||
| 7611 | The class checks for and uses the variable as needed. | 7603 | The class checks for and uses the variable as needed. |
| 7612 | 7604 | ||
| 7605 | SYSLINUX_SPLASH | ||
| 7606 | An ``.LSS`` file used as the background for the VGA boot menu when | ||
| 7607 | you use the boot menu. You need to set this variable in your recipe. | ||
| 7608 | |||
| 7609 | The :ref:`syslinux <ref-classes-syslinux>` class checks for this | ||
| 7610 | variable and if found, the OpenEmbedded build system installs the | ||
| 7611 | splash screen. | ||
| 7612 | |||
| 7613 | SYSROOT_DESTDIR | 7613 | SYSROOT_DESTDIR |
| 7614 | Points to the temporary directory under the work directory (default | 7614 | Points to the temporary directory under the work directory (default |
| 7615 | "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``") | 7615 | "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``") |
| @@ -8096,6 +8096,49 @@ system and gives an overview of their function and contents. | |||
| 8096 | WORKDIR/oe-rootfs-repo | 8096 | WORKDIR/oe-rootfs-repo |
| 8097 | . | 8097 | . |
| 8098 | 8098 | ||
| 8099 | TEST_SUITES | ||
| 8100 | An ordered list of tests (modules) to run against an image when | ||
| 8101 | performing automated runtime testing. | ||
| 8102 | |||
| 8103 | The OpenEmbedded build system provides a core set of tests that can | ||
| 8104 | be used against images. | ||
| 8105 | |||
| 8106 | .. note:: | ||
| 8107 | |||
| 8108 | Currently, there is only support for running these tests under | ||
| 8109 | QEMU. | ||
| 8110 | |||
| 8111 | Tests include ``ping``, ``ssh``, ``df`` among others. You can add | ||
| 8112 | your own tests to the list of tests by appending ``TEST_SUITES`` as | ||
| 8113 | follows: | ||
| 8114 | :: | ||
| 8115 | |||
| 8116 | TEST_SUITES_append = " mytest" | ||
| 8117 | |||
| 8118 | Alternatively, you can | ||
| 8119 | provide the "auto" option to have all applicable tests run against | ||
| 8120 | the image. | ||
| 8121 | :: | ||
| 8122 | |||
| 8123 | TEST_SUITES_append = " auto" | ||
| 8124 | |||
| 8125 | Using this option causes the | ||
| 8126 | build system to automatically run tests that are applicable to the | ||
| 8127 | image. Tests that are not applicable are skipped. | ||
| 8128 | |||
| 8129 | The order in which tests are run is important. Tests that depend on | ||
| 8130 | another test must appear later in the list than the test on which | ||
| 8131 | they depend. For example, if you append the list of tests with two | ||
| 8132 | tests (``test_A`` and ``test_B``) where ``test_B`` is dependent on | ||
| 8133 | ``test_A``, then you must order the tests as follows: | ||
| 8134 | :: | ||
| 8135 | |||
| 8136 | TEST_SUITES = "test_A test_B" | ||
| 8137 | |||
| 8138 | For more information on testing images, see the | ||
| 8139 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | ||
| 8140 | section in the Yocto Project Development Tasks Manual. | ||
| 8141 | |||
| 8099 | TEST_TARGET | 8142 | TEST_TARGET |
| 8100 | Specifies the target controller to use when running tests against a | 8143 | Specifies the target controller to use when running tests against a |
| 8101 | test image. The default controller to use is "qemu": | 8144 | test image. The default controller to use is "qemu": |
| @@ -8150,49 +8193,6 @@ system and gives an overview of their function and contents. | |||
| 8150 | directly accessible from your host and you need to do port address | 8193 | directly accessible from your host and you need to do port address |
| 8151 | translation. | 8194 | translation. |
| 8152 | 8195 | ||
| 8153 | TEST_SUITES | ||
| 8154 | An ordered list of tests (modules) to run against an image when | ||
| 8155 | performing automated runtime testing. | ||
| 8156 | |||
| 8157 | The OpenEmbedded build system provides a core set of tests that can | ||
| 8158 | be used against images. | ||
| 8159 | |||
| 8160 | .. note:: | ||
| 8161 | |||
| 8162 | Currently, there is only support for running these tests under | ||
| 8163 | QEMU. | ||
| 8164 | |||
| 8165 | Tests include ``ping``, ``ssh``, ``df`` among others. You can add | ||
| 8166 | your own tests to the list of tests by appending ``TEST_SUITES`` as | ||
| 8167 | follows: | ||
| 8168 | :: | ||
| 8169 | |||
| 8170 | TEST_SUITES_append = " mytest" | ||
| 8171 | |||
| 8172 | Alternatively, you can | ||
| 8173 | provide the "auto" option to have all applicable tests run against | ||
| 8174 | the image. | ||
| 8175 | :: | ||
| 8176 | |||
| 8177 | TEST_SUITES_append = " auto" | ||
| 8178 | |||
| 8179 | Using this option causes the | ||
| 8180 | build system to automatically run tests that are applicable to the | ||
| 8181 | image. Tests that are not applicable are skipped. | ||
| 8182 | |||
| 8183 | The order in which tests are run is important. Tests that depend on | ||
| 8184 | another test must appear later in the list than the test on which | ||
| 8185 | they depend. For example, if you append the list of tests with two | ||
| 8186 | tests (``test_A`` and ``test_B``) where ``test_B`` is dependent on | ||
| 8187 | ``test_A``, then you must order the tests as follows: | ||
| 8188 | :: | ||
| 8189 | |||
| 8190 | TEST_SUITES = "test_A test_B" | ||
| 8191 | |||
| 8192 | For more information on testing images, see the | ||
| 8193 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | ||
| 8194 | section in the Yocto Project Development Tasks Manual. | ||
| 8195 | |||
| 8196 | TESTIMAGE_AUTO | 8196 | TESTIMAGE_AUTO |
| 8197 | Automatically runs the series of automated tests for images when an | 8197 | Automatically runs the series of automated tests for images when an |
| 8198 | image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes | 8198 | image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes |
| @@ -8378,6 +8378,23 @@ system and gives an overview of their function and contents. | |||
| 8378 | in turn, affects the tune variables themselves (i.e. the tune can | 8378 | in turn, affects the tune variables themselves (i.e. the tune can |
| 8379 | supply its own set of flags). | 8379 | supply its own set of flags). |
| 8380 | 8380 | ||
| 8381 | TUNE_FEATURES | ||
| 8382 | Features used to "tune" a compiler for optimal use given a specific | ||
| 8383 | processor. The features are defined within the tune files and allow | ||
| 8384 | arguments (i.e. ``TUNE_*ARGS``) to be dynamically generated based on | ||
| 8385 | the features. | ||
| 8386 | |||
| 8387 | The OpenEmbedded build system verifies the features to be sure they | ||
| 8388 | are not conflicting and that they are supported. | ||
| 8389 | |||
| 8390 | The BitBake configuration file (``meta/conf/bitbake.conf``) defines | ||
| 8391 | ``TUNE_FEATURES`` as follows: | ||
| 8392 | :: | ||
| 8393 | |||
| 8394 | TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}" | ||
| 8395 | |||
| 8396 | See the :term:`DEFAULTTUNE` variable for more information. | ||
| 8397 | |||
| 8381 | TUNE_LDARGS | 8398 | TUNE_LDARGS |
| 8382 | Specifies architecture-specific linker flags for the target system. | 8399 | Specifies architecture-specific linker flags for the target system. |
| 8383 | The set of flags is based on the selected tune features. | 8400 | The set of flags is based on the selected tune features. |
| @@ -8396,23 +8413,6 @@ system and gives an overview of their function and contents. | |||
| 8396 | in turn, affects the tune variables themselves (i.e. the tune can | 8413 | in turn, affects the tune variables themselves (i.e. the tune can |
| 8397 | supply its own set of flags). | 8414 | supply its own set of flags). |
| 8398 | 8415 | ||
| 8399 | TUNE_FEATURES | ||
| 8400 | Features used to "tune" a compiler for optimal use given a specific | ||
| 8401 | processor. The features are defined within the tune files and allow | ||
| 8402 | arguments (i.e. ``TUNE_*ARGS``) to be dynamically generated based on | ||
| 8403 | the features. | ||
| 8404 | |||
| 8405 | The OpenEmbedded build system verifies the features to be sure they | ||
| 8406 | are not conflicting and that they are supported. | ||
| 8407 | |||
| 8408 | The BitBake configuration file (``meta/conf/bitbake.conf``) defines | ||
| 8409 | ``TUNE_FEATURES`` as follows: | ||
| 8410 | :: | ||
| 8411 | |||
| 8412 | TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}" | ||
| 8413 | |||
| 8414 | See the :term:`DEFAULTTUNE` variable for more information. | ||
| 8415 | |||
| 8416 | TUNE_PKGARCH | 8416 | TUNE_PKGARCH |
| 8417 | The package architecture understood by the packaging system to define | 8417 | The package architecture understood by the packaging system to define |
| 8418 | the architecture, ABI, and tuning of output packages. The specific | 8418 | the architecture, ABI, and tuning of output packages. The specific |
| @@ -8559,14 +8559,6 @@ system and gives an overview of their function and contents. | |||
| 8559 | Options for the device tree compiler passed to mkimage '-D' | 8559 | Options for the device tree compiler passed to mkimage '-D' |
| 8560 | feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. | 8560 | feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. |
| 8561 | 8561 | ||
| 8562 | UBOOT_RD_LOADADDRESS | ||
| 8563 | Specifies the load address for the RAM disk image. | ||
| 8564 | During FIT image creation, the | ||
| 8565 | ``UBOOT_RD_LOADADDRESS`` variable is used | ||
| 8566 | in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the | ||
| 8567 | load address to be used in creating the Image Tree Source for | ||
| 8568 | the FIT image. | ||
| 8569 | |||
| 8570 | UBOOT_RD_ENTRYPOINT | 8562 | UBOOT_RD_ENTRYPOINT |
| 8571 | Specifies the entrypoint for the RAM disk image. | 8563 | Specifies the entrypoint for the RAM disk image. |
| 8572 | During FIT image creation, the | 8564 | During FIT image creation, the |
| @@ -8575,6 +8567,14 @@ system and gives an overview of their function and contents. | |||
| 8575 | entrypoint to be used in creating the Image Tree Source for | 8567 | entrypoint to be used in creating the Image Tree Source for |
| 8576 | the FIT image. | 8568 | the FIT image. |
| 8577 | 8569 | ||
| 8570 | UBOOT_RD_LOADADDRESS | ||
| 8571 | Specifies the load address for the RAM disk image. | ||
| 8572 | During FIT image creation, the | ||
| 8573 | ``UBOOT_RD_LOADADDRESS`` variable is used | ||
| 8574 | in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the | ||
| 8575 | load address to be used in creating the Image Tree Source for | ||
| 8576 | the FIT image. | ||
| 8577 | |||
| 8578 | UBOOT_SIGN_ENABLE | 8578 | UBOOT_SIGN_ENABLE |
| 8579 | Enable signing of FIT image. The default value is "0". | 8579 | Enable signing of FIT image. The default value is "0". |
| 8580 | 8580 | ||
| @@ -8872,6 +8872,15 @@ system and gives an overview of their function and contents. | |||
| 8872 | can control with this variable, see the | 8872 | can control with this variable, see the |
| 8873 | ":ref:`insane.bbclass <ref-classes-insane>`" section. | 8873 | ":ref:`insane.bbclass <ref-classes-insane>`" section. |
| 8874 | 8874 | ||
| 8875 | WKS_FILE | ||
| 8876 | Specifies the location of the Wic kickstart file that is used by the | ||
| 8877 | OpenEmbedded build system to create a partitioned image | ||
| 8878 | (image\ ``.wic``). For information on how to create a partitioned | ||
| 8879 | image, see the | ||
| 8880 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" | ||
| 8881 | section in the Yocto Project Development Tasks Manual. For details on | ||
| 8882 | the kickstart file format, see the ":doc:`../ref-manual/ref-kickstart`" Chapter. | ||
| 8883 | |||
| 8875 | WKS_FILE_DEPENDS | 8884 | WKS_FILE_DEPENDS |
| 8876 | When placed in the recipe that builds your image, this variable lists | 8885 | When placed in the recipe that builds your image, this variable lists |
| 8877 | build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only | 8886 | build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only |
| @@ -8897,15 +8906,6 @@ system and gives an overview of their function and contents. | |||
| 8897 | previous example, some-native-tool would be replaced with an actual | 8906 | previous example, some-native-tool would be replaced with an actual |
| 8898 | native tool on which the build would depend. | 8907 | native tool on which the build would depend. |
| 8899 | 8908 | ||
| 8900 | WKS_FILE | ||
| 8901 | Specifies the location of the Wic kickstart file that is used by the | ||
| 8902 | OpenEmbedded build system to create a partitioned image | ||
| 8903 | (image\ ``.wic``). For information on how to create a partitioned | ||
| 8904 | image, see the | ||
| 8905 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" | ||
| 8906 | section in the Yocto Project Development Tasks Manual. For details on | ||
| 8907 | the kickstart file format, see the ":doc:`../ref-manual/ref-kickstart`" Chapter. | ||
| 8908 | |||
| 8909 | WORKDIR | 8909 | WORKDIR |
| 8910 | The pathname of the work directory in which the OpenEmbedded build | 8910 | The pathname of the work directory in which the OpenEmbedded build |
| 8911 | system builds a recipe. This directory is located within the | 8911 | system builds a recipe. This directory is located within the |
