mirror of
https://git.yoctoproject.org/poky
synced 2026-06-02 01:19:52 +00:00
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>
This commit is contained in:
committed by
Richard Purdie
parent
84251f8d24
commit
9fece9c361
@@ -1081,12 +1081,12 @@ Here are the tests you can list with the :term:`WARN_QA` and
|
||||
might result in host contamination of the build output.
|
||||
|
||||
- ``installed-vs-shipped:`` Reports when files have been installed
|
||||
within ``do_install`` but have not been included in any package by
|
||||
within :ref:`ref-tasks-install` but have not been included in any package by
|
||||
way of the :term:`FILES` variable. Files that do not
|
||||
appear in any package cannot be present in an image later on in the
|
||||
build process. Ideally, all installed files should be packaged or not
|
||||
installed at all. These files can be deleted at the end of
|
||||
``do_install`` if the files are not needed in any package.
|
||||
:ref:`ref-tasks-install` if the files are not needed in any package.
|
||||
|
||||
- ``invalid-chars:`` Checks that the recipe metadata variables
|
||||
:term:`DESCRIPTION`,
|
||||
@@ -1339,7 +1339,7 @@ Only a single U-boot boot script can be added to the FIT image created by
|
||||
``kernel-fitimage`` and the boot script is optional.
|
||||
The boot script is specified in the ITS file as a text file containing
|
||||
U-boot commands. When using a boot script the user should configure the
|
||||
U-boot ``do_install`` task to copy the script to sysroot.
|
||||
U-boot :ref:`ref-tasks-install` task to copy the script to sysroot.
|
||||
So the script can be included in the FIT image by the ``kernel-fitimage``
|
||||
class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to
|
||||
load 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.
|
||||
|
||||
.. note::
|
||||
|
||||
The ``setuptools3`` class ``do_install()`` task now installs the ``wheel``
|
||||
The ``setuptools3`` class :ref:`ref-tasks-install` task now installs the ``wheel``
|
||||
binary archive. In current versions of ``setuptools`` the legacy ``setup.py
|
||||
install`` method is deprecated. If the ``setup.py`` cannot be used with
|
||||
wheels, for example it creates files outside of the Python module or
|
||||
|
||||
@@ -437,7 +437,7 @@ practice very effective.
|
||||
**Q:** The files provided by my ``*-native`` recipe do not appear to be
|
||||
available to other recipes. Files are missing from the native sysroot,
|
||||
my recipe is installing to the wrong place, or I am getting permissions
|
||||
errors during the do_install task in my recipe! What is wrong?
|
||||
errors during the :ref:`ref-tasks-install` task in my recipe! What is wrong?
|
||||
|
||||
**A:** This situation results when a build system does not recognize the
|
||||
environment variables supplied to it by :term:`BitBake`. The
|
||||
|
||||
@@ -162,7 +162,7 @@ Errors and Warnings
|
||||
normally expected to be empty (such as ``/tmp``). These files may
|
||||
be more appropriately installed to a different location, or
|
||||
perhaps alternatively not installed at all, usually by updating the
|
||||
``do_install`` task/function.
|
||||
:ref:`ref-tasks-install` task/function.
|
||||
|
||||
.. _qa-check-arch:
|
||||
|
||||
@@ -536,7 +536,7 @@ Errors and Warnings
|
||||
in (e.g. ``FILES:${``\ :term:`PN`\ ``}`` for the main
|
||||
package).
|
||||
|
||||
- Delete the files at the end of the ``do_install`` task if the
|
||||
- Delete the files at the end of the :ref:`ref-tasks-install` task if the
|
||||
files are not needed in any package.
|
||||
|
||||
|
||||
@@ -582,7 +582,7 @@ Errors and Warnings
|
||||
``${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
|
||||
``do_install`` step if they are not needed.
|
||||
:ref:`ref-tasks-install` step if they are not needed.
|
||||
|
||||
|
||||
.. _qa-check-mime-xdg:
|
||||
@@ -592,7 +592,7 @@ Errors and Warnings
|
||||
The specified package contains a .desktop file with a 'MimeType' key
|
||||
present, but does not inherit the mime-xdg class that is required in
|
||||
order for that to be activated. Either add ``inherit mime`` to the
|
||||
recipe or remove the files at the ``do_install`` step if they are not
|
||||
recipe or remove the files at the :ref:`ref-tasks-install` step if they are not
|
||||
needed.
|
||||
|
||||
|
||||
@@ -667,8 +667,8 @@ Errors and Warnings
|
||||
|
||||
If ``usrmerge`` is in :term:`DISTRO_FEATURES`, this check will ensure that no package
|
||||
installs files to root (``/bin``, ``/sbin``, ``/lib``, ``/lib64``) directories. If you are seeing this
|
||||
message, it indicates that the ``do_install`` step (or perhaps the build process that
|
||||
``do_install`` is calling into, e.g. ``make install`` is using hardcoded paths instead
|
||||
message, it indicates that the :ref:`ref-tasks-install` step (or perhaps the build process that
|
||||
:ref:`ref-tasks-install` is calling into, e.g. ``make install`` is using hardcoded paths instead
|
||||
of the variables set up for this (``bindir``, ``sbindir``, etc.), and should be
|
||||
changed so that it does.
|
||||
|
||||
|
||||
@@ -168,7 +168,7 @@ section in the Yocto Project Overview and Concepts Manual.
|
||||
Copies files that are to be packaged into the holding area
|
||||
``${``\ :term:`D`\ ``}``. This task runs with the current
|
||||
working directory set to ``${``\ :term:`B`\ ``}``, which is the
|
||||
compilation directory. The ``do_install`` task, as well as other tasks
|
||||
compilation directory. The :ref:`ref-tasks-install` task, as well as other tasks
|
||||
that either directly or indirectly depend on the installed files (e.g.
|
||||
:ref:`ref-tasks-package`, ``do_package_write_*``, and
|
||||
:ref:`ref-tasks-rootfs`), run under
|
||||
|
||||
@@ -5675,7 +5675,7 @@ system and gives an overview of their function and contents.
|
||||
way to ensure this is to use the ``oe_runmake`` function.
|
||||
|
||||
If the software being built experiences dependency issues during
|
||||
the ``do_install`` task that result in race conditions, you can
|
||||
the :ref:`ref-tasks-install` task that result in race conditions, you can
|
||||
clear the :term:`PARALLEL_MAKEINST` variable within the recipe as a
|
||||
workaround. For information on addressing race conditions, see the
|
||||
":ref:`dev-manual/common-tasks:debugging parallel make races`"
|
||||
|
||||
Reference in New Issue
Block a user