ref-manual: add that "work-shared" has kernel stuff

Submitted by Robert P. J. Day on May 1, 2021, 2:28 p.m. | Patch ID: 179729

Details

Message ID 3e51e58e-2e1f-d3a5-465b-52ca6bcdc3ff@crashcourse.ca
State New
Headers show

Commit Message

Robert P. J. Day May 1, 2021, 2:28 p.m.
Clarify that the /tmp/work-shared directory contains kernel-related
content in addition to gcc stuff.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

Patch hide | download patch | download mbox

diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index f8dc7d282..cbfc6bfbe 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -649,8 +649,15 @@  A number of key subdirectories exist 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. In practice, this is used for two things, the first being
+``gcc`` and its variants (e.g. ``gcc-cross``, ``libgcc``,
+``gcc-runtime``, and so forth).
+
+The second type of content installed under this directory is shareable
+kernel-related content, as defined in ``bitbake.conf``::
+
+   STAGING_KERNEL_DIR = "${TMPDIR}/work-shared/${MACHINE}/kernel-source"
+   STAGING_KERNEL_BUILDDIR = "${TMPDIR}/work-shared/${MACHINE}/kernel-build-artifacts"

 .. _structure-meta: