Re: [docs][PATCH 1/2] ref-manual/classes.rst: add details about actions done by base.bbclass

["Antonin Godard" <antonin.godard@bootlin.com>]

On Sun Sep 21, 2025 at 6:43 PM CEST, BELHADJ SALEM Talel via lists.yoctoproject.org wrote:
> Signed-off-by: Talel BELHAJ SALEM <bhstalel@gmail.com>
> ---
>  documentation/ref-manual/classes.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
>
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 662121ed9..791c6b2ef 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -183,6 +183,14 @@ The class also contains some commonly used functions such as
>  :term:`EXTRA_OEMAKE` variable as well as the
>  arguments passed directly to ``oe_runmake``.
>  
> +The following actions, among others, are handled by this class:

I would perhaps phrase this differently, how about:

"""
For example, the following items are handled by this class:
"""

So intent is more about giving some examples about what the class is doing.

> +
> +- Define default dependencies and add them to :term:`DEPENDS` if :term:`INHIBIT_DEFAULT_DEPS`
> +  is not defined

What dependencies? I'm afraid adding this sentence may add confusion instead of
adding precision.

> +- Handle :term:`PACKAGECONFIG` variable

This is vague too. I would extend this sentence to briefly give some context.

> +- Handle the provided license via :term:`LICENSE` and :term:`LIC_FILES_CHKSUM` variables

s/license/license(s)

This is again a bit vague, I'm not sure what's the added value. How about:

"""
Handle the provided license(s) specified in the :term:`LICENSE` variable, and
verify its checksum specified in the :term:`LIC_FILES_CHKSUM` variable.
"""

> +- Prepare the native recipe that correspond to the scheme set in :term:`SRC_URI`

This is too vague, I'm not sure what you wanted to convey here.

> +
>  .. _ref-classes-bash-completion:
>  
>  ``bash-completion``

I would finish by saying:

"""
See the source code of the :ref:`ref-classes-base` class to get a complete
overview of what the class handles.
"""

So that way we insist on the fact that we were just giving examples.

Thanks,
Antonin

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