diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-11-22 11:19:58 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-01 19:20:29 +0000 |
commit | 4d01625794c6517e07fe0b6218c7c3ce004f5951 (patch) | |
tree | 7d1cc8da1e784d73b344d231f2a093ab46f61abc /documentation/dev-manual | |
parent | 55621c31f1edbdb2f3d72e80916fed031e2ba298 (diff) | |
download | poky-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>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 60 |
1 files changed, 22 insertions, 38 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 | ||
2022 | Packaging | 2014 | Packaging |
2023 | --------- | 2015 | --------- |
@@ -2370,8 +2362,7 @@ Autotooled Package | |||
2370 | 2362 | ||
2371 | Applications that use Autotools such as ``autoconf`` and ``automake`` | 2363 | Applications that use Autotools such as ``autoconf`` and ``automake`` |
2372 | require a recipe that has a source archive listed in :term:`SRC_URI` and | 2364 | require a recipe that has a source archive listed in :term:`SRC_URI` and |
2373 | also inherit the | 2365 | also inherit the :ref:`autotools <ref-classes-autotools>` class, |
2374 | :ref:`autotools <ref-classes-autotools>` class, | ||
2375 | which contains the definitions of all the steps needed to build an | 2366 | which contains the definitions of all the steps needed to build an |
2376 | Autotool-based application. The result of the build is automatically | 2367 | Autotool-based application. The result of the build is automatically |
2377 | packaged. And, if the application uses NLS for localization, packages | 2368 | packaged. 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 |
4405 | the external directory and use it as is, not copy it. | 4396 | the external directory and use it as is, not copy it. |
4406 | 4397 | ||
4407 | To build from software that comes from an external source, all you need | 4398 | To build from software that comes from an external source, all you need to do |
4408 | to do is inherit the | 4399 | is inherit the :ref:`externalsrc <ref-classes-externalsrc>` class and then set |
4409 | :ref:`externalsrc <ref-classes-externalsrc>` class | 4400 | the :term:`EXTERNALSRC` variable to point to your external source code. Here |
4410 | and then set the | 4401 | are the statements to put in your ``local.conf`` file:: |
4411 | :term:`EXTERNALSRC` variable to | ||
4412 | point to your external source code. Here are the statements to put in | ||
4413 | your ``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: | |||
4494 | 1. *Using Local Files Only:* Inside your ``local.conf`` file, add the | 4482 | 1. *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, | |||
7441 | you need to prepare the recipes that build the packages you want to | 7428 | you need to prepare the recipes that build the packages you want to |
7442 | test. Here is what you have to do for each recipe: | 7429 | test. 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 |