From: Alexander Kanavin <alex.kanavin@gmail.com>
To: docs@lists.yoctoproject.org
Cc: Alexander Kanavin <alex@linutronix.de>
Subject: [PATCH 5/6] ref-manual: correct references to WORKDIR to account for recent do_unpack changes
Date: Mon, 23 Jun 2025 14:42:56 +0200 [thread overview]
Message-ID: <20250623124257.1544615-5-alex.kanavin@gmail.com> (raw)
In-Reply-To: <20250623124257.1544615-1-alex.kanavin@gmail.com>
From: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
---
documentation/ref-manual/structure.rst | 2 +-
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 2190f5b90e5..d6dbb294018 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``
built within the Yocto Project. For this package, a work directory of
``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred
to as the :term:`WORKDIR`, is created. Within this directory, the source is
-unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt.
+unpacked to ``sources/linux-qemux86-standard-build`` and then patched by Quilt.
(See the ":ref:`dev-manual/quilt:using quilt in your workflow`" section in
the Yocto Project Development Tasks Manual for more information.) Within
the ``linux-qemux86-standard-build`` directory, standard Quilt
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c6ae3fb8bcc..7fe152c57e3 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.
build process. By default, this directory is the same as the
:term:`S` directory, which is defined as::
- S = "${WORKDIR}/${BP}"
+ S = "${UNPACKDIR}/${BP}"
You can separate the (:term:`S`) directory and the directory pointed to
by the :term:`B` variable. Most Autotools-based recipes support
@@ -8039,7 +8039,7 @@ system and gives an overview of their function and contents.
:term:`S`
The location in the :term:`Build Directory` where
unpacked recipe source code resides. By default, this directory is
- ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``,
+ ``${``\ :term:`UNPACKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``,
where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe
version. If the source tarball extracts the code to a directory named
anything other than ``${BPN}-${PV}``, or if the source code is
@@ -8052,19 +8052,10 @@ system and gives an overview of their function and contents.
``poky/build``. In this case, the work directory the build system
uses to keep the unpacked recipe for ``db`` is the following::
- poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19
+ poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/sources/db-5.1.19
The unpacked source code resides in the ``db-5.1.19`` folder.
- This next example assumes a Git repository. By default, Git
- repositories are cloned to ``${WORKDIR}/git`` during
- :ref:`ref-tasks-fetch`. Since this path is different
- from the default value of :term:`S`, you must set it specifically so the
- source can be located::
-
- SRC_URI = "git://path/to/repo.git;branch=main"
- S = "${WORKDIR}/git"
-
:term:`SANITY_REQUIRED_UTILITIES`
Specifies a list of command-line utilities that should be checked for
during the initial sanity checking process when running BitBake. If
@@ -8439,7 +8430,6 @@ system and gives an overview of their function and contents.
sources are fetched from a Git repository and ``setup.py`` is in a
``python/pythonmodule`` subdirectory, you would have this::
- S = "${WORKDIR}/git"
SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule"
:term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS`
--
2.39.5
next prev parent reply other threads:[~2025-06-23 12:43 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-23 12:42 [PATCH 1/6] overview-manual: correct value of UNPACKDIR and put S under it Alexander Kanavin
2025-06-23 12:42 ` [PATCH 2/6] ref-manual: drop a sentence about a 'legacy way' to specify UNPACKDIR Alexander Kanavin
2025-06-23 12:42 ` [PATCH 3/6] dev-manual: replace WORKDIR with UNPACKDIR where appropriate Alexander Kanavin
2025-06-23 12:42 ` [PATCH 4/6] overview-manual: correct the bitbake tasks map section and diagram to account for sources in UNPACKDIR Alexander Kanavin
2025-06-23 12:42 ` Alexander Kanavin [this message]
2025-06-23 12:42 ` [PATCH 6/6] migration-guides/migration-5.1.rst: correct S/UNPACKDIR patterns for file-only recipes Alexander Kanavin
2025-06-24 7:43 ` [docs] " Antonin Godard
2025-06-24 9:13 ` Alexander Kanavin
2025-06-24 9:38 ` Antonin Godard
2025-07-01 8:37 ` [PATCH 1/6] overview-manual: correct value of UNPACKDIR and put S under it Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250623124257.1544615-5-alex.kanavin@gmail.com \
--to=alex.kanavin@gmail.com \
--cc=alex@linutronix.de \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.