From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>,
Quentin Schulz <foss@0leil.net>
Subject: [PATCH 08/30] manuals: add references to the "do_package" task
Date: Fri, 23 Sep 2022 19:51:57 +0200 [thread overview]
Message-ID: <20220923175219.6652-9-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com>
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/dev-manual/common-tasks.rst | 6 +++---
documentation/overview-manual/concepts.rst | 12 ++++++------
documentation/ref-manual/structure.rst | 2 +-
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 22d1634f1b..74b050f600 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
by the OpenEmbedded build system and some specific steps you need to
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
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.
- *Running QA Checks*: The
@@ -9634,7 +9634,7 @@ Running Specific Tasks
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``,
-: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
: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
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:
individual packages.
- :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.
- :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
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
-``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
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
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
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
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::
do_package[sstate-plaindirs] = "${PKGD} ${PKGDEST}"
@@ -2101,7 +2101,7 @@ dependencies, you must manually declare the dependencies.
:term:`PRIVATE_LIBS` inside
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
located. For each module, the package that contains the module is
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
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
of a ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
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:
split into individual packages.
- ``${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
the recipe.
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 63af2730e7..1bb8bc1918 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
:term:`PACKAGES` and :term:`FILES`
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
important package metadata. For additional information, see the
:term:`PKGDESTWORK` variable and the
--
2.34.1
next prev parent reply other threads:[~2022-09-23 17:53 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-23 17:51 [PATCH 00/30] manuals: add missing references to tasks michael.opdenacker
2022-09-23 17:51 ` [PATCH 01/30] manuals: add references to the "do_fetch" task michael.opdenacker
2022-09-23 17:51 ` [PATCH 03/30] manuals: add references to the "do_build" task michael.opdenacker
2022-09-23 17:51 ` [PATCH 04/30] manuals: add reference to "do_configure" task michael.opdenacker
2022-09-26 13:57 ` [docs] " Quentin Schulz
2022-10-05 18:01 ` Michael Opdenacker
2022-09-23 17:51 ` [PATCH 05/30] manuals: add reference to the "do_compile" task michael.opdenacker
2022-09-23 17:51 ` [PATCH 06/30] manuals: add references to the "do_deploy" task michael.opdenacker
2022-09-26 13:40 ` [docs] " Quentin Schulz
[not found] ` <06a1c1e5-0a0c-5c0f-d05e-6e51967be786@bootlin.com>
2022-10-06 7:49 ` Quentin Schulz
2022-09-26 14:04 ` Quentin Schulz
2022-10-05 18:11 ` Michael Opdenacker
2022-10-06 7:54 ` Quentin Schulz
2022-09-23 17:51 ` [PATCH 07/30] manuals: add references to the "do_image" task michael.opdenacker
2022-09-23 17:51 ` michael.opdenacker [this message]
2022-09-23 17:51 ` [PATCH 09/30] manuals: add references to the "do_package_qa" task michael.opdenacker
2022-09-23 17:51 ` [PATCH 10/30] overview-manual: concepts.rst: add reference to "do_packagedata" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 11/30] manuals: add references to the "do_patch" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 12/30] manuals: add references to "do_package_write_*" tasks michael.opdenacker
2022-09-23 17:52 ` [PATCH 13/30] ref-manual: variables.rst: add reference to "do_populate_lic" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 14/30] manuals: add reference to the "do_populate_sdk" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 15/30] overview-manual: concepts.rst: add reference to "do_populate_sdk_ext" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 16/30] manuals: add references to "do_populate_sysroot" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 17/30] manuals: add references to the "do_unpack" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 18/30] dev-manual: common-tasks.rst: add reference to "do_clean" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 19/30] manuals: add references to the "do_cleanall" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 20/30] ref-manual: tasks.rst: add references to the "do_cleansstate" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 21/30] manuals: add references to the "do_devshell" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 22/30] dev-manual: common-tasks.rst: add reference to "do_listtasks" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 23/30] manuals: add references to the "do_bundle_initramfs" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 24/30] manuals: add references to the "do_rootfs" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 25/30] ref-manual: tasks.rst: add reference to the "do_kernel_checkout" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 26/30] manuals: add reference to the "do_kernel_configcheck" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 27/30] manuals: add references to the "do_kernel_configme" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 28/30] ref-manual: tasks.rst: add reference to the "do_kernel_metadata" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 29/30] migration-guides: add reference to the "do_shared_workdir" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 30/30] ref-manual: tasks.rst: add reference to the "do_validate_branches" task michael.opdenacker
2022-09-26 14:00 ` [docs] [PATCH 00/30] manuals: add missing references to tasks Quentin Schulz
2022-10-05 18:15 ` Michael Opdenacker
[not found] ` <20220923175219.6652-3-michael.opdenacker@bootlin.com>
2022-09-26 14:04 ` [docs] [PATCH 02/30] manuals: add reference to the "do_install" task Quentin Schulz
2022-10-05 18:06 ` Michael Opdenacker
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220923175219.6652-9-michael.opdenacker@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=foss@0leil.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox