diff options
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/classes.rst | 14 | ||||
| -rw-r--r-- | documentation/ref-manual/qa-checks.rst | 20 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 23 |
3 files changed, 27 insertions, 30 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 3a13cf56ef..3aab8290a0 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
| @@ -210,9 +210,8 @@ information. | |||
| 210 | An alternative version of the :ref:`binconfig <ref-classes-binconfig>` | 210 | An alternative version of the :ref:`binconfig <ref-classes-binconfig>` |
| 211 | class, which disables binary configuration scripts by making them return | 211 | class, which disables binary configuration scripts by making them return |
| 212 | an error in favor of using ``pkg-config`` to query the information. The | 212 | an error in favor of using ``pkg-config`` to query the information. The |
| 213 | scripts to be disabled should be specified using the | 213 | scripts to be disabled should be specified using the :term:`BINCONFIG` |
| 214 | :term:`BINCONFIG` variable within the recipe inheriting | 214 | variable within the recipe inheriting the class. |
| 215 | the class. | ||
| 216 | 215 | ||
| 217 | .. _ref-classes-buildhistory: | 216 | .. _ref-classes-buildhistory: |
| 218 | 217 | ||
| @@ -580,8 +579,7 @@ By default, the OpenEmbedded build system uses the :term:`S` | |||
| 580 | and :term:`B` variables to locate unpacked recipe source code | 579 | and :term:`B` variables to locate unpacked recipe source code |
| 581 | and to build it, respectively. When your recipe inherits the | 580 | and to build it, respectively. When your recipe inherits the |
| 582 | :ref:`externalsrc <ref-classes-externalsrc>` class, you use the | 581 | :ref:`externalsrc <ref-classes-externalsrc>` class, you use the |
| 583 | :term:`EXTERNALSRC` and | 582 | :term:`EXTERNALSRC` and :term:`EXTERNALSRC_BUILD` variables to |
| 584 | :term:`EXTERNALSRC_BUILD` variables to | ||
| 585 | ultimately define :term:`S` and :term:`B`. | 583 | ultimately define :term:`S` and :term:`B`. |
| 586 | 584 | ||
| 587 | By default, this class expects the source code to support recipe builds | 585 | By default, this class expects the source code to support recipe builds |
| @@ -734,9 +732,9 @@ register and unregister the schemas in the target image. | |||
| 734 | ``gettext.bbclass`` | 732 | ``gettext.bbclass`` |
| 735 | =================== | 733 | =================== |
| 736 | 734 | ||
| 737 | The :ref:`gettext <ref-classes-gettext>` class provides support for building software that uses | 735 | The :ref:`gettext <ref-classes-gettext>` class provides support for building |
| 738 | the GNU ``gettext`` internationalization and localization system. All | 736 | software that uses the GNU ``gettext`` internationalization and localization |
| 739 | recipes building software that use ``gettext`` should inherit this | 737 | system. All recipes building software that use ``gettext`` should inherit this |
| 740 | class. | 738 | class. |
| 741 | 739 | ||
| 742 | .. _ref-classes-github-releases: | 740 | .. _ref-classes-github-releases: |
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst index 3947dcfc17..1a768aac93 100644 --- a/documentation/ref-manual/qa-checks.rst +++ b/documentation/ref-manual/qa-checks.rst | |||
| @@ -579,10 +579,10 @@ Errors and Warnings | |||
| 579 | - ``package contains mime types but does not inherit mime: <packagename> path '<file>' [mime]`` | 579 | - ``package contains mime types but does not inherit mime: <packagename> path '<file>' [mime]`` |
| 580 | 580 | ||
| 581 | The specified package contains mime type files (``.xml`` files in | 581 | The specified package contains mime type files (``.xml`` files in |
| 582 | ``${datadir}/mime/packages``) and yet does not inherit the mime | 582 | ``${datadir}/mime/packages``) and yet does not inherit the |
| 583 | class which will ensure that these get properly installed. Either | 583 | :ref:`mime <ref-classes-mime>` class which will ensure that these get |
| 584 | add ``inherit mime`` to the recipe or remove the files at the | 584 | properly installed. Either add ``inherit mime`` to the recipe or remove the |
| 585 | :ref:`ref-tasks-install` step if they are not needed. | 585 | files at the :ref:`ref-tasks-install` step if they are not needed. |
| 586 | 586 | ||
| 587 | 587 | ||
| 588 | .. _qa-check-mime-xdg: | 588 | .. _qa-check-mime-xdg: |
| @@ -620,11 +620,13 @@ Errors and Warnings | |||
| 620 | 620 | ||
| 621 | - ``<recipename>: recipe doesn't inherit features_check [unhandled-features-check]`` | 621 | - ``<recipename>: recipe doesn't inherit features_check [unhandled-features-check]`` |
| 622 | 622 | ||
| 623 | This check ensures that if one of the variables that the :ref:`features_check <ref-classes-features_check>` | 623 | This check ensures that if one of the variables that the |
| 624 | class supports (e.g. :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe | 624 | :ref:`features_check <ref-classes-features_check>` class supports (e.g. |
| 625 | inherits ``features_check`` in order for the requirement to actually work. If | 625 | :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe |
| 626 | you are seeing this message, either add ``inherit features_check`` to your recipe | 626 | inherits :ref:`features_check <ref-classes-features_check>` in order for |
| 627 | or remove the reference to the variable if it is not needed. | 627 | the requirement to actually work. If you are seeing this message, either |
| 628 | add ``inherit features_check`` to your recipe or remove the reference to | ||
| 629 | the variable if it is not needed. | ||
| 628 | 630 | ||
| 629 | 631 | ||
| 630 | .. _qa-check-missing-update-alternatives: | 632 | .. _qa-check-missing-update-alternatives: |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index ca62365cc3..8b54420d95 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -126,8 +126,7 @@ system and gives an overview of their function and contents. | |||
| 126 | ":ref:`ref-classes-update-alternatives`" section. | 126 | ":ref:`ref-classes-update-alternatives`" section. |
| 127 | 127 | ||
| 128 | :term:`ANY_OF_DISTRO_FEATURES` | 128 | :term:`ANY_OF_DISTRO_FEATURES` |
| 129 | When inheriting the | 129 | When inheriting the :ref:`features_check <ref-classes-features_check>` |
| 130 | :ref:`features_check <ref-classes-features_check>` | ||
| 131 | class, this variable identifies a list of distribution features where | 130 | class, this variable identifies a list of distribution features where |
| 132 | at least one must be enabled in the current configuration in order | 131 | at least one must be enabled in the current configuration in order |
| 133 | for the OpenEmbedded build system to build the recipe. In other words, | 132 | for the OpenEmbedded build system to build the recipe. In other words, |
| @@ -215,12 +214,11 @@ system and gives an overview of their function and contents. | |||
| 215 | 214 | ||
| 216 | If you use the previous statement to retrieve the latest version of | 215 | If you use the previous statement to retrieve the latest version of |
| 217 | software, you need to be sure :term:`PV` contains | 216 | software, you need to be sure :term:`PV` contains |
| 218 | ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you | 217 | ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you have a kernel |
| 219 | have a kernel recipe that inherits the | 218 | recipe that inherits the :ref:`kernel <ref-classes-kernel>` class and you |
| 220 | :ref:`kernel <ref-classes-kernel>` class and you use the previous | 219 | use the previous statement. In this example, ``${SRCPV}`` does not |
| 221 | statement. In this example, ``${SRCPV}`` does not automatically get | 220 | automatically get into :term:`PV`. Consequently, you need to change |
| 222 | into :term:`PV`. Consequently, you need to change :term:`PV` in your recipe | 221 | :term:`PV` in your recipe so that it does contain ``${SRCPV}``. |
| 223 | so that it does contain ``${SRCPV}``. | ||
| 224 | 222 | ||
| 225 | For more information see the | 223 | For more information see the |
| 226 | ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" | 224 | ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" |
| @@ -3566,9 +3564,9 @@ system and gives an overview of their function and contents. | |||
| 3566 | 3564 | ||
| 3567 | IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete" | 3565 | IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete" |
| 3568 | 3566 | ||
| 3569 | Recipes inheriting the ``image`` class should copy files to be | 3567 | Recipes inheriting the :ref:`image <ref-classes-image>` class should copy |
| 3570 | deployed into :term:`IMGDEPLOYDIR`, and the class will take care of | 3568 | files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take |
| 3571 | copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. | 3569 | care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. |
| 3572 | 3570 | ||
| 3573 | :term:`INC_PR` | 3571 | :term:`INC_PR` |
| 3574 | Helps define the recipe revision for recipes that share a common | 3572 | Helps define the recipe revision for recipes that share a common |
| @@ -6542,8 +6540,7 @@ system and gives an overview of their function and contents. | |||
| 6542 | section. | 6540 | section. |
| 6543 | 6541 | ||
| 6544 | :term:`REQUIRED_DISTRO_FEATURES` | 6542 | :term:`REQUIRED_DISTRO_FEATURES` |
| 6545 | When inheriting the | 6543 | When inheriting the :ref:`features_check <ref-classes-features_check>` |
| 6546 | :ref:`features_check <ref-classes-features_check>` | ||
| 6547 | class, this variable identifies distribution features that must exist | 6544 | class, this variable identifies distribution features that must exist |
| 6548 | in the current configuration in order for the OpenEmbedded build | 6545 | in the current configuration in order for the OpenEmbedded build |
| 6549 | system to build the recipe. In other words, if the | 6546 | system to build the recipe. In other words, if the |
