summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-11-22 11:19:58 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-12-01 19:20:29 +0000
commit4d01625794c6517e07fe0b6218c7c3ce004f5951 (patch)
tree7d1cc8da1e784d73b344d231f2a093ab46f61abc
parent55621c31f1edbdb2f3d72e80916fed031e2ba298 (diff)
downloadpoky-4d01625794c6517e07fe0b6218c7c3ce004f5951.tar.gz
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 <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/common-tasks.rst60
-rw-r--r--documentation/migration-guides/migration-1.5.rst4
-rw-r--r--documentation/migration-guides/migration-3.0.rst4
-rw-r--r--documentation/migration-guides/migration-3.3.rst6
-rw-r--r--documentation/ref-manual/classes.rst14
-rw-r--r--documentation/ref-manual/qa-checks.rst20
-rw-r--r--documentation/ref-manual/variables.rst23
-rw-r--r--documentation/sdk-manual/appendix-customizing.rst15
8 files changed, 64 insertions, 82 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 96a6a76180..3ba64e1477 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -1703,26 +1703,21 @@ your software is built:
1703 need to modify the configuration. 1703 need to modify the configuration.
1704 1704
1705 When using Autotools, your recipe needs to inherit the 1705 When using Autotools, your recipe needs to inherit the
1706 :ref:`autotools <ref-classes-autotools>` class 1706 :ref:`autotools <ref-classes-autotools>` class and it does not have to
1707 and your recipe does not have to contain a 1707 contain a :ref:`ref-tasks-configure` task. However, you might still want to
1708 :ref:`ref-tasks-configure` task. 1708 make some adjustments. For example, you can set :term:`EXTRA_OECONF` or
1709 However, you might still want to make some adjustments. For example, 1709 :term:`PACKAGECONFIG_CONFARGS` to pass any needed configure options that
1710 you can set 1710 are specific to the recipe.
1711 :term:`EXTRA_OECONF` or
1712 :term:`PACKAGECONFIG_CONFARGS`
1713 to pass any needed configure options that are specific to the recipe.
1714 1711
1715- *CMake:* If your source files have a ``CMakeLists.txt`` file, then 1712- *CMake:* If your source files have a ``CMakeLists.txt`` file, then
1716 your software is built using CMake. If this is the case, you just 1713 your software is built using CMake. If this is the case, you just
1717 need to modify the configuration. 1714 need to modify the configuration.
1718 1715
1719 When you use CMake, your recipe needs to inherit the 1716 When you use CMake, your recipe needs to inherit the
1720 :ref:`cmake <ref-classes-cmake>` class and your 1717 :ref:`cmake <ref-classes-cmake>` class and it does not have to contain a
1721 recipe does not have to contain a 1718 :ref:`ref-tasks-configure` task. You can make some adjustments by setting
1722 :ref:`ref-tasks-configure` task. 1719 :term:`EXTRA_OECMAKE` to pass any needed configure options that are
1723 You can make some adjustments by setting 1720 specific to the recipe.
1724 :term:`EXTRA_OECMAKE` to
1725 pass any needed configure options that are specific to the recipe.
1726 1721
1727 .. note:: 1722 .. note::
1728 1723
@@ -1997,9 +1992,8 @@ different ways:
1997 shutdown of all other programs. 1992 shutdown of all other programs.
1998 1993
1999 To enable a service using SysVinit, your recipe needs to inherit the 1994 To enable a service using SysVinit, your recipe needs to inherit the
2000 :ref:`update-rc.d <ref-classes-update-rc.d>` 1995 :ref:`update-rc.d <ref-classes-update-rc.d>` class. The class helps
2001 class. The class helps facilitate safely installing the package on 1996 facilitate safely installing the package on the target.
2002 the target.
2003 1997
2004 You will need to set the 1998 You will need to set the
2005 :term:`INITSCRIPT_PACKAGES`, 1999 :term:`INITSCRIPT_PACKAGES`,
@@ -2014,10 +2008,8 @@ different ways:
2014 https://freedesktop.org/wiki/Software/systemd/. 2008 https://freedesktop.org/wiki/Software/systemd/.
2015 2009
2016 To enable a service using systemd, your recipe needs to inherit the 2010 To enable a service using systemd, your recipe needs to inherit the
2017 :ref:`systemd <ref-classes-systemd>` class. See 2011 :ref:`systemd <ref-classes-systemd>` class. See the ``systemd.bbclass`` file
2018 the ``systemd.bbclass`` file located in your :term:`Source Directory` 2012 located in your :term:`Source Directory` section for more information.
2019 section for
2020 more information.
2021 2013
2022Packaging 2014Packaging
2023--------- 2015---------
@@ -2370,8 +2362,7 @@ Autotooled Package
2370 2362
2371Applications that use Autotools such as ``autoconf`` and ``automake`` 2363Applications that use Autotools such as ``autoconf`` and ``automake``
2372require a recipe that has a source archive listed in :term:`SRC_URI` and 2364require a recipe that has a source archive listed in :term:`SRC_URI` and
2373also inherit the 2365also inherit the :ref:`autotools <ref-classes-autotools>` class,
2374:ref:`autotools <ref-classes-autotools>` class,
2375which contains the definitions of all the steps needed to build an 2366which contains the definitions of all the steps needed to build an
2376Autotool-based application. The result of the build is automatically 2367Autotool-based application. The result of the build is automatically
2377packaged. And, if the application uses NLS for localization, packages 2368packaged. And, if the application uses NLS for localization, packages
@@ -4404,13 +4395,10 @@ where the development occurs. You want the recipe's
4404:term:`SRC_URI` variable to point to 4395:term:`SRC_URI` variable to point to
4405the external directory and use it as is, not copy it. 4396the external directory and use it as is, not copy it.
4406 4397
4407To build from software that comes from an external source, all you need 4398To build from software that comes from an external source, all you need to do
4408to do is inherit the 4399is inherit the :ref:`externalsrc <ref-classes-externalsrc>` class and then set
4409:ref:`externalsrc <ref-classes-externalsrc>` class 4400the :term:`EXTERNALSRC` variable to point to your external source code. Here
4410and then set the 4401are the statements to put in your ``local.conf`` file::
4411:term:`EXTERNALSRC` variable to
4412point to your external source code. Here are the statements to put in
4413your ``local.conf`` file::
4414 4402
4415 INHERIT += "externalsrc" 4403 INHERIT += "externalsrc"
4416 EXTERNALSRC:pn-myrecipe = "path-to-your-source-tree" 4404 EXTERNALSRC:pn-myrecipe = "path-to-your-source-tree"
@@ -4494,8 +4482,7 @@ directory:
44941. *Using Local Files Only:* Inside your ``local.conf`` file, add the 44821. *Using Local Files Only:* Inside your ``local.conf`` file, add the
4495 :term:`SOURCE_MIRROR_URL` variable, inherit the 4483 :term:`SOURCE_MIRROR_URL` variable, inherit the
4496 :ref:`own-mirrors <ref-classes-own-mirrors>` class, and use the 4484 :ref:`own-mirrors <ref-classes-own-mirrors>` class, and use the
4497 :term:`BB_NO_NETWORK` variable to your ``local.conf``. 4485 :term:`BB_NO_NETWORK` variable to your ``local.conf``::
4498 ::
4499 4486
4500 SOURCE_MIRROR_URL ?= "file:///home/your-download-dir/" 4487 SOURCE_MIRROR_URL ?= "file:///home/your-download-dir/"
4501 INHERIT += "own-mirrors" 4488 INHERIT += "own-mirrors"
@@ -7441,8 +7428,7 @@ In order to enable a recipe to run installed ptests on target hardware,
7441you need to prepare the recipes that build the packages you want to 7428you need to prepare the recipes that build the packages you want to
7442test. Here is what you have to do for each recipe: 7429test. Here is what you have to do for each recipe:
7443 7430
7444- *Be sure the recipe inherits 7431- *Be sure the recipe inherits the* :ref:`ptest <ref-classes-ptest>` *class:*
7445 the* :ref:`ptest <ref-classes-ptest>` *class:*
7446 Include the following line in each recipe:: 7432 Include the following line in each recipe::
7447 7433
7448 inherit ptest 7434 inherit ptest
@@ -8868,8 +8854,7 @@ You can start the tests automatically or manually:
8868 bitbake core-image-sato 8854 bitbake core-image-sato
8869 8855
8870- *Manually running tests:* To manually run the tests, first globally 8856- *Manually running tests:* To manually run the tests, first globally
8871 inherit the 8857 inherit the :ref:`testimage <ref-classes-testimage>` class
8872 :ref:`testimage <ref-classes-testimage>` class
8873 by editing your ``local.conf`` file:: 8858 by editing your ``local.conf`` file::
8874 8859
8875 INHERIT += "testimage" 8860 INHERIT += "testimage"
@@ -9287,8 +9272,7 @@ In addition to variable values, the output of the ``bitbake -e`` and
9287 classes included globally, recursively listing the files they include 9272 classes included globally, recursively listing the files they include
9288 or inherit in turn. Much of the behavior of the OpenEmbedded build 9273 or inherit in turn. Much of the behavior of the OpenEmbedded build
9289 system (including the behavior of the :ref:`ref-manual/tasks:normal recipe build tasks`) is 9274 system (including the behavior of the :ref:`ref-manual/tasks:normal recipe build tasks`) is
9290 implemented in the 9275 implemented in the :ref:`base <ref-classes-base>` class and the
9291 :ref:`base <ref-classes-base>` class and the
9292 classes it inherits, rather than being built into BitBake itself. 9276 classes it inherits, rather than being built into BitBake itself.
9293 9277
9294- After the variable values, all functions appear in the output. For 9278- After the variable values, all functions appear in the output. For
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst
index b47980dc67..ad7e239eaf 100644
--- a/documentation/migration-guides/migration-1.5.rst
+++ b/documentation/migration-guides/migration-1.5.rst
@@ -221,8 +221,8 @@ Task Recipes
221 221
222The previously deprecated ``task.bbclass`` has now been dropped. For 222The previously deprecated ``task.bbclass`` has now been dropped. For
223recipes that previously inherited from this class, you should rename 223recipes that previously inherited from this class, you should rename
224them from ``task-*`` to ``packagegroup-*`` and inherit packagegroup 224them from ``task-*`` to ``packagegroup-*`` and inherit
225instead. 225:ref:`packagegroup <ref-classes-packagegroup>` instead.
226 226
227For more information, see the ":ref:`ref-classes-packagegroup`" section. 227For more information, see the ":ref:`ref-classes-packagegroup`" section.
228 228
diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst
index 95a33d4dd4..107d2b8797 100644
--- a/documentation/migration-guides/migration-3.0.rst
+++ b/documentation/migration-guides/migration-3.0.rst
@@ -259,7 +259,9 @@ The following miscellaneous changes have occurred.
259 259
260- The ``gnome`` class has been removed because it now does very little. 260- The ``gnome`` class has been removed because it now does very little.
261 You should update recipes that previously inherited this class to do 261 You should update recipes that previously inherited this class to do
262 the following: inherit gnomebase gtk-icon-cache gconf mime 262 the following::
263
264 inherit gnomebase gtk-icon-cache gconf mime
263 265
264- The ``meta/recipes-kernel/linux/linux-dtb.inc`` file has been 266- The ``meta/recipes-kernel/linux/linux-dtb.inc`` file has been
265 removed. This file was previously deprecated in favor of setting 267 removed. This file was previously deprecated in favor of setting
diff --git a/documentation/migration-guides/migration-3.3.rst b/documentation/migration-guides/migration-3.3.rst
index d110aacd81..e8e5935e19 100644
--- a/documentation/migration-guides/migration-3.3.rst
+++ b/documentation/migration-guides/migration-3.3.rst
@@ -99,9 +99,9 @@ variable so that recipes can specify it explicitly, for example::
99 99
100Recipes that inherit from ``distutils3`` (or 100Recipes that inherit from ``distutils3`` (or
101:ref:`setuptools3 <ref-classes-setuptools3>` which itself inherits 101:ref:`setuptools3 <ref-classes-setuptools3>` which itself inherits
102``distutils3``) that also set :term:`S` to 102``distutils3``) that also set :term:`S` to point to a Python module within a
103point to a Python module within a subdirectory in the aforementioned 103subdirectory in the aforementioned manner should be changed to set
104manner should be changed to set ``DISTUTILS_SETUP_PATH`` instead. 104``DISTUTILS_SETUP_PATH`` instead.
105 105
106 106
107.. _migration-3.3-bitbake: 107.. _migration-3.3-bitbake:
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.
210An alternative version of the :ref:`binconfig <ref-classes-binconfig>` 210An alternative version of the :ref:`binconfig <ref-classes-binconfig>`
211class, which disables binary configuration scripts by making them return 211class, which disables binary configuration scripts by making them return
212an error in favor of using ``pkg-config`` to query the information. The 212an error in favor of using ``pkg-config`` to query the information. The
213scripts to be disabled should be specified using the 213scripts to be disabled should be specified using the :term:`BINCONFIG`
214:term:`BINCONFIG` variable within the recipe inheriting 214variable within the recipe inheriting the class.
215the 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`
580and :term:`B` variables to locate unpacked recipe source code 579and :term:`B` variables to locate unpacked recipe source code
581and to build it, respectively. When your recipe inherits the 580and 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
585ultimately define :term:`S` and :term:`B`. 583ultimately define :term:`S` and :term:`B`.
586 584
587By default, this class expects the source code to support recipe builds 585By 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
737The :ref:`gettext <ref-classes-gettext>` class provides support for building software that uses 735The :ref:`gettext <ref-classes-gettext>` class provides support for building
738the GNU ``gettext`` internationalization and localization system. All 736software that uses the GNU ``gettext`` internationalization and localization
739recipes building software that use ``gettext`` should inherit this 737system. All recipes building software that use ``gettext`` should inherit this
740class. 738class.
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
diff --git a/documentation/sdk-manual/appendix-customizing.rst b/documentation/sdk-manual/appendix-customizing.rst
index 66218fccd6..dfd51bda1c 100644
--- a/documentation/sdk-manual/appendix-customizing.rst
+++ b/documentation/sdk-manual/appendix-customizing.rst
@@ -44,14 +44,13 @@ build system applies them against ``local.conf`` and ``auto.conf``:
44 :term:`ESDK_LOCALCONF_ALLOW` overrides either of the previous two 44 :term:`ESDK_LOCALCONF_ALLOW` overrides either of the previous two
45 filters. The default value is blank. 45 filters. The default value is blank.
46 46
47- Classes inherited globally with 47- Classes inherited globally with :term:`INHERIT` that are listed in
48 :term:`INHERIT` that are listed in 48 :term:`ESDK_CLASS_INHERIT_DISABLE` are disabled. Using
49 :term:`ESDK_CLASS_INHERIT_DISABLE` 49 :term:`ESDK_CLASS_INHERIT_DISABLE` to disable these classes is the typical
50 are disabled. Using :term:`ESDK_CLASS_INHERIT_DISABLE` to disable these 50 method to disable classes that are problematic or unnecessary in the SDK
51 classes is the typical method to disable classes that are problematic 51 context. The default value disables the
52 or unnecessary in the SDK context. The default value disables the 52 :ref:`buildhistory <ref-classes-buildhistory>` and
53 :ref:`buildhistory <ref-classes-buildhistory>` 53 :ref:`icecc <ref-classes-icecc>` classes.
54 and :ref:`icecc <ref-classes-icecc>` classes.
55 54
56Additionally, the contents of ``conf/sdk-extra.conf``, when present, are 55Additionally, the contents of ``conf/sdk-extra.conf``, when present, are
57appended to the end of ``conf/local.conf`` within the produced SDK, 56appended to the end of ``conf/local.conf`` within the produced SDK,