mirror of
https://git.yoctoproject.org/poky
synced 2026-05-30 12:29:55 +00:00
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>
This commit is contained in:
committed by
Richard Purdie
parent
3c6b2798a0
commit
b3dc55b051
@@ -2028,10 +2028,10 @@ Successful packaging is a combination of automated processes performed
|
|||||||
by the OpenEmbedded build system and some specific steps you need to
|
by the OpenEmbedded build system and some specific steps you need to
|
||||||
take. The following list describes the process:
|
take. The following list describes the process:
|
||||||
|
|
||||||
- *Splitting Files*: The ``do_package`` task splits the files produced
|
- *Splitting Files*: The :ref:`ref-tasks-package` task splits the files produced
|
||||||
by the recipe into logical components. Even software that produces a
|
by the recipe into logical components. Even software that produces a
|
||||||
single binary might still have debug symbols, documentation, and
|
single binary might still have debug symbols, documentation, and
|
||||||
other logical components that should be split out. The ``do_package``
|
other logical components that should be split out. The :ref:`ref-tasks-package`
|
||||||
task ensures that files are split up and packaged correctly.
|
task ensures that files are split up and packaged correctly.
|
||||||
|
|
||||||
- *Running QA Checks*: The
|
- *Running QA Checks*: The
|
||||||
@@ -9594,7 +9594,7 @@ Running Specific Tasks
|
|||||||
|
|
||||||
Any given recipe consists of a set of tasks. The standard BitBake
|
Any given recipe consists of a set of tasks. The standard BitBake
|
||||||
behavior in most cases is: :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``,
|
behavior in most cases is: :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``,
|
||||||
:ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, ``do_package``,
|
:ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, :ref:`ref-tasks-package`,
|
||||||
``do_package_write_*``, and :ref:`ref-tasks-build`. The default task is
|
``do_package_write_*``, and :ref:`ref-tasks-build`. The default task is
|
||||||
:ref:`ref-tasks-build` and any tasks on which it depends build first. Some tasks,
|
:ref:`ref-tasks-build` and any tasks on which it depends build first. Some tasks,
|
||||||
such as ``do_devshell``, are not part of the default build chain. If you
|
such as ``do_devshell``, are not part of the default build chain. If you
|
||||||
|
|||||||
@@ -905,7 +905,7 @@ the analysis and package splitting process use several areas:
|
|||||||
individual packages.
|
individual packages.
|
||||||
|
|
||||||
- :term:`PKGDESTWORK`: A
|
- :term:`PKGDESTWORK`: A
|
||||||
temporary work area (i.e. ``pkgdata``) used by the ``do_package``
|
temporary work area (i.e. ``pkgdata``) used by the :ref:`ref-tasks-package`
|
||||||
task to save package metadata.
|
task to save package metadata.
|
||||||
|
|
||||||
- :term:`PKGDEST`: The parent
|
- :term:`PKGDEST`: The parent
|
||||||
@@ -1210,13 +1210,13 @@ and other preceding tasks. For example, if BitBake runs
|
|||||||
``do_populate_sysroot_setscene`` for something, it does not make sense
|
``do_populate_sysroot_setscene`` for something, it does not make sense
|
||||||
to run any of the :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``,
|
to run any of the :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``,
|
||||||
:ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, and :ref:`ref-tasks-install` tasks. However, if
|
:ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, and :ref:`ref-tasks-install` tasks. However, if
|
||||||
``do_package`` needs to be run, BitBake needs to run those other tasks.
|
:ref:`ref-tasks-package` needs to be run, BitBake needs to run those other tasks.
|
||||||
|
|
||||||
It becomes more complicated if everything can come from an sstate cache
|
It becomes more complicated if everything can come from an sstate cache
|
||||||
because some objects are simply not required at all. For example, you do
|
because some objects are simply not required at all. For example, you do
|
||||||
not need a compiler or native tools, such as quilt, if there isn't anything
|
not need a compiler or native tools, such as quilt, if there isn't anything
|
||||||
to compile or patch. If the ``do_package_write_*`` packages are available
|
to compile or patch. If the ``do_package_write_*`` packages are available
|
||||||
from sstate, BitBake does not need the ``do_package`` task data.
|
from sstate, BitBake does not need the :ref:`ref-tasks-package` task data.
|
||||||
|
|
||||||
To handle all these complexities, BitBake runs in two phases. The first
|
To handle all these complexities, BitBake runs in two phases. The first
|
||||||
is the "setscene" stage. During this stage, BitBake first checks the
|
is the "setscene" stage. During this stage, BitBake first checks the
|
||||||
@@ -1854,7 +1854,7 @@ The following list explains the previous example:
|
|||||||
|
|
||||||
In cases where ``sstate-inputdirs`` and ``sstate-outputdirs`` would be
|
In cases where ``sstate-inputdirs`` and ``sstate-outputdirs`` would be
|
||||||
the same, you can use ``sstate-plaindirs``. For example, to preserve the
|
the same, you can use ``sstate-plaindirs``. For example, to preserve the
|
||||||
${:term:`PKGD`} and ${:term:`PKGDEST`} output from the ``do_package``
|
${:term:`PKGD`} and ${:term:`PKGDEST`} output from the :ref:`ref-tasks-package`
|
||||||
task, use the following::
|
task, use the following::
|
||||||
|
|
||||||
do_package[sstate-plaindirs] = "${PKGD} ${PKGDEST}"
|
do_package[sstate-plaindirs] = "${PKGD} ${PKGDEST}"
|
||||||
@@ -2101,7 +2101,7 @@ dependencies, you must manually declare the dependencies.
|
|||||||
:term:`PRIVATE_LIBS` inside
|
:term:`PRIVATE_LIBS` inside
|
||||||
the package's recipe.
|
the package's recipe.
|
||||||
|
|
||||||
- ``pcdeps``: During the ``do_package`` task of each recipe, all
|
- ``pcdeps``: During the :ref:`ref-tasks-package` task of each recipe, all
|
||||||
pkg-config modules (``*.pc`` files) installed by the recipe are
|
pkg-config modules (``*.pc`` files) installed by the recipe are
|
||||||
located. For each module, the package that contains the module is
|
located. For each module, the package that contains the module is
|
||||||
registered as providing the module. The resulting module-to-package
|
registered as providing the module. The resulting module-to-package
|
||||||
@@ -2147,7 +2147,7 @@ dependencies, you must manually declare the dependencies.
|
|||||||
:term:`ALLOW_EMPTY` variable
|
:term:`ALLOW_EMPTY` variable
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
The ``do_package`` task depends on the ``do_packagedata`` task of each
|
The :ref:`ref-tasks-package` task depends on the ``do_packagedata`` task of each
|
||||||
recipe in :term:`DEPENDS` through use
|
recipe in :term:`DEPENDS` through use
|
||||||
of a ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
|
of a ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
|
||||||
declaration, which guarantees that the required
|
declaration, which guarantees that the required
|
||||||
|
|||||||
@@ -630,7 +630,7 @@ Here are key subdirectories within each recipe work directory:
|
|||||||
split into individual packages.
|
split into individual packages.
|
||||||
|
|
||||||
- ``${WORKDIR}/packages-split``: Contains the output of the
|
- ``${WORKDIR}/packages-split``: Contains the output of the
|
||||||
``do_package`` task after the output has been split into individual
|
:ref:`ref-tasks-package` task after the output has been split into individual
|
||||||
packages. There are subdirectories for each individual package created by
|
packages. There are subdirectories for each individual package created by
|
||||||
the recipe.
|
the recipe.
|
||||||
|
|
||||||
|
|||||||
@@ -212,7 +212,7 @@ based on available packages and files. This task makes use of the
|
|||||||
:term:`PACKAGES` and :term:`FILES`
|
:term:`PACKAGES` and :term:`FILES`
|
||||||
variables.
|
variables.
|
||||||
|
|
||||||
The ``do_package`` task, in conjunction with the
|
The :ref:`ref-tasks-package` task, in conjunction with the
|
||||||
:ref:`ref-tasks-packagedata` task, also saves some
|
:ref:`ref-tasks-packagedata` task, also saves some
|
||||||
important package metadata. For additional information, see the
|
important package metadata. For additional information, see the
|
||||||
:term:`PKGDESTWORK` variable and the
|
:term:`PKGDESTWORK` variable and the
|
||||||
|
|||||||
Reference in New Issue
Block a user