From 0b73ea395b10f1cea7ef1744bdc3ad6d1c6927c4 Mon Sep 17 00:00:00 2001 From: Dawid Bijak Date: Thu, 23 Apr 2026 18:49:25 +0200 Subject: [PATCH] overview-manual/concepts.rst: fix do_prepare_recipe_sysroot task description The description incorrectly stated that the sysroots are set up for use during the packaging phase. In fact, do_prepare_recipe_sysroot runs before do_configure, and the sysroots are consumed by do_configure and do_compile. Refer to do_configure and do_compile as the tasks that consume prepared sysroots. Briefly describe the role of each sysroot. Link do_configure, do_compile, and do_populate_sysroot via :ref: to ease navigation. Suggested-by: Alexander Kanavin Suggested-by: Antonin Godard (From yocto-docs rev: 1c5e7f136d7460fa5ad4c8a49ab1de31bd670e59) Signed-off-by: Dawid Bijak Signed-off-by: Antonin Godard (cherry picked from commit b50e8d36bdab53b004711ebc284d8ce8be593859) Signed-off-by: Antonin Godard Signed-off-by: Paul Barker --- documentation/overview-manual/concepts.rst | 27 ++++++++++++---------- 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 06a6834600..4e6cef43a7 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -808,17 +808,20 @@ to a holding area (staged) in preparation for packaging: This step in the build process consists of the following tasks: - :ref:`ref-tasks-prepare_recipe_sysroot`: - This task sets up the two sysroots in - ``${``\ :term:`WORKDIR`\ ``}`` - (i.e. ``recipe-sysroot`` and ``recipe-sysroot-native``) so that - during the packaging phase the sysroots can contain the contents of - the - :ref:`ref-tasks-populate_sysroot` - tasks of the recipes on which the recipe containing the tasks - depends. A sysroot exists for both the target and for the native - binaries, which run on the host system. + This task sets up the two sysroots in the ``${``\ :term:`WORKDIR`\ ``}`` (i.e. + ``recipe-sysroot`` and ``recipe-sysroot-native``) so that the subsequent tasks + of the recipe (notably :ref:`ref-tasks-configure` and :ref:`ref-tasks-compile`) + can access the libraries, headers, and similar files built by the recipes on + which it depends. -- *do_configure*: This task configures the source by enabling and + - ``recipe-sysroot``: contains target libraries, and associated headers and + other data needed to cross-build software from its sources + + - ``recipe-sysroot-native``: contains host-native executables with their libraries + and other data, so that they can be run directly on the build host when + that is required by the build process + +- :ref:`ref-tasks-configure`: This task configures the source by enabling and disabling any build-time and configuration options for the software being built. Configurations can come from the recipe itself as well as from an inherited class. Additionally, the software itself might @@ -837,7 +840,7 @@ This step in the build process consists of the following tasks: class, see the :ref:`ref-classes-autotools` class :yocto_git:`here `. -- *do_compile*: Once a configuration task has been satisfied, +- :ref:`ref-tasks-compile`: Once a configuration task has been satisfied, BitBake compiles the source using the :ref:`ref-tasks-compile` task. Compilation occurs in the directory pointed to by the @@ -845,7 +848,7 @@ This step in the build process consists of the following tasks: :term:`B` directory is, by default, the same as the :term:`S` directory. -- *do_install*: After compilation completes, BitBake executes the +- :ref:`ref-tasks-install`: After compilation completes, BitBake executes the :ref:`ref-tasks-install` task. This task copies files from the :term:`B` directory and places them in a holding area pointed to by the :term:`D`