diff options
author | Alexander Kanavin <alex@linutronix.de> | 2025-06-23 14:42:56 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-06-30 17:44:21 +0100 |
commit | 73ecebe8a65159b32017789f5d676577bce2031e (patch) | |
tree | ca5a35ae22f9204b7c8fc7fd81cadfea8bf8fae9 /documentation/ref-manual | |
parent | 5ebf08ad8d7a79c9ad4c8abb004db6dbf88d9e22 (diff) | |
download | poky-73ecebe8a65159b32017789f5d676577bce2031e.tar.gz |
ref-manual: correct references to WORKDIR to account for recent do_unpack changes
(From yocto-docs rev: 2e83260484c102fe7b788585cbdd7ca91ba91d85)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/structure.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 16 |
2 files changed, 4 insertions, 14 deletions
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 2190f5b90e..d6dbb29401 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -611,7 +611,7 @@ example, consider ``linux-yocto-kernel-3.0`` on the machine ``qemux86`` | |||
611 | built within the Yocto Project. For this package, a work directory of | 611 | built within the Yocto Project. For this package, a work directory of |
612 | ``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred | 612 | ``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred |
613 | to as the :term:`WORKDIR`, is created. Within this directory, the source is | 613 | to as the :term:`WORKDIR`, is created. Within this directory, the source is |
614 | unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. | 614 | unpacked to ``sources/linux-qemux86-standard-build`` and then patched by Quilt. |
615 | (See the ":ref:`dev-manual/quilt:using quilt in your workflow`" section in | 615 | (See the ":ref:`dev-manual/quilt:using quilt in your workflow`" section in |
616 | the Yocto Project Development Tasks Manual for more information.) Within | 616 | the Yocto Project Development Tasks Manual for more information.) Within |
617 | the ``linux-qemux86-standard-build`` directory, standard Quilt | 617 | the ``linux-qemux86-standard-build`` directory, standard Quilt |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 10d363a389..0a748c9187 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -265,7 +265,7 @@ system and gives an overview of their function and contents. | |||
265 | build process. By default, this directory is the same as the | 265 | build process. By default, this directory is the same as the |
266 | :term:`S` directory, which is defined as:: | 266 | :term:`S` directory, which is defined as:: |
267 | 267 | ||
268 | S = "${WORKDIR}/${BP}" | 268 | S = "${UNPACKDIR}/${BP}" |
269 | 269 | ||
270 | You can separate the (:term:`S`) directory and the directory pointed to | 270 | You can separate the (:term:`S`) directory and the directory pointed to |
271 | by the :term:`B` variable. Most Autotools-based recipes support | 271 | by the :term:`B` variable. Most Autotools-based recipes support |
@@ -8060,7 +8060,7 @@ system and gives an overview of their function and contents. | |||
8060 | :term:`S` | 8060 | :term:`S` |
8061 | The location in the :term:`Build Directory` where | 8061 | The location in the :term:`Build Directory` where |
8062 | unpacked recipe source code resides. By default, this directory is | 8062 | unpacked recipe source code resides. By default, this directory is |
8063 | ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, | 8063 | ``${``\ :term:`UNPACKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, |
8064 | where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe | 8064 | where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe |
8065 | version. If the source tarball extracts the code to a directory named | 8065 | version. If the source tarball extracts the code to a directory named |
8066 | anything other than ``${BPN}-${PV}``, or if the source code is | 8066 | anything other than ``${BPN}-${PV}``, or if the source code is |
@@ -8073,19 +8073,10 @@ system and gives an overview of their function and contents. | |||
8073 | ``poky/build``. In this case, the work directory the build system | 8073 | ``poky/build``. In this case, the work directory the build system |
8074 | uses to keep the unpacked recipe for ``db`` is the following:: | 8074 | uses to keep the unpacked recipe for ``db`` is the following:: |
8075 | 8075 | ||
8076 | poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19 | 8076 | poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/sources/db-5.1.19 |
8077 | 8077 | ||
8078 | The unpacked source code resides in the ``db-5.1.19`` folder. | 8078 | The unpacked source code resides in the ``db-5.1.19`` folder. |
8079 | 8079 | ||
8080 | This next example assumes a Git repository. By default, Git | ||
8081 | repositories are cloned to ``${WORKDIR}/git`` during | ||
8082 | :ref:`ref-tasks-fetch`. Since this path is different | ||
8083 | from the default value of :term:`S`, you must set it specifically so the | ||
8084 | source can be located:: | ||
8085 | |||
8086 | SRC_URI = "git://path/to/repo.git;branch=main" | ||
8087 | S = "${WORKDIR}/git" | ||
8088 | |||
8089 | :term:`SANITY_REQUIRED_UTILITIES` | 8080 | :term:`SANITY_REQUIRED_UTILITIES` |
8090 | Specifies a list of command-line utilities that should be checked for | 8081 | Specifies a list of command-line utilities that should be checked for |
8091 | during the initial sanity checking process when running BitBake. If | 8082 | during the initial sanity checking process when running BitBake. If |
@@ -8460,7 +8451,6 @@ system and gives an overview of their function and contents. | |||
8460 | sources are fetched from a Git repository and ``setup.py`` is in a | 8451 | sources are fetched from a Git repository and ``setup.py`` is in a |
8461 | ``python/pythonmodule`` subdirectory, you would have this:: | 8452 | ``python/pythonmodule`` subdirectory, you would have this:: |
8462 | 8453 | ||
8463 | S = "${WORKDIR}/git" | ||
8464 | SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule" | 8454 | SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule" |
8465 | 8455 | ||
8466 | :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS` | 8456 | :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS` |