summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/classes.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-09-23 17:20:26 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-10-07 10:54:25 +0100
commit9fece9c36125aeec1ee3b3845fc914ec0dbf3034 (patch)
tree9ee53e939349006219c1b325c5afa395e723dd14 /documentation/ref-manual/classes.rst
parent84251f8d24034163ec785d0f5715634b90f2c1bf (diff)
downloadpoky-9fece9c36125aeec1ee3b3845fc914ec0dbf3034.tar.gz
manuals: add reference to the "do_install" task
[YOCTO #14508] (From yocto-docs rev: 933ad27b81dfc4a28e7c48ca7bb2d1363e8c037f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/classes.rst')
-rw-r--r--documentation/ref-manual/classes.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index f402d090c9..673e90d9ec 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1081,12 +1081,12 @@ Here are the tests you can list with the :term:`WARN_QA` and
1081 might result in host contamination of the build output. 1081 might result in host contamination of the build output.
1082 1082
1083- ``installed-vs-shipped:`` Reports when files have been installed 1083- ``installed-vs-shipped:`` Reports when files have been installed
1084 within ``do_install`` but have not been included in any package by 1084 within :ref:`ref-tasks-install` but have not been included in any package by
1085 way of the :term:`FILES` variable. Files that do not 1085 way of the :term:`FILES` variable. Files that do not
1086 appear in any package cannot be present in an image later on in the 1086 appear in any package cannot be present in an image later on in the
1087 build process. Ideally, all installed files should be packaged or not 1087 build process. Ideally, all installed files should be packaged or not
1088 installed at all. These files can be deleted at the end of 1088 installed at all. These files can be deleted at the end of
1089 ``do_install`` if the files are not needed in any package. 1089 :ref:`ref-tasks-install` if the files are not needed in any package.
1090 1090
1091- ``invalid-chars:`` Checks that the recipe metadata variables 1091- ``invalid-chars:`` Checks that the recipe metadata variables
1092 :term:`DESCRIPTION`, 1092 :term:`DESCRIPTION`,
@@ -1339,7 +1339,7 @@ Only a single U-boot boot script can be added to the FIT image created by
1339``kernel-fitimage`` and the boot script is optional. 1339``kernel-fitimage`` and the boot script is optional.
1340The boot script is specified in the ITS file as a text file containing 1340The boot script is specified in the ITS file as a text file containing
1341U-boot commands. When using a boot script the user should configure the 1341U-boot commands. When using a boot script the user should configure the
1342U-boot ``do_install`` task to copy the script to sysroot. 1342U-boot :ref:`ref-tasks-install` task to copy the script to sysroot.
1343So the script can be included in the FIT image by the ``kernel-fitimage`` 1343So the script can be included in the FIT image by the ``kernel-fitimage``
1344class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to 1344class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to
1345load the boot script from the FIT image and executes it. 1345load the boot script from the FIT image and executes it.
@@ -2412,7 +2412,7 @@ uses these build systems, the recipe needs to inherit the ``setuptools3`` class.
2412 2412
2413 .. note:: 2413 .. note::
2414 2414
2415 The ``setuptools3`` class ``do_install()`` task now installs the ``wheel`` 2415 The ``setuptools3`` class :ref:`ref-tasks-install` task now installs the ``wheel``
2416 binary archive. In current versions of ``setuptools`` the legacy ``setup.py 2416 binary archive. In current versions of ``setuptools`` the legacy ``setup.py
2417 install`` method is deprecated. If the ``setup.py`` cannot be used with 2417 install`` method is deprecated. If the ``setup.py`` cannot be used with
2418 wheels, for example it creates files outside of the Python module or 2418 wheels, for example it creates files outside of the Python module or