diff mbox series

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

Message ID 20251203-doc-file-include-require-v1-2-fc708832b475@cherry.de
State New
Headers show
Series doc: bitbake-user-manual: few fixes related to locating include files | expand

Commit Message

Quentin Schulz Dec. 3, 2025, 5:06 p.m. UTC
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(-)

Comments

Antonin Godard Dec. 4, 2025, 1:16 p.m. UTC | #1
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
diff mbox series

Patch

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