All of lore.kernel.org
 help / color / mirror / Atom feed
From: Quentin Schulz <quentin.schulz@cherry.de>
To: alperyasinak1@gmail.com, docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH] ref-manual/variables.rst: document KERNEL_EXTRA_FEATURES
Date: Mon, 2 Jun 2025 13:36:03 +0200	[thread overview]
Message-ID: <4f224337-e7c7-4ccb-a0cc-861fddcabc07@cherry.de> (raw)
In-Reply-To: <20250531154900.53941-1-alperyasinak1@gmail.com>

Hi Alper,

On 5/31/25 5:49 PM, Alper Ak via lists.yoctoproject.org wrote:
> Fix [YOCTO #15751]
> 
> Signed-off-by: Alper Ak <alperyasinak1@gmail.com>
> ---
>   documentation/ref-manual/variables.rst | 18 ++++++++++++++++++
>   1 file changed, 18 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index c697bdbbb..2f0925b15 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -5202,6 +5202,24 @@ system and gives an overview of their function and contents.
>         Specifies additional ``make`` command-line arguments the OpenEmbedded
>         build system passes on when compiling the kernel.
>   
> +   :term:`KERNEL_EXTRA_FEATURES`
> +      Specifies optional kernel features to be added on top of the base
> +      configuration in kernel recipes that inherit the :ref:`ref-classes-kernel-yocto` class.
> +

I'm not sure that is true?

git grep KERNEL_EXTRA_FEATURES meta/classes-recipe/kernel-yocto.bbclass

returns nothing.

Looking at the layer level, it seems KERNEL_EXTRA_FEATURES is never used 
as is, only as part of KERNEL_FEATURES, and always in final/leaf recipes 
and not .inc files or classes.

> +      This variable complements :term:`KERNEL_FEATURES` by allowing layers

It doesn't as far as I could tell? You need to make 
KERNEL_EXTRA_FEATURES part of the KERNEL_FEATURES variable for that to 
be true?

> +      to include or override additional features without requiring Python code or
> +      recipe finalize hooks.
> +
> +      Features are defined in ``.scc`` files, which serve as kernel :term:`Metadata` and usually include patches
> +      and configuration fragments to be used during the kernel build process to modify the Linux kernel.

Gut feeling is that those two lines are too long but haven't checked 
myself, compare to other long lines in this file to see when we wrap text.

> +      For example::
> +
> +         KERNEL_EXTRA_FEATURES = "features/netfilter/netfilter.scc"
> +         KERNEL_FEATURES:append = " ${KERNEL_EXTRA_FEATURES}"
> +
> +      By default, :term:`KERNEL_EXTRA_FEATURES` is empty. But, some distributions

It's not, it simply doesn't exist that is all I believe?

> +      such as Poky may set a default value using a soft assignment (``?=``).

Does it? I don't see it, only an :append is used.

I'll let Antonin decide but I am not entirely sure it makes sense to 
document this variable, which is very recipe specific. A point could be 
made that since poky.conf modifies it, maybe it makes sense to document 
it :)

Cheers,
Quentin


  reply	other threads:[~2025-06-02 11:36 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-31 15:49 [PATCH] ref-manual/variables.rst: document KERNEL_EXTRA_FEATURES Alper Ak
2025-06-02 11:36 ` Quentin Schulz [this message]
2025-06-02 15:41   ` [docs] " Alper Ak
2025-06-04  7:46     ` Antonin Godard
2025-06-04  9:52       ` Alper Ak
2025-06-06  8:16         ` Antonin Godard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4f224337-e7c7-4ccb-a0cc-861fddcabc07@cherry.de \
    --to=quentin.schulz@cherry.de \
    --cc=alperyasinak1@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.