Skip to contentSkip to conversation

overview-manual/concepts.rst: fix do_prepare_recipe_sysroot task description

PATCH Superseded Dawid Bijak 3 participants 4 messages Apr 22 – Apr 23

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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.

Reword to refer to subsequent tasks in the recipe and call out do_configure and do_compile explicitly.

---
 documentation/overview-manual/concepts.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
documentation/overview-manual/concepts.rst +5 -5
index 1faa790f3..e4a8c60f7 100644
@@ -782,12 +782,12 @@ This step in the build process consists of the following tasks:
    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
+   subsequent tasks in the recipe (notably :ref:`ref-tasks-configure`
+   and :ref:`ref-tasks-compile`) can access 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.
+   tasks of the recipes on which the recipe depends. A sysroot
+   exists for both the target and for the native binaries, which
+   run on the host system.
 
 -  *do_configure*: This task configures the source by enabling and
    disabling any build-time and configuration options for the software
Signature · 1 line
2.48.1
#1 lore raw

Hi,

Quoted 20 lines · Dawid Bijak via lists.yoctoproject.org

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.

Reword to refer to subsequent tasks in the recipe and call out do_configure and do_compile explicitly.

---
 documentation/overview-manual/concepts.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
documentation/overview-manual/concepts.rst +0 -0
index 1faa790f3..e4a8c60f7 100644
@@ -782,12 +782,12 @@ This step in the build process consists of the following tasks:
    This task sets up the two sysroots in
    ``${``\ :term:`WORKDIR`\ ``}``

documentation/overview-manual/concepts.rst This step in the build process consists of the following tasks: · line 788

Quoted 10 lines
documentation/overview-manual/concepts.rst +3 -5
    (i.e. ``recipe-sysroot`` and ``recipe-sysroot-native``) so that
-   during the packaging phase the sysroots can contain the contents of
-   the
+   subsequent tasks in the recipe (notably :ref:`ref-tasks-configure`
+   and :ref:`ref-tasks-compile`) can access 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.
+   tasks of the recipes on which the recipe depends.

I think we can go further than that even.

I am dubious on the "contents of the tasks" phrasing. This does not make much sense to me, to be honest.

How about:

"""
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.
"""

?

documentation/overview-manual/concepts.rst This step in the build process consists of the following tasks: · line 790

Quoted 3 lines
documentation/overview-manual/concepts.rst +3 -0
+   A sysroot
+   exists for both the target and for the native binaries, which
+   run on the host system.

I think this would benefit from a bullet point list, to make the distinction clearer:

"""
A sysroot exists for:

- The target binaries (``recipe-sysroot``)
- And for the native binaries (``recipe-sysroot-native``), which run on the host system. """

What do you think?

Thanks for the patch,
Antonin

#2 lore raw
Quoted 6 lines · Antonin Godard via lists.yoctoproject.org

"""
A sysroot exists for:

(quoted diff) +0 -2
-  The target binaries (``recipe-sysroot``)
-  And for the native binaries (``recipe-sysroot-native``), which run on the host system.

"""

I think you could make this distinction:

- target sysroot contains target libraries, and associated headers and other data needed to cross-build software from its sources
- native sysroot contains 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

Alex

#3 lore raw
Quoted 10 lines · Alexander Kanavin via lists.yoctoproject.org
Quoted 6 lines · Antonin Godard via lists.yoctoproject.org

"""
A sysroot exists for:

(quoted diff) +0 -2
-  The target binaries (``recipe-sysroot``)
-  And for the native binaries (``recipe-sysroot-native``), which run on the host system.

"""

Quoted 7 lines

I think you could make this distinction:

- target sysroot contains target libraries, and associated headers and other data needed to cross-build software from its sources
- native sysroot contains 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

I second this, even better thanks!

David, a v2 with all the suggestions would be great.

Thanks,
Antonin