diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/ref-manual/variables.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 33da2286b3..cd55bf13b1 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -7960,6 +7960,23 @@ system and gives an overview of their function and contents. | |||
| 7960 | the recipe will be skipped, and if the build system attempts to build | 7960 | the recipe will be skipped, and if the build system attempts to build |
| 7961 | the recipe then an error will be triggered. | 7961 | the recipe then an error will be triggered. |
| 7962 | 7962 | ||
| 7963 | :term:`REQUIRED_IMAGE_FEATURES` | ||
| 7964 | When inheriting the :ref:`ref-classes-features_check` class, this variable | ||
| 7965 | identifies image features that must exist in the current | ||
| 7966 | configuration in order for the :term:`OpenEmbedded Build System` to build | ||
| 7967 | the recipe. In other words, if the :term:`REQUIRED_IMAGE_FEATURES` variable | ||
| 7968 | lists a feature that does not appear in :term:`IMAGE_FEATURES` within the | ||
| 7969 | current configuration, then the recipe will be skipped, and if the build | ||
| 7970 | system attempts to build the recipe then an error will be triggered. | ||
| 7971 | |||
| 7972 | Compared to other ``REQUIRED_*_FEATURES`` variables, the | ||
| 7973 | :term:`REQUIRED_IMAGE_FEATURES` varible only targets image recipes, as the | ||
| 7974 | :term:`IMAGE_FEATURES` variable is handled by the :ref:`ref-classes-core-image` | ||
| 7975 | class). However, the :term:`REQUIRED_IMAGE_FEATURES` varible can also be | ||
| 7976 | set from a :term:`Configuration File`, such as a distro | ||
| 7977 | configuration file, if the list of required image features should apply to | ||
| 7978 | all images using this :term:`DISTRO`. | ||
| 7979 | |||
| 7963 | :term:`REQUIRED_MACHINE_FEATURES` | 7980 | :term:`REQUIRED_MACHINE_FEATURES` |
| 7964 | When inheriting the :ref:`ref-classes-features_check` class, this variable | 7981 | When inheriting the :ref:`ref-classes-features_check` class, this variable |
| 7965 | identifies :term:`MACHINE_FEATURES` that must exist in the current | 7982 | identifies :term:`MACHINE_FEATURES` that must exist in the current |
