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.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 9cdcc1b61b..07b5b6f95c 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5585,6 +5585,21 @@ system and gives an overview of their function and contents.
5585 5585
5586 NON_MULTILIB_RECIPES = "grub grub-efi make-mod-scripts ovmf u-boot" 5586 NON_MULTILIB_RECIPES = "grub grub-efi make-mod-scripts ovmf u-boot"
5587 5587
5588 :term:`NVDCVE_API_KEY`
5589 The NVD API key used to retrieve data from the CVE database when
5590 using :ref:`ref-classes-cve-check`.
5591
5592 By default, no API key is used, which results in larger delays between API
5593 requests and limits the number of queries to the public rate limits posted
5594 at the `NVD developer's page <https://nvd.nist.gov/developers/start-here>`__.
5595
5596 NVD API keys can be requested through the
5597 `Request an API Key <https://nvd.nist.gov/developers/request-an-api-key>`__
5598 page. You can set this variable to the NVD API key in your ``local.conf`` file.
5599 Example::
5600
5601 NVDCVE_API_KEY = "fe753&7a2-1427-347d-23ff-b2e2b7ca5f3"
5602
5588 :term:`OBJCOPY` 5603 :term:`OBJCOPY`
5589 The minimal command and arguments to run ``objcopy``. 5604 The minimal command and arguments to run ``objcopy``.
5590 5605
@@ -6829,6 +6844,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 6844 explicitly if that will not match the package name (e.g. where the
6830 package name has a prefix, underscores, uppercase letters etc.) 6845 package name has a prefix, underscores, uppercase letters etc.)
6831 6846
6847 :term:`PYPI_PACKAGE_EXT`
6848 When inheriting the :ref:`ref-classes-pypi` class, specifies the
6849 file extension to use when fetching a package from `PyPI
6850 <https://pypi.org/>`__. Default is ``tar.gz``.
6851
6852 :term:`PYPI_SRC_URI`
6853 When inheriting the :ref:`ref-classes-pypi` class, specifies the
6854 full `pythonhosted <https://files.pythonhosted.org/>`__ URI for
6855 fetching the package to be built. The default value is constructed
6856 based upon :term:`PYPI_PACKAGE`, :term:`PYPI_PACKAGE_EXT`, and
6857 :term:`PV`. Most recipes will not need to set this variable unless
6858 they are building an unstable (i.e. development) version.
6859
6832 :term:`PYTHON_ABI` 6860 :term:`PYTHON_ABI`
6833 When used by recipes that inherit the :ref:`ref-classes-setuptools3` 6861 When used by recipes that inherit the :ref:`ref-classes-setuptools3`
6834 class, denotes the Application Binary Interface (ABI) currently in use 6862 class, denotes the Application Binary Interface (ABI) currently in use
@@ -9670,6 +9698,11 @@ system and gives an overview of their function and contents.
9670 :ref:`ref-classes-insane` class and is only enabled if the 9698 :ref:`ref-classes-insane` class and is only enabled if the
9671 recipe inherits the :ref:`ref-classes-autotools` class. 9699 recipe inherits the :ref:`ref-classes-autotools` class.
9672 9700
9701 :term:`UNPACKDIR`
9702 This variable, used by the :ref:`ref-classes-base` class,
9703 specifies where fetches sources should be unpacked by the
9704 :ref:`ref-tasks-unpack` task.
9705
9673 :term:`UPDATERCPN` 9706 :term:`UPDATERCPN`
9674 For recipes inheriting the 9707 For recipes inheriting the
9675 :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN` 9708 :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN`
@@ -9771,6 +9804,12 @@ system and gives an overview of their function and contents.
9771 ``meta-poky/conf/templates/default/local.conf.sample`` in the 9804 ``meta-poky/conf/templates/default/local.conf.sample`` in the
9772 :term:`Source Directory`. 9805 :term:`Source Directory`.
9773 9806
9807 :term:`USERADD_DEPENDS`
9808 Specifies a list of recipes that create users / groups (via
9809 :term:`USERADD_PARAM` / :term:`GROUPADD_PARAM`) which a recipe
9810 depends upon. This ensures that those users / groups are available
9811 when building a recipe.
9812
9774 :term:`USERADD_ERROR_DYNAMIC` 9813 :term:`USERADD_ERROR_DYNAMIC`
9775 If set to ``error``, forces the OpenEmbedded build system to produce 9814 If set to ``error``, forces the OpenEmbedded build system to produce
9776 an error if the user identification (``uid``) and group 9815 an error if the user identification (``uid``) and group