diff options
author | Antonin Godard <antonin.godard@bootlin.com> | 2024-10-16 17:24:48 +0200 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2024-10-24 06:31:59 -0700 |
commit | 1ab34a5f6407b597f569c4b08d341e82db488f2c (patch) | |
tree | d941d03774e71c07e2ec086345d4e9b576261430 /documentation | |
parent | 810813a59fc556fe6c76a48de40ba4e73e6cfda9 (diff) | |
download | poky-1ab34a5f6407b597f569c4b08d341e82db488f2c.tar.gz |
ref-manual: structure.rst: document missing tmp/ dirs
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>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/structure.rst | 35 |
1 files changed, 33 insertions, 2 deletions
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 496fd6ae41..4cf23544db 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -476,6 +476,30 @@ the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`" | |||
476 | section in the Yocto Project Application Development and the Extensible | 476 | section in the Yocto Project Application Development and the Extensible |
477 | Software Development Kit (eSDK) manual. | 477 | Software Development Kit (eSDK) manual. |
478 | 478 | ||
479 | .. _structure-build-tmp-hosttools: | ||
480 | |||
481 | ``build/tmp/hosttools/`` | ||
482 | ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
483 | |||
484 | The OpenEmbedded build system uses this directory to create symbolic links to | ||
485 | some of the host components that are allowed to be called within tasks. These | ||
486 | are basic components listed in the :ref:`ref-manual/system-requirements:required | ||
487 | packages for the build host` section. These components are also listed in the | ||
488 | :term:`HOSTTOOLS` variable and are limited to this list to prevent host | ||
489 | contamination. | ||
490 | |||
491 | .. _structure-build-tmp-pkgdata: | ||
492 | |||
493 | ``build/tmp/pkgdata/`` | ||
494 | ~~~~~~~~~~~~~~~~~~~~~~ | ||
495 | |||
496 | The OpenEmbedded build system uses this directory to store package metadata | ||
497 | generated during the :ref:`ref-tasks-packagedata` task. The files stored in this | ||
498 | directory contain information about each output package produced by the | ||
499 | OpenEmbedded build system, and are used in different ways by the build system | ||
500 | such as ":ref:`dev-manual/debugging:viewing package information with | ||
501 | \`\`oe-pkgdata-util\`\``". | ||
502 | |||
479 | .. _structure-build-tmp-sstate-control: | 503 | .. _structure-build-tmp-sstate-control: |
480 | 504 | ||
481 | ``build/tmp/sstate-control/`` | 505 | ``build/tmp/sstate-control/`` |
@@ -649,8 +673,15 @@ Here are key subdirectories within each recipe work directory: | |||
649 | 673 | ||
650 | For efficiency, the OpenEmbedded build system creates and uses this | 674 | For efficiency, the OpenEmbedded build system creates and uses this |
651 | directory to hold recipes that share a work directory with other | 675 | directory to hold recipes that share a work directory with other |
652 | recipes. In practice, this is only used for ``gcc`` and its variants | 676 | recipes. This is for example used for ``gcc`` and its variants (e.g. |
653 | (e.g. ``gcc-cross``, ``libgcc``, ``gcc-runtime``, and so forth). | 677 | ``gcc-cross``, ``libgcc``, ``gcc-runtime``, and so forth), or by the |
678 | :ref:`ref-classes-kernel` class to make the kernel source code and kernel build | ||
679 | artifacts available to out-of-tree kernel modules or other kernel-dependent | ||
680 | recipes. | ||
681 | |||
682 | In practice, only a few recipes make use of the ``work-shared`` directory. This | ||
683 | directory is especially useful for recipes that would induce a lot of storage | ||
684 | space if they were to be shared with the standard :term:`Sysroot` mechanism. | ||
654 | 685 | ||
655 | .. _structure-meta: | 686 | .. _structure-meta: |
656 | 687 | ||