[PATCH 0/3] doc: bitbake-user-manual: few fixes related to locating include files

[PATCH 0/3] doc: bitbake-user-manual: few fixes related to locating include files

[Quentin Schulz]

This fixes a few oversight, reorder paragraph about the file location
search paths and specify inherit_defer can be used for classes too.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
Quentin Schulz (3):
      doc: fix a few typos
      doc: bitbake-user-manual-intro: specify inherit_defer directive for recipe classes
      doc: bitbake-user-manual-metadata: reorder introduction on how to locate include files

 doc/bitbake-user-manual/bitbake-user-manual-intro.rst    | 11 ++++++-----
 doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 11 ++++++-----
 2 files changed, 12 insertions(+), 10 deletions(-)
---
base-commit: 720df1a53452983c1c832f624490e255cf389204
change-id: 20251203-doc-file-include-require-f260460d0416

Best regards,
-- 
Quentin Schulz <quentin.schulz@cherry.de>

[PATCH 1/3] doc: fix a few typos

[Quentin Schulz]

From: Quentin Schulz <quentin.schulz@cherry.de>

Some spurious whitespaces, bad grammar and typo are fixed here.

Fixes: 7bd36f6c6d33 ("doc: extend classes and include/require documentation")
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 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
-   <bitbake-user-manual/bitbake-user-manual-intro:Configuration Files>`.  These
+   <bitbake-user-manual/bitbake-user-manual-intro:Configuration Files>`. 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

-- 
2.52.0

Re: [docs] [PATCH 1/3] doc: fix a few typos

[Antonin Godard]

On Wed Dec 3, 2025 at 6:06 PM CET, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@cherry.de>
>
> Some spurious whitespaces, bad grammar and typo are fixed here.
>
> Fixes: 7bd36f6c6d33 ("doc: extend classes and include/require documentation")
> Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
> ---
>  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
> -   <bitbake-user-manual/bitbake-user-manual-intro:Configuration Files>`.  These
> +   <bitbake-user-manual/bitbake-user-manual-intro:Configuration Files>`. 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

Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>

Thank you!
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

[PATCH 2/3] doc: bitbake-user-manual-intro: specify inherit_defer directive for recipe classes

[Quentin Schulz]

From: Quentin Schulz <quentin.schulz@cherry.de>

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 <quentin.schulz@cherry.de>
---
 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 <ref-bitbake-user-manual-metadata-inherit>` directive. They do
-   not support being inherited globally. For example, you would use the recipe
-   class named ``myclass`` like so::
+   :ref:`inherit <ref-bitbake-user-manual-metadata-inherit>` or
+   :ref:`inherit_defer <ref-bitbake-user-manual-metadata-inherit-defer>`
+   directive. They do not support being inherited globally. For example, you
+   would use the recipe class named ``myclass`` like so::
 
       inherit myclass
 

-- 
2.52.0

Re: [docs] [PATCH 2/3] doc: bitbake-user-manual-intro: specify inherit_defer directive for recipe classes

[Antonin Godard]

On Wed Dec 3, 2025 at 6:06 PM CET, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@cherry.de>
>
> 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 <quentin.schulz@cherry.de>
> ---
>  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 <ref-bitbake-user-manual-metadata-inherit>` directive. They do
> -   not support being inherited globally. For example, you would use the recipe
> -   class named ``myclass`` like so::
> +   :ref:`inherit <ref-bitbake-user-manual-metadata-inherit>` or
> +   :ref:`inherit_defer <ref-bitbake-user-manual-metadata-inherit-defer>`
> +   directive. They do not support being inherited globally. For example, you
> +   would use the recipe class named ``myclass`` like so::
>  
>        inherit myclass
>  

Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>

Thank you!
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

[PATCH 3/3] doc: bitbake-user-manual-metadata: reorder introduction on how to locate include files

[Quentin Schulz]

From: Quentin Schulz <quentin.schulz@cherry.de>

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 <quentin.schulz@cherry.de>
---
 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
-<ref-include-directive>` and :ref:`require <require-inclusion>` directives.
+BitBake first searches the current directory for needed include files for
+:ref:`include <ref-include-directive>` and :ref:`require <require-inclusion>`
+directives.
+BitBake also uses the :term:`BBPATH` variable.
 
 .. note::
 

-- 
2.52.0

Re: [docs] [PATCH 3/3] doc: bitbake-user-manual-metadata: reorder introduction on how to locate include files

[Antonin Godard]

On Wed Dec 3, 2025 at 6:06 PM CET, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@cherry.de>
>
> 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 <quentin.schulz@cherry.de>
> ---
>  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
> -<ref-include-directive>` and :ref:`require <require-inclusion>` directives.
> +BitBake first searches the current directory for needed include files for
> +:ref:`include <ref-include-directive>` and :ref:`require <require-inclusion>`
> +directives.
> +BitBake also uses the :term:`BBPATH` variable.
>  
>  .. note::
>  

Yes, and it's even clearly shown in the example that follows...

Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>

Thank you!
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com