diff options
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/classes.rst | 8 | ||||
| -rw-r--r-- | documentation/ref-manual/faq.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/qa-checks.rst | 12 | ||||
| -rw-r--r-- | documentation/ref-manual/tasks.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 2 |
5 files changed, 13 insertions, 13 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. |
| 1340 | The boot script is specified in the ITS file as a text file containing | 1340 | The boot script is specified in the ITS file as a text file containing |
| 1341 | U-boot commands. When using a boot script the user should configure the | 1341 | U-boot commands. When using a boot script the user should configure the |
| 1342 | U-boot ``do_install`` task to copy the script to sysroot. | 1342 | U-boot :ref:`ref-tasks-install` task to copy the script to sysroot. |
| 1343 | So the script can be included in the FIT image by the ``kernel-fitimage`` | 1343 | So the script can be included in the FIT image by the ``kernel-fitimage`` |
| 1344 | class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to | 1344 | class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to |
| 1345 | load the boot script from the FIT image and executes it. | 1345 | 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. | |||
| 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 |
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 61049523a0..cb90677923 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
| @@ -437,7 +437,7 @@ practice very effective. | |||
| 437 | **Q:** The files provided by my ``*-native`` recipe do not appear to be | 437 | **Q:** The files provided by my ``*-native`` recipe do not appear to be |
| 438 | available to other recipes. Files are missing from the native sysroot, | 438 | available to other recipes. Files are missing from the native sysroot, |
| 439 | my recipe is installing to the wrong place, or I am getting permissions | 439 | my recipe is installing to the wrong place, or I am getting permissions |
| 440 | errors during the do_install task in my recipe! What is wrong? | 440 | errors during the :ref:`ref-tasks-install` task in my recipe! What is wrong? |
| 441 | 441 | ||
| 442 | **A:** This situation results when a build system does not recognize the | 442 | **A:** This situation results when a build system does not recognize the |
| 443 | environment variables supplied to it by :term:`BitBake`. The | 443 | environment variables supplied to it by :term:`BitBake`. The |
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst index fbab1dc92e..ff8916aedf 100644 --- a/documentation/ref-manual/qa-checks.rst +++ b/documentation/ref-manual/qa-checks.rst | |||
| @@ -162,7 +162,7 @@ Errors and Warnings | |||
| 162 | normally expected to be empty (such as ``/tmp``). These files may | 162 | normally expected to be empty (such as ``/tmp``). These files may |
| 163 | be more appropriately installed to a different location, or | 163 | be more appropriately installed to a different location, or |
| 164 | perhaps alternatively not installed at all, usually by updating the | 164 | perhaps alternatively not installed at all, usually by updating the |
| 165 | ``do_install`` task/function. | 165 | :ref:`ref-tasks-install` task/function. |
| 166 | 166 | ||
| 167 | .. _qa-check-arch: | 167 | .. _qa-check-arch: |
| 168 | 168 | ||
| @@ -536,7 +536,7 @@ Errors and Warnings | |||
| 536 | in (e.g. ``FILES:${``\ :term:`PN`\ ``}`` for the main | 536 | in (e.g. ``FILES:${``\ :term:`PN`\ ``}`` for the main |
| 537 | package). | 537 | package). |
| 538 | 538 | ||
| 539 | - Delete the files at the end of the ``do_install`` task if the | 539 | - Delete the files at the end of the :ref:`ref-tasks-install` task if the |
| 540 | files are not needed in any package. | 540 | files are not needed in any package. |
| 541 | 541 | ||
| 542 | 542 | ||
| @@ -582,7 +582,7 @@ Errors and Warnings | |||
| 582 | ``${datadir}/mime/packages``) and yet does not inherit the mime | 582 | ``${datadir}/mime/packages``) and yet does not inherit the mime |
| 583 | class which will ensure that these get properly installed. Either | 583 | class which will ensure that these get properly installed. Either |
| 584 | add ``inherit mime`` to the recipe or remove the files at the | 584 | add ``inherit mime`` to the recipe or remove the files at the |
| 585 | ``do_install`` step if they are not needed. | 585 | :ref:`ref-tasks-install` step if they are not needed. |
| 586 | 586 | ||
| 587 | 587 | ||
| 588 | .. _qa-check-mime-xdg: | 588 | .. _qa-check-mime-xdg: |
| @@ -592,7 +592,7 @@ Errors and Warnings | |||
| 592 | The specified package contains a .desktop file with a 'MimeType' key | 592 | The specified package contains a .desktop file with a 'MimeType' key |
| 593 | present, but does not inherit the mime-xdg class that is required in | 593 | present, but does not inherit the mime-xdg class that is required in |
| 594 | order for that to be activated. Either add ``inherit mime`` to the | 594 | order for that to be activated. Either add ``inherit mime`` to the |
| 595 | recipe or remove the files at the ``do_install`` step if they are not | 595 | recipe or remove the files at the :ref:`ref-tasks-install` step if they are not |
| 596 | needed. | 596 | needed. |
| 597 | 597 | ||
| 598 | 598 | ||
| @@ -667,8 +667,8 @@ Errors and Warnings | |||
| 667 | 667 | ||
| 668 | If ``usrmerge`` is in :term:`DISTRO_FEATURES`, this check will ensure that no package | 668 | If ``usrmerge`` is in :term:`DISTRO_FEATURES`, this check will ensure that no package |
| 669 | installs files to root (``/bin``, ``/sbin``, ``/lib``, ``/lib64``) directories. If you are seeing this | 669 | installs files to root (``/bin``, ``/sbin``, ``/lib``, ``/lib64``) directories. If you are seeing this |
| 670 | message, it indicates that the ``do_install`` step (or perhaps the build process that | 670 | message, it indicates that the :ref:`ref-tasks-install` step (or perhaps the build process that |
| 671 | ``do_install`` is calling into, e.g. ``make install`` is using hardcoded paths instead | 671 | :ref:`ref-tasks-install` is calling into, e.g. ``make install`` is using hardcoded paths instead |
| 672 | of the variables set up for this (``bindir``, ``sbindir``, etc.), and should be | 672 | of the variables set up for this (``bindir``, ``sbindir``, etc.), and should be |
| 673 | changed so that it does. | 673 | changed so that it does. |
| 674 | 674 | ||
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 2a692c1725..24203fcf78 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst | |||
| @@ -168,7 +168,7 @@ section in the Yocto Project Overview and Concepts Manual. | |||
| 168 | Copies files that are to be packaged into the holding area | 168 | Copies files that are to be packaged into the holding area |
| 169 | ``${``\ :term:`D`\ ``}``. This task runs with the current | 169 | ``${``\ :term:`D`\ ``}``. This task runs with the current |
| 170 | working directory set to ``${``\ :term:`B`\ ``}``, which is the | 170 | working directory set to ``${``\ :term:`B`\ ``}``, which is the |
| 171 | compilation directory. The ``do_install`` task, as well as other tasks | 171 | compilation directory. The :ref:`ref-tasks-install` task, as well as other tasks |
| 172 | that either directly or indirectly depend on the installed files (e.g. | 172 | that either directly or indirectly depend on the installed files (e.g. |
| 173 | :ref:`ref-tasks-package`, ``do_package_write_*``, and | 173 | :ref:`ref-tasks-package`, ``do_package_write_*``, and |
| 174 | :ref:`ref-tasks-rootfs`), run under | 174 | :ref:`ref-tasks-rootfs`), run under |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 2e2e16574c..1582664e62 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -5675,7 +5675,7 @@ system and gives an overview of their function and contents. | |||
| 5675 | way to ensure this is to use the ``oe_runmake`` function. | 5675 | way to ensure this is to use the ``oe_runmake`` function. |
| 5676 | 5676 | ||
| 5677 | If the software being built experiences dependency issues during | 5677 | If the software being built experiences dependency issues during |
| 5678 | the ``do_install`` task that result in race conditions, you can | 5678 | the :ref:`ref-tasks-install` task that result in race conditions, you can |
| 5679 | clear the :term:`PARALLEL_MAKEINST` variable within the recipe as a | 5679 | clear the :term:`PARALLEL_MAKEINST` variable within the recipe as a |
| 5680 | workaround. For information on addressing race conditions, see the | 5680 | workaround. For information on addressing race conditions, see the |
| 5681 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" | 5681 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" |
