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 07/30] manuals: add references to the "do_image" task
Date: Fri, 23 Sep 2022 19:51:56 +0200	[thread overview]
Message-ID: <20220923175219.6652-8-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  | 2 +-
 documentation/overview-manual/concepts.rst | 4 ++--
 documentation/ref-manual/tasks.rst         | 8 ++++----
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 0b512601e5..22d1634f1b 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -3853,7 +3853,7 @@ to be added to the recipe that builds the ``core-image-sato`` image::
    do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_rootfs"
 
 In this example, the `from_multiconfig` is "x86". The `to_multiconfig` is "arm". The
-task on which the ``do_image`` task in the recipe depends is the
+task on which the :ref:`ref-tasks-image` task in the recipe depends is the
 ``do_rootfs`` task from the ``core-image-minimal`` recipe associated
 with the "arm" multiconfig.
 
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index f3f8cbd95c..3bb728f990 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -1036,7 +1036,7 @@ the
 variable. This variable specifies a list of functions to call before the
 build system creates the final image output files.
 
-The build system dynamically creates ``do_image_*`` tasks as needed,
+The build system dynamically creates :ref:`do_image_* <ref-tasks-image>` tasks as needed,
 based on the image types specified in the
 :term:`IMAGE_FSTYPES` variable.
 The process turns everything into an image file or a set of image files
@@ -2162,7 +2162,7 @@ operations that are normally reserved for the root user (e.g.
 :ref:`ref-tasks-install`,
 :ref:`do_package_write* <ref-tasks-package_write_deb>`,
 :ref:`ref-tasks-rootfs`, and
-:ref:`do_image* <ref-tasks-image>`). For example,
+:ref:`do_image_* <ref-tasks-image>`). For example,
 the :ref:`ref-tasks-install` task benefits from being able to set the UID and GID
 of installed files to arbitrary values.
 
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 5efe64b35d..63af2730e7 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -128,15 +128,15 @@ module.
 ``do_image``
 ------------
 
-Starts the image generation process. The ``do_image`` task runs after
+Starts the image generation process. The :ref:`ref-tasks-image` task runs after
 the OpenEmbedded build system has run the
 :ref:`ref-tasks-rootfs` task during which packages are
 identified for installation into the image and the root filesystem is
 created, complete with post-processing.
 
-The ``do_image`` task performs pre-processing on the image through the
+The :ref:`ref-tasks-image` task performs pre-processing on the image through the
 :term:`IMAGE_PREPROCESS_COMMAND` and
-dynamically generates supporting ``do_image_*`` tasks as needed.
+dynamically generates supporting :ref:`do_image_* <ref-tasks-image>` tasks as needed.
 
 For more information on image creation, see the ":ref:`overview-manual/concepts:image generation`"
 section in the Yocto Project Overview and Concepts Manual.
@@ -149,7 +149,7 @@ section in the Yocto Project Overview and Concepts Manual.
 Completes the image generation process. The ``do_image_complete`` task
 runs after the OpenEmbedded build system has run the
 :ref:`ref-tasks-image` task during which image
-pre-processing occurs and through dynamically generated ``do_image_*``
+pre-processing occurs and through dynamically generated :ref:`do_image_* <ref-tasks-image>`
 tasks the image is constructed.
 
 The ``do_image_complete`` task performs post-processing on the image
-- 
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 ` michael.opdenacker [this message]
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 ` [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-8-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