diff options
| -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 3503ca038e..261d11dd76 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -7463,6 +7463,23 @@ system and gives an overview of their function and contents. | |||
| 7463 | the recipe will be skipped, and if the build system attempts to build | 7463 | the recipe will be skipped, and if the build system attempts to build |
| 7464 | the recipe then an error will be triggered. | 7464 | the recipe then an error will be triggered. |
| 7465 | 7465 | ||
| 7466 | :term:`REQUIRED_IMAGE_FEATURES` | ||
| 7467 | When inheriting the :ref:`ref-classes-features_check` class, this variable | ||
| 7468 | identifies image features that must exist in the current | ||
| 7469 | configuration in order for the :term:`OpenEmbedded Build System` to build | ||
| 7470 | the recipe. In other words, if the :term:`REQUIRED_IMAGE_FEATURES` variable | ||
| 7471 | lists a feature that does not appear in :term:`IMAGE_FEATURES` within the | ||
| 7472 | current configuration, then the recipe will be skipped, and if the build | ||
| 7473 | system attempts to build the recipe then an error will be triggered. | ||
| 7474 | |||
| 7475 | Compared to other ``REQUIRED_*_FEATURES`` variables, the | ||
| 7476 | :term:`REQUIRED_IMAGE_FEATURES` varible only targets image recipes, as the | ||
| 7477 | :term:`IMAGE_FEATURES` variable is handled by the :ref:`ref-classes-core-image` | ||
| 7478 | class). However, the :term:`REQUIRED_IMAGE_FEATURES` varible can also be | ||
| 7479 | set from a :term:`Configuration File`, such as a distro | ||
| 7480 | configuration file, if the list of required image features should apply to | ||
| 7481 | all images using this :term:`DISTRO`. | ||
| 7482 | |||
| 7466 | :term:`REQUIRED_MACHINE_FEATURES` | 7483 | :term:`REQUIRED_MACHINE_FEATURES` |
| 7467 | When inheriting the :ref:`ref-classes-features_check` class, this variable | 7484 | When inheriting the :ref:`ref-classes-features_check` class, this variable |
| 7468 | identifies :term:`MACHINE_FEATURES` that must exist in the current | 7485 | identifies :term:`MACHINE_FEATURES` that must exist in the current |
