From patchwork Wed Dec 24 16:24:16 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 77435 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 C41BFE776C3 for ; Wed, 24 Dec 2025 16:24:52 +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.123569.1766593484392597218 for ; Wed, 24 Dec 2025 08:24:45 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=JojSU2rY; 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 DA6F71A23E1 for ; Wed, 24 Dec 2025 16:24:42 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id B1E846073D for ; Wed, 24 Dec 2025 16:24:42 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 0C78310AB12F3; Wed, 24 Dec 2025 17:24:42 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1766593482; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=s63xbhhn6yaKjxoCFqVDY6i+2BKDpidG2ePugl4G5zY=; b=JojSU2rYW6MEImUMfSweYiv11wnMKcZ8bMQrmiiAS+JJowma3ahEiRVtZz7zHavkChKtPh JW3jM45rzuh8YChS1aOIWuVYINrvWN3BzlCFLg9KgQH3RLKhazlAfzTv+9e2e3Dzaac9E8 GwnSIO5ZcyiDod4K8oiNQLZV08575tFNmXIsylBJFYe5U/NXfcdgarjxlJhw4zRgHnrZKL rkvykqAnaVXhmrAyXtS1rTOPSwySLoyRTCJS0wjRbM3rVtaYFYvcvPw5DCjoJ9d9VpVCUf UU8nkLS0qSAQF+R49ZNCp22ZX0eAM7WyL7o2Qojs54C6CitPrN5zp7J+hLyeYg== From: Antonin Godard Date: Wed, 24 Dec 2025 17:24:16 +0100 Subject: [PATCH 1/5] ref-manual/terms.rst: refresh the Build Directory definition MIME-Version: 1.0 Message-Id: <20251224-terms-refresh-v1-1-691329fd038f@bootlin.com> References: <20251224-terms-refresh-v1-0-691329fd038f@bootlin.com> In-Reply-To: <20251224-terms-refresh-v1-0-691329fd038f@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=4492; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=tjUhkUks3VSzRdpA0ny7RzDmY41+YK1sNBSUkfzh8gI=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpTBPHATQ6/G1iG3cebgX699IAvJ4rLNadUcRua ti/Tu2Qjx6JAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaUwTxwAKCRDRgEFAKaOo NtvSEADA0/nTik2g3d7ZFjwMVDxECeZzqZsMTVRkHUx/FAMfcgfRyM7faVR7hfNrzD4coPFhvub 1l4tOIE2k8tKnhRePMB2nKdGy5/F+3IqHuDa4Jw+Pu/A44yDTmVg+GY5zzkXqIaFuZywGiMwA7N BkQJQyrkPenS/blXApkspbhNfeJQHgR4JUsETp/xwkEfK+9urlXeX6SAVzmbMWslTBN7QhCSGbN j9rT0ZKy6TC+tU8F6RawXUT+BXs/D5NIHMvBa9kgEtEedIXqEpM7RZ5jfuOPeX2gIzKidNXIYrm S9625PF0nBtI8StroXm6/2YGNg2fou92Irx3DRBUHITTkTeSNlA6n8qY8Lc8XR+Nsdi3gnG+zNt uqqv/s0eeLYnuNdgjf+lUTivhs+vMV9mikQAUgUVIv5QZm3CF27vXZVEzwZxWUpLkFaqNzcqGaN q1DtTWPlcdSr9J+M4ili0QOUhwu0yKh6rGJxfJFhSy9FY+ZNszfqwPfyhAj96E1QW37qJ+nt4xn 6Gr7rnaVnx8OCgLCF5eDN0jWiBRSoQcTZdi2D5o37CJ+X/9/0dmjfN8A90aNHyflqwQRJ3yRg93 0Cwokl272zwqM9sX1ZMddFIVUKIOGRIDU7MgJY4mdLwEzwgDi4CBgZL/uEx9E2usg3/GDgnmBQq pJOd9/KaQAqS2/g== 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 ; Wed, 24 Dec 2025 16:24:52 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8323 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..4b9b6ed88 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``: + - Create the :term:`Build Directory` inside your home 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``: + - 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 Wed Dec 24 16:24:17 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 77434 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 D9B0EE776C9 for ; Wed, 24 Dec 2025 16:24:52 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.123070.1766593484926011857 for ; Wed, 24 Dec 2025 08:24:45 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=RU2UYowb; 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 6FF311A23E2 for ; Wed, 24 Dec 2025 16:24:43 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 478FE6073D for ; Wed, 24 Dec 2025 16:24:43 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id A4C3E10AB1359; Wed, 24 Dec 2025 17:24:42 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1766593482; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=bnBr8cqLEtWYHwaz0/sAObM/c9I1Lo7xPcTs3C0Thfk=; b=RU2UYowbCYvn/5E84V7Lo9va6kQm9CW7tMvMtCOxO0/kHxKWVCwRgWQSaNAd4SIJUsj1tm 93f+EmYVKFcAvs8FyEUY9pTCKlBSxss6fXo3caSe1KztuHDZsgXQWDOUx/GAYBdN1+up2K 9ajJo3oJ7tW1nVrIsehPaetVJCriZSZ2oHKXyOwOZWq5SPyPzMcArOc1gdlU1O9+3ythOb M6+aGTEttM2kBZFi63Hx2GqFg3gsMyi7RKZTG3qWDjVNbrYuEhu0oMVQ3AB9BUTjbSJce4 Cn+qRBvCzKHbPqzF4vgaxCDQDRYUsvvgHdgTf7zCZzOkaMy/63TgnFq83Yml+g== From: Antonin Godard Date: Wed, 24 Dec 2025 17:24:17 +0100 Subject: [PATCH 2/5] ref-manual/terms.rst: refresh the OpenEmbedded-Core definition MIME-Version: 1.0 Message-Id: <20251224-terms-refresh-v1-2-691329fd038f@bootlin.com> References: <20251224-terms-refresh-v1-0-691329fd038f@bootlin.com> In-Reply-To: <20251224-terms-refresh-v1-0-691329fd038f@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=1000; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=Mnx2v71iRlXjY29ZI2Y38rMM2M/0gPBopopm431VBvs=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpTBPHcDG496DRHEsrN2LxwxReQW6PuXAbaZSh/ EUDWObg4AuJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaUwTxwAKCRDRgEFAKaOo Nq13EADDjIckeCkenmyTcMV2ciXDr2v8Gwv1LndffVCbebyrnmG5INqkZkXLSn8YsohFJTIFnUz KqY3j0+n6Wb0fhkZtqYNk69KcAeIkp/NgxBNxSo+/oShitQ8Blmc4n7J84S+WEXUvTB5zx0P7pG 9hFCqGn9PiEDTBbXvOrS0xNdrTOn47ZViI0FCIzwS8tKVwqJGkVW9wMwCS4Qj59A5mNbXQACWtC 00i3Ppex2SHESKfiv5i3+6aTPoWPvoU1EkC0R05hXl6fkPF1lLwLyO/dFwx15Y/kN/YWGE4NIRB hpQqm6SA5US7rdCS/e4lpozF+NUvOtJ++lQPzpXNdAlUokfDxFjQhoCrsPqhMY9C5sWHPx2J6YF QmqjJ8ERvhAK3Pcn3CuLWBm0w0ersPzd/bhxsGL1JBUj5L7D21SUv71KGwDv3Ct1QLdIs7WUdeK Y6Uz+uUL7X5+K6b/6btr2Lxwl/eClxNe/9nRvLEF0B4ZWNY63W0Cdn/Vw6Bdqe/PHVJU+3Yj+a9 tLxUtx41rsoSk5yi0K8A8ZFBKm/xPKQqqI3XaWM9qCJZbe+JSXudvTb5rRHk16auqh8uY+YG8w7 ts9OqqYXzDQh/S2kjE1PDv7RqJlaWoci+nj7YW3A10FE01qT4aJPJmghYS/4BccRzhb2XHaOpmH muwhLjpxZxdkDjA== 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 ; Wed, 24 Dec 2025 16:24:52 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8325 After the Poky repository obsolescence, refresh the OpenEmbedded-Core definition. 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 4b9b6ed88..b7a7679ae 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 Wed Dec 24 16:24:18 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 77436 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 E47BDE776CB for ; Wed, 24 Dec 2025 16:24:52 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.123071.1766593485444851778 for ; Wed, 24 Dec 2025 08:24:45 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=HO1ODLW2; 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 EC9421A23E4 for ; Wed, 24 Dec 2025 16:24:43 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id C36556073D for ; Wed, 24 Dec 2025 16:24:43 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 30E3710AB135D; Wed, 24 Dec 2025 17:24:43 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1766593483; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=rEitk5z1VAMYfX30u6WaqEOe1o/j3KaG4m5FNo0ENBI=; b=HO1ODLW2Cf0gaynqB2JOACc/P3tR2DMx1gwhtcNjw9FHIQEFU6P6ejMeB9yh+1p9fdPFPp eyMvBgZ6eR2LeSfrZgOfsSfcAIK/1zFB+CP/kxIC+Xnm2JM1h6bW+bNzGqHQGOTZzvQro9 St58WsjipSB+JTr9Q7iBdrPp/Qxx7muu3TV+aYX6AVY9LXl4ShNGpKATZQt5B2co3ANt7P P89qdmMJD9a63QGFi0OfobB3h/iGa8jn2GlCdb4oS8rCPpSxSEh5PCIkhKa4nLjYTfIDv1 DM/k0MxgOF/u9XvQO3BVkCNFxia737YamGQZ02Fw2d3zg+kASlt9OH/+Rnr+Qw== From: Antonin Godard Date: Wed, 24 Dec 2025 17:24:18 +0100 Subject: [PATCH 3/5] ref-manual/terms.rst: simplify the Source Directory definition MIME-Version: 1.0 Message-Id: <20251224-terms-refresh-v1-3-691329fd038f@bootlin.com> References: <20251224-terms-refresh-v1-0-691329fd038f@bootlin.com> In-Reply-To: <20251224-terms-refresh-v1-0-691329fd038f@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=5914; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=aBApjWJIBSkYBq3VKvk32ebKatNE+tEVei8LMUC0DRo=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpTBPHQOq9bNoaTEPaubdCoZeOJY9TQhCREQ8Fy o7cJeb8c9KJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaUwTxwAKCRDRgEFAKaOo NjP+D/96iBLszei10EDcBJmlMezLwBlK0sZSK0tvNjKaEZcZHJtVipaFN7yCODOV1iUStnlJMpX CP1yvh0q/DQaQdR++VHgYDjG/2Xj4sTvg1zu6FecP38QNR94TbXaTTthdO1DMX8rpaN8FNj22uB 6tY84AI3yhFOFDo3AZcydPEFvmvG5XhJY040bLbsEmBAVveX/wXOtnpdV4LPRPaXndhuDPXGY+n UWF5RSVWfw4l2AZGK+fvk+hlpQiATGLQ7FsWMoZ7p+OKJcyVI6CqGxPyn/va2Fmw+2RRK8lPv25 bea4dR69ycoP6JZJ3mbaDrmxIHgLCm/CnU/sAW5p2OJVVxR1m96zgx9dZuxlscOw1T0W0pA35fc XAirRkRQfCsEl+GwHCjS+coEs245xvSWk6gmqEFdPHDzUI/gEKGJJwv2N9y1tkKf+qcEbl2E3wr ApkPOqP/qwcThpMKinQjOAvUMgJHa+XJ+aQ4B5TmKai1mBzP4EBGTeI9nAqfA2NNCtdHBUJW3GG S2qrj0YjilVEN+MLOtb6KmbcXshaJR0D3zaqqLDZWaTLPYWYqEcGXU+m2OHMTFfA8gU8h2JwvK2 cbxdNuKY7SPMKFX5Gn7wAfTQEO2Z3QiAJh1kGqIEO0VCl1wtRaQl6q2pt7TJouggPQGZl+ml+CI qc4gnmHWg0juSIA== 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 ; Wed, 24 Dec 2025 16:24:52 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8326 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. 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 | 66 +++++++++++--------------------------- 1 file changed, 18 insertions(+), 48 deletions(-) diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index b7a7679ae..21e30de96 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst @@ -526,20 +526,23 @@ 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 + `). + + - Manually setting up the :term:`Layers ` (see + :doc:`/dev-manual/poky-manual-setup`). - Creating a local copy of the - poky - Git repository is the recommended method for setting up your - Source Directory. + 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". - 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 the + :doc:`/ref-manual/structure` section of the Yocto Project Reference Manual. .. note:: @@ -547,43 +550,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 Wed Dec 24 16:24:19 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 77432 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 C7134E776C0 for ; Wed, 24 Dec 2025 16:24:52 +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.123571.1766593486082073174 for ; Wed, 24 Dec 2025 08:24:46 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=Fk7gfncD; 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 90A521A23E5 for ; Wed, 24 Dec 2025 16:24:44 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 68C676073D for ; Wed, 24 Dec 2025 16:24:44 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id AF77410AB1361; Wed, 24 Dec 2025 17:24:43 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1766593484; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=mycUxQGR4nIueQ8liozywLuvHmCSjFFAXHZQZ3aELDo=; b=Fk7gfncDR9OlV1Wxu47K3GIV+1f2XhJ3D936S7NBYhYPSd69olAcRx46h1arVvDU7wn56S 0A1YM2NkFIKUPtNkx8gleJvZcBMdfxzwtLCf5LJLq7888cuyrgtrgau26miZp+0yOSwScd E4MMNVg6ypGt/pDGhvCaeT4xpMDsnM9zpu4YelAMli4TJKu8Uk9yeLfTi+FK/g25vbFL1F dwxQYFMObOfizRK5nxZQlf67Ln5u2yzQEHlDycXCPQ0TPEVYLw1h3J3SdfPh7ozF9UsGQs 2lWmZoQ03zLwdHDmK2eMIDtH9E6tWRo+/nv8STY62XYp8LvtBgv4WDK3pyDYRQ== From: Antonin Godard Date: Wed, 24 Dec 2025 17:24:19 +0100 Subject: [PATCH 4/5] dev-manual/poky-manual-setup.rst: mention the Source Directory MIME-Version: 1.0 Message-Id: <20251224-terms-refresh-v1-4-691329fd038f@bootlin.com> References: <20251224-terms-refresh-v1-0-691329fd038f@bootlin.com> In-Reply-To: <20251224-terms-refresh-v1-0-691329fd038f@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=1404; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=/NHLOlHpjd2FVObLdUgfTk2G4D/nw19z+cO6zo7jM6g=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpTBPIOy2ZmwYgLLOceD7luUt0IXduOe1ks0j28 p/b1ewuTGiJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaUwTyAAKCRDRgEFAKaOo Nk5DD/wKXkoBUOowh+5pjgEFovBSHyXcO1TJeSVh4PT29I+26LZ5Yx1mGDDB+G1y3ESU3FpFT52 OXr/cC1BIgvmB+LWxEMC45GhXBaHOx365h4kSY8Mc0dCVCwCr4XWDH3o7W/0qGSxPXkTwQ58ILR sPEYAappOR2jg0h84nkw7VZZ+GMnk9VcEtejHBf2YWgWEMSl5ff0iYWg2FlEn7jjcM3Tc2Mt5og YFvGv/2PBFGueead/RCguwLbXwoEnnGUHD445VW8AWIjX6blOfUF5VXnJZXyU9h0wVCQhAzOSds +QDdQBDnr2bLQkEKugfldpe4LmCMl6THJxP/kTrM5Lyn9qJruZj1h5jM6wgjs8qyd/cEPvxwAAD EgbzDrNmaDk3Z4qoOrCycZ682RszAiC4E831jYFI1Lqx39fWHUjhAr+1X3tpiQc8TFDuet6iYi+ 7TgU/RJM6nrCJGPcyqohAzN2J5Di2d0WufO+zrKwGVJmujDYJ2K/jKOqR2/xzdmehrf+WfajbBL erSg2nGNNoH80CnGoyUyIG9OMfeNXWyi0Fixs3Q9CDP8mMmfHRKjFt1dJQUIq9JxK7J3RDC+LGW tljCi0rbUoX8j7KvgXJscRcPaCgs05S4hPLRSMl04AirU1j4wfABpnBP52fU03t1CnG893DwwSD rfS435/zWB5ebzA== 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 ; Wed, 24 Dec 2025 16:24:52 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8327 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 --- documentation/dev-manual/poky-manual-setup.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/documentation/dev-manual/poky-manual-setup.rst b/documentation/dev-manual/poky-manual-setup.rst index bcda9d7e7..7ee084007 100644 --- a/documentation/dev-manual/poky-manual-setup.rst +++ b/documentation/dev-manual/poky-manual-setup.rst @@ -22,7 +22,15 @@ 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. +We will name it ``project`` in the following sections: + +.. 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 Wed Dec 24 16:24:20 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 77433 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 D325CE776C5 for ; Wed, 24 Dec 2025 16:24:52 +0000 (UTC) Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.123074.1766593487320622673 for ; Wed, 24 Dec 2025 08:24:47 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=0/nWls4B; 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 24C9D1A23E6 for ; Wed, 24 Dec 2025 16:24:45 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id F17086073D for ; Wed, 24 Dec 2025 16:24:44 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 62ED310AB1362; Wed, 24 Dec 2025 17:24:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1766593484; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=Y2Ed8/m/uZMw1hx7aH/9YMBJmA2IYx4EQXAj3D15/wI=; b=0/nWls4BXD1H9Qb+gN+1GCFC+6awdEmsQYrzpM/ma8fXx6KaFpKiW8LZ9pVfm7p3qJNSk0 afGtMh3+Q7IOT0eXWYFue1VQ9RcEu6MIBP8JHG/qTtEVE3GEFzOVh7jWWH1yBmi3X2Qr6I Z+OnGIyyP6snid86Gagj5gPXEG7VHTxC6HhSLEIZPGvLiBH1Y/soetLdQoI/vMCaippRJG IaIkf1ImcJWk5dqvwX0NlcBmA4Rxqw4fLCAsnhfxgjAlsvCOufBcfglP0+IZuyd3EV6jvN tMmQbEW6U4fymecdQGU7T+GdOcvCZ58f08pINuCorgRY9RBR0xczCYsx/scLDQ== From: Antonin Godard Date: Wed, 24 Dec 2025 17:24:20 +0100 Subject: [PATCH 5/5] ref-manual/terms.rst: refresh the OpenEmbedded build system definition MIME-Version: 1.0 Message-Id: <20251224-terms-refresh-v1-5-691329fd038f@bootlin.com> References: <20251224-terms-refresh-v1-0-691329fd038f@bootlin.com> In-Reply-To: <20251224-terms-refresh-v1-0-691329fd038f@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=1018; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=etSqCmaPWhbWIIrU1ukekyJcBuMkQlVdxTfl0wz8WQo=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBpTBPIYH6vmOp+iov9ai5W4SkyFe6BjJNSxhUX0 H3Tp+kq9JOJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaUwTyAAKCRDRgEFAKaOo NgMOEACn78cxRs1xKC9NeJr6hxFUrcO/mtACoGLcnaNvwlzU/v1OwhdLjX8JbpNBvDLpzg6naKi ULhGp8ecqfgqGmDv6kQGjK0elcDAvWd5ld9PN8SkGJk+DVUfcvQbODGVJimrsgFhWeDs8T6jelT Lwgh4VHlPfN7wrmf4yLJbcFB1dkld8rLvNZkLVQ/9XMzU/H7Up0wfzfECebq7aJrOJqBa3r/1X7 Zqk4OVfyGkIavPihiQCeZat/B+8mliYyOAIYM3gBgBXRpGA+gP1uUz7fP2Z+5UN4RPAlBq/8DSR lY216dDosHDVQJqjh83JMDSpRNn59Cgh3/6AnzCzvbuMfSVCC2pxoB6aIkEmgAc6djds/39eaqL cxLCml83jS7PsmHNqdzJuRLPk67TnlaXg1P3XlM6VefjhuzTMMz8klhWw31ODIx3od+kf61Q1ej YKuGlBiwRceNzEhyaU1LjyfdLLSnc6QZYaOYr/nNe7jXIxFqqc/urcuecebUej1ezG6xqpVCnqC 2L8hikuAUBR+uwd8hJ/57IJ+XdzyjYuXvGjovoM5J90hWAeX8PLbOedbM8OBRCce0LPWKo2+qEz 2SwMq8JvX93qZUEVPmeKzLzcgvdl+XDBIxZAbytJizPFiBA/dvsW7QtNAgIs3wshcSjdoyT5vaU CC+iuGWKaAqu5QQ== 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 ; Wed, 24 Dec 2025 16:24:52 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8328 Remove the mention of Poky containing BitBake, just mention BitBake. Signed-off-by: Antonin Godard --- documentation/ref-manual/terms.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index 21e30de96..ea674eff6 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst @@ -403,7 +403,7 @@ universal, the list includes them just in case: :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 + known as :term:`BitBake` which is 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