summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2025-03-11 14:31:07 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-03-24 17:32:34 +0000
commit61a71927194e7dd52df7e8c822612122b2e06b51 (patch)
tree692069bad56d8fe5c0e0001cb375ed1cccae2458
parent2d843491f3a31f17db7a99ff4262f16cbd424a32 (diff)
downloadpoky-61a71927194e7dd52df7e8c822612122b2e06b51.tar.gz
overview-manual/concepts: add UNPACKDIR in the directory description
Mention that UNPACKDIR is used as a location to unpack the source code, and that S is the final location of the source code. This is deliberately vague, because as there are multiple instances of how these directories can be defined and used. The proper explanation of how the UNPACKDIR and S directories interact is left to the reference manual, under the UNPACKDIR variable description. (From yocto-docs rev: 76361ae37bd45c9ce5190fb6c7c400bf2fc14003) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/overview-manual/concepts.rst15
1 files changed, 9 insertions, 6 deletions
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index ccbe2f47fd..e4d806f98f 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -704,10 +704,10 @@ a defined structure. For additional general information on the
704the Yocto Project Reference Manual. 704the Yocto Project Reference Manual.
705 705
706Each recipe has an area in the :term:`Build Directory` where the unpacked 706Each recipe has an area in the :term:`Build Directory` where the unpacked
707source code resides. The :term:`S` variable points to this area for a recipe's 707source code resides. The :term:`UNPACKDIR` variable points to this area for a
708unpacked source code. The name of that directory for any given recipe is 708recipe's unpacked source code, and has the default ``sources-unpack`` name. The
709defined from several different variables. The preceding figure and the 709preceding figure and the following list describe the :term:`Build Directory`'s
710following list describe the :term:`Build Directory`'s hierarchy: 710hierarchy:
711 711
712- :term:`TMPDIR`: The base directory 712- :term:`TMPDIR`: The base directory
713 where the OpenEmbedded build system performs all its work during the 713 where the OpenEmbedded build system performs all its work during the
@@ -736,8 +736,11 @@ following list describe the :term:`Build Directory`'s hierarchy:
736 - :term:`PV`: The version of the 736 - :term:`PV`: The version of the
737 recipe used to build the package. 737 recipe used to build the package.
738 738
739- :term:`S`: Contains the unpacked source 739- :term:`UNPACKDIR`: Contains the unpacked source files for a given recipe.
740 files for a given recipe. 740
741- :term:`S`: Contains the final location of the source code.
742
743 The default value for :term:`BP` is ``${BPN}-${PV}`` where:
741 744
742 - :term:`BPN`: The name of the recipe 745 - :term:`BPN`: The name of the recipe
743 used to build the package. The :term:`BPN` variable is a version of 746 used to build the package. The :term:`BPN` variable is a version of