From 4d01625794c6517e07fe0b6218c7c3ce004f5951 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Tue, 22 Nov 2022 11:19:58 +0100 Subject: manuals: fix paragraphs with the "inherit" word Nothing wrong with this word, but instances of "inherit" were looked for while looking for class names without references. Fixing alignment and sometimes syntax. (From yocto-docs rev: c418c645a360e74ebb91765a3041336f03097e0d) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/ref-manual/classes.rst | 14 ++++++-------- documentation/ref-manual/qa-checks.rst | 20 +++++++++++--------- documentation/ref-manual/variables.rst | 23 ++++++++++------------- 3 files changed, 27 insertions(+), 30 deletions(-) (limited to 'documentation/ref-manual') 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. An alternative version of the :ref:`binconfig ` class, which disables binary configuration scripts by making them return an error in favor of using ``pkg-config`` to query the information. The -scripts to be disabled should be specified using the -:term:`BINCONFIG` variable within the recipe inheriting -the class. +scripts to be disabled should be specified using the :term:`BINCONFIG` +variable within the recipe inheriting the class. .. _ref-classes-buildhistory: @@ -580,8 +579,7 @@ By default, the OpenEmbedded build system uses the :term:`S` and :term:`B` variables to locate unpacked recipe source code and to build it, respectively. When your recipe inherits the :ref:`externalsrc ` class, you use the -:term:`EXTERNALSRC` and -:term:`EXTERNALSRC_BUILD` variables to +:term:`EXTERNALSRC` and :term:`EXTERNALSRC_BUILD` variables to ultimately define :term:`S` and :term:`B`. 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. ``gettext.bbclass`` =================== -The :ref:`gettext ` class provides support for building software that uses -the GNU ``gettext`` internationalization and localization system. All -recipes building software that use ``gettext`` should inherit this +The :ref:`gettext ` class provides support for building +software that uses the GNU ``gettext`` internationalization and localization +system. All recipes building software that use ``gettext`` should inherit this class. .. _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 - ``package contains mime types but does not inherit mime: path '' [mime]`` The specified package contains mime type files (``.xml`` files in - ``${datadir}/mime/packages``) and yet does not inherit the mime - class which will ensure that these get properly installed. Either - add ``inherit mime`` to the recipe or remove the files at the - :ref:`ref-tasks-install` step if they are not needed. + ``${datadir}/mime/packages``) and yet does not inherit the + :ref:`mime ` class which will ensure that these get + properly installed. Either add ``inherit mime`` to the recipe or remove the + files at the :ref:`ref-tasks-install` step if they are not needed. .. _qa-check-mime-xdg: @@ -620,11 +620,13 @@ Errors and Warnings - ``: recipe doesn't inherit features_check [unhandled-features-check]`` - This check ensures that if one of the variables that the :ref:`features_check ` - class supports (e.g. :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe - inherits ``features_check`` in order for the requirement to actually work. If - you are seeing this message, either add ``inherit features_check`` to your recipe - or remove the reference to the variable if it is not needed. + This check ensures that if one of the variables that the + :ref:`features_check ` class supports (e.g. + :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe + inherits :ref:`features_check ` in order for + the requirement to actually work. If you are seeing this message, either + add ``inherit features_check`` to your recipe or remove the reference to + the variable if it is not needed. .. _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. ":ref:`ref-classes-update-alternatives`" section. :term:`ANY_OF_DISTRO_FEATURES` - When inheriting the - :ref:`features_check ` + When inheriting the :ref:`features_check ` class, this variable identifies a list of distribution features where at least one must be enabled in the current configuration in order 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. If you use the previous statement to retrieve the latest version of software, you need to be sure :term:`PV` contains - ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you - have a kernel recipe that inherits the - :ref:`kernel ` class and you use the previous - statement. In this example, ``${SRCPV}`` does not automatically get - into :term:`PV`. Consequently, you need to change :term:`PV` in your recipe - so that it does contain ``${SRCPV}``. + ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you have a kernel + recipe that inherits the :ref:`kernel ` class and you + use the previous statement. In this example, ``${SRCPV}`` does not + automatically get into :term:`PV`. Consequently, you need to change + :term:`PV` in your recipe so that it does contain ``${SRCPV}``. For more information see the ":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. IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete" - Recipes inheriting the ``image`` class should copy files to be - deployed into :term:`IMGDEPLOYDIR`, and the class will take care of - copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. + Recipes inheriting the :ref:`image ` class should copy + files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take + care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. :term:`INC_PR` 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. section. :term:`REQUIRED_DISTRO_FEATURES` - When inheriting the - :ref:`features_check ` + When inheriting the :ref:`features_check ` class, this variable identifies distribution features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe. In other words, if the -- cgit v1.2.3-54-g00ecf