public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>,
	Quentin Schulz <foss@0leil.net>
Subject: [PATCH 12/30] manuals: add references to "do_package_write_*" tasks
Date: Fri, 23 Sep 2022 19:52:01 +0200	[thread overview]
Message-ID: <20220923175219.6652-13-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com>

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Using a reference to "do_package_write_deb", the first entry
in the list.

[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/dev-manual/common-tasks.rst  | 2 +-
 documentation/overview-manual/concepts.rst | 4 ++--
 documentation/ref-manual/classes.rst       | 2 +-
 documentation/ref-manual/tasks.rst         | 2 +-
 documentation/ref-manual/variables.rst     | 4 ++--
 5 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 947e10560a..dbf7dad558 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -9635,7 +9635,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``, :ref:`ref-tasks-patch`,
 :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:`do_package_write_* <ref-tasks-package_write_deb>`, 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
 wish to run a task that is not part of the default build chain, you can
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index f1457522da..a477139996 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -1198,7 +1198,7 @@ the work involved would be equal to or greater than the underlying task.
 
 In the build system, the common tasks that have setscene variants are
 :ref:`ref-tasks-package`,
-``do_package_write_*``,
+:ref:`do_package_write_* <ref-tasks-package_write_deb>`,
 :ref:`ref-tasks-deploy`,
 :ref:`ref-tasks-packagedata`, and
 :ref:`ref-tasks-populate_sysroot`.
@@ -1215,7 +1215,7 @@ to run any of the :ref:`ref-tasks-fetch`, ``do_unpack``, :ref:`ref-tasks-patch`,
 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
+to compile or patch. If the :ref:`do_package_write_* <ref-tasks-package_write_deb>` packages are available
 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
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 076ebb31ae..977dc34523 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -47,7 +47,7 @@ splitting out of debug symbols during packaging).
    even if the recipes do not produce architecture-specific output.
 
    Configuring such recipes for all architectures causes the
-   ``do_package_write_*`` tasks to
+   :ref:`do_package_write_* <ref-tasks-package_write_deb>` tasks to
    have different signatures for the machines with different tunings.
    Additionally, unnecessary rebuilds occur every time an image for a
    different :term:`MACHINE` is built even when the recipe never changes.
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index f0129c1f72..b099ce7a5c 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -170,7 +170,7 @@ Copies files that are to be packaged into the holding area
 working directory set to ``${``\ :term:`B`\ ``}``, which is the
 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-package`, :ref:`do_package_write_* <ref-tasks-package_write_deb>`, and
 :ref:`ref-tasks-rootfs`), run under
 :ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`.
 
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 45d058a281..272673d90b 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6200,7 +6200,7 @@ system and gives an overview of their function and contents.
       The practical effect of the above :term:`RDEPENDS` assignment is that
       ``bar`` and ``baz`` will be declared as dependencies inside the
       package ``foo`` when it is written out by one of the
-      :ref:`do_package_write_\* <ref-tasks-package_write_deb>` tasks.
+      :ref:`do_package_write_* <ref-tasks-package_write_deb>` tasks.
       Exactly how this is done depends on which package format is used,
       which is determined by
       :term:`PACKAGE_CLASSES`. When the
@@ -6212,7 +6212,7 @@ system and gives an overview of their function and contents.
       added. This dependency is from the recipe's
       :ref:`ref-tasks-build` (not to be confused with
       :ref:`ref-tasks-compile`) task to the
-      ``do_package_write_*`` task of the recipes that build ``bar`` and
+      :ref:`do_package_write_* <ref-tasks-package_write_deb>` task of the recipes that build ``bar`` and
       ``baz``.
 
       The names of the packages you list within :term:`RDEPENDS` must be the
-- 
2.34.1



  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 ` [PATCH 08/30] manuals: add references to the "do_package" task michael.opdenacker
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 ` michael.opdenacker [this message]
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-13-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