summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-09-23 19:36:01 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-10-07 10:54:26 +0100
commit40b77252122884b8395d59648147a93f2d0e33d9 (patch)
tree36432316236f203c17aefce0e2dace6adca0012a /documentation
parentb42af6aa4a5c64f80091d9445b79e2565515854c (diff)
downloadpoky-40b77252122884b8395d59648147a93f2d0e33d9.tar.gz
manuals: add references to the "do_rootfs" task
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 926c836e5184243fb1aee113962e11c01f0297ee) 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.rst6
-rw-r--r--documentation/migration-guides/migration-2.1.rst8
-rw-r--r--documentation/migration-guides/migration-2.5.rst2
-rw-r--r--documentation/overview-manual/concepts.rst2
4 files changed, 9 insertions, 9 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 32268931a4..a4741c5a8b 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -3854,7 +3854,7 @@ to be added to the recipe that builds the ``core-image-sato`` image::
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 :ref:`ref-tasks-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:ref:`ref-tasks-rootfs` task from the ``core-image-minimal`` recipe associated
3858with the "arm" multiconfig. 3858with the "arm" multiconfig.
3859 3859
3860Once you set up this dependency, you can build the "x86" multiconfig 3860Once you set up this dependency, you can build the "x86" multiconfig
@@ -3864,7 +3864,7 @@ using a BitBake command as follows::
3864 3864
3865This command executes all the tasks needed to create the 3865This command executes all the tasks needed to create the
3866``core-image-sato`` image for the "x86" multiconfig. Because of the 3866``core-image-sato`` image for the "x86" multiconfig. Because of the
3867dependency, BitBake also executes through the ``do_rootfs`` task for the 3867dependency, BitBake also executes through the :ref:`ref-tasks-rootfs` task for the
3868"arm" multiconfig build. 3868"arm" multiconfig build.
3869 3869
3870Having a recipe depend on the root filesystem of another build might not 3870Having a recipe depend on the root filesystem of another build might not
@@ -9041,7 +9041,7 @@ Class methods are as follows:
9041 9041
9042- *hasPackage(pkg):* Returns "True" if ``pkg`` is in the installed 9042- *hasPackage(pkg):* Returns "True" if ``pkg`` is in the installed
9043 package list of the image, which is based on the manifest file that 9043 package list of the image, which is based on the manifest file that
9044 is generated during the ``do_rootfs`` task. 9044 is generated during the :ref:`ref-tasks-rootfs` task.
9045 9045
9046- *hasFeature(feature):* Returns "True" if the feature is in 9046- *hasFeature(feature):* Returns "True" if the feature is in
9047 :term:`IMAGE_FEATURES` or 9047 :term:`IMAGE_FEATURES` or
diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst
index bfc600ccca..c19ba5501c 100644
--- a/documentation/migration-guides/migration-2.1.rst
+++ b/documentation/migration-guides/migration-2.1.rst
@@ -128,12 +128,12 @@ separate :ref:`ref-tasks-image` tasks for clarity both in
128operation and in the code. 128operation and in the code.
129 129
130For most cases, this change does not present any problems. However, if 130For most cases, this change does not present any problems. However, if
131you have made customizations that directly modify the ``do_rootfs`` task 131you have made customizations that directly modify the :ref:`ref-tasks-rootfs` task
132or that mention ``do_rootfs``, you might need to update those changes. 132or that mention :ref:`ref-tasks-rootfs`, you might need to update those changes.
133In particular, if you had added any tasks after ``do_rootfs``, you 133In particular, if you had added any tasks after :ref:`ref-tasks-rootfs`, you
134should make edits so that those tasks are after the 134should make edits so that those tasks are after the
135:ref:`ref-tasks-image-complete` task rather than 135:ref:`ref-tasks-image-complete` task rather than
136after ``do_rootfs`` so that your added tasks run at the correct 136after :ref:`ref-tasks-rootfs` so that your added tasks run at the correct
137time. 137time.
138 138
139A minor part of this restructuring is that the post-processing 139A minor part of this restructuring is that the post-processing
diff --git a/documentation/migration-guides/migration-2.5.rst b/documentation/migration-guides/migration-2.5.rst
index abd26809df..04f4cd7e73 100644
--- a/documentation/migration-guides/migration-2.5.rst
+++ b/documentation/migration-guides/migration-2.5.rst
@@ -261,7 +261,7 @@ The following are additional changes:
261 ``pkg_postinst_ontarget()`` or call 261 ``pkg_postinst_ontarget()`` or call
262 ``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``. 262 ``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``.
263 Any failure of a ``pkg_postinst()`` script (including ``exit 1``) 263 Any failure of a ``pkg_postinst()`` script (including ``exit 1``)
264 will trigger a warning during ``do_rootfs``. 264 will trigger a warning during :ref:`ref-tasks-rootfs`.
265 265
266 For more information, see the 266 For more information, see the
267 ":ref:`dev-manual/common-tasks:post-installation scripts`" 267 ":ref:`dev-manual/common-tasks:post-installation scripts`"
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 2aa7676324..8b8625a080 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -1012,7 +1012,7 @@ all the post installation scripts must succeed on the build host during
1012the package installation phase since the root filesystem on the target 1012the package installation phase since the root filesystem on the target
1013is read-only. 1013is read-only.
1014 1014
1015The final stages of the ``do_rootfs`` task handle post processing. Post 1015The final stages of the :ref:`ref-tasks-rootfs` task handle post processing. Post
1016processing includes creation of a manifest file and optimizations. 1016processing includes creation of a manifest file and optimizations.
1017 1017
1018The manifest file (``.manifest``) resides in the same directory as the 1018The manifest file (``.manifest``) resides in the same directory as the