From patchwork Fri Jan 23 14:58:11 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 79509 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 7A747D74EE2 for ; Fri, 23 Jan 2026 14:58:29 +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.69974.1769180305092227973 for ; Fri, 23 Jan 2026 06:58:26 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=1pcLDWmk; 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 73EE64E42221 for ; Fri, 23 Jan 2026 14:58:23 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 499046070A for ; Fri, 23 Jan 2026 14:58:23 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id A1AC7119A8547; Fri, 23 Jan 2026 15:58:22 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1769180302; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=KGDL8Tri+XFXdl/FkDG17qOugNyn3OdcXB0ZPdfmBGc=; b=1pcLDWmkw4WvUlNlNKTGcYzr7zCwbhgG6DGCDwGhN8kl4mrSI7xrMipJCBYK2o1Ejo80Q1 4Mxaf/G66bXf4ARYTLk0PPb/RbUYOKptzjgeIHky8D9RTZXoKQXnF67Vj4BDm7gjVTClY+ 9W+ozJf7Ljad9MJd159uLNpLjEDh7t3SQEfXFm1KK3nIgin3ffR/Ov8WBGQj04cv0OWfvH DWln+H3SVC28neIpG4jfqqR5OyoNwFu7OXXShMHNz5kYnU8XCQNgH96Yw+l70/YPcdEIdh 37Va1um8S52ogWcDWn8qQ956ADkpk7+UA6mkasRtEVa6czqVe6WMBS7AfLYJxA== From: Antonin Godard Date: Fri, 23 Jan 2026 15:58:11 +0100 Subject: [PATCH v3 1/5] ref-manual/terms.rst: refresh the Build Directory definition MIME-Version: 1.0 Message-Id: <20260123-terms-refresh-v3-1-41c35f0a6a13@bootlin.com> References: <20260123-terms-refresh-v3-0-41c35f0a6a13@bootlin.com> In-Reply-To: <20260123-terms-refresh-v3-0-41c35f0a6a13@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=4527; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=ybka8j/Wa2/gbPJd80jLUxyeH8JiKn0o2HFMwHy9BHs=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpc4yMHK2yaBwx+K9CUWi2PNhZRZb0TviT91RGx ki1tVYJgniJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaXOMjAAKCRDRgEFAKaOo Nk7xD/9uHV5x2knWwFeoGsNISZXRu49Zf1PHJKkkHkcBM2dGES3ESYXbEsZzxfaJqPQI2mhnGzr Zr3Txtq16lQNTpKHKgzbPSRxaVTBVlX+mxdK7hSfwsvusbcEdiVubp7vSn3LjkihL9ctAQuuQNJ 2pBFHT/Iaqylu+4elnvDGr6lPOuEcjOAn8PQCV4TXfrK3gvQyOTcR+qZ6u3lZZLqSVujyc4jhEt MicUWS1gXIy3KaKYRh4B3O0tkCjVmjcBN80XLMsnKS+d2kDhZzRA4w8k7boscA8Ee/pE6DRZU2P oBambpBpNQQ5P56ZlozWH1Vsg3eAUQdlk12UGM6eZVlPYcUibBbeL8EHxYfWbGd+OE5bQyyY+xF ydUq204DfGCgMIAYtZVf1qSlofTXf3QhiJ4WgkoE22r7RJp75x4NTopTGE15jbPrwKLvmObNRyV 7+8rM8Sk+LhTl2Cc2+NGxtDbk6sOjsyARdU1cRdMBfDiNEd1eNlRKCTqSpcL6ReBhIS2bmynWgr tPjtnC1mgcn5T6KYAlHx1scI2PCJPkmc+5431CVRUzyf6FL4+P7XiZSXP7/i8kb4TFKaP8sYGIZ 9ZXUO0TN5UxE/UBtQ4MmB5oLFOWjayc7VjE8zN34FZwz81aG+X1/cgJ7+2Envvi6CGIhRy3YWpx 8H5OgCqbn6em7Ww== 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 ; Fri, 23 Jan 2026 14:58:29 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8640 After the Poky repository obsolescence, refresh the build directory definition. Fix the formatting and indenting issues while at it. Signed-off-by: Antonin Godard Reviewed-by: Quentin Schulz --- 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..fe68b41af 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 ``bitbake-builds``: - - 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 bitbake-builds + $ source layers/openembedded-core/oe-init-build-env - - Create the :term:`Build Directory` inside your home directory and - specifically name it ``test-builds``: + - Or provide a path to the :term:`Build Directory` when sourcing + ``oe-init-build-env``. 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 test-builds + $ source bitbake-builds/layers/openembedded-core/oe-init-build-env mybuilds/YP-&DISTRO; - - 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``: + This path can also be an absolute path and be outside of the current + working directory: - .. code-block:: shell + .. code-block:: console - $ source poky/oe-init-build-env mybuilds/YP-&DISTRO; + $ source bitbake-builds/layers/openembedded-core/oe-init-build-env /opt/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 Fri Jan 23 14:58:12 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 79511 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 88A49D74EE4 for ; Fri, 23 Jan 2026 14:58:29 +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.69573.1769180306350404486 for ; Fri, 23 Jan 2026 06:58:27 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=HDVPx5Rr; 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 93C31C21ABF for ; Fri, 23 Jan 2026 14:58:24 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 42CEF6070A; Fri, 23 Jan 2026 14:58:24 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 43752119A8720; Fri, 23 Jan 2026 15:58:23 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1769180303; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=HBwrqhUydk3Kh9YxEImM7fTYvHtucodHFjO6qPOrwLc=; b=HDVPx5Rr3btHgiK7KTtHuhswIN7P4Ix7z8rQcwty3ryyiFYTt9Vt5WH58h+Q2cS7yZpxh2 XDMse+AyeaAizr/UnlE7z1cupp0N5YyEfHqBvmUYXepZw/+uFUCK5+pygWQ8Qy8jaP+agg vcRRI7L2W4b/BnhGn4AZK62tz2L1I8SRKPe0zcV0M+36ScRASevFMKX9bfVTz381DZp+pC 6WRg80gkvXkbycAfd3w45aHcRDYITz5UbpZmsrMiuzohloIFktYrx+DsZvDFeE8mvDC4PL S0uC+SQR++iFL8htH+Se6JB/x3CzR9gHQG2zIuYDsZRuEhfoTW/DdKjr1tPzAg== From: Antonin Godard Date: Fri, 23 Jan 2026 15:58:12 +0100 Subject: [PATCH v3 2/5] ref-manual/terms.rst: refresh the OpenEmbedded-Core definition MIME-Version: 1.0 Message-Id: <20260123-terms-refresh-v3-2-41c35f0a6a13@bootlin.com> References: <20260123-terms-refresh-v3-0-41c35f0a6a13@bootlin.com> In-Reply-To: <20260123-terms-refresh-v3-0-41c35f0a6a13@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=O0FQHC18RgTMkLH2zn4KhaOc+fQPzShxuOAWjyUzkfE=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpc4yMTLnsOU3bhXcOanCLCYJu19D9yjXwFK2wY ixfe22VNsmJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaXOMjAAKCRDRgEFAKaOo NqM/EADOcTLaGz2Qpt0QvOLcta/lNfG369oo5GVQHF6h2VGq3tWYbZRCHp8X1qko/vCTBmsFzVx nEFZgukmBZUYhscbwf8R146L1aZHF1QWqi15TWNaSSw0iY3JhxPXnyCDA4w7F4oVM3XLMAe/l/6 eKa6nXBU54Q3qE4yKuTpHc9V3kxcpXTHPOPUuWncwpXki9wELI7pMu55WnT6r7LcwarKNkx/Nu2 beoLbUlJLynH9Z272q1drz2lGAT9wHXOvn8noG+sFQkcqHWuovUzk1i4mItl2JLB5w+dtjeDAf6 x6DmZNtHYh2UqjVZrTNp4AOlI+ybxKphTRKM5JVB3/7EOxoy42D9DQ/vzgCIBzL/CDfrxG1RW29 rWa4FjQNBxa6WS+717HHPF1E+YVeR32DogQwlZIOXa1TN32nCwglp1lBpuAPmUSg7wZAwx5UCIF QNZaPNq08ZOfdzStBjz8/47Ef+nsNrniNmim+/zJf5GCcaFeFiZ0zmrn+ZKBkjsO/1UidyivZNt f8C0LVXspbxR1tlwl9IwlxdAl4vJjFZf6T+tKbZ0yImkjyKLJtTGj4abmLJHWu0lZLhzbj54vTn t87VblQ1Vebj3bcNZyq6iHxSDqWcAs+SXrbz7BtkoD9rcwtQ4N0ax8TfD7TAphPNye+9vZVCJxe tirvOVCJg4HG2jw== 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 ; Fri, 23 Jan 2026 14:58:29 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8642 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 fe68b41af..8e07b71ba 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 Fri Jan 23 14:58:13 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 79512 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 94D0CD74EE9 for ; Fri, 23 Jan 2026 14:58:29 +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.69572.1769180306350149643 for ; Fri, 23 Jan 2026 06:58:27 -0800 Authentication-Results: mx.groups.io; dkim=fail reason="dkim: body hash did not verify" header.i=@bootlin.com header.s=dkim header.b=A5LJ7qAM; 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 F08DCC214FC for ; Fri, 23 Jan 2026 14:58:24 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id ABBB36070A for ; Fri, 23 Jan 2026 14:58:24 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 1FA24119A87A7; Fri, 23 Jan 2026 15:58:24 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1769180304; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=ilTmjfve4nfDUynOP6YAsNrjbfa17iiMf/Q/z3T41YU=; b=A5LJ7qAMw8PD7nd7+FDfLVfGiTN7O7fHiYi6nGcuXMSbczIuspxBt7iDSL7r7AYtSz92hL Ko9Eciw8zeRpSQjAUVQSVmKbnl/81FSMRKzlN6RX8tLxnAa7K+VFeL0sR+8+RZGY6UxqdA tZt5bmpiTUpHTx2hv0WEd6lCdyHP1/SrrBNJ70A00IS5v2emznwf3Qe7VnZKmNXFby31aO Ic0NJ2yoeCIHa0nySJtFFb0zNhayxmu/xX0Ke+aHJHcej2urEh62j6NUDOy8MLN3pAzBGT PaeeYhqk5k5g+NPNEtogUbtolZkSRBDrXotq5Q7Yr3T8Cd0Om1ckhEVBWtobkQ== From: Antonin Godard Date: Fri, 23 Jan 2026 15:58:13 +0100 Subject: [PATCH v3 3/5] ref-manual/terms.rst: simplify the Source Directory definition MIME-Version: 1.0 Message-Id: <20260123-terms-refresh-v3-3-41c35f0a6a13@bootlin.com> References: <20260123-terms-refresh-v3-0-41c35f0a6a13@bootlin.com> In-Reply-To: <20260123-terms-refresh-v3-0-41c35f0a6a13@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=6434; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=wjr3JGSDNcunYwJZKU0dpqcwwSp/cqTpiS7c6UMfjaI=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpc4yMGChzrEpZwTUyJx3sC4ocGYiH4aiv3Tk0J LwXXn+9tqeJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaXOMjAAKCRDRgEFAKaOo NlZ0D/4pr8MT6G+ivjWom5BqXhIaLqI2w0jv5xWnDK3HNIVEcUgOeVTlg2ii/DrgNoKSMceLoxI cz1ceJU5wexqyv2nZKtpP6yfZ7vVTtFXQsuazKZZx06OowXIg+HxIfuSs0L0bp61maMYUXndovT dci8j3zIQsQgOG7s1pv9VXjuYN8maQ1ErdQyadVAPTBTSgOvggaJ8ahiWmyiKuuIAzHQ5mg2BJZ JSv67NZ2y4YU5g+T4espnoDYZ68lsHfKEgt7RzzYXJZb/FclF6/+5hZR3S/wJNMi3wfEE20ohkC tW/9mOAQUh52u6oesAEYr20oeWcizSutX0p1JcYMrQBMTCQHQDLO4MnuL2IZc8luBjDRPgX0cAr GTKwAynbrp1wKH9Rj0oDyxIx+652+1SCIEZjnWcvjmM/qevutKqKhnInmo4cUdVY2w/TGqIc1J/ oYrO9zow90lz+ZDfLEL+2aVpSRWGkGFTFaM7WubvnzGkg4NII+/KVXpOqqpbzXnjFbyLIOFY04S BeHfrDTARfQvtkrAPf6h6a13qFVD5C8pkc+nj8Y6cCj6qfoSD2acwoPwQVXH5HTt8+jV3y14UcI Jil+1rsDJcI8mSunKTM3mka/hK/AoK7gBkahU/N4JnOjHpNZjr4pp5mL5t3C8qApnJoIASXuubs +ioqE/KGFUTxuAA== 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 ; Fri, 23 Jan 2026 14:58:29 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8643 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 Reviewed-by: Quentin Schulz --- documentation/ref-manual/terms.rst | 80 +++++++++++++++----------------------- 1 file changed, 32 insertions(+), 48 deletions(-) diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index 8e07b71ba..d384b5bbe 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 "bitbake-builds". + + A typical layout for the :term:`Source Directory` would be: - Creating a local copy of the - poky - Git repository is the recommended method for setting up your - Source Directory. + .. code-block:: text - Sometimes you might hear the term "poky directory" used to refer to - this directory structure. + bitbake-builds/ + ├── build/ + └── layers/ + + Where the ``layers/`` directory corresponds to the directory containing + :term:`layers ` for your project, and the ``build/`` directory + corresponds to the :term:`Build Directory`. + + 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,11 @@ 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), + 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 Fri Jan 23 14:58:14 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 79508 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 7A787D74EE3 for ; Fri, 23 Jan 2026 14:58:29 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.69574.1769180307432056386 for ; Fri, 23 Jan 2026 06:58:27 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=Fl/BNRl1; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id EF7191A2A37 for ; Fri, 23 Jan 2026 14:58:25 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id C67306070A; Fri, 23 Jan 2026 14:58:25 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id DCE7F119A87BC; Fri, 23 Jan 2026 15:58:24 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1769180305; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=9pif0IfN9QpMiKlAVSdS2NNlTe9rlrwEPQ7pWL32SSo=; b=Fl/BNRl1rNW+mUZLc4SJzFbfMf6mN8i1N6G4fNgNGUv5mOVThknA1CMcRuGzBcwl52AaIv k5AswqZxjoVoZUCFrt9Kk7FUrp9qY60m9UeKtTvA3xN3/sXZ6LWRNXBf2cYnKdKtTp6rae qCsWmlbrlwG8oNX1MGpxG5R/xuapbkoqJ/GBEOWrSCgTuiah1Y1pQz5zmO55BqGpaZdDjA snZBCvoQQKRf5nZNnTqI313q8b2QeynK1WD5vjeV2XI+QVSjeLosOrzfxiU0G86uBrMfXa xvovIfWVrDalnlLlnWlXZS7uf0tvebTPbX0T13MRHLBIr6l6JzTN7fiSLdOUeA== From: Antonin Godard Date: Fri, 23 Jan 2026 15:58:14 +0100 Subject: [PATCH v3 4/5] dev-manual/poky-manual-setup.rst: mention the Source Directory MIME-Version: 1.0 Message-Id: <20260123-terms-refresh-v3-4-41c35f0a6a13@bootlin.com> References: <20260123-terms-refresh-v3-0-41c35f0a6a13@bootlin.com> In-Reply-To: <20260123-terms-refresh-v3-0-41c35f0a6a13@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=1554; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=xZ6P3pz27eY22XlriTdrCFyYnXYE4aDCs4F/JmCiWR8=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpc4yMFjNh01Ppq8sR1ASqUF+VtSdfm3CLb60eV 8L0F+qeo2OJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaXOMjAAKCRDRgEFAKaOo NvOYD/4t+/1AUPDLnIJH0S93FKbWo4/iIPUzA62kCsRXEjMsYKs0gUihZTbsZQsOlZ7cX3yNgwS iI7Hu/N85mRatKB/TZ+J5daV4f9c0ZvPr7ME9RQ1SPOY2qD0TU3eiqQ7wzp9M6+XtrpQxEeglyG BacarRywfjzh+967KLtbIstiMYPbEbidiBKdXI5z/fF+5LDlxABHEjso6H6KQePaApPjJFRg80n m6rPdHc/GNmg0UvofGw/besqJhokZOhgUKwh20+XSo7w0ob3Bt3njcq53nKn5PBKm1tzw5QovzU J9Ia6TbSqy5dvkl8wJYE4TjmfL7h9+jv4IYOA2mWvqsn4ZSw94iS+QAC+na6fsqGBWlOKxerMZQ okUGryIGuYK6tQiR+oF804Y/SrDIiLpQx53YlwPTG0TotLuRT2XjQ+I59PWbCQ3qj2Rg5mHRXs7 E2P975OEC6UVkHaT7rmqxO/y7BsDmILv/5itqx0jpvH47oKwQgyqmnwpszfBB1K5Jf5suCXUdrF yyhrK2F3Lg1cQ7orVfPs11k4xdb6a/h0tSI+6lRzHc6ybych/dayO3gMLEkrvYsvuaLiiStTTws ivVT1+RZkvK0fj3DiIkybnmDve4LHZpDOKI0nIh4bEPz7ryahLlaUbRg2wxV9EVOdR4NU+RtVPv U94y7lHsmnpa5MA== 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 ; Fri, 23 Jan 2026 14:58:29 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8644 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. Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard --- 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..4bc9b97b6 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 ``bitbake-builds`` as the name of the +:term:`Source Directory`. Here's how to create it: + +.. code-block:: console + + $ mkdir bitbake-builds + $ cd bitbake-builds + +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 Fri Jan 23 14:58:15 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 79510 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 9AF7BD74EE7 for ; Fri, 23 Jan 2026 14:58:29 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.69575.1769180308173255136 for ; Fri, 23 Jan 2026 06:58:28 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=i+Mt6vJG; 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 A84B24E4221C; Fri, 23 Jan 2026 14:58:26 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 7E1786070A; Fri, 23 Jan 2026 14:58:26 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 9EB57119A8547; Fri, 23 Jan 2026 15:58:25 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1769180306; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=aUntCg+7DYzH5SkGo1H3mT/RtIgVyVxKixQ1aH5dd7Q=; b=i+Mt6vJGEL0t6HXxj4uIKOaLBFnHScrC3HgkkEODp6f0ecJgOOTnq0cM+iHdRNspAOw5Ic aTMP0jJYLTvyQCsS6eKGj0uRQ4E+W5FhSbKWq9ZrOiYh773HqGkEvTvJZSXgo/KXwcRxZK PBwqPINVLZvYSxsCh/YKnOFf3g+4f6KlkucexEfRAMWcnzrlhyPqJIqB1Ka1T5vHnjb7Sa ia7yaUnSovigDoRWPmLDoIKiegtD3XpSfaYRaCNW2erMaH7xGPn28Bn4XINe+3qgA3jETh 1snKEPfXkofEtZ+wDvhp0Rru/GL795NJAFWe+fyIc+Dn4gOyAoMi3TUq/ddQ4g== From: Antonin Godard Date: Fri, 23 Jan 2026 15:58:15 +0100 Subject: [PATCH v3 5/5] ref-manual/terms.rst: refresh the OpenEmbedded build system definition MIME-Version: 1.0 Message-Id: <20260123-terms-refresh-v3-5-41c35f0a6a13@bootlin.com> References: <20260123-terms-refresh-v3-0-41c35f0a6a13@bootlin.com> In-Reply-To: <20260123-terms-refresh-v3-0-41c35f0a6a13@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=1567; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=HjO0dODpHfqUO5O9s4GdjPtuReYBNL2L3gLgkqMdRPM=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpc4yMDnO52wayXsMaybfvWrh59tyB062GbGigx ZjScU7hxJCJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaXOMjAAKCRDRgEFAKaOo NuFrD/9Yyp75+3d3cYKFeeMFIJZZn880fcFIwggjZ0GGxQP9kXZtmCDNq40Dak2GoO1cpvJoN6w YbhIG/uERXThxqrzDjktrYU9FVlm0OhXWEXQVMiQcpRaTEdvoytT9MIr9tEEbhQsIYWXTLORYqd 5PkKhCPkCKISIIZx/Z3Wko+RXymCmNhQLlQh26FeIZAeujfoOvTa6gLhx/Kgq3lm2lIYOtwrWnQ /c2fRyy6lOqUXGUD7b55dZTdFPiBZ7BXoR6lRs2RI28Ce2tYX3BBLdmQadfb7AGR33i2MYBxQOW j36BgOka9c0Guf+4dyDXqtkn5uYedJ7h50lAPvlnJeGOsxjEAdpdGAtzLI6d+nIEyEqDLzUJm7w HlqMhURZQIlWSWzCn4FiuHsn2EEYW8sYv43L/jQ3fMEHCkAuKU3w2mv75QWkB1z0gn199FQr/ph 6losmSQb9azmnGx1WHLNJFfJueP1KaaVpXuLBlQtkjcDqQgv/H5Us1k2MIndMiQVY0gfgOsuyw0 ALDJ8BIyRD467xfISMF95/Er/eVDoV9814h/mQeUmAfTDczMBsNKppiydkKx6e46LvJHtwnGv2m ol4EAxtl2uqCauhydKHs6fU5zgMUWzmkSiIMtzQi9xGc9u7TLbwVS3guL0tGptZRbv9ySqBjj0l fVlP4PIEGcjcTXA== 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 ; Fri, 23 Jan 2026 14:58:29 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8645 Remove the mention of Poky containing BitBake, just mention BitBake. Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard --- 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 d384b5bbe..e7b781d35 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, 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::