diff options
Diffstat (limited to 'poky/documentation/ref-manual/variables.rst')
| -rw-r--r-- | poky/documentation/ref-manual/variables.rst | 493 |
1 files changed, 240 insertions, 253 deletions
diff --git a/poky/documentation/ref-manual/variables.rst b/poky/documentation/ref-manual/variables.rst index ecb2b60c73..634f19a673 100644 --- a/poky/documentation/ref-manual/variables.rst +++ b/poky/documentation/ref-manual/variables.rst @@ -17,6 +17,7 @@ system and gives an overview of their function and contents. :term:`W <WARN_QA>` :term:`X <XSERVER>` .. glossary:: + :sorted: :term:`ABIEXTENSION` Extension to the Application Binary Interface (ABI) field of the GNU @@ -206,11 +207,6 @@ system and gives an overview of their function and contents. The default value is "${PACKAGES}", which causes the debian class to act on all packages that are explicitly generated by the recipe. - :term:`AUTO_SYSLINUXMENU` - Enables creating an automatic menu for the syslinux bootloader. You - must set this variable in your recipe. The - :ref:`syslinux <ref-classes-syslinux>` class checks this variable. - :term:`AUTOREV` When :term:`SRCREV` is set to the value of this variable, it specifies to use the latest source revision in the repository. Here is an example:: @@ -230,6 +226,11 @@ system and gives an overview of their function and contents. ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" section in the Yocto Project Development Tasks Manual. + :term:`AUTO_SYSLINUXMENU` + Enables creating an automatic menu for the syslinux bootloader. You + must set this variable in your recipe. The + :ref:`syslinux <ref-classes-syslinux>` class checks this variable. + :term:`AVAILABLE_LICENSES` List of licenses found in the directories specified by :term:`COMMON_LICENSE_DIR` and @@ -1306,6 +1307,40 @@ system and gives an overview of their function and contents. the recipe will be skipped, and if the build system attempts to build the recipe then an error will be triggered. + :term:`COPY_LIC_DIRS` + If set to "1" along with the + :term:`COPY_LIC_MANIFEST` variable, the + OpenEmbedded build system copies into the image the license files, + which are located in ``/usr/share/common-licenses``, for each + package. The license files are placed in directories within the image + itself during build time. + + .. note:: + + The :term:`COPY_LIC_DIRS` does not offer a path for adding licenses for + newly installed packages to an image, which might be most suitable for + read-only filesystems that cannot be upgraded. See the + :term:`LICENSE_CREATE_PACKAGE` variable for additional information. + You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" + section in the Yocto Project Development Tasks Manual for + information on providing license text. + + :term:`COPY_LIC_MANIFEST` + If set to "1", the OpenEmbedded build system copies the license + manifest for the image to + ``/usr/share/common-licenses/license.manifest`` within the image + itself during build time. + + .. note:: + + The :term:`COPY_LIC_MANIFEST` does not offer a path for adding licenses for + newly installed packages to an image, which might be most suitable for + read-only filesystems that cannot be upgraded. See the + :term:`LICENSE_CREATE_PACKAGE` variable for additional information. + You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" + section in the Yocto Project Development Tasks Manual for + information on providing license text. + :term:`COPYLEFT_LICENSE_EXCLUDE` A space-separated list of licenses to exclude from the source archived by the :ref:`archiver <ref-classes-archiver>` class. In @@ -1374,40 +1409,6 @@ system and gives an overview of their function and contents. is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which is inherited by the :ref:`archiver <ref-classes-archiver>` class. - :term:`COPY_LIC_DIRS` - If set to "1" along with the - :term:`COPY_LIC_MANIFEST` variable, the - OpenEmbedded build system copies into the image the license files, - which are located in ``/usr/share/common-licenses``, for each - package. The license files are placed in directories within the image - itself during build time. - - .. note:: - - The :term:`COPY_LIC_DIRS` does not offer a path for adding licenses for - newly installed packages to an image, which might be most suitable for - read-only filesystems that cannot be upgraded. See the - :term:`LICENSE_CREATE_PACKAGE` variable for additional information. - You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" - section in the Yocto Project Development Tasks Manual for - information on providing license text. - - :term:`COPY_LIC_MANIFEST` - If set to "1", the OpenEmbedded build system copies the license - manifest for the image to - ``/usr/share/common-licenses/license.manifest`` within the image - itself during build time. - - .. note:: - - The :term:`COPY_LIC_MANIFEST` does not offer a path for adding licenses for - newly installed packages to an image, which might be most suitable for - read-only filesystems that cannot be upgraded. See the - :term:`LICENSE_CREATE_PACKAGE` variable for additional information. - You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" - section in the Yocto Project Development Tasks Manual for - information on providing license text. - :term:`CORE_IMAGE_EXTRA_INSTALL` Specifies the list of packages to be added to the image. You should only set this variable in the ``local.conf`` configuration file found @@ -1472,16 +1473,16 @@ system and gives an overview of their function and contents. variable only in certain contexts (e.g. when building for kernel and kernel module recipes). - :term:`CVE_CHECK_PN_WHITELIST` - The list of package names (:term:`PN`) for which - CVEs (Common Vulnerabilities and Exposures) are ignored. - - :term:`CVE_CHECK_WHITELIST` + :term:`CVE_CHECK_IGNORE` The list of CVE IDs which are ignored. Here is an example from the :oe_layerindex:`Python3 recipe</layerindex/recipe/23823>`:: # This is windows only issue. - CVE_CHECK_WHITELIST += "CVE-2020-15523" + CVE_CHECK_IGNORE += "CVE-2020-15523" + + :term:`CVE_CHECK_SKIP_RECIPE` + The list of package names (:term:`PN`) for which + CVEs (Common Vulnerabilities and Exposures) are ignored. :term:`CVE_PRODUCT` In a recipe, defines the name used to match the recipe name @@ -1568,21 +1569,6 @@ system and gives an overview of their function and contents. compiling a system for debugging. This variable defaults to "-O -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe". - :term:`DEFAULT_PREFERENCE` - Specifies a weak bias for recipe selection priority. - - The most common usage of this is variable is to set it to "-1" within - a recipe for a development version of a piece of software. Using the - variable in this way causes the stable version of the recipe to build - by default in the absence of :term:`PREFERRED_VERSION` being used to - build the development version. - - .. note:: - - The bias provided by :term:`DEFAULT_PREFERENCE` is weak and is overridden - by :term:`BBFILE_PRIORITY` if that variable is different between two - layers that contain different versions of the same recipe. - :term:`DEBUG_PREFIX_MAP` Allows to set C compiler options, such as ``-fdebug-prefix-map``, ``-fmacro-prefix-map``, and ``-ffile-prefix-map``, which allow to @@ -1600,6 +1586,21 @@ system and gives an overview of their function and contents. This variable is set in the ``meta/conf/bitbake.conf`` file. It is not intended to be user-configurable. + :term:`DEFAULT_PREFERENCE` + Specifies a weak bias for recipe selection priority. + + The most common usage of this is variable is to set it to "-1" within + a recipe for a development version of a piece of software. Using the + variable in this way causes the stable version of the recipe to build + by default in the absence of :term:`PREFERRED_VERSION` being used to + build the development version. + + .. note:: + + The bias provided by :term:`DEFAULT_PREFERENCE` is weak and is overridden + by :term:`BBFILE_PRIORITY` if that variable is different between two + layers that contain different versions of the same recipe. + :term:`DEFAULTTUNE` The default CPU and Application Binary Interface (ABI) tunings (i.e. the "tune") used by the OpenEmbedded build system. The @@ -1982,25 +1983,6 @@ system and gives an overview of their function and contents. is included in the default value of :term:`OVERRIDES`. - :term:`DISTUTILS_SETUP_PATH` - When used by recipes that inherit the - :ref:`distutils3 <ref-classes-distutils3>` class, this variable should - be used to specify the directory in which the ``setup.py`` file is - located if it is not at the root of the source tree (as specified by - :term:`S`). For example, in a recipe where the sources are fetched from - a Git repository and ``setup.py`` is in a ``python/pythonmodule`` - subdirectory, you would have this:: - - S = "${WORKDIR}/git" - DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule" - - .. note:: - - ``distutils`` has been deprecated in Python 3.10 and will be removed - in Python 3.12. For this reason, the use of :ref:`distutils3 <ref-classes-distutils3>` - is deprecated. Instead use :ref:`setuptools3 <ref-classes-setuptools3>` and the - :term:`SETUPTOOLS_SETUP_PATH` variable. - :term:`DL_DIR` The central download directory used by the build process to store downloads. By default, :term:`DL_DIR` gets files suitable for mirroring @@ -2086,6 +2068,68 @@ system and gives an overview of their function and contents. can control with this variable, see the ":ref:`ref-classes-insane`" section. + :term:`ESDK_CLASS_INHERIT_DISABLE` + A list of classes to remove from the :term:`INHERIT` + value globally within the extensible SDK configuration. The + :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the + default value:: + + ESDK_CLASS_INHERIT_DISABLE ?= "buildhistory icecc" + + Some classes are not generally applicable within the extensible SDK + context. You can use this variable to disable those classes. + + For additional information on how to customize the extensible SDK's + configuration, see the + ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + + :term:`ESDK_LOCALCONF_ALLOW` + A list of variables allowed through from the OpenEmbedded build + system configuration into the extensible SDK configuration. By + default, the list of variables is empty and is set in the + :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class. + + This list overrides the variables specified using the + :term:`ESDK_LOCALCONF_REMOVE` variable as well as + other variables automatically added due to the "/" character + being found at the start of the + value, which is usually indicative of being a path and thus might not + be valid on the system where the SDK is installed. + + For additional information on how to customize the extensible SDK's + configuration, see the + ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + + :term:`ESDK_LOCALCONF_REMOVE` + A list of variables not allowed through from the OpenEmbedded build + system configuration into the extensible SDK configuration. Usually, + these are variables that are specific to the machine on which the + build system is running and thus would be potentially problematic + within the extensible SDK. + + By default, :term:`ESDK_LOCALCONF_REMOVE` is set in the + :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and + excludes the following variables: + + - :term:`CONF_VERSION` + - :term:`BB_NUMBER_THREADS` + - :term:`BB_NUMBER_PARSE_THREADS` + - :term:`PARALLEL_MAKE` + - :term:`PRSERV_HOST` + - :term:`SSTATE_MIRRORS` :term:`DL_DIR` + - :term:`SSTATE_DIR` :term:`TMPDIR` + - :term:`BB_SERVER_TIMEOUT` + + For additional information on how to customize the extensible SDK's + configuration, see the + ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + :term:`EXCLUDE_FROM_SHLIBS` Triggers the OpenEmbedded build system's shared libraries resolver to exclude an entire package when scanning for shared libraries. @@ -2253,16 +2297,6 @@ system and gives an overview of their function and contents. To add packages to the root filesystem, see the various :term:`RDEPENDS` and :term:`RRECOMMENDS` variables. - :term:`EXTRANATIVEPATH` - A list of subdirectories of - ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}`` - added to the beginning of the environment variable ``PATH``. As an - example, the following prepends - "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to - ``PATH``:: - - EXTRANATIVEPATH = "foo bar" - :term:`EXTRA_OECMAKE` Additional `CMake <https://cmake.org/overview/>`__ options. See the :ref:`cmake <ref-classes-cmake>` class for additional information. @@ -2319,6 +2353,16 @@ system and gives an overview of their function and contents. At present, ``passwd-expire`` may only work for remote logins when using OpenSSH and not dropbear as an SSH server. + :term:`EXTRANATIVEPATH` + A list of subdirectories of + ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}`` + added to the beginning of the environment variable ``PATH``. As an + example, the following prepends + "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to + ``PATH``:: + + EXTRANATIVEPATH = "foo bar" + :term:`FEATURE_PACKAGES` Defines one or more packages to include in an image when a specific item is included in :term:`IMAGE_FEATURES`. @@ -2612,10 +2656,6 @@ system and gives an overview of their function and contents. Specifies the signature algorithm used in creating the FIT Image. For e.g. rsa2048. - :term:`FIT_SIGN_NUMBITS` - Size of private key in number of bits used in fitImage. The default - value is "2048". - :term:`FIT_SIGN_INDIVIDUAL` If set to "1", then the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class will sign the kernel, dtb and ramdisk images individually in addition @@ -2623,6 +2663,10 @@ system and gives an overview of their function and contents. intending to verify signatures in another context than booting via U-Boot. + :term:`FIT_SIGN_NUMBITS` + Size of private key in number of bits used in fitImage. The default + value is "2048". + :term:`FONT_EXTRA_RDEPENDS` When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, this variable specifies the runtime dependencies for font packages. @@ -2819,6 +2863,10 @@ system and gives an overview of their function and contents. - Given a recipe being built for a little-endian MIPS target running Linux, the value might be "mipsel-linux". + :term:`HOST_VENDOR` + Specifies the name of the vendor. :term:`HOST_VENDOR` is normally the + same as :term:`TARGET_VENDOR`. + :term:`HOSTTOOLS` A space-separated list (filter) of tools on the build host that should be allowed to be called from within build tasks. Using this @@ -2839,9 +2887,15 @@ system and gives an overview of their function and contents. :term:`HOSTTOOLS_NONFATAL` is not found on the build host. Thus, you can use :term:`HOSTTOOLS_NONFATAL` to filter optional host tools. - :term:`HOST_VENDOR` - Specifies the name of the vendor. :term:`HOST_VENDOR` is normally the - same as :term:`TARGET_VENDOR`. + :term:`ICECC_CLASS_DISABLE` + Identifies user classes that you do not want the Icecream distributed + compile support to consider. This variable is used by the + :ref:`icecc <ref-classes-icecc>` class. You set this variable in + your ``local.conf`` file. + + When you list classes using this variable, the recipes inheriting + those classes will not benefit from distributed compilation across + remote hosts. Instead they will be built locally. :term:`ICECC_DISABLED` Disables or enables the ``icecc`` (Icecream) function. For more @@ -2898,17 +2952,7 @@ system and gives an overview of their function and contents. this variable, the :ref:`icecc <ref-classes-icecc>` class attempts to define it by locating ``icecc`` using ``which``. - :term:`ICECC_USER_CLASS_BL` - Identifies user classes that you do not want the Icecream distributed - compile support to consider. This variable is used by the - :ref:`icecc <ref-classes-icecc>` class. You set this variable in - your ``local.conf`` file. - - When you list classes using this variable, the recipes inheriting - those classes will not benefit from distributed compilation across - remote hosts. Instead they will be built locally. - - :term:`ICECC_USER_PACKAGE_BL` + :term:`ICECC_RECIPE_DISABLE` Identifies user recipes that you do not want the Icecream distributed compile support to consider. This variable is used by the :ref:`icecc <ref-classes-icecc>` class. You set this variable in @@ -2918,7 +2962,7 @@ system and gives an overview of their function and contents. from distributed compilation across remote hosts. Instead they will be built locally. - :term:`ICECC_USER_PACKAGE_WL` + :term:`ICECC_RECIPE_ENABLE` Identifies user recipes that use an empty :term:`PARALLEL_MAKE` variable that you want to force remote distributed compilation on using the Icecream @@ -2930,40 +2974,6 @@ system and gives an overview of their function and contents. The base name of image output files. This variable defaults to the recipe name (``${``\ :term:`PN`\ ``}``). - :term:`IMAGE_EFI_BOOT_FILES` - A space-separated list of files installed into the boot partition - when preparing an image using the Wic tool with the - ``bootimg-efi`` source plugin. By default, - the files are - installed under the same name as the source files. To change the - installed name, separate it from the original name with a semi-colon - (;). Source files need to be located in - :term:`DEPLOY_DIR_IMAGE`. Here are two - examples:: - - IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2" - IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio" - - Alternatively, source files can be picked up using a glob pattern. In - this case, the destination file must have the same name as the base - name of the source file path. To install files into a directory - within the target location, pass its name after a semi-colon (;). - Here are two examples:: - - IMAGE_EFI_BOOT_FILES = "boot/loader/*" - IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/" - - The first example - installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/`` - into the root of the target partition. The second example installs - the same files into a ``boot`` directory within the target partition. - - You can find information on how to use the Wic tool in the - ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" - section of the Yocto Project Development Tasks Manual. Reference - material for Wic is located in the - ":doc:`/ref-manual/kickstart`" chapter. - :term:`IMAGE_BOOT_FILES` A space-separated list of files installed into the boot partition when preparing an image using the Wic tool with the @@ -3036,6 +3046,40 @@ system and gives an overview of their function and contents. device table files, see ``meta/files/device_table-minimal.txt`` as an example. + :term:`IMAGE_EFI_BOOT_FILES` + A space-separated list of files installed into the boot partition + when preparing an image using the Wic tool with the + ``bootimg-efi`` source plugin. By default, + the files are + installed under the same name as the source files. To change the + installed name, separate it from the original name with a semi-colon + (;). Source files need to be located in + :term:`DEPLOY_DIR_IMAGE`. Here are two + examples:: + + IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2" + IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio" + + Alternatively, source files can be picked up using a glob pattern. In + this case, the destination file must have the same name as the base + name of the source file path. To install files into a directory + within the target location, pass its name after a semi-colon (;). + Here are two examples:: + + IMAGE_EFI_BOOT_FILES = "boot/loader/*" + IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/" + + The first example + installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/`` + into the root of the target partition. The second example installs + the same files into a ``boot`` directory within the target partition. + + You can find information on how to use the Wic tool in the + ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" + section of the Yocto Project Development Tasks Manual. Reference + material for Wic is located in the + ":doc:`/ref-manual/kickstart`" chapter. + :term:`IMAGE_FEATURES` The primary list of features to include in an image. Typically, you configure this variable in an image recipe. Although you can use this @@ -3457,7 +3501,7 @@ system and gives an overview of their function and contents. This functionality is only regularly tested using the following setting:: - INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0" + INCOMPATIBLE_LICENSE = "GPL-3.0* LGPL-3.0* AGPL-3.0*" Although you can use other settings, you might be required to @@ -4348,9 +4392,9 @@ system and gives an overview of their function and contents. Here are some examples:: - LICENSE = "LGPLv2.1 | GPLv3" - LICENSE = "MPL-1 & LGPLv2.1" - LICENSE = "GPLv2+" + LICENSE = "LGPL-2.1-only | GPL-3.0-only" + LICENSE = "MPL-1.0 & LGPL-2.1-only" + LICENSE = "GPL-2.0-or-later" The first example is from the recipes for Qt, which the user may choose to distribute under either @@ -4365,8 +4409,8 @@ system and gives an overview of their function and contents. but has accompanying documentation licensed under the GNU Free Documentation License 1.2 could be specified as follows:: - LICENSE = "GFDL-1.2 & GPLv2" - LICENSE:${PN} = "GPLv2" + LICENSE = "GFDL-1.2 & GPL-2.0-only" + LICENSE:${PN} = "GPL-2.0.only" LICENSE:${PN}-doc = "GFDL-1.2" :term:`LICENSE_CREATE_PACKAGE` @@ -4394,7 +4438,7 @@ system and gives an overview of their function and contents. :term:`LICENSE_FLAGS` Specifies additional flags for a recipe you must allow through - :term:`LICENSE_FLAGS_WHITELIST` in + :term:`LICENSE_FLAGS_ACCEPTED` in order for the recipe to be built. When providing multiple flags, separate them with spaces. @@ -4405,7 +4449,7 @@ system and gives an overview of their function and contents. ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" section in the Yocto Project Development Tasks Manual. - :term:`LICENSE_FLAGS_WHITELIST` + :term:`LICENSE_FLAGS_ACCEPTED` Lists license flags that when specified in :term:`LICENSE_FLAGS` within a recipe should not prevent that recipe from being built. For more information, see the @@ -5156,18 +5200,6 @@ system and gives an overview of their function and contents. ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section in the Yocto Project Development Tasks Manual. - :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` - Prevents specific packages from being installed when you are - installing complementary packages. - - You might find that you want to prevent installing certain packages - when you are installing complementary packages. For example, if you - are using :term:`IMAGE_FEATURES` to install - ``dev-pkgs``, you might not want to install all packages from a - particular multilib. If you find yourself in this situation, you can - use the :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` variable to specify regular - expressions to match the packages you want to exclude. - :term:`PACKAGE_EXCLUDE` Lists packages that should not be installed into an image. For example:: @@ -5195,6 +5227,18 @@ system and gives an overview of their function and contents. :term:`BAD_RECOMMENDATIONS` variables for related information. + :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` + Prevents specific packages from being installed when you are + installing complementary packages. + + You might find that you want to prevent installing certain packages + when you are installing complementary packages. For example, if you + are using :term:`IMAGE_FEATURES` to install + ``dev-pkgs``, you might not want to install all packages from a + particular multilib. If you find yourself in this situation, you can + use the :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` variable to specify regular + expressions to match the packages you want to exclude. + :term:`PACKAGE_EXTRA_ARCHS` Specifies the list of architectures compatible with the device CPU. This variable is useful when you build for several different devices @@ -5588,12 +5632,24 @@ system and gives an overview of their function and contents. :term:`PE` is the default value of the :term:`PKGE` variable. + :term:`PEP517_WHEEL_PATH` + When used by recipes that inherit the + :ref:`python_pep517 <ref-classes-python_pep517>` class, + denotes the path to ``dist/`` (short for distribution) where the + binary archive ``wheel`` is built. + :term:`PF` Specifies the recipe or package name and includes all version and revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and ``bash-4.2-r1/``). This variable is comprised of the following: ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`} + :term:`PIP_INSTALL_ARGS` + When used by recipes that inherit the + :ref:`python_pep517 <ref-classes-python_pep517>` class, + denotes the arguments passed to ``pip install`` to adjust the + behavior of how the ``wheel`` is installed. + :term:`PIXBUF_PACKAGES` When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` class, this variable identifies packages that contain the pixbuf @@ -5700,18 +5756,6 @@ system and gives an overview of their function and contents. packages for the target and for Multilib, :term:`PN` would be ``bash`` and ``lib64-bash``, respectively. - :term:`PNBLACKLIST` - Lists recipes you do not want the OpenEmbedded build system to build. - This variable works in conjunction with the - :ref:`blacklist <ref-classes-blacklist>` class, which is inherited - globally. - - To prevent a recipe from being built, use the :term:`PNBLACKLIST` - variable in your ``local.conf`` file. Here is an example that - prevents ``myrecipe`` from being built:: - - PNBLACKLIST[myrecipe] = "Not supported by our organization." - :term:`POPULATE_SDK_POST_HOST_COMMAND` Specifies a list of functions to call once the OpenEmbedded build system has created the host part of the SDK. You can specify @@ -6023,8 +6067,7 @@ system and gives an overview of their function and contents. :term:`PYTHON_ABI` When used by recipes that inherit the - :ref:`distutils3 <ref-classes-distutils3>`, - :ref:`setuptools3 <ref-classes-setuptools3>` classes, denotes the + :ref:`setuptools3 <ref-classes-setuptools3>` class, denotes the Application Binary Interface (ABI) currently in use for Python. By default, the ABI is "m". You do not have to set this variable as the OpenEmbedded build system sets it for you. @@ -6033,14 +6076,9 @@ system and gives an overview of their function and contents. names used when installing the Python headers and libraries in sysroot (e.g. ``.../python3.3m/...``). - Recipes that inherit the :ref:`distutils3 <ref-classes-distutils3>` class during cross-builds also - use this variable to locate the headers and libraries of the - appropriate Python that the extension is targeting. - :term:`PYTHON_PN` When used by recipes that inherit the - `distutils3 <ref-classes-distutils3>`, - :ref:`setuptools3 <ref-classes-setuptools3>` classes, specifies the + :ref:`setuptools3 <ref-classes-setuptools3>` classe, specifies the major Python version being built. For Python 3.x, :term:`PYTHON_PN` would be "python3". You do not have to set this variable as the OpenEmbedded build system automatically sets it for you. @@ -6454,7 +6492,7 @@ system and gives an overview of their function and contents. from the default value of :term:`S`, you must set it specifically so the source can be located:: - SRC_URI = "git://path/to/repo.git" + SRC_URI = "git://path/to/repo.git;branch=main" S = "${WORKDIR}/git" :term:`SANITY_REQUIRED_UTILITIES` @@ -6559,68 +6597,6 @@ system and gives an overview of their function and contents. :term:`SDK_EXT_TYPE` is set to "minimal", and defaults to "1" if :term:`SDK_EXT_TYPE` is set to "full". - :term:`SDK_INHERIT_BLACKLIST` - A list of classes to remove from the :term:`INHERIT` - value globally within the extensible SDK configuration. The - :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the - default value:: - - SDK_INHERIT_BLACKLIST ?= "buildhistory icecc" - - Some classes are not generally applicable within the extensible SDK - context. You can use this variable to disable those classes. - - For additional information on how to customize the extensible SDK's - configuration, see the - ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - - :term:`SDK_LOCAL_CONF_BLACKLIST` - A list of variables not allowed through from the OpenEmbedded build - system configuration into the extensible SDK configuration. Usually, - these are variables that are specific to the machine on which the - build system is running and thus would be potentially problematic - within the extensible SDK. - - By default, :term:`SDK_LOCAL_CONF_BLACKLIST` is set in the - :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and - excludes the following variables: - - - :term:`CONF_VERSION` - - :term:`BB_NUMBER_THREADS` - - :term:`BB_NUMBER_PARSE_THREADS` - - :term:`PARALLEL_MAKE` - - :term:`PRSERV_HOST` - - :term:`SSTATE_MIRRORS` :term:`DL_DIR` - - :term:`SSTATE_DIR` :term:`TMPDIR` - - :term:`BB_SERVER_TIMEOUT` - - For additional information on how to customize the extensible SDK's - configuration, see the - ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - - :term:`SDK_LOCAL_CONF_WHITELIST` - A list of variables allowed through from the OpenEmbedded build - system configuration into the extensible SDK configuration. By - default, the list of variables is empty and is set in the - :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class. - - This list overrides the variables specified using the - :term:`SDK_LOCAL_CONF_BLACKLIST` variable as well as - other variables automatically added due to the "/" character - being found at the start of the - value, which is usually indicative of being a path and thus might not - be valid on the system where the SDK is installed. - - For additional information on how to customize the extensible SDK's - configuration, see the - ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - :term:`SDK_NAME` The base name for SDK output files. The name is derived from the :term:`DISTRO`, :term:`TCLIBC`, @@ -6946,6 +6922,18 @@ system and gives an overview of their function and contents. SKIP_FILEDEPS = "1" + :term:`SKIP_RECIPE` + Used to prevent the OpenEmbedded build system from building a given + recipe. Specify the :term:`PN` value as a variable flag (``varflag``) + and provide a reason, which will be reported when attempting to + build the recipe. + + To prevent a recipe from being built, use the :term:`SKIP_RECIPE` + variable in your ``local.conf`` file or distribution configuration. + Here is an example which prevents ``myrecipe`` from being built:: + + SKIP_RECIPE[myrecipe] = "Not supported by our organization." + :term:`SOC_FAMILY` Groups together machines based upon the same family of SOC (System On Chip). You typically set this variable in a common ``.inc`` file that @@ -7505,14 +7493,14 @@ system and gives an overview of their function and contents. /sysroot-only \ " - :term:`SYSROOT_DIRS_BLACKLIST` + :term:`SYSROOT_DIRS_IGNORE` Directories that are not staged into the sysroot by the :ref:`ref-tasks-populate_sysroot` task. You can use this variable to exclude certain subdirectories of directories listed in :term:`SYSROOT_DIRS` from staging. By default, the following directories are not staged:: - SYSROOT_DIRS_BLACKLIST = " \ + SYSROOT_DIRS_IGNORE = " \ ${mandir} \ ${docdir} \ ${infodir} \ @@ -8425,7 +8413,7 @@ system and gives an overview of their function and contents. passes and uses "all" for the target during the U-Boot building process. - :term:`UNKNOWN_CONFIGURE_WHITELIST` + :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` Specifies a list of options that, if reported by the configure script as being invalid, should not generate a warning during the :ref:`ref-tasks-configure` task. Normally, invalid @@ -8435,10 +8423,10 @@ system and gives an overview of their function and contents. However, there are common options that are passed to all configure scripts at a class level, but might not be valid for some configure scripts. Therefore warnings about these options are useless. - For these cases, the options are added to :term:`UNKNOWN_CONFIGURE_WHITELIST`. + For these cases, the options are added to :term:`UNKNOWN_CONFIGURE_OPT_IGNORE`. The configure arguments check that uses - :term:`UNKNOWN_CONFIGURE_WHITELIST` is part of the + :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` is part of the :ref:`insane <ref-classes-insane>` class and is only enabled if the recipe inherits the :ref:`autotools <ref-classes-autotools>` class. @@ -8536,12 +8524,11 @@ system and gives an overview of their function and contents. :term:`USER_CLASSES` A list of classes to globally inherit. These classes are used by the - OpenEmbedded build system to enable extra features (e.g. - ``buildstats``, ``image-prelink``, and so forth). + OpenEmbedded build system to enable extra features. The default list is set in your ``local.conf`` file:: - USER_CLASSES ?= "buildstats image-prelink" + USER_CLASSES ?= "buildstats" For more information, see ``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`. |