From patchwork Tue Jan 20 15:17:00 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 79222 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 62CFBD2ED1B for ; Tue, 20 Jan 2026 15:17:17 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.8792.1768922232876878230 for ; Tue, 20 Jan 2026 07:17:14 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=ZI9k20Ts; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id 5DD894E421AE for ; Tue, 20 Jan 2026 15:17:11 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 338BB606AB for ; Tue, 20 Jan 2026 15:17:11 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 9AF9110B6B4FB; Tue, 20 Jan 2026 16:17:10 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1768922230; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=mJrqtodLdku80BaQYQ21y+mmP8ndksLtj8+KZGovCGo=; b=ZI9k20Ts3MRoqDd0L8PSoYC/v3l79CWWvzIxz5FtbXDE0px7mim0yc1Lo4axZj0R37vnxy in0DSffG3z4xd0JK1OY1vhu4kBVIJJxjQqRdXI3dZHxvK1G5B0aTtXJkofSTQT30r5FnXY tVs51Yg5d2j2/7fAkTdfYz2DBoj4nKjH7OWyFhtu5QkJSMy9wq01Tc9K+ZmEGPA/K0d0KS 4WKgNa5ed5lNp20MJvo5+8VcWrT47bykvM5TP/VJY/uDCpKBlQZJhNEUclmrmBTQrgRgwc UiWyPrS05sZksWxBjASAcXdQXaykMlT1TShda+67bHqA6amQG9B0Nv+QzGxz9A== From: Antonin Godard Date: Tue, 20 Jan 2026 16:17:00 +0100 Subject: [PATCH v2 1/5] ref-manual/terms.rst: refresh the Build Directory definition MIME-Version: 1.0 Message-Id: <20260120-terms-refresh-v2-1-fa49d15b209f@bootlin.com> References: <20260120-terms-refresh-v2-0-fa49d15b209f@bootlin.com> In-Reply-To: <20260120-terms-refresh-v2-0-fa49d15b209f@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=4509; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=sVktb6+iylFKBuUGcpgujo8T3WgjkeNMwxB5eFOaT9w=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpb5x0zLtjtn3Uz37z8Gxx/y4bRbDDzIxz25fbb 2dHeLjUTpeJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaW+cdAAKCRDRgEFAKaOo NpMWEADKNPgnjTmSU3BUv20VFC1cfLaUSFn3H6xPEcbvBV2VIOKtoT5G0R2ehzWKGD8Hd137qyz YPPB8KQYdBXldzSu0ji2VS3/hiw+c8ryMuxUKLcj4QIynUWlVuwg0zb9maaZmGyB9jXFMKHjXi0 cf3M8D8oXjioVVeqlzqaHvgl9+VWdtcHfQGEWR1CDg2Fw6ejFifmdY9tImMf4xx4Cv3bp4XLbZB XscrYxy2tSF5KapwTpihGM1oSYtr44+h2m+K8NMxRUg4LFOby5Vd+EprjXOugGjWE4RQQXEw04o mwh6oDzFs2W6t6LdXJGVygUC0r2Jbrv/VAO+sQ5URt3XFxZ/KLyQXUpBn1i02MPTNRdhHa9Zz0y f4IMySFgx9sfTUmYZqHTSqJDEA8NjuEmfEn2wmG2sxWx77hrYiPRPBYsWTm7rlL2YwS0rxrnzva 7cmiPy3lq1RwLNNt+pllMJ5xyUKT9aq7xu3J0AtdhEG3ek8mke7bPqTLjNvEqBoJvbZUL40lShB 9EkCKdnAyoU685wn8cVdvpCCfqwSO6xx8Ws06MjMeyKf+ZqNu8MbiN82X9pR+KQ4xwiGnwOZ1wk l4113Lj9JeTWXhyMIhw+Hw5ALbhhspaGNbSO1LX6OOMW0NWms1itXItdirRV5xefFzrW1ojuhBp 7/uQ1bsyXpmoNsg== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 20 Jan 2026 15:17:17 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8594 After the Poky repository obsolescence, refresh the build directory definition. Fix the formatting and indenting issues while at it. Signed-off-by: Antonin Godard --- documentation/ref-manual/terms.rst | 46 +++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index 6a9f88061..93a2febc7 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst @@ -63,36 +63,39 @@ universal, the list includes them just in case: This term refers to the area used by the OpenEmbedded build system for builds. The area is created when you ``source`` the setup environment script that is found in the Source Directory - (i.e. :ref:`ref-manual/structure:``oe-init-build-env```). The + (i.e. :ref:`ref-manual/structure:``oe-init-build-env```, or + ``init-build-env`` when using :doc:`bitbake-setup + `). The :term:`TOPDIR` variable points to the :term:`Build Directory`. - You have a lot of flexibility when creating the :term:`Build Directory`. + When setting up the build manually (see :doc:`/dev-manual/poky-manual-setup`), + you have a lot of flexibility when creating the :term:`Build Directory`. Here are some examples that show how to create the directory. The - examples assume your :term:`Source Directory` is named ``poky``: + examples assume your :term:`Source Directory` is named ``project``: - - Create the :term:`Build Directory` inside your Source Directory and let - the name of the :term:`Build Directory` default to ``build``: + - Create the :term:`Build Directory` inside your Source Directory and let + the name of the :term:`Build Directory` default to ``build``: - .. code-block:: shell + .. code-block:: console - $ cd poky - $ source oe-init-build-env + $ cd project + $ source layers/openembedded-core/oe-init-build-env - - Create the :term:`Build Directory` inside your home directory and - specifically name it ``test-builds``: + - Or create the :term:`Build Directory` inside your current working + directory and specifically name it ``test-builds``: - .. code-block:: shell + .. code-block:: console - $ source poky/oe-init-build-env test-builds + $ source project/layers/openembedded-core/oe-init-build-env test-builds - - Provide a directory path and specifically name the - :term:`Build Directory`. Any intermediate folders in the pathname - must exist. This next example creates a :term:`Build Directory` - named ``YP-&DISTRO;`` within the existing directory ``mybuilds``: + - Or provide a directory path and specifically name the + :term:`Build Directory`. Any intermediate folders in the pathname + must exist. This next example creates a :term:`Build Directory` + named ``YP-&DISTRO;`` within the existing directory ``mybuilds``: - .. code-block:: shell + .. code-block:: shell - $ source poky/oe-init-build-env mybuilds/YP-&DISTRO; + $ source project/layers/openembedded-core/oe-init-build-env mybuilds/YP-&DISTRO; .. note:: @@ -100,9 +103,10 @@ universal, the list includes them just in case: temporary directory the build system uses for its work. :term:`TMPDIR` cannot be under NFS. Thus, by default, the :term:`Build Directory` cannot be under NFS. However, if you need the :term:`Build Directory` to be under NFS, you can - set this up by setting :term:`TMPDIR` in your ``local.conf`` file to use a local - drive. Doing so effectively separates :term:`TMPDIR` from :term:`TOPDIR`, which is the - :term:`Build Directory`. + set this up by setting :term:`TMPDIR` in your + :ref:`structure-build-conf-site.conf` file to use a local drive. Doing + so effectively separates :term:`TMPDIR` from :term:`TOPDIR`, which is + the :term:`Build Directory`. :term:`Build Host` The system used to build images in a Yocto Project Development From patchwork Tue Jan 20 15:17:01 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 79223 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6F80FD2ED1E for ; Tue, 20 Jan 2026 15:17:17 +0000 (UTC) Received: from smtpout-04.galae.net (smtpout-04.galae.net [185.171.202.116]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.8795.1768922234236819623 for ; Tue, 20 Jan 2026 07:17:14 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=onBYKX2P; spf=pass (domain: bootlin.com, ip: 185.171.202.116, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-04.galae.net (Postfix) with ESMTPS id B8CC4C214F3 for ; Tue, 20 Jan 2026 15:16:44 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id D8D96606AB; Tue, 20 Jan 2026 15:17:11 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 1C23010B6B52A; Tue, 20 Jan 2026 16:17:11 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1768922231; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=QQ0O5MK6PQC8G1VDTxDXBKHLjQtbj7y1QA+tmEEeFDQ=; b=onBYKX2Pk+OB1FOiA76Lxk6BNWWc966yIm99L80xwGXb0JaSqsTsyopQh+fEs2OavHZOcn htYJ1A2hIW/naRwgUokdfM2ScGEkp8TFyVwsujElwBjNmI07R/VvrbT/jYdmjtV71i9U8p 7qcti9Zt+ir9+YEJG4FIJRuI2J699k6pVocgCqSmxgVY+rh3JYQdDWMBSDbqjO8KxQJmD9 VATnra/wZvGdv4CY+njE9zPe2EIetKXLp3ACd+qQFh9jPzVlbv0h6N3zo/ucKSZgT2i43R a+DEufpOGfSEIU/TWr4CBgELyoUo9Tk2kj+10MVeH8oRw3Y5C1Kdsp/qX3501w== From: Antonin Godard Date: Tue, 20 Jan 2026 16:17:01 +0100 Subject: [PATCH v2 2/5] ref-manual/terms.rst: refresh the OpenEmbedded-Core definition MIME-Version: 1.0 Message-Id: <20260120-terms-refresh-v2-2-fa49d15b209f@bootlin.com> References: <20260120-terms-refresh-v2-0-fa49d15b209f@bootlin.com> In-Reply-To: <20260120-terms-refresh-v2-0-fa49d15b209f@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard , Quentin Schulz X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1056; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=tRMAwWRnSk+0/EyXl48WfrY/RLoL03Sesi2v+U+WCcA=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpb5x0vnqSEe0R5akkJUA+ZdSgy9/6oCHpQ7OdI JypnRZ9iVqJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaW+cdAAKCRDRgEFAKaOo NngLD/9PEtQI1yWMelwhKPtA1N0yWPinyb8P1guOVgUJtxDQDqQADcP2qRVfRgXFpuL280pLJPX iCe98CRt4F6LAm/sHSM/WYAJ05TpfralyJmhyb8GMwUYVQdEpkjR39kuJ99qS1Ilw3WxKoIsizN sPcSll+f6Xg/7gLNyuGSJXIJ2KKSUbeMgmLczfUKT49RsffVIXT7XcKDW6Y8q3cDtlZqXLyBtCp ELJtC1YLTgM7FGyJbrmHVNkfvpZMIei+jzin7nT1AruPQxpbwhzhAMGXsLv/nhh5u8LKmNGf849 Xs7F0pUbg97J8FMMR8J0nYhzb0hYItkGQtTxuk+orh4y5ANFLH5vCliyNjofFaJqyOzsCwuawCM GcG7nn3YAy6braqUgDHdoNKRJ3Phm5+q2ouXexE7CHSsGEu4aW+Qf08Z+HSl5a4zWWlk6EDj8Og Maigjq5TjohaSpXrXQwgc3snVwF702aEzmWqgOJ6wPWjTGnKPnvTaj3T01ChbgmO1jgb03n7B/y 2gIP4BajVPXSSqTA2k2n5rmGVM7YgzHXZe6Y5VlmKA31eWu/w38cbcjrFiAaa22B/wBVaJCkG0o QNBwBSfT5aM0AdcMQZLsvbKjFu/3ALUID/cR2NSMM3AkBvK1E9O+vUtNXkUjdDEuS7DEK0QHFgh JB+Zvo42XKMRe9Q== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 20 Jan 2026 15:17:17 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8595 After the Poky repository obsolescence, refresh the OpenEmbedded-Core definition. Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard --- documentation/ref-manual/terms.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index 93a2febc7..d908af4ae 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst @@ -424,8 +424,8 @@ universal, the list includes them just in case: recipes. The result is a tightly controlled and an quality-assured core set of recipes. - You can see the Metadata in the ``meta`` directory of the Yocto - Project :yocto_git:`Source Repositories `. + You can browse the source of :term:`OpenEmbedded-Core (OE-Core)` at + :oe_git:`openembedded-core `. :term:`Package` In the context of the Yocto Project, this term refers to a From patchwork Tue Jan 20 15:17:02 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 79225 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 77441C9830C for ; Tue, 20 Jan 2026 15:17:17 +0000 (UTC) Received: from smtpout-04.galae.net (smtpout-04.galae.net [185.171.202.116]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.8671.1768922234187421018 for ; Tue, 20 Jan 2026 07:17:14 -0800 Authentication-Results: mx.groups.io; dkim=fail reason="dkim: body hash did not verify" header.i=@bootlin.com header.s=dkim header.b=kAXt9si2; spf=pass (domain: bootlin.com, ip: 185.171.202.116, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-04.galae.net (Postfix) with ESMTPS id 4B11EC214F4 for ; Tue, 20 Jan 2026 15:16:45 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 6822D606AB for ; Tue, 20 Jan 2026 15:17:12 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id B6D0410B6B52B; Tue, 20 Jan 2026 16:17:11 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1768922232; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=tOByyDAsSwX+XGjbK0/MYJG3kCEyu6nDkFV9pH0+3uY=; b=kAXt9si2eXZORnD4OHehRT4HmK+//hgT6u7CwbwkgrtYvZihk5vd9V8He/eguq2O1nPz8Y 3IHcChZ+Ktu1PPuLF6MsUPdcwx3UK14otWxh/1Njps8g8cE8iX4AZv0yMIa729wULsuee0 hQ5cm3EzH9f3Qiqf5pRHw8uS42mEXmIW4ThEoH5UKc0KROvTC3ytenKvpvW1LLrVQXdlAP RGkZtf1P+JPFzQZHFCxd4ejj1voxSsjS/JTbyoRs55LbJpETLtSo9Xe/2Ub2D+gIib1EMr 0+WFqViTX7U7tSTOhJYxTJeR/jPzB0Ow1XNMqKIOzRuER0TV7HpiHrZroUUMSQ== From: Antonin Godard Date: Tue, 20 Jan 2026 16:17:02 +0100 Subject: [PATCH v2 3/5] ref-manual/terms.rst: simplify the Source Directory definition MIME-Version: 1.0 Message-Id: <20260120-terms-refresh-v2-3-fa49d15b209f@bootlin.com> References: <20260120-terms-refresh-v2-0-fa49d15b209f@bootlin.com> In-Reply-To: <20260120-terms-refresh-v2-0-fa49d15b209f@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=6441; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=kjrFsq/qqUZuz/BC5qCtae+Nt9GdTMn4jV+W96ug/Q0=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpb5x0cQyrmD5qhZ88/Qn+4eKOkTj7EE2SwJwfG brfS6zRyZCJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaW+cdAAKCRDRgEFAKaOo NngrD/45osdB2VxcfhrpwAF4Fk+1EEhaePiXA+QTaC6MARs1PpCJ6eC+ApRHrW9TZjN9wOuKcho y5cqt2cFBoXcJFopvuS4jqbjUw8PE4o8+EhZOI524ZFoQ8zpln1uJubUtpA0juShRd1w0r/SwuU GWtOxs2QkzVRMYX6LB2ybbl7pe3WXLnkVEjOTt5QlVXiWcNYkudQV8pXTf1jsox69idI0AaavrW GjAIc3bYzxx8fDfMcZ7FpJjGBFR24NmUbS+bz1A9m3XjPHEvyVQR6+7Ale7QRGw1gm73N7qw/9P nvfo6+btFlAE7hsMFqnoKeYGBxiX3zYTrHEhWZrhqdSTRDw4mODDDiUgibqCWy9ksZ/8l87nxtZ q/gPDWRmhXs2oiHH9A7rKRy6Itn8Bf4eS5nEzuyknxPIrqgl/3dBDdS9jgPVSR20cQAmNXG1NF5 X+aM41DX4i6RnxEGGMqdBZYMcYzxywdqY5E9btm+M+PtYPJLz6yfAs0OBIGk7OtChVPuo8jqVjw 952bD9x7KIvHFYL6dAP3G8njW5ClRr3T74I2V410DyFf8ffyTu8Xzr5IUP5U5cNOzGmRmPd4QcM iRAey6v0uXg/czxmK1iQxSLPDj6bfZpo2hVc23z6IwoOR3Iqn+slmVHGFk46hKd4RJAR/Ur5w7v e/kUK7YHZl+nFsQ== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 20 Jan 2026 15:17:17 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8596 Now that we no longer have Poky around, simplify the Source Directory definition: - Make references to existing documents that show how to create this Source Directory. - This directory contains sources, the layout in which they are presented does not matter so much, as it can be different and/or freeform depending on whether we use bitbake-setup or not. The definition chooses "project" as the name of the source directory and is the one that should be used when showing examples in the documentation. A typical Source Directory would look like the following: project/ ├── build/ └── layers/ Other parts of the documentation referencing to this as the Poky repository still have to be updated. This will also mean that this definition will be used a lot less across the documentation: in most cases, when the "Source Directory" is referenced as the Poky repository, it can be replaced by OpenEmbedded-Core, Bitbake, the documentation, or meta-yocto. We'll keep this definition around regardless, as it can be useful to denote this group of directories in a more general sense. Signed-off-by: Antonin Godard --- documentation/ref-manual/terms.rst | 79 +++++++++++++++----------------------- 1 file changed, 31 insertions(+), 48 deletions(-) diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index d908af4ae..ab8eb6123 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst @@ -526,20 +526,36 @@ universal, the list includes them just in case: a software bill of materials`" section of the Development Tasks manual. :term:`Source Directory` - This term refers to the directory structure - created as a result of creating a local copy of the ``poky`` Git - repository ``git://git.yoctoproject.org/poky`` or expanding a - released ``poky`` tarball. + This term refers to the directory structure created as a result of setting + up your environment to build images with the Yocto Project, which can be + done in two ways: - .. note:: + - Using the ``bitbake-setup`` command-line utility (see :doc:`Setting Up + The Environment With bitbake-setup + `). + + - Or manually setting up the :term:`Layers ` (see + :doc:`/dev-manual/poky-manual-setup`). + + In either case, the result will be a set of :term:`Layers ` and a + :term:`Build Directory`: this is the Source Directory for your build. The + documentation usually denotes this directory with the name "project". + + A typical layout for the :term:`Source Directory` would be: + + .. code-block:: text + + project/ + ├── build/ + └── layers/ - Creating a local copy of the - poky - Git repository is the recommended method for setting up your - Source Directory. + Where the ``layers/`` directory corresponds to the directory containing + :term:`layers ` for your project, and the ``build/`` directory + corresponds to the :term:`Build Directory`. - Sometimes you might hear the term "poky directory" used to refer to - this directory structure. + We present a :term:`Source Directory` structure and its components in + details in the :doc:`/ref-manual/structure` section of the Yocto Project + Reference Manual. .. note:: @@ -547,43 +563,10 @@ universal, the list includes them just in case: names that contain spaces. Be sure that the Source Directory you use does not contain these types of names. - The Source Directory contains BitBake, Documentation, Metadata and - other files that all support the Yocto Project. Consequently, you - must have the Source Directory in place on your development system in - order to do any development using the Yocto Project. - - When you create a local copy of the Git repository, you can name the - repository anything you like. Throughout much of the documentation, - "poky" is used as the name of the top-level folder of the local copy - of the poky Git repository. So, for example, cloning the ``poky`` Git - repository results in a local Git repository whose top-level folder - is also named "poky". - - While it is not recommended that you use tarball extraction to set up - the Source Directory, if you do, the top-level directory name of the - Source Directory is derived from the Yocto Project release tarball. - For example, downloading and unpacking poky tarballs from - :yocto_dl:`/releases/yocto/&DISTRO_REL_LATEST_TAG;/` - results in a Source Directory whose root folder is named poky. - - - It is important to understand the differences between the Source - Directory created by unpacking a released tarball as compared to - cloning ``git://git.yoctoproject.org/poky``. When you unpack a - tarball, you have an exact copy of the files based on the time of - release --- a fixed release point. Any changes you make to your local - files in the Source Directory are on top of the release and will - remain local only. On the other hand, when you clone the ``poky`` Git - repository, you have an active development repository with access to - the upstream repository's branches and tags. In this case, any local - changes you make to the local Source Directory can be later applied - to active development branches of the upstream ``poky`` Git - repository. - - For more information on concepts related to Git repositories, - branches, and tags, see the - ":ref:`overview-manual/development-environment:repositories, tags, and branches`" - section in the Yocto Project Overview and Concepts Manual. + The Source Directory contains BitBake, OpenEmbedded-Core (OE-Core), + Documentation, Metadata and other files that all support the Yocto Project. + Consequently, you must have the Source Directory in place on your + development system in order to do any development using the Yocto Project. :term:`SPDX` This term means *Software Package Data Exchange*, and is used as an open From patchwork Tue Jan 20 15:17:03 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 79221 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 52EFAD2ED18 for ; Tue, 20 Jan 2026 15:17:17 +0000 (UTC) Received: from smtpout-04.galae.net (smtpout-04.galae.net [185.171.202.116]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.8796.1768922234713096144 for ; Tue, 20 Jan 2026 07:17:15 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=ah2RaV++; spf=pass (domain: bootlin.com, ip: 185.171.202.116, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-04.galae.net (Postfix) with ESMTPS id E7ED9C214F5 for ; Tue, 20 Jan 2026 15:16:45 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 14C2C606AB for ; Tue, 20 Jan 2026 15:17:13 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 541A610B6B52D; Tue, 20 Jan 2026 16:17:12 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1768922232; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=d+eEuacwsq4PxGxOTGPnBbGtE/rfSDLAOSXACwk4CMA=; b=ah2RaV++YS2BW6QwarJ79aX+l8/bSjpmKSGY4LRADbnJNhfDpA5jlEuT3kZn6bFJfM91Q+ XTRU/X8CkLJtyVWcMLvp02S+7Iq5RppWaxcR5NC9pDQWTXka3kIfOpOk3cxkh3Id3siLnb BCih1J0aD8CSB0pAqaVfN4FojyIzmHwYjzFi44P36zAxt/2QT6t27hvsomzANYfklrDVhK bF5VlnlmO1dd9T3kB8vbHFTGvybhvQ8EfsZjQ+vZ3u1gBNP04Qwe9zUohhewameMnO1bQP qXxHm1uP2dUGFjv0KjqSPlDp7B0UZT+jPYWHvRZNk9dTmXFdP0F1wIzMa/a0VA== From: Antonin Godard Date: Tue, 20 Jan 2026 16:17:03 +0100 Subject: [PATCH v2 4/5] dev-manual/poky-manual-setup.rst: mention the Source Directory MIME-Version: 1.0 Message-Id: <20260120-terms-refresh-v2-4-fa49d15b209f@bootlin.com> References: <20260120-terms-refresh-v2-0-fa49d15b209f@bootlin.com> In-Reply-To: <20260120-terms-refresh-v2-0-fa49d15b209f@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1477; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=iBv+earSHPKCn36BOyId4np6IEWEJXCvhJGP/+G4PoE=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpb5x0jBXMmsL6rH6nYvZtzv3hTr3bNuHLHIc6r OGET/XXxyWJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaW+cdAAKCRDRgEFAKaOo NtYUD/4gHSl03vk4t5l6XPJJKHODncBpSlUzTIsP1V6EatO8EUwpJvilsiDe93tTMIFm1RJY7Em DFIeVJxIFp7VDRpSgM8o+MwR9ywzPeyh4Yek3nUoglX8e1WpnkCpF6Nt6OeMG707pH5O8qIGM+B ETfudgzJtwedZTzYiKM4e6e/wbWoWgRGBTfiZGnQbAqyvOYCf5VxiNSd0l1KcCi8WrEPAbiqXPo uLIWBgsvr6yPSS+zlQ5CT0uUvmm2aDgtM83RECfMNkTCCeSJOAAzdjvJ7HhmcREQcciJ+1mehUZ roaXkixHTcIO77kiRRioMZ8zMcGj7B+D3h8nKKGcfOUNuqpS+eIDwhYUyMROrqkOft0LcOF/BMQ LE58/tPqj8tXDGV7otY1G1VhqhmyHWZSg9AcfgvwqxMmtU+cEslCWcbc4KNRsJRtduOWXM2MaWR GN6horgXTi6pdT4lxH4wpXbuii/8QxiTc0WxtXV1FBUhyY56KLVeq68SnRFceWDjupzYIpKyMDE D3/cvN3Vv28sUn0FVyTxjS3aJkBuVJjxuh6WnPcxkmtvxXQ1VLzPuFOTs32PXRhlJoPqvx1icIP psUx/U64e6xhdHqBR836ujYJYHuLeIPStH4Vx2j5hJ1E9sIx0d8kTWdU0LwLcT/7Stz1/+z+xgz bFZQM78IcfMCBVA== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 20 Jan 2026 15:17:17 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8597 After switching to the new definition of "Source Directory", i.e. the base directory for your project (which used to be poky), mention it in this document on manually setting up the layers for a project. As stated in terms.rst, use "project" for the directory name. Signed-off-by: Antonin Godard Reviewed-by: Quentin Schulz --- documentation/dev-manual/poky-manual-setup.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/documentation/dev-manual/poky-manual-setup.rst b/documentation/dev-manual/poky-manual-setup.rst index bcda9d7e7..9e18dab8e 100644 --- a/documentation/dev-manual/poky-manual-setup.rst +++ b/documentation/dev-manual/poky-manual-setup.rst @@ -22,7 +22,16 @@ release or a Long Term Support release. Once you complete the setup instructions for your machine (see the :doc:`/ref-manual/system-requirements` section of the Yocto Project Reference -Manual), you need to get a copy of the different :term:`layers ` needed +Manual), create a :term:`Source Directory`: the base directory for your project. +Throughout the documentation, we will use ``project`` as the name of the +:term:`Source Directory`. Here's how to create it: + +.. code-block:: console + + $ mkdir project + $ cd project + +You need to get a copy of the different :term:`layers ` needed to setup the :term:`Poky` reference distribution on your build host. Use the following commands: From patchwork Tue Jan 20 15:17:04 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 79224 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 63024D2ED1C for ; Tue, 20 Jan 2026 15:17:17 +0000 (UTC) Received: from smtpout-04.galae.net (smtpout-04.galae.net [185.171.202.116]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.8797.1768922234974256339 for ; Tue, 20 Jan 2026 07:17:15 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=2AO/812/; spf=pass (domain: bootlin.com, ip: 185.171.202.116, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-04.galae.net (Postfix) with ESMTPS id 4ED4EC214F6 for ; Tue, 20 Jan 2026 15:16:46 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 6DADB606AB for ; Tue, 20 Jan 2026 15:17:13 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id DF2B810B6B52E; Tue, 20 Jan 2026 16:17:12 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1768922233; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=3QE/1ZlkCyltlXWKHbSl2Y5F9AL+Tca+2gvYyTCfSJE=; b=2AO/812/EIOVsktbL1RS1gPNAtWT8d2MdqTHleT40cDjbQBnHzwsmR9ZADiRes9cY18b3N uD9hdPUBYHutCYLDX5YWDQcf/V5JCG7/yJCP+ApNV13IUZqmfaBWoAJJyf0291OL3bP44n NBcWSTV+TJEZQPD9r/LD4ZhNqBk830U2UuKzHNlUoMSG/cleyEZOFaQ4aHdAt1lK1qStjU Lu3jQuhgRiHCgGL9ovN++bN5D/xQRhrnMgiz9iNjPvV/z9BMakn7nE0S7i6zapqv9bFHMR Q6wXb/uQKSUQscQf/GMtHUB+A/nZhwTEUVxmigZOi4R1J2ECW9BOolQfU7rOKg== From: Antonin Godard Date: Tue, 20 Jan 2026 16:17:04 +0100 Subject: [PATCH v2 5/5] ref-manual/terms.rst: refresh the OpenEmbedded build system definition MIME-Version: 1.0 Message-Id: <20260120-terms-refresh-v2-5-fa49d15b209f@bootlin.com> References: <20260120-terms-refresh-v2-0-fa49d15b209f@bootlin.com> In-Reply-To: <20260120-terms-refresh-v2-0-fa49d15b209f@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1515; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=7ZsNxJGyxM2js2Se8/QxmlJ3B5RfmIIAHGPuvM7Ew54=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpb5x1waNfZ6Y2htOde7DG2/g1Y7MJQYntCKPst NvRYvXQ9s+JAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaW+cdQAKCRDRgEFAKaOo NpyrD/9+eJCgouzOj94rMgg5XdvDFRZXsSEjIjAzcFpd2S5bCbZGZdQNyrolSTnk+yGWSz8jmH2 xdHgJquNsw6PgXhY+ZEoj8ewodDGtL0Wkuj/J5ek4L+KW9MK4gZB4DEuM859cs4KYg3p6x5vnOV w+FnvEe6dZsXrfo9Z0gibp2/Gp/gQC40KrQOjGonPwfj6yfDMtTSJBj+pjfIvhA5uhdx6gaOAiL CsXGWJu5z4+5oNoEyBXXfsHVEnSdSE/YQnohbWs57yxVs9CsWy3imNLXI0qNwVFLRrk3I6il9no exQMBB/ZuKEobqu7UbD2QOByJYiva25C6V6oCehDHwr2OvplAwQVmikBi6bGWE/c2B8ZfHFHvuW 1p+cy8RUMQQLH291zKFfEfzLxEPDo0LZUjaHlrnVHv8CrTcKVubQvJvOA1FVctxPw5po8kzf9vR k0NqoKTlRj70wvRumcSpP2YR8iD3wslA25H7uRPvjB4/IYp40TKgEbI4kkUNx/R00SMSU98Azeh RvP+RykMvivqy6O0in31X9/4VsbQ6eNbdyO1eGEKmlaOCbB7VlfPp4sxOyHYzs4fZe5ReT7Tzur kWsBnX58uCnds4L6/7tb30l5dDoPbebb0vZ/5BUOt57D+RHJ6r4B68Lu6lf05r+a5rl5R/omSdf zrYTZnSzVyOcqaQ== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 20 Jan 2026 15:17:17 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8598 Remove the mention of Poky containing BitBake, just mention BitBake. Signed-off-by: Antonin Godard Reviewed-by: Quentin Schulz --- documentation/ref-manual/terms.rst | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index ab8eb6123..1e8a9d57d 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst @@ -401,14 +401,11 @@ universal, the list includes them just in case: section for details. :term:`OpenEmbedded Build System` - The build system specific to the Yocto - Project. The OpenEmbedded build system is based on another project - known as "Poky", which uses :term:`BitBake` as the task - executor. Throughout the Yocto Project documentation set, the - OpenEmbedded build system is sometimes referred to simply as "the - build system". If other build systems, such as a host or target build - system are referenced, the documentation clearly states the - difference. + The build system used by the Yocto Project, using :term:`Bitbake` as the + task executor. Throughout the Yocto Project documentation set, the + OpenEmbedded build system is sometimes referred to simply as "the build + system". If other build systems, such as a host or target build system are + referenced, the documentation clearly states the difference. .. note::