diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-09-23 18:04:29 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-10-07 10:54:25 +0100 |
| commit | b3dc55b0516da0ef9381baa034fa95f77a3c0119 (patch) | |
| tree | c502144ff8533e1e42d96090e6cf9e3aea78e4ea /documentation | |
| parent | 3c6b2798a0758c6a12f8ea8f451f3a294263da76 (diff) | |
| download | poky-b3dc55b0516da0ef9381baa034fa95f77a3c0119.tar.gz | |
manuals: add references to the "do_package" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 179139e6710f6dde0de25200c372705ed8ef13bc)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/dev-manual/common-tasks.rst | 6 | ||||
| -rw-r--r-- | documentation/overview-manual/concepts.rst | 12 | ||||
| -rw-r--r-- | documentation/ref-manual/structure.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/tasks.rst | 2 |
4 files changed, 11 insertions, 11 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 5d1a09cbd0..de26851521 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
| @@ -2028,10 +2028,10 @@ Successful packaging is a combination of automated processes performed | |||
| 2028 | by the OpenEmbedded build system and some specific steps you need to | 2028 | by the OpenEmbedded build system and some specific steps you need to |
| 2029 | take. The following list describes the process: | 2029 | take. The following list describes the process: |
| 2030 | 2030 | ||
| 2031 | - *Splitting Files*: The ``do_package`` task splits the files produced | 2031 | - *Splitting Files*: The :ref:`ref-tasks-package` task splits the files produced |
| 2032 | by the recipe into logical components. Even software that produces a | 2032 | by the recipe into logical components. Even software that produces a |
| 2033 | single binary might still have debug symbols, documentation, and | 2033 | single binary might still have debug symbols, documentation, and |
| 2034 | other logical components that should be split out. The ``do_package`` | 2034 | other logical components that should be split out. The :ref:`ref-tasks-package` |
| 2035 | task ensures that files are split up and packaged correctly. | 2035 | task ensures that files are split up and packaged correctly. |
| 2036 | 2036 | ||
| 2037 | - *Running QA Checks*: The | 2037 | - *Running QA Checks*: The |
| @@ -9594,7 +9594,7 @@ Running Specific Tasks | |||
| 9594 | 9594 | ||
| 9595 | Any given recipe consists of a set of tasks. The standard BitBake | 9595 | Any given recipe consists of a set of tasks. The standard BitBake |
| 9596 | behavior in most cases is: :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``, | 9596 | behavior in most cases is: :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``, |
| 9597 | :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, ``do_package``, | 9597 | :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, :ref:`ref-tasks-package`, |
| 9598 | ``do_package_write_*``, and :ref:`ref-tasks-build`. The default task is | 9598 | ``do_package_write_*``, and :ref:`ref-tasks-build`. The default task is |
| 9599 | :ref:`ref-tasks-build` and any tasks on which it depends build first. Some tasks, | 9599 | :ref:`ref-tasks-build` and any tasks on which it depends build first. Some tasks, |
| 9600 | such as ``do_devshell``, are not part of the default build chain. If you | 9600 | such as ``do_devshell``, are not part of the default build chain. If you |
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 3bb728f990..bbe0ec345b 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
| @@ -905,7 +905,7 @@ the analysis and package splitting process use several areas: | |||
| 905 | individual packages. | 905 | individual packages. |
| 906 | 906 | ||
| 907 | - :term:`PKGDESTWORK`: A | 907 | - :term:`PKGDESTWORK`: A |
| 908 | temporary work area (i.e. ``pkgdata``) used by the ``do_package`` | 908 | temporary work area (i.e. ``pkgdata``) used by the :ref:`ref-tasks-package` |
| 909 | task to save package metadata. | 909 | task to save package metadata. |
| 910 | 910 | ||
| 911 | - :term:`PKGDEST`: The parent | 911 | - :term:`PKGDEST`: The parent |
| @@ -1210,13 +1210,13 @@ and other preceding tasks. For example, if BitBake runs | |||
| 1210 | ``do_populate_sysroot_setscene`` for something, it does not make sense | 1210 | ``do_populate_sysroot_setscene`` for something, it does not make sense |
| 1211 | to run any of the :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``, | 1211 | to run any of the :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``, |
| 1212 | :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, and :ref:`ref-tasks-install` tasks. However, if | 1212 | :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, and :ref:`ref-tasks-install` tasks. However, if |
| 1213 | ``do_package`` needs to be run, BitBake needs to run those other tasks. | 1213 | :ref:`ref-tasks-package` needs to be run, BitBake needs to run those other tasks. |
| 1214 | 1214 | ||
| 1215 | It becomes more complicated if everything can come from an sstate cache | 1215 | It becomes more complicated if everything can come from an sstate cache |
| 1216 | because some objects are simply not required at all. For example, you do | 1216 | because some objects are simply not required at all. For example, you do |
| 1217 | not need a compiler or native tools, such as quilt, if there isn't anything | 1217 | not need a compiler or native tools, such as quilt, if there isn't anything |
| 1218 | to compile or patch. If the ``do_package_write_*`` packages are available | 1218 | to compile or patch. If the ``do_package_write_*`` packages are available |
| 1219 | from sstate, BitBake does not need the ``do_package`` task data. | 1219 | from sstate, BitBake does not need the :ref:`ref-tasks-package` task data. |
| 1220 | 1220 | ||
| 1221 | To handle all these complexities, BitBake runs in two phases. The first | 1221 | To handle all these complexities, BitBake runs in two phases. The first |
| 1222 | is the "setscene" stage. During this stage, BitBake first checks the | 1222 | is the "setscene" stage. During this stage, BitBake first checks the |
| @@ -1854,7 +1854,7 @@ The following list explains the previous example: | |||
| 1854 | 1854 | ||
| 1855 | In cases where ``sstate-inputdirs`` and ``sstate-outputdirs`` would be | 1855 | In cases where ``sstate-inputdirs`` and ``sstate-outputdirs`` would be |
| 1856 | the same, you can use ``sstate-plaindirs``. For example, to preserve the | 1856 | the same, you can use ``sstate-plaindirs``. For example, to preserve the |
| 1857 | ${:term:`PKGD`} and ${:term:`PKGDEST`} output from the ``do_package`` | 1857 | ${:term:`PKGD`} and ${:term:`PKGDEST`} output from the :ref:`ref-tasks-package` |
| 1858 | task, use the following:: | 1858 | task, use the following:: |
| 1859 | 1859 | ||
| 1860 | do_package[sstate-plaindirs] = "${PKGD} ${PKGDEST}" | 1860 | do_package[sstate-plaindirs] = "${PKGD} ${PKGDEST}" |
| @@ -2101,7 +2101,7 @@ dependencies, you must manually declare the dependencies. | |||
| 2101 | :term:`PRIVATE_LIBS` inside | 2101 | :term:`PRIVATE_LIBS` inside |
| 2102 | the package's recipe. | 2102 | the package's recipe. |
| 2103 | 2103 | ||
| 2104 | - ``pcdeps``: During the ``do_package`` task of each recipe, all | 2104 | - ``pcdeps``: During the :ref:`ref-tasks-package` task of each recipe, all |
| 2105 | pkg-config modules (``*.pc`` files) installed by the recipe are | 2105 | pkg-config modules (``*.pc`` files) installed by the recipe are |
| 2106 | located. For each module, the package that contains the module is | 2106 | located. For each module, the package that contains the module is |
| 2107 | registered as providing the module. The resulting module-to-package | 2107 | registered as providing the module. The resulting module-to-package |
| @@ -2147,7 +2147,7 @@ dependencies, you must manually declare the dependencies. | |||
| 2147 | :term:`ALLOW_EMPTY` variable | 2147 | :term:`ALLOW_EMPTY` variable |
| 2148 | for more information. | 2148 | for more information. |
| 2149 | 2149 | ||
| 2150 | The ``do_package`` task depends on the ``do_packagedata`` task of each | 2150 | The :ref:`ref-tasks-package` task depends on the ``do_packagedata`` task of each |
| 2151 | recipe in :term:`DEPENDS` through use | 2151 | recipe in :term:`DEPENDS` through use |
| 2152 | of a ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` | 2152 | of a ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` |
| 2153 | declaration, which guarantees that the required | 2153 | declaration, which guarantees that the required |
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 429f81e14c..533745b370 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
| @@ -630,7 +630,7 @@ Here are key subdirectories within each recipe work directory: | |||
| 630 | split into individual packages. | 630 | split into individual packages. |
| 631 | 631 | ||
| 632 | - ``${WORKDIR}/packages-split``: Contains the output of the | 632 | - ``${WORKDIR}/packages-split``: Contains the output of the |
| 633 | ``do_package`` task after the output has been split into individual | 633 | :ref:`ref-tasks-package` task after the output has been split into individual |
| 634 | packages. There are subdirectories for each individual package created by | 634 | packages. There are subdirectories for each individual package created by |
| 635 | the recipe. | 635 | the recipe. |
| 636 | 636 | ||
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index a92468d8df..e87be90cc0 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst | |||
| @@ -212,7 +212,7 @@ based on available packages and files. This task makes use of the | |||
| 212 | :term:`PACKAGES` and :term:`FILES` | 212 | :term:`PACKAGES` and :term:`FILES` |
| 213 | variables. | 213 | variables. |
| 214 | 214 | ||
| 215 | The ``do_package`` task, in conjunction with the | 215 | The :ref:`ref-tasks-package` task, in conjunction with the |
| 216 | :ref:`ref-tasks-packagedata` task, also saves some | 216 | :ref:`ref-tasks-packagedata` task, also saves some |
| 217 | important package metadata. For additional information, see the | 217 | important package metadata. For additional information, see the |
| 218 | :term:`PKGDESTWORK` variable and the | 218 | :term:`PKGDESTWORK` variable and the |
