public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: [PATCH 2/4] dev-manual/temporary-source-code.rst: fix definition of WORKDIR
Date: Mon, 01 Dec 2025 10:55:20 +0100	[thread overview]
Message-ID: <20251201-fixes-v1-2-1cf15a5a4cbe@bootlin.com> (raw)
In-Reply-To: <20251201-fixes-v1-0-1cf15a5a4cbe@bootlin.com>

Fix the definition of WORKDIR to match OE-Core.
Rename the Source Directory to "project" as part of the transition to
bitbake-setup and the removal of Poky as in "the Poky repository".

Reported-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/dev-manual/temporary-source-code.rst | 14 ++++----------
 1 file changed, 4 insertions(+), 10 deletions(-)

diff --git a/documentation/dev-manual/temporary-source-code.rst b/documentation/dev-manual/temporary-source-code.rst
index 9a7cd0f77..977edbc3f 100644
--- a/documentation/dev-manual/temporary-source-code.rst
+++ b/documentation/dev-manual/temporary-source-code.rst
@@ -43,11 +43,11 @@ In turn, the path to the work directory for the recipe
 (:term:`WORKDIR`) is defined as
 follows::
 
-   ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}
+   ${BASE_WORKDIR}/${MULTIMACH_TARGET_SYS}/${PN}/${PV}
 
 The actual directory depends on several things:
 
--  :term:`TMPDIR`: The top-level build
+-  :term:`BASE_WORKDIR`: The top-level build
    output directory.
 
 -  :term:`MULTIMACH_TARGET_SYS`:
@@ -55,19 +55,13 @@ The actual directory depends on several things:
 
 -  :term:`PN`: The recipe name.
 
--  :term:`EXTENDPE`: The epoch --- if
-   :term:`PE` is not specified, which is
-   usually the case for most recipes, then :term:`EXTENDPE` is blank.
-
 -  :term:`PV`: The recipe version.
 
--  :term:`PR`: The recipe revision.
-
 As an example, assume a Source Directory top-level folder named
-``poky``, a default :term:`Build Directory` at ``poky/build``, and a
+``project``, a default :term:`Build Directory` at ``project/build``, and a
 ``qemux86-poky-linux`` machine target system. Furthermore, suppose your
 recipe is named ``foo_1.3.0.bb``. In this case, the work directory the
 build system uses to build the package would be as follows::
 
-   poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0
+   project/build/tmp/work/qemux86-poky-linux/foo/1.3.0
 

-- 
2.51.0



  parent reply	other threads:[~2025-12-01  9:55 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-01  9:55 [PATCH 0/4] Various docs fixes Antonin Godard
2025-12-01  9:55 ` [PATCH 1/4] ref-manual/variables.rst: NVD_DB_VERSION: fix default value Antonin Godard
2025-12-01  9:55 ` Antonin Godard [this message]
2025-12-01  9:55 ` [PATCH 3/4] overview-manual/yp-intro.rst: change removed ECOSYSTEM to ABOUT Antonin Godard
2025-12-01  9:55 ` [PATCH 4/4] overview-manual/yp-intro.rst: link to YP members and participants Antonin Godard
2025-12-16 16:12 ` [PATCH 0/4] Various docs fixes 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=20251201-fixes-v1-2-1cf15a5a4cbe@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=thomas.petazzoni@bootlin.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox