summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst108
1 files changed, 84 insertions, 24 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 9cdcc1b61b..32c9e7407d 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1681,6 +1681,12 @@ system and gives an overview of their function and contents.
1681 :term:`CVE_CHECK_IGNORE` 1681 :term:`CVE_CHECK_IGNORE`
1682 This variable is deprecated and should be replaced by :term:`CVE_STATUS`. 1682 This variable is deprecated and should be replaced by :term:`CVE_STATUS`.
1683 1683
1684 :term:`CVE_CHECK_REPORT_PATCHED`
1685 Specifies whether or not the :ref:`ref-classes-cve-check`
1686 class should report patched or ignored CVEs. The default is "1", but you
1687 may wish to set it to "0" if you do not need patched or ignored CVEs in
1688 the logs.
1689
1684 :term:`CVE_CHECK_SHOW_WARNINGS` 1690 :term:`CVE_CHECK_SHOW_WARNINGS`
1685 Specifies whether or not the :ref:`ref-classes-cve-check` 1691 Specifies whether or not the :ref:`ref-classes-cve-check`
1686 class should generate warning messages on the console when unpatched 1692 class should generate warning messages on the console when unpatched
@@ -1871,6 +1877,13 @@ system and gives an overview of their function and contents.
1871 by :term:`BBFILE_PRIORITY` if that variable is different between two 1877 by :term:`BBFILE_PRIORITY` if that variable is different between two
1872 layers that contain different versions of the same recipe. 1878 layers that contain different versions of the same recipe.
1873 1879
1880 :term:`DEFAULT_TIMEZONE`
1881 Specifies the time zone set in the image.
1882
1883 This variable causes the ``tzdata`` package to configure
1884 ``${sysconfdir}/localtime`` accordingly. Valid values are all files
1885 found in ``/usr/share/zoneinfo`` like ``CET`` or ``Asia/Baku``.
1886
1874 :term:`DEFAULTTUNE` 1887 :term:`DEFAULTTUNE`
1875 The default CPU and Application Binary Interface (ABI) tunings (i.e. 1888 The default CPU and Application Binary Interface (ABI) tunings (i.e.
1876 the "tune") used by the OpenEmbedded build system. The 1889 the "tune") used by the OpenEmbedded build system. The
@@ -3958,6 +3971,7 @@ system and gives an overview of their function and contents.
3958 - wic.bz2 3971 - wic.bz2
3959 - wic.gz 3972 - wic.gz
3960 - wic.lzma 3973 - wic.lzma
3974 - wic.zst
3961 3975
3962 For more information about these types of images, see 3976 For more information about these types of images, see
3963 ``meta/classes-recipe/image_types*.bbclass`` in the :term:`Source Directory`. 3977 ``meta/classes-recipe/image_types*.bbclass`` in the :term:`Source Directory`.
@@ -5585,6 +5599,21 @@ system and gives an overview of their function and contents.
5585 5599
5586 NON_MULTILIB_RECIPES = "grub grub-efi make-mod-scripts ovmf u-boot" 5600 NON_MULTILIB_RECIPES = "grub grub-efi make-mod-scripts ovmf u-boot"
5587 5601
5602 :term:`NVDCVE_API_KEY`
5603 The NVD API key used to retrieve data from the CVE database when
5604 using :ref:`ref-classes-cve-check`.
5605
5606 By default, no API key is used, which results in larger delays between API
5607 requests and limits the number of queries to the public rate limits posted
5608 at the `NVD developer's page <https://nvd.nist.gov/developers/start-here>`__.
5609
5610 NVD API keys can be requested through the
5611 `Request an API Key <https://nvd.nist.gov/developers/request-an-api-key>`__
5612 page. You can set this variable to the NVD API key in your ``local.conf`` file.
5613 Example::
5614
5615 NVDCVE_API_KEY = "fe753&7a2-1427-347d-23ff-b2e2b7ca5f3"
5616
5588 :term:`OBJCOPY` 5617 :term:`OBJCOPY`
5589 The minimal command and arguments to run ``objcopy``. 5618 The minimal command and arguments to run ``objcopy``.
5590 5619
@@ -6829,6 +6858,19 @@ system and gives an overview of their function and contents.
6829 explicitly if that will not match the package name (e.g. where the 6858 explicitly if that will not match the package name (e.g. where the
6830 package name has a prefix, underscores, uppercase letters etc.) 6859 package name has a prefix, underscores, uppercase letters etc.)
6831 6860
6861 :term:`PYPI_PACKAGE_EXT`
6862 When inheriting the :ref:`ref-classes-pypi` class, specifies the
6863 file extension to use when fetching a package from `PyPI
6864 <https://pypi.org/>`__. Default is ``tar.gz``.
6865
6866 :term:`PYPI_SRC_URI`
6867 When inheriting the :ref:`ref-classes-pypi` class, specifies the
6868 full `pythonhosted <https://files.pythonhosted.org/>`__ URI for
6869 fetching the package to be built. The default value is constructed
6870 based upon :term:`PYPI_PACKAGE`, :term:`PYPI_PACKAGE_EXT`, and
6871 :term:`PV`. Most recipes will not need to set this variable unless
6872 they are building an unstable (i.e. development) version.
6873
6832 :term:`PYTHON_ABI` 6874 :term:`PYTHON_ABI`
6833 When used by recipes that inherit the :ref:`ref-classes-setuptools3` 6875 When used by recipes that inherit the :ref:`ref-classes-setuptools3`
6834 class, denotes the Application Binary Interface (ABI) currently in use 6876 class, denotes the Application Binary Interface (ABI) currently in use
@@ -7052,6 +7094,13 @@ system and gives an overview of their function and contents.
7052 The default value is ``"${WORKDIR}/recipe-sysroot-native"``. 7094 The default value is ``"${WORKDIR}/recipe-sysroot-native"``.
7053 Do not modify it. 7095 Do not modify it.
7054 7096
7097 :term:`RECIPE_UPDATE_EXTRA_TASKS`
7098 For some recipes, after the new source has been unpacked, additional tasks
7099 may need to be run during an upgrade. A good example of this is recipes
7100 which inherit :ref:`ref-classes-cargo-update-recipe-crates`, where the
7101 `do_update_crates` task needs to be run whenever Cargo.toml/Cargo.lock have
7102 changed in the source.
7103
7055 :term:`REPODIR` 7104 :term:`REPODIR`
7056 See :term:`bitbake:REPODIR` in the BitBake manual. 7105 See :term:`bitbake:REPODIR` in the BitBake manual.
7057 7106
@@ -8536,29 +8585,6 @@ system and gives an overview of their function and contents.
8536 /sysroot-only \ 8585 /sysroot-only \
8537 " 8586 "
8538 8587
8539 :term:`SYSROOT_DIRS_IGNORE`
8540 Directories that are not staged into the sysroot by the
8541 :ref:`ref-tasks-populate_sysroot` task. You
8542 can use this variable to exclude certain subdirectories of
8543 directories listed in :term:`SYSROOT_DIRS` from
8544 staging. By default, the following directories are not staged::
8545
8546 SYSROOT_DIRS_IGNORE = " \
8547 ${mandir} \
8548 ${docdir} \
8549 ${infodir} \
8550 ${datadir}/X11/locale \
8551 ${datadir}/applications \
8552 ${datadir}/bash-completion \
8553 ${datadir}/fonts \
8554 ${datadir}/gtk-doc/html \
8555 ${datadir}/installed-tests \
8556 ${datadir}/locale \
8557 ${datadir}/pixmaps \
8558 ${datadir}/terminfo \
8559 ${libdir}/${BPN}/ptest \
8560 "
8561
8562 Consider the following example in which you need to manipulate this variable. 8588 Consider the following example in which you need to manipulate this variable.
8563 Assume you have a recipe ``A`` that provides a shared library ``.so.*`` that is 8589 Assume you have a recipe ``A`` that provides a shared library ``.so.*`` that is
8564 installed into a custom folder other than "``${libdir}``" 8590 installed into a custom folder other than "``${libdir}``"
@@ -8570,7 +8596,7 @@ system and gives an overview of their function and contents.
8570 is just to show the usefulness of setting :term:`SYSROOT_DIRS`. 8596 is just to show the usefulness of setting :term:`SYSROOT_DIRS`.
8571 8597
8572 When a recipe ``B`` :term:`DEPENDS` on ``A``, it means what is in 8598 When a recipe ``B`` :term:`DEPENDS` on ``A``, it means what is in
8573 :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``B`` 8599 :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``A``
8574 into ``B``'s :term:`SYSROOT_DESTDIR` that is "``${WORKDIR}/sysroot-destdir``". 8600 into ``B``'s :term:`SYSROOT_DESTDIR` that is "``${WORKDIR}/sysroot-destdir``".
8575 8601
8576 Now, since ``/opt/lib`` is not in :term:`SYSROOT_DIRS`, it will never be copied to 8602 Now, since ``/opt/lib`` is not in :term:`SYSROOT_DIRS`, it will never be copied to
@@ -8588,6 +8614,29 @@ system and gives an overview of their function and contents.
8588 8614
8589 TARGET_LDFLAGS:append = " -L${RECIPE_SYSROOT}/opt/lib" 8615 TARGET_LDFLAGS:append = " -L${RECIPE_SYSROOT}/opt/lib"
8590 8616
8617 :term:`SYSROOT_DIRS_IGNORE`
8618 Directories that are not staged into the sysroot by the
8619 :ref:`ref-tasks-populate_sysroot` task. You
8620 can use this variable to exclude certain subdirectories of
8621 directories listed in :term:`SYSROOT_DIRS` from
8622 staging. By default, the following directories are not staged::
8623
8624 SYSROOT_DIRS_IGNORE = " \
8625 ${mandir} \
8626 ${docdir} \
8627 ${infodir} \
8628 ${datadir}/X11/locale \
8629 ${datadir}/applications \
8630 ${datadir}/bash-completion \
8631 ${datadir}/fonts \
8632 ${datadir}/gtk-doc/html \
8633 ${datadir}/installed-tests \
8634 ${datadir}/locale \
8635 ${datadir}/pixmaps \
8636 ${datadir}/terminfo \
8637 ${libdir}/${BPN}/ptest \
8638 "
8639
8591 :term:`SYSROOT_DIRS_NATIVE` 8640 :term:`SYSROOT_DIRS_NATIVE`
8592 Extra directories staged into the sysroot by the 8641 Extra directories staged into the sysroot by the
8593 :ref:`ref-tasks-populate_sysroot` task for 8642 :ref:`ref-tasks-populate_sysroot` task for
@@ -9670,6 +9719,11 @@ system and gives an overview of their function and contents.
9670 :ref:`ref-classes-insane` class and is only enabled if the 9719 :ref:`ref-classes-insane` class and is only enabled if the
9671 recipe inherits the :ref:`ref-classes-autotools` class. 9720 recipe inherits the :ref:`ref-classes-autotools` class.
9672 9721
9722 :term:`UNPACKDIR`
9723 This variable, used by the :ref:`ref-classes-base` class,
9724 specifies where fetches sources should be unpacked by the
9725 :ref:`ref-tasks-unpack` task.
9726
9673 :term:`UPDATERCPN` 9727 :term:`UPDATERCPN`
9674 For recipes inheriting the 9728 For recipes inheriting the
9675 :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN` 9729 :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN`
@@ -9771,6 +9825,12 @@ system and gives an overview of their function and contents.
9771 ``meta-poky/conf/templates/default/local.conf.sample`` in the 9825 ``meta-poky/conf/templates/default/local.conf.sample`` in the
9772 :term:`Source Directory`. 9826 :term:`Source Directory`.
9773 9827
9828 :term:`USERADD_DEPENDS`
9829 Specifies a list of recipes that create users / groups (via
9830 :term:`USERADD_PARAM` / :term:`GROUPADD_PARAM`) which a recipe
9831 depends upon. This ensures that those users / groups are available
9832 when building a recipe.
9833
9774 :term:`USERADD_ERROR_DYNAMIC` 9834 :term:`USERADD_ERROR_DYNAMIC`
9775 If set to ``error``, forces the OpenEmbedded build system to produce 9835 If set to ``error``, forces the OpenEmbedded build system to produce
9776 an error if the user identification (``uid``) and group 9836 an error if the user identification (``uid``) and group