summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-09-23 17:59:23 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-10-07 10:54:25 +0100
commit3c6b2798a0758c6a12f8ea8f451f3a294263da76 (patch)
tree7d5dce72293077154f2f6167079969f7fec99c34 /documentation
parent0e8d0ecc6ce511bacc59d06214d6e53ee4dceaad (diff)
downloadpoky-3c6b2798a0758c6a12f8ea8f451f3a294263da76.tar.gz
manuals: add references to the "do_image" task
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 2f53d0a52a48f828f00d3bc3f887fd537692a256) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/common-tasks.rst2
-rw-r--r--documentation/overview-manual/concepts.rst4
-rw-r--r--documentation/ref-manual/tasks.rst8
3 files changed, 7 insertions, 7 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 7e1cf1dd70..5d1a09cbd0 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::
3853 do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_rootfs" 3853 do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_rootfs"
3854 3854
3855In this example, the `from_multiconfig` is "x86". The `to_multiconfig` is "arm". The 3855In this example, the `from_multiconfig` is "x86". The `to_multiconfig` is "arm". The
3856task on which the ``do_image`` task in the recipe depends is the 3856task on which the :ref:`ref-tasks-image` task in the recipe depends is the
3857``do_rootfs`` task from the ``core-image-minimal`` recipe associated 3857``do_rootfs`` task from the ``core-image-minimal`` recipe associated
3858with the "arm" multiconfig. 3858with the "arm" multiconfig.
3859 3859
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
1036variable. This variable specifies a list of functions to call before the 1036variable. This variable specifies a list of functions to call before the
1037build system creates the final image output files. 1037build system creates the final image output files.
1038 1038
1039The build system dynamically creates ``do_image_*`` tasks as needed, 1039The build system dynamically creates :ref:`do_image_* <ref-tasks-image>` tasks as needed,
1040based on the image types specified in the 1040based on the image types specified in the
1041:term:`IMAGE_FSTYPES` variable. 1041:term:`IMAGE_FSTYPES` variable.
1042The process turns everything into an image file or a set of image files 1042The 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.
2162:ref:`ref-tasks-install`, 2162:ref:`ref-tasks-install`,
2163:ref:`do_package_write* <ref-tasks-package_write_deb>`, 2163:ref:`do_package_write* <ref-tasks-package_write_deb>`,
2164:ref:`ref-tasks-rootfs`, and 2164:ref:`ref-tasks-rootfs`, and
2165:ref:`do_image* <ref-tasks-image>`). For example, 2165:ref:`do_image_* <ref-tasks-image>`). For example,
2166the :ref:`ref-tasks-install` task benefits from being able to set the UID and GID 2166the :ref:`ref-tasks-install` task benefits from being able to set the UID and GID
2167of installed files to arbitrary values. 2167of installed files to arbitrary values.
2168 2168
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index f47a30e467..a92468d8df 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -128,15 +128,15 @@ module.
128``do_image`` 128``do_image``
129------------ 129------------
130 130
131Starts the image generation process. The ``do_image`` task runs after 131Starts the image generation process. The :ref:`ref-tasks-image` task runs after
132the OpenEmbedded build system has run the 132the OpenEmbedded build system has run the
133:ref:`ref-tasks-rootfs` task during which packages are 133:ref:`ref-tasks-rootfs` task during which packages are
134identified for installation into the image and the root filesystem is 134identified for installation into the image and the root filesystem is
135created, complete with post-processing. 135created, complete with post-processing.
136 136
137The ``do_image`` task performs pre-processing on the image through the 137The :ref:`ref-tasks-image` task performs pre-processing on the image through the
138:term:`IMAGE_PREPROCESS_COMMAND` and 138:term:`IMAGE_PREPROCESS_COMMAND` and
139dynamically generates supporting ``do_image_*`` tasks as needed. 139dynamically generates supporting :ref:`do_image_* <ref-tasks-image>` tasks as needed.
140 140
141For more information on image creation, see the ":ref:`overview-manual/concepts:image generation`" 141For more information on image creation, see the ":ref:`overview-manual/concepts:image generation`"
142section in the Yocto Project Overview and Concepts Manual. 142section in the Yocto Project Overview and Concepts Manual.
@@ -149,7 +149,7 @@ section in the Yocto Project Overview and Concepts Manual.
149Completes the image generation process. The ``do_image_complete`` task 149Completes the image generation process. The ``do_image_complete`` task
150runs after the OpenEmbedded build system has run the 150runs after the OpenEmbedded build system has run the
151:ref:`ref-tasks-image` task during which image 151:ref:`ref-tasks-image` task during which image
152pre-processing occurs and through dynamically generated ``do_image_*`` 152pre-processing occurs and through dynamically generated :ref:`do_image_* <ref-tasks-image>`
153tasks the image is constructed. 153tasks the image is constructed.
154 154
155The ``do_image_complete`` task performs post-processing on the image 155The ``do_image_complete`` task performs post-processing on the image