summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2020-10-03 10:23:35 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-01-04 10:55:00 +0000
commit23b1085ba7ec78450c4f28286ef4dd021fe9df84 (patch)
tree544ea2866417b280e430a327594f06136f2ac136 /documentation
parent38274e24653fc1e8993f079d2fc9f517f11eff09 (diff)
downloadpoky-23b1085ba7ec78450c4f28286ef4dd021fe9df84.tar.gz
docs: ref-manual: ref-variables: fix alphabetical order in glossary
(From yocto-docs rev: 7b8763580813466d10efd0c0df90dc6403f18894) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 77aa3990cab4fb01706d0b6b0284c38e4d9dda56) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.rst170
1 files changed, 85 insertions, 85 deletions
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 2965252357..6b00380350 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -7533,14 +7533,6 @@ system and gives an overview of their function and contents.
7533 7533
7534 The class checks for and uses the variable as needed. 7534 The class checks for and uses the variable as needed.
7535 7535
7536 SYSLINUX_SPLASH
7537 An ``.LSS`` file used as the background for the VGA boot menu when
7538 you use the boot menu. You need to set this variable in your recipe.
7539
7540 The :ref:`syslinux <ref-classes-syslinux>` class checks for this
7541 variable and if found, the OpenEmbedded build system installs the
7542 splash screen.
7543
7544 SYSLINUX_SERIAL_TTY 7536 SYSLINUX_SERIAL_TTY
7545 Specifies the alternate console=tty... kernel boot argument. The 7537 Specifies the alternate console=tty... kernel boot argument. The
7546 variable's default value is set in the 7538 variable's default value is set in the
@@ -7551,6 +7543,14 @@ system and gives an overview of their function and contents.
7551 7543
7552 The class checks for and uses the variable as needed. 7544 The class checks for and uses the variable as needed.
7553 7545
7546 SYSLINUX_SPLASH
7547 An ``.LSS`` file used as the background for the VGA boot menu when
7548 you use the boot menu. You need to set this variable in your recipe.
7549
7550 The :ref:`syslinux <ref-classes-syslinux>` class checks for this
7551 variable and if found, the OpenEmbedded build system installs the
7552 splash screen.
7553
7554 SYSROOT_DESTDIR 7554 SYSROOT_DESTDIR
7555 Points to the temporary directory under the work directory (default 7555 Points to the temporary directory under the work directory (default
7556 "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``") 7556 "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``")
@@ -8037,6 +8037,49 @@ system and gives an overview of their function and contents.
8037 WORKDIR/oe-rootfs-repo 8037 WORKDIR/oe-rootfs-repo
8038 . 8038 .
8039 8039
8040 TEST_SUITES
8041 An ordered list of tests (modules) to run against an image when
8042 performing automated runtime testing.
8043
8044 The OpenEmbedded build system provides a core set of tests that can
8045 be used against images.
8046
8047 .. note::
8048
8049 Currently, there is only support for running these tests under
8050 QEMU.
8051
8052 Tests include ``ping``, ``ssh``, ``df`` among others. You can add
8053 your own tests to the list of tests by appending ``TEST_SUITES`` as
8054 follows:
8055 ::
8056
8057 TEST_SUITES_append = " mytest"
8058
8059 Alternatively, you can
8060 provide the "auto" option to have all applicable tests run against
8061 the image.
8062 ::
8063
8064 TEST_SUITES_append = " auto"
8065
8066 Using this option causes the
8067 build system to automatically run tests that are applicable to the
8068 image. Tests that are not applicable are skipped.
8069
8070 The order in which tests are run is important. Tests that depend on
8071 another test must appear later in the list than the test on which
8072 they depend. For example, if you append the list of tests with two
8073 tests (``test_A`` and ``test_B``) where ``test_B`` is dependent on
8074 ``test_A``, then you must order the tests as follows:
8075 ::
8076
8077 TEST_SUITES = "test_A test_B"
8078
8079 For more information on testing images, see the
8080 ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`"
8081 section in the Yocto Project Development Tasks Manual.
8082
8040 TEST_TARGET 8083 TEST_TARGET
8041 Specifies the target controller to use when running tests against a 8084 Specifies the target controller to use when running tests against a
8042 test image. The default controller to use is "qemu": 8085 test image. The default controller to use is "qemu":
@@ -8091,49 +8134,6 @@ system and gives an overview of their function and contents.
8091 directly accessible from your host and you need to do port address 8134 directly accessible from your host and you need to do port address
8092 translation. 8135 translation.
8093 8136
8094 TEST_SUITES
8095 An ordered list of tests (modules) to run against an image when
8096 performing automated runtime testing.
8097
8098 The OpenEmbedded build system provides a core set of tests that can
8099 be used against images.
8100
8101 .. note::
8102
8103 Currently, there is only support for running these tests under
8104 QEMU.
8105
8106 Tests include ``ping``, ``ssh``, ``df`` among others. You can add
8107 your own tests to the list of tests by appending ``TEST_SUITES`` as
8108 follows:
8109 ::
8110
8111 TEST_SUITES_append = " mytest"
8112
8113 Alternatively, you can
8114 provide the "auto" option to have all applicable tests run against
8115 the image.
8116 ::
8117
8118 TEST_SUITES_append = " auto"
8119
8120 Using this option causes the
8121 build system to automatically run tests that are applicable to the
8122 image. Tests that are not applicable are skipped.
8123
8124 The order in which tests are run is important. Tests that depend on
8125 another test must appear later in the list than the test on which
8126 they depend. For example, if you append the list of tests with two
8127 tests (``test_A`` and ``test_B``) where ``test_B`` is dependent on
8128 ``test_A``, then you must order the tests as follows:
8129 ::
8130
8131 TEST_SUITES = "test_A test_B"
8132
8133 For more information on testing images, see the
8134 ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`"
8135 section in the Yocto Project Development Tasks Manual.
8136
8137 TESTIMAGE_AUTO 8137 TESTIMAGE_AUTO
8138 Automatically runs the series of automated tests for images when an 8138 Automatically runs the series of automated tests for images when an
8139 image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes 8139 image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes
@@ -8319,6 +8319,23 @@ system and gives an overview of their function and contents.
8319 in turn, affects the tune variables themselves (i.e. the tune can 8319 in turn, affects the tune variables themselves (i.e. the tune can
8320 supply its own set of flags). 8320 supply its own set of flags).
8321 8321
8322 TUNE_FEATURES
8323 Features used to "tune" a compiler for optimal use given a specific
8324 processor. The features are defined within the tune files and allow
8325 arguments (i.e. ``TUNE_*ARGS``) to be dynamically generated based on
8326 the features.
8327
8328 The OpenEmbedded build system verifies the features to be sure they
8329 are not conflicting and that they are supported.
8330
8331 The BitBake configuration file (``meta/conf/bitbake.conf``) defines
8332 ``TUNE_FEATURES`` as follows:
8333 ::
8334
8335 TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}"
8336
8337 See the :term:`DEFAULTTUNE` variable for more information.
8338
8322 TUNE_LDARGS 8339 TUNE_LDARGS
8323 Specifies architecture-specific linker flags for the target system. 8340 Specifies architecture-specific linker flags for the target system.
8324 The set of flags is based on the selected tune features. 8341 The set of flags is based on the selected tune features.
@@ -8337,23 +8354,6 @@ system and gives an overview of their function and contents.
8337 in turn, affects the tune variables themselves (i.e. the tune can 8354 in turn, affects the tune variables themselves (i.e. the tune can
8338 supply its own set of flags). 8355 supply its own set of flags).
8339 8356
8340 TUNE_FEATURES
8341 Features used to "tune" a compiler for optimal use given a specific
8342 processor. The features are defined within the tune files and allow
8343 arguments (i.e. ``TUNE_*ARGS``) to be dynamically generated based on
8344 the features.
8345
8346 The OpenEmbedded build system verifies the features to be sure they
8347 are not conflicting and that they are supported.
8348
8349 The BitBake configuration file (``meta/conf/bitbake.conf``) defines
8350 ``TUNE_FEATURES`` as follows:
8351 ::
8352
8353 TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}"
8354
8355 See the :term:`DEFAULTTUNE` variable for more information.
8356
8357 TUNE_PKGARCH 8357 TUNE_PKGARCH
8358 The package architecture understood by the packaging system to define 8358 The package architecture understood by the packaging system to define
8359 the architecture, ABI, and tuning of output packages. The specific 8359 the architecture, ABI, and tuning of output packages. The specific
@@ -8500,14 +8500,6 @@ system and gives an overview of their function and contents.
8500 Options for the device tree compiler passed to mkimage '-D' 8500 Options for the device tree compiler passed to mkimage '-D'
8501 feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. 8501 feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class.
8502 8502
8503 UBOOT_RD_LOADADDRESS
8504 Specifies the load address for the RAM disk image.
8505 During FIT image creation, the
8506 ``UBOOT_RD_LOADADDRESS`` variable is used
8507 in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the
8508 load address to be used in creating the Image Tree Source for
8509 the FIT image.
8510
8511 UBOOT_RD_ENTRYPOINT 8503 UBOOT_RD_ENTRYPOINT
8512 Specifies the entrypoint for the RAM disk image. 8504 Specifies the entrypoint for the RAM disk image.
8513 During FIT image creation, the 8505 During FIT image creation, the
@@ -8516,6 +8508,14 @@ system and gives an overview of their function and contents.
8516 entrypoint to be used in creating the Image Tree Source for 8508 entrypoint to be used in creating the Image Tree Source for
8517 the FIT image. 8509 the FIT image.
8518 8510
8511 UBOOT_RD_LOADADDRESS
8512 Specifies the load address for the RAM disk image.
8513 During FIT image creation, the
8514 ``UBOOT_RD_LOADADDRESS`` variable is used
8515 in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the
8516 load address to be used in creating the Image Tree Source for
8517 the FIT image.
8518
8519 UBOOT_SIGN_ENABLE 8519 UBOOT_SIGN_ENABLE
8520 Enable signing of FIT image. The default value is "0". 8520 Enable signing of FIT image. The default value is "0".
8521 8521
@@ -8813,6 +8813,15 @@ system and gives an overview of their function and contents.
8813 can control with this variable, see the 8813 can control with this variable, see the
8814 ":ref:`insane.bbclass <ref-classes-insane>`" section. 8814 ":ref:`insane.bbclass <ref-classes-insane>`" section.
8815 8815
8816 WKS_FILE
8817 Specifies the location of the Wic kickstart file that is used by the
8818 OpenEmbedded build system to create a partitioned image
8819 (image\ ``.wic``). For information on how to create a partitioned
8820 image, see the
8821 ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`"
8822 section in the Yocto Project Development Tasks Manual. For details on
8823 the kickstart file format, see the ":doc:`../ref-manual/ref-kickstart`" Chapter.
8824
8816 WKS_FILE_DEPENDS 8825 WKS_FILE_DEPENDS
8817 When placed in the recipe that builds your image, this variable lists 8826 When placed in the recipe that builds your image, this variable lists
8818 build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only 8827 build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only
@@ -8838,15 +8847,6 @@ system and gives an overview of their function and contents.
8838 previous example, some-native-tool would be replaced with an actual 8847 previous example, some-native-tool would be replaced with an actual
8839 native tool on which the build would depend. 8848 native tool on which the build would depend.
8840 8849
8841 WKS_FILE
8842 Specifies the location of the Wic kickstart file that is used by the
8843 OpenEmbedded build system to create a partitioned image
8844 (image\ ``.wic``). For information on how to create a partitioned
8845 image, see the
8846 ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`"
8847 section in the Yocto Project Development Tasks Manual. For details on
8848 the kickstart file format, see the ":doc:`../ref-manual/ref-kickstart`" Chapter.
8849
8850 WORKDIR 8850 WORKDIR
8851 The pathname of the work directory in which the OpenEmbedded build 8851 The pathname of the work directory in which the OpenEmbedded build
8852 system builds a recipe. This directory is located within the 8852 system builds a recipe. This directory is located within the