summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/ref-manual/structure.rst35
1 files changed, 33 insertions, 2 deletions
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index e4d8b54bb9..bbeda78c79 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -484,6 +484,30 @@ the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`"
484section in the Yocto Project Application Development and the Extensible 484section in the Yocto Project Application Development and the Extensible
485Software Development Kit (eSDK) manual. 485Software Development Kit (eSDK) manual.
486 486
487.. _structure-build-tmp-hosttools:
488
489``build/tmp/hosttools/``
490~~~~~~~~~~~~~~~~~~~~~~~~
491
492The OpenEmbedded build system uses this directory to create symbolic links to
493some of the host components that are allowed to be called within tasks. These
494are basic components listed in the :ref:`ref-manual/system-requirements:required
495packages for the build host` section. These components are also listed in the
496:term:`HOSTTOOLS` variable and are limited to this list to prevent host
497contamination.
498
499.. _structure-build-tmp-pkgdata:
500
501``build/tmp/pkgdata/``
502~~~~~~~~~~~~~~~~~~~~~~
503
504The OpenEmbedded build system uses this directory to store package metadata
505generated during the :ref:`ref-tasks-packagedata` task. The files stored in this
506directory contain information about each output package produced by the
507OpenEmbedded build system, and are used in different ways by the build system
508such as ":ref:`dev-manual/debugging:viewing package information with
509\`\`oe-pkgdata-util\`\``".
510
487.. _structure-build-tmp-sstate-control: 511.. _structure-build-tmp-sstate-control:
488 512
489``build/tmp/sstate-control/`` 513``build/tmp/sstate-control/``
@@ -657,8 +681,15 @@ Here are key subdirectories within each recipe work directory:
657 681
658For efficiency, the OpenEmbedded build system creates and uses this 682For efficiency, the OpenEmbedded build system creates and uses this
659directory to hold recipes that share a work directory with other 683directory to hold recipes that share a work directory with other
660recipes. In practice, this is only used for ``gcc`` and its variants 684recipes. This is for example used for ``gcc`` and its variants (e.g.
661(e.g. ``gcc-cross``, ``libgcc``, ``gcc-runtime``, and so forth). 685``gcc-cross``, ``libgcc``, ``gcc-runtime``, and so forth), or by the
686:ref:`ref-classes-kernel` class to make the kernel source code and kernel build
687artifacts available to out-of-tree kernel modules or other kernel-dependent
688recipes.
689
690In practice, only a few recipes make use of the ``work-shared`` directory. This
691directory is especially useful for recipes that would induce a lot of storage
692space if they were to be shared with the standard :term:`Sysroot` mechanism.
662 693
663.. _structure-meta: 694.. _structure-meta:
664 695