summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-10-13 08:42:10 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-12-01 19:20:29 +0000
commit55621c31f1edbdb2f3d72e80916fed031e2ba298 (patch)
tree49499b82a28ed611fb478605e11fa173294f1e87 /documentation/ref-manual/variables.rst
parent7ecd9877e6a1b235070d6feba59a3840ebbc5255 (diff)
downloadpoky-55621c31f1edbdb2f3d72e80916fed031e2ba298.tar.gz
manuals: add missing references to classes
Sometimes fixing line length in modified paragraphs too. [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst125
1 files changed, 64 insertions, 61 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index d3aae63308..ca62365cc3 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -203,8 +203,9 @@ system and gives an overview of their function and contents.
203 packages should be checked for libraries and renamed according to 203 packages should be checked for libraries and renamed according to
204 Debian library package naming. 204 Debian library package naming.
205 205
206 The default value is "${PACKAGES}", which causes the debian class to 206 The default value is "${PACKAGES}", which causes the
207 act on all packages that are explicitly generated by the recipe. 207 :ref:`debian <ref-classes-debian>` class to act on all packages that are
208 explicitly generated by the recipe.
208 209
209 :term:`AUTOREV` 210 :term:`AUTOREV`
210 When :term:`SRCREV` is set to the value of this variable, it specifies to 211 When :term:`SRCREV` is set to the value of this variable, it specifies to
@@ -576,9 +577,9 @@ system and gives an overview of their function and contents.
576 ``quilt-native``, which is a copy of Quilt built to run on the build 577 ``quilt-native``, which is a copy of Quilt built to run on the build
577 system; "crosses" such as ``gcc-cross``, which is a compiler built to 578 system; "crosses" such as ``gcc-cross``, which is a compiler built to
578 run on the build machine but produces binaries that run on the target 579 run on the build machine but produces binaries that run on the target
579 :term:`MACHINE`; "nativesdk", which targets the SDK 580 :term:`MACHINE`; ":ref:`nativesdk <ref-classes-nativesdk>`", which
580 machine instead of :term:`MACHINE`; and "mulitlibs" in the form 581 targets the SDK machine instead of :term:`MACHINE`; and "mulitlibs" in
581 "``multilib:``\ multilib_name". 582 the form "``multilib:``\ multilib_name".
582 583
583 To build a different variant of the recipe with a minimal amount of 584 To build a different variant of the recipe with a minimal amount of
584 code, it usually is as simple as adding the following to your recipe:: 585 code, it usually is as simple as adding the following to your recipe::
@@ -906,7 +907,7 @@ system and gives an overview of their function and contents.
906 The toolchain binary prefix used for native recipes. The OpenEmbedded 907 The toolchain binary prefix used for native recipes. The OpenEmbedded
907 build system uses the :term:`BUILD_PREFIX` value to set the 908 build system uses the :term:`BUILD_PREFIX` value to set the
908 :term:`TARGET_PREFIX` when building for 909 :term:`TARGET_PREFIX` when building for
909 ``native`` recipes. 910 :ref:`native <ref-classes-native>` recipes.
910 911
911 :term:`BUILD_STRIP` 912 :term:`BUILD_STRIP`
912 Specifies the command to be used to strip debugging symbols from 913 Specifies the command to be used to strip debugging symbols from
@@ -917,7 +918,7 @@ system and gives an overview of their function and contents.
917 :term:`BUILD_SYS` 918 :term:`BUILD_SYS`
918 Specifies the system, including the architecture and the operating 919 Specifies the system, including the architecture and the operating
919 system, to use when building for the build host (i.e. when building 920 system, to use when building for the build host (i.e. when building
920 ``native`` recipes). 921 :ref:`native <ref-classes-native>` recipes).
921 922
922 The OpenEmbedded build system automatically sets this variable based 923 The OpenEmbedded build system automatically sets this variable based
923 on :term:`BUILD_ARCH`, 924 on :term:`BUILD_ARCH`,
@@ -1417,8 +1418,10 @@ system and gives an overview of their function and contents.
1417 :term:`COPYLEFT_RECIPE_TYPES` 1418 :term:`COPYLEFT_RECIPE_TYPES`
1418 A space-separated list of recipe types to include in the source 1419 A space-separated list of recipe types to include in the source
1419 archived by the :ref:`archiver <ref-classes-archiver>` class. 1420 archived by the :ref:`archiver <ref-classes-archiver>` class.
1420 Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``, 1421 Recipe types are ``target``, :ref:`native <ref-classes-native>`,
1421 ``crosssdk``, and ``cross-canadian``. 1422 :ref:`nativesdk <ref-classes-nativesdk>`,
1423 :ref:`cross <ref-classes-cross>`, :ref:`crosssdk <ref-classes-crosssdk>`,
1424 and :ref:`cross-canadian <ref-classes-cross-canadian>`.
1422 1425
1423 The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES` 1426 The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES`
1424 is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>` 1427 is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>`
@@ -1751,9 +1754,8 @@ system and gives an overview of their function and contents.
1751 :term:`DEPLOY_DIR_DEB` 1754 :term:`DEPLOY_DIR_DEB`
1752 Points to the area that the OpenEmbedded build system uses to place 1755 Points to the area that the OpenEmbedded build system uses to place
1753 Debian packages that are ready to be used outside of the build 1756 Debian packages that are ready to be used outside of the build
1754 system. This variable applies only when 1757 system. This variable applies only when :term:`PACKAGE_CLASSES` contains
1755 :term:`PACKAGE_CLASSES` contains 1758 ":ref:`package_deb <ref-classes-package_deb>`".
1756 "package_deb".
1757 1759
1758 The BitBake configuration file initially defines the 1760 The BitBake configuration file initially defines the
1759 :term:`DEPLOY_DIR_DEB` variable as a sub-folder of 1761 :term:`DEPLOY_DIR_DEB` variable as a sub-folder of
@@ -1794,9 +1796,8 @@ system and gives an overview of their function and contents.
1794 :term:`DEPLOY_DIR_IPK` 1796 :term:`DEPLOY_DIR_IPK`
1795 Points to the area that the OpenEmbedded build system uses to place 1797 Points to the area that the OpenEmbedded build system uses to place
1796 IPK packages that are ready to be used outside of the build system. 1798 IPK packages that are ready to be used outside of the build system.
1797 This variable applies only when 1799 This variable applies only when :term:`PACKAGE_CLASSES` contains
1798 :term:`PACKAGE_CLASSES` contains 1800 ":ref:`package_ipk <ref-classes-package_ipk>`".
1799 "package_ipk".
1800 1801
1801 The BitBake configuration file initially defines this variable as a 1802 The BitBake configuration file initially defines this variable as a
1802 sub-folder of :term:`DEPLOY_DIR`:: 1803 sub-folder of :term:`DEPLOY_DIR`::
@@ -1814,9 +1815,8 @@ system and gives an overview of their function and contents.
1814 :term:`DEPLOY_DIR_RPM` 1815 :term:`DEPLOY_DIR_RPM`
1815 Points to the area that the OpenEmbedded build system uses to place 1816 Points to the area that the OpenEmbedded build system uses to place
1816 RPM packages that are ready to be used outside of the build system. 1817 RPM packages that are ready to be used outside of the build system.
1817 This variable applies only when 1818 This variable applies only when :term:`PACKAGE_CLASSES` contains
1818 :term:`PACKAGE_CLASSES` contains 1819 ":ref:`package_rpm <ref-classes-package_rpm>`".
1819 "package_rpm".
1820 1820
1821 The BitBake configuration file initially defines this variable as a 1821 The BitBake configuration file initially defines this variable as a
1822 sub-folder of :term:`DEPLOY_DIR`:: 1822 sub-folder of :term:`DEPLOY_DIR`::
@@ -1834,9 +1834,8 @@ system and gives an overview of their function and contents.
1834 :term:`DEPLOY_DIR_TAR` 1834 :term:`DEPLOY_DIR_TAR`
1835 Points to the area that the OpenEmbedded build system uses to place 1835 Points to the area that the OpenEmbedded build system uses to place
1836 tarballs that are ready to be used outside of the build system. This 1836 tarballs that are ready to be used outside of the build system. This
1837 variable applies only when 1837 variable applies only when :term:`PACKAGE_CLASSES` contains
1838 :term:`PACKAGE_CLASSES` contains 1838 ":ref:`package_tar <ref-classes-package_tar>`".
1839 "package_tar".
1840 1839
1841 The BitBake configuration file initially defines this variable as a 1840 The BitBake configuration file initially defines this variable as a
1842 sub-folder of :term:`DEPLOY_DIR`:: 1841 sub-folder of :term:`DEPLOY_DIR`::
@@ -1993,11 +1992,11 @@ system and gives an overview of their function and contents.
1993 1992
1994 :term:`DISTRO_FEATURES_FILTER_NATIVESDK` 1993 :term:`DISTRO_FEATURES_FILTER_NATIVESDK`
1995 Specifies a list of features that if present in the target 1994 Specifies a list of features that if present in the target
1996 :term:`DISTRO_FEATURES` value should be 1995 :term:`DISTRO_FEATURES` value should be included in
1997 included in :term:`DISTRO_FEATURES` when building nativesdk recipes. This 1996 :term:`DISTRO_FEATURES` when building
1998 variable is used in addition to the features filtered using the 1997 :ref:`nativesdk <ref-classes-nativesdk>` recipes. This variable is used
1999 :term:`DISTRO_FEATURES_NATIVESDK` 1998 in addition to the features filtered using the
2000 variable. 1999 :term:`DISTRO_FEATURES_NATIVESDK` variable.
2001 2000
2002 :term:`DISTRO_FEATURES_NATIVE` 2001 :term:`DISTRO_FEATURES_NATIVE`
2003 Specifies a list of features that should be included in 2002 Specifies a list of features that should be included in
@@ -2010,10 +2009,9 @@ system and gives an overview of their function and contents.
2010 :term:`DISTRO_FEATURES_NATIVESDK` 2009 :term:`DISTRO_FEATURES_NATIVESDK`
2011 Specifies a list of features that should be included in 2010 Specifies a list of features that should be included in
2012 :term:`DISTRO_FEATURES` when building 2011 :term:`DISTRO_FEATURES` when building
2013 nativesdk recipes. This variable is used in addition to the features 2012 :ref:`nativesdk <ref-classes-nativesdk>` recipes. This variable is used
2014 filtered using the 2013 in addition to the features filtered using the
2015 :term:`DISTRO_FEATURES_FILTER_NATIVESDK` 2014 :term:`DISTRO_FEATURES_FILTER_NATIVESDK` variable.
2016 variable.
2017 2015
2018 :term:`DISTRO_NAME` 2016 :term:`DISTRO_NAME`
2019 The long name of the distribution. For information on the short name 2017 The long name of the distribution. For information on the short name
@@ -4124,12 +4122,12 @@ system and gives an overview of their function and contents.
4124 4122
4125 :term:`KERNEL_CLASSES` 4123 :term:`KERNEL_CLASSES`
4126 A list of classes defining kernel image types that the 4124 A list of classes defining kernel image types that the
4127 :ref:`kernel <ref-classes-kernel>` class should inherit. You 4125 :ref:`kernel <ref-classes-kernel>` class should inherit. You typically
4128 typically append this variable to enable extended image types. An 4126 append this variable to enable extended image types. An example is
4129 example is the "kernel-fitimage", which enables fitImage support and 4127 ":ref:`kernel-fitimage <ref-classes-kernel-fitimage>`", which enables
4130 resides in ``meta/classes-recipe/kernel-fitimage.bbclass``. You can register 4128 fitImage support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``.
4131 custom kernel image types with the :ref:`kernel <ref-classes-kernel>` class using this 4129 You can register custom kernel image types with the
4132 variable. 4130 :ref:`kernel <ref-classes-kernel>` class using this variable.
4133 4131
4134 :term:`KERNEL_DEBUG_TIMESTAMPS` 4132 :term:`KERNEL_DEBUG_TIMESTAMPS`
4135 If set to "1", enables timestamping functionality during building 4133 If set to "1", enables timestamping functionality during building
@@ -4949,16 +4947,18 @@ system and gives an overview of their function and contents.
4949 4947
4950 .. note:: 4948 .. note::
4951 4949
4952 The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation is 4950 The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation
4953 historical and comes from a time when ``nativesdk`` was a suffix 4951 is historical and comes from a time when
4954 rather than a prefix on the recipe name. When ``nativesdk`` was turned 4952 ":ref:`nativesdk <ref-classes-nativesdk>`"
4953 was a suffix rather than a prefix on the recipe name. When
4954 ":ref:`nativesdk <ref-classes-nativesdk>`" was turned
4955 into a prefix, it made sense to set :term:`MLPREFIX` for it as well. 4955 into a prefix, it made sense to set :term:`MLPREFIX` for it as well.
4956 4956
4957 To help understand when :term:`MLPREFIX` might be needed, consider when 4957 To help understand when :term:`MLPREFIX` might be needed, consider when
4958 :term:`BBCLASSEXTEND` is used to provide a 4958 :term:`BBCLASSEXTEND` is used to provide a
4959 ``nativesdk`` version of a recipe in addition to the target version. 4959 :ref:`nativesdk <ref-classes-nativesdk>` version of a recipe in addition
4960 If that recipe declares build-time dependencies on tasks in other 4960 to the target version. If that recipe declares build-time dependencies
4961 recipes by using :term:`DEPENDS`, then a dependency on 4961 on tasks in other recipes by using :term:`DEPENDS`, then a dependency on
4962 "foo" will automatically get rewritten to a dependency on 4962 "foo" will automatically get rewritten to a dependency on
4963 "nativesdk-foo". However, dependencies like the following will not 4963 "nativesdk-foo". However, dependencies like the following will not
4964 get rewritten automatically:: 4964 get rewritten automatically::
@@ -5406,12 +5406,13 @@ system and gives an overview of their function and contents.
5406 OpenEmbedded build system uses when packaging data. 5406 OpenEmbedded build system uses when packaging data.
5407 5407
5408 You can provide one or more of the following arguments for the 5408 You can provide one or more of the following arguments for the
5409 variable: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk 5409 variable::
5410 package_tar" 5410
5411 PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk package_tar"
5411 5412
5412 .. note:: 5413 .. note::
5413 5414
5414 While it is a legal option, the ``package_tar`` 5415 While it is a legal option, the :ref:`package_tar <ref-classes-package_tar>`
5415 class has limited functionality due to no support for package 5416 class has limited functionality due to no support for package
5416 dependencies by that backend. Therefore, it is recommended that 5417 dependencies by that backend. Therefore, it is recommended that
5417 you do not use it. 5418 you do not use it.
@@ -5925,8 +5926,9 @@ system and gives an overview of their function and contents.
5925 :term:`PIXBUF_PACKAGES` 5926 :term:`PIXBUF_PACKAGES`
5926 When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` 5927 When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>`
5927 class, this variable identifies packages that contain the pixbuf 5928 class, this variable identifies packages that contain the pixbuf
5928 loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache`` 5929 loaders used with ``gdk-pixbuf``. By default, the
5929 class assumes that the loaders are in the recipe's main package (i.e. 5930 :ref:`pixbufcache <ref-classes-pixbufcache>` class assumes that
5931 the loaders are in the recipe's main package (i.e.
5930 ``${``\ :term:`PN`\ ``}``). Use this variable if the 5932 ``${``\ :term:`PN`\ ``}``). Use this variable if the
5931 loaders you need are in a package other than that main package. 5933 loaders you need are in a package other than that main package.
5932 5934
@@ -6358,7 +6360,7 @@ system and gives an overview of their function and contents.
6358 6360
6359 :term:`PYTHON_PN` 6361 :term:`PYTHON_PN`
6360 When used by recipes that inherit the 6362 When used by recipes that inherit the
6361 :ref:`setuptools3 <ref-classes-setuptools3>` classe, specifies the 6363 :ref:`setuptools3 <ref-classes-setuptools3>` class, specifies the
6362 major Python version being built. For Python 3.x, :term:`PYTHON_PN` would 6364 major Python version being built. For Python 3.x, :term:`PYTHON_PN` would
6363 be "python3". You do not have to set this variable as the 6365 be "python3". You do not have to set this variable as the
6364 OpenEmbedded build system automatically sets it for you. 6366 OpenEmbedded build system automatically sets it for you.
@@ -6562,10 +6564,9 @@ system and gives an overview of their function and contents.
6562 for the same recipe, the :term:`REQUIRED_VERSION` value applies. 6564 for the same recipe, the :term:`REQUIRED_VERSION` value applies.
6563 6565
6564 :term:`RM_WORK_EXCLUDE` 6566 :term:`RM_WORK_EXCLUDE`
6565 With ``rm_work`` enabled, this variable specifies a list of recipes 6567 With :ref:`rm_work <ref-classes-rm-work>` enabled, this variable
6566 whose work directories should not be removed. See the 6568 specifies a list of recipes whose work directories should not be removed.
6567 ":ref:`ref-classes-rm-work`" section for more 6569 See the ":ref:`ref-classes-rm-work`" section for more details.
6568 details.
6569 6570
6570 :term:`ROOT_HOME` 6571 :term:`ROOT_HOME`
6571 Defines the root home directory. By default, this directory is set as 6572 Defines the root home directory. By default, this directory is set as
@@ -6830,9 +6831,9 @@ system and gives an overview of their function and contents.
6830 6831
6831 :term:`SDK_DEPLOY` 6832 :term:`SDK_DEPLOY`
6832 The directory set up and used by the 6833 The directory set up and used by the
6833 :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which 6834 :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which the
6834 the SDK is deployed. The ``populate_sdk_base`` class defines 6835 SDK is deployed. The :ref:`populate_sdk_base <ref-classes-populate-sdk>`
6835 :term:`SDK_DEPLOY` as follows:: 6836 class defines :term:`SDK_DEPLOY` as follows::
6836 6837
6837 SDK_DEPLOY = "${TMPDIR}/deploy/sdk" 6838 SDK_DEPLOY = "${TMPDIR}/deploy/sdk"
6838 6839
@@ -6950,7 +6951,8 @@ system and gives an overview of their function and contents.
6950 :term:`SDK_DIR` variable for more information. 6951 :term:`SDK_DIR` variable for more information.
6951 6952
6952 :term:`SDK_PREFIX` 6953 :term:`SDK_PREFIX`
6953 The toolchain binary prefix used for ``nativesdk`` recipes. The 6954 The toolchain binary prefix used for
6955 :ref:`nativesdk <ref-classes-nativesdk>` recipes. The
6954 OpenEmbedded build system uses the :term:`SDK_PREFIX` value to set the 6956 OpenEmbedded build system uses the :term:`SDK_PREFIX` value to set the
6955 :term:`TARGET_PREFIX` when building 6957 :term:`TARGET_PREFIX` when building
6956 ``nativesdk`` recipes. The default value is "${SDK_SYS}-". 6958 ``nativesdk`` recipes. The default value is "${SDK_SYS}-".
@@ -7761,7 +7763,7 @@ system and gives an overview of their function and contents.
7761 7763
7762 Some recipes build binaries that can run on the target system but 7764 Some recipes build binaries that can run on the target system but
7763 those binaries in turn generate code for another different system 7765 those binaries in turn generate code for another different system
7764 (e.g. cross-canadian recipes). Using terminology from GNU, the 7766 (e.g. :ref:`cross-canadian <ref-classes-cross-canadian>` recipes). Using terminology from GNU, the
7765 primary system is referred to as the "HOST" and the secondary, or 7767 primary system is referred to as the "HOST" and the secondary, or
7766 different, system is referred to as the "TARGET". Thus, the binaries 7768 different, system is referred to as the "TARGET". Thus, the binaries
7767 run on the "HOST" system and generate binaries for the "TARGET" 7769 run on the "HOST" system and generate binaries for the "TARGET"
@@ -8205,8 +8207,8 @@ system and gives an overview of their function and contents.
8205 - For native recipes, the build system sets the variable to the 8207 - For native recipes, the build system sets the variable to the
8206 value of :term:`BUILD_PREFIX`. 8208 value of :term:`BUILD_PREFIX`.
8207 8209
8208 - For native SDK recipes (``nativesdk``), the build system sets the 8210 - For native SDK recipes (:ref:`nativesdk <ref-classes-nativesdk>`),
8209 variable to the value of :term:`SDK_PREFIX`. 8211 the build system sets the variable to the value of :term:`SDK_PREFIX`.
8210 8212
8211 :term:`TARGET_SYS` 8213 :term:`TARGET_SYS`
8212 Specifies the system, including the architecture and the operating 8214 Specifies the system, including the architecture and the operating
@@ -8817,8 +8819,9 @@ system and gives an overview of their function and contents.
8817 :term:`UBOOT_MKIMAGE_DTCOPTS` 8819 :term:`UBOOT_MKIMAGE_DTCOPTS`
8818 Options for the device tree compiler passed to mkimage '-D' 8820 Options for the device tree compiler passed to mkimage '-D'
8819 feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. 8821 feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class.
8820 If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then kernel-fitimage will not 8822 If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then
8821 pass the ``-D`` option to mkimage. 8823 :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` will not pass the
8824 ``-D`` option to mkimage.
8822 8825
8823 :term:`UBOOT_MKIMAGE_KERNEL_TYPE` 8826 :term:`UBOOT_MKIMAGE_KERNEL_TYPE`
8824 Specifies the type argument for the kernel as passed to ``uboot-mkimage``. 8827 Specifies the type argument for the kernel as passed to ``uboot-mkimage``.