MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 12:59:02 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

ref-manual: structure.rst: document missing tmp/ dirs

Browse Source 
Document `hosttools/`, `pkgdata/` and add some more information on
`work-shared/`.

Adresses [YOCTO #14543].

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 259fce03ffab9fb588676c1e150d999d54cf6d85)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 372b5b4ca55819c294970b20aa8b8d8167144329)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
This commit is contained in:
Antonin Godard 2024-10-16 17:24:48 +02:00 committed by Steve Sakoman
parent 810813a59f
commit 1ab34a5f64
1 changed files with 33 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
documentation/ref-manual/structure.rst
View File

@ -476,6 +476,30 @@ the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`"
section in the Yocto Project Application Development and the Extensible
Software Development Kit (eSDK) manual.
.. _structure-build-tmp-hosttools:
``build/tmp/hosttools/``
~~~~~~~~~~~~~~~~~~~~~~~~
The OpenEmbedded build system uses this directory to create symbolic links to
some of the host components that are allowed to be called within tasks. These
are basic components listed in the :ref:`ref-manual/system-requirements:required
packages for the build host` section. These components are also listed in the
:term:`HOSTTOOLS` variable and are limited to this list to prevent host
contamination.
.. _structure-build-tmp-pkgdata:
``build/tmp/pkgdata/``
~~~~~~~~~~~~~~~~~~~~~~
The OpenEmbedded build system uses this directory to store package metadata
generated during the :ref:`ref-tasks-packagedata` task. The files stored in this
directory contain information about each output package produced by the
OpenEmbedded build system, and are used in different ways by the build system
such as ":ref:`dev-manual/debugging:viewing package information with
\`\`oe-pkgdata-util\`\``".
.. _structure-build-tmp-sstate-control:
``build/tmp/sstate-control/``
@ -649,8 +673,15 @@ Here are key subdirectories within each recipe work directory:
For efficiency, the OpenEmbedded build system creates and uses this
directory to hold recipes that share a work directory with other
recipes. In practice, this is only used for ``gcc`` and its variants
(e.g. ``gcc-cross``, ``libgcc``, ``gcc-runtime``, and so forth).
recipes. This is for example used for ``gcc`` and its variants (e.g.
``gcc-cross``, ``libgcc``, ``gcc-runtime``, and so forth), or by the
:ref:`ref-classes-kernel` class to make the kernel source code and kernel build
artifacts available to out-of-tree kernel modules or other kernel-dependent
recipes.
In practice, only a few recipes make use of the ``work-shared`` directory. This
directory is especially useful for recipes that would induce a lot of storage
space if they were to be shared with the standard :term:`Sysroot` mechanism.
.. _structure-meta: