[07/30] manuals: add references to the "do_image" task

Message ID	20220923175219.6652-8-michael.opdenacker@bootlin.com
State	New
Headers	show Return-Path: <michael.opdenacker@bootlin.com> ip: 217.70.178.232, mailfrom: michael.opdenacker@bootlin.com) sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 3803C200002; Fri, 23 Sep 2022 17:53:07 +0000 (UTC) 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 Message-Id: <20220923175219.6652-8-michael.opdenacker@bootlin.com> In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit
Series	manuals: add missing references to tasks \| expand [00/30] manuals: add missing references to tasks [01/30] manuals: add references to the "do_fetch" task [03/30] manuals: add references to the "do_build" task [04/30] manuals: add reference to "do_configure" task [05/30] manuals: add reference to the "do_compile" task [06/30] manuals: add references to the "do_deploy" task [07/30] manuals: add references to the "do_image" task [08/30] manuals: add references to the "do_package" task [09/30] manuals: add references to the "do_package_qa" task [10/30] overview-manual: concepts.rst: add reference to "do_packagedata" task [11/30] manuals: add references to the "do_patch" task [12/30] manuals: add references to "do_package_write_*" tasks [13/30] ref-manual: variables.rst: add reference to "do_populate_lic" task [14/30] manuals: add reference to the "do_populate_sdk" task [15/30] overview-manual: concepts.rst: add reference to "do_populate_sdk_ext" task [16/30] manuals: add references to "do_populate_sysroot" task [17/30] manuals: add references to the "do_unpack" task [18/30] dev-manual: common-tasks.rst: add reference to "do_clean" task [19/30] manuals: add references to the "do_cleanall" task [20/30] ref-manual: tasks.rst: add references to the "do_cleansstate" task [21/30] manuals: add references to the "do_devshell" task [22/30] dev-manual: common-tasks.rst: add reference to "do_listtasks" task [23/30] manuals: add references to the "do_bundle_initramfs" task [24/30] manuals: add references to the "do_rootfs" task [25/30] ref-manual: tasks.rst: add reference to the "do_kernel_checkout" task [26/30] manuals: add reference to the "do_kernel_configcheck" task [27/30] manuals: add references to the "do_kernel_configme" task [28/30] ref-manual: tasks.rst: add reference to the "do_kernel_metadata" task [29/30] migration-guides: add reference to the "do_shared_workdir" task [30/30] ref-manual: tasks.rst: add reference to the "do_validate_branches" task

Message ID

20220923175219.6652-8-michael.opdenacker@bootlin.com

State

New

Headers

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
Message-Id: <20220923175219.6652-8-michael.opdenacker@bootlin.com>
In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com>
References: <20220923175219.6652-1-michael.opdenacker@bootlin.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

Series

manuals: add missing references to tasks | expand

Commit Message

Michael Opdenacker Sept. 23, 2022, 5:51 p.m. UTC

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

[07/30] manuals: add references to the "do_image" task

Commit Message

Patch