summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-06-13 17:58:07 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-06-21 20:57:17 +0100
commit50acfba977ea69e6e5f315d905bf584820d3bca1 (patch)
treed65d6ac9783dc9fbc168affff2fe721fef727bbc /documentation
parent8a5caba86326a4b193733f423938d3bb44f6cf3c (diff)
downloadpoky-50acfba977ea69e6e5f315d905bf584820d3bca1.tar.gz
ref-manual: add description for the "sysroot" term
This term is used throughout the manual but is not properly introduced anywhere. (From yocto-docs rev: 51426a0762a5988aa835e065f5258fd7ac474c52) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/terms.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index cba514c345..512032a67e 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -383,6 +383,31 @@ universal, the list includes them just in case:
383 ":ref:`overview-manual/development-environment:repositories, tags, and branches`" 383 ":ref:`overview-manual/development-environment:repositories, tags, and branches`"
384 section in the Yocto Project Overview and Concepts Manual. 384 section in the Yocto Project Overview and Concepts Manual.
385 385
386 :term:`Sysroot`
387 When cross-compiling, the target file system may be differently laid
388 out and contain different things compared to the host system. The concept
389 of a *sysroot* is directory which looks like the target filesystem and
390 can be used to cross-compile against.
391
392 In the context of cross-compiling toolchains, a *sysroot*
393 typically contains C library and kernel headers, plus the
394 compiled binaries for the C library. A *multilib toolchain*
395 can contain multiple variants of the C library binaries,
396 each compiled for a target instruction set (such as ``armv5``,
397 ``armv7`` and ``armv8``), and possibly optimized for a specific CPU core.
398
399 In the more specific context of the OpenEmbedded build System and
400 of the Yocto Project, each recipe has two sysroots:
401
402 - A *target sysroot* contains all the **target** libraries and headers
403 needed to build the recipe.
404
405 - A *native sysroot* contains all the **host** files and executables
406 needed to build the recipe.
407
408 See the :term:`SYSROOT_* <SYSROOT_DESTDIR>` variables controlling
409 how sysroots are created and stored.
410
386 :term:`Task` 411 :term:`Task`
387 A per-recipe unit of execution for BitBake (e.g. 412 A per-recipe unit of execution for BitBake (e.g.
388 :ref:`ref-tasks-compile`, 413 :ref:`ref-tasks-compile`,