From patchwork Wed Dec 3 17:06:50 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 75808 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 AB401D1BDC1 for ; Wed, 3 Dec 2025 17:07:08 +0000 (UTC) Received: from smtp-42a8.mail.infomaniak.ch (smtp-42a8.mail.infomaniak.ch [84.16.66.168]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.20778.1764781622193153830 for ; Wed, 03 Dec 2025 09:07:03 -0800 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: 0leil.net, ip: 84.16.66.168, mailfrom: foss+yocto@0leil.net) Received: from smtp-3-0001.mail.infomaniak.ch (smtp-3-0001.mail.infomaniak.ch [10.4.36.108]) by smtp-3-3000.mail.infomaniak.ch (Postfix) with ESMTPS id 4dM3w44GHvzKbC; Wed, 3 Dec 2025 18:07:00 +0100 (CET) Received: from unknown by smtp-3-0001.mail.infomaniak.ch (Postfix) with ESMTPA id 4dM3w4199mzJV1; Wed, 3 Dec 2025 18:07:00 +0100 (CET) From: Quentin Schulz Date: Wed, 03 Dec 2025 18:06:50 +0100 Subject: [PATCH 1/3] doc: fix a few typos MIME-Version: 1.0 Message-Id: <20251203-doc-file-include-require-v1-1-fc708832b475@cherry.de> References: <20251203-doc-file-include-require-v1-0-fc708832b475@cherry.de> In-Reply-To: <20251203-doc-file-include-require-v1-0-fc708832b475@cherry.de> To: bitbake-devel@lists.openembedded.org Cc: docs@lists.yoctoproject.org, Quentin Schulz X-Mailer: b4 0.14.3 X-Infomaniak-Routing: alpha 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, 03 Dec 2025 17:07:08 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8202 From: Quentin Schulz Some spurious whitespaces, bad grammar and typo are fixed here. Fixes: 7bd36f6c6d33 ("doc: extend classes and include/require documentation") Signed-off-by: Quentin Schulz --- doc/bitbake-user-manual/bitbake-user-manual-intro.rst | 4 ++-- doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst index 9837b009e..2875e18f3 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst @@ -213,7 +213,7 @@ BitBake supports class files installed in three different directories: - ``classes-global/``: these classes must be inherited globally through the :term:`INHERIT` variable in a :ref:`configuration file - `. These + `. These classes are included for every recipe being built. For example, you would use the global class named ``myclass`` like so:: @@ -227,7 +227,7 @@ BitBake supports class files installed in three different directories: inherit myclass - ``classes/``: this final directory is meant for classes that can be used in - the two contexts explain above. In other words, they can be inherit either + the two contexts explain above. In other words, they can be inherited either globally or in a recipe. For details on how BitBake locates class files, see the diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst index e5075a346..ef8ab024d 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst @@ -1060,7 +1060,7 @@ Additionally, BitBake searches the current directory for :ref:`include .. note:: - The BBPATH variable is analogous to the environment variable PATH . + The BBPATH variable is analogous to the environment variable PATH. For these two directives, BitBake includes the first file it finds. @@ -1135,7 +1135,7 @@ would be searched in this order:: .. note:: - Note that the order of the list above does not depend on where the class in + Note that the order of the list above does not depend on where the class is inherited from. Likewise, for classes inherited with the :term:`INHERIT` variable, the From patchwork Wed Dec 3 17:06:51 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 75809 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 C8587D1BDCC for ; Wed, 3 Dec 2025 17:07:08 +0000 (UTC) Received: from smtp-42a8.mail.infomaniak.ch (smtp-42a8.mail.infomaniak.ch [84.16.66.168]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.20773.1764781622691625910 for ; Wed, 03 Dec 2025 09:07:03 -0800 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: 0leil.net, ip: 84.16.66.168, mailfrom: foss+yocto@0leil.net) Received: from smtp-3-0001.mail.infomaniak.ch (smtp-3-0001.mail.infomaniak.ch [10.4.36.108]) by smtp-3-3000.mail.infomaniak.ch (Postfix) with ESMTPS id 4dM3w50nMJzNGV; Wed, 3 Dec 2025 18:07:01 +0100 (CET) Received: from unknown by smtp-3-0001.mail.infomaniak.ch (Postfix) with ESMTPA id 4dM3w44lYtzHvP; Wed, 3 Dec 2025 18:07:00 +0100 (CET) From: Quentin Schulz Date: Wed, 03 Dec 2025 18:06:51 +0100 Subject: [PATCH 2/3] doc: bitbake-user-manual-intro: specify inherit_defer directive for recipe classes MIME-Version: 1.0 Message-Id: <20251203-doc-file-include-require-v1-2-fc708832b475@cherry.de> References: <20251203-doc-file-include-require-v1-0-fc708832b475@cherry.de> In-Reply-To: <20251203-doc-file-include-require-v1-0-fc708832b475@cherry.de> To: bitbake-devel@lists.openembedded.org Cc: docs@lists.yoctoproject.org, Quentin Schulz X-Mailer: b4 0.14.3 X-Infomaniak-Routing: alpha 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, 03 Dec 2025 17:07:08 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8203 From: Quentin Schulz We specify the recipe classes must be used with inherit but they can actually also be used with inherit_defer directive so let's make that clear. Fixes: 7bd36f6c6d33 ("doc: extend classes and include/require documentation") Signed-off-by: Quentin Schulz --- doc/bitbake-user-manual/bitbake-user-manual-intro.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst index 2875e18f3..329b02829 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst @@ -220,9 +220,10 @@ BitBake supports class files installed in three different directories: INHERIT += "myclass" - ``classes-recipe/``: these classes must be inherited from a recipe using the - :ref:`inherit ` directive. They do - not support being inherited globally. For example, you would use the recipe - class named ``myclass`` like so:: + :ref:`inherit ` or + :ref:`inherit_defer ` + directive. They do not support being inherited globally. For example, you + would use the recipe class named ``myclass`` like so:: inherit myclass From patchwork Wed Dec 3 17:06:52 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 75807 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 9CB44D15DBC for ; Wed, 3 Dec 2025 17:07:08 +0000 (UTC) Received: from smtp-8fac.mail.infomaniak.ch (smtp-8fac.mail.infomaniak.ch [83.166.143.172]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.20774.1764781623116120309 for ; Wed, 03 Dec 2025 09:07:03 -0800 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: 0leil.net, ip: 83.166.143.172, mailfrom: foss+yocto@0leil.net) Received: from smtp-3-0001.mail.infomaniak.ch (smtp-3-0001.mail.infomaniak.ch [10.4.36.108]) by smtp-3-3000.mail.infomaniak.ch (Postfix) with ESMTPS id 4dM3w53pCrzN4f; Wed, 3 Dec 2025 18:07:01 +0100 (CET) Received: from unknown by smtp-3-0001.mail.infomaniak.ch (Postfix) with ESMTPA id 4dM3w50qrnzJ5n; Wed, 3 Dec 2025 18:07:01 +0100 (CET) From: Quentin Schulz Date: Wed, 03 Dec 2025 18:06:52 +0100 Subject: [PATCH 3/3] doc: bitbake-user-manual-metadata: reorder introduction on how to locate include files MIME-Version: 1.0 Message-Id: <20251203-doc-file-include-require-v1-3-fc708832b475@cherry.de> References: <20251203-doc-file-include-require-v1-0-fc708832b475@cherry.de> In-Reply-To: <20251203-doc-file-include-require-v1-0-fc708832b475@cherry.de> To: bitbake-devel@lists.openembedded.org Cc: docs@lists.yoctoproject.org, Quentin Schulz X-Mailer: b4 0.14.3 X-Infomaniak-Routing: alpha 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, 03 Dec 2025 17:07:08 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8205 From: Quentin Schulz BitBake first searches the relative to the local directory before going through BBPATH. Fixes: 7bd36f6c6d33 ("doc: extend classes and include/require documentation") Signed-off-by: Quentin Schulz --- doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst index ef8ab024d..ef401d4ab 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst @@ -1054,9 +1054,10 @@ bitbake will treat that as direct value assignment in its configuration:: Locating Include Files ---------------------- -BitBake uses the :term:`BBPATH` variable to locate needed include files. -Additionally, BitBake searches the current directory for :ref:`include -` and :ref:`require ` directives. +BitBake first searches the current directory for needed include files for +:ref:`include ` and :ref:`require ` +directives. +BitBake also uses the :term:`BBPATH` variable. .. note::