[1/1] ref-manual: document KERNEL_SPLIT_MODULES variable

This variable controls the kernel module spliting.

Signed-off-by: Dixit Parmar <dixitparmar19@gmail.com>
---
 documentation/ref-manual/variables.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

On 2025-06-05 09:34, Dixit Parmar via lists.openembedded.org wrote:
> This variable controls the kernel module spliting.
>
> Signed-off-by: Dixit Parmar <dixitparmar19@gmail.com>

Hi,

This should actually go to the following list:

|

docs@lists.yoctoproject.org|

> ---
>   documentation/ref-manual/variables.rst | 9 +++++++++
>   1 file changed, 9 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 9768d8f5b..592401eb6 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -5359,6 +5359,15 @@ system and gives an overview of their function and contents.
>         the :term:`KERNEL_PATH` variable. Both variables are common variables
>         used by external Makefiles to point to the kernel source directory.
>   
> +   :term:`KERNEL_SPLIT_MODULES`
> +      Allow opt-out of split kernel modules. For some use cases, a monolithic
> +      kernel-modules package containing all modules built from the kernel
> +      sources may be preferred. For one, download time is shorter and
> +      installation time is faster.
> +      Default set to 1, one subpackage per module. Setting it 0 will generate
> +      a monolithic kernel-modules package containing all modules built from
> +      the source.
> +
>      :term:`KERNEL_SRC`
>         The location of the kernel sources. This variable is set to the value
>         of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module`
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#218019): https://lists.openembedded.org/g/openembedded-core/message/218019
> Mute This Topic: https://lists.openembedded.org/mt/113485120/7611679
> Group Owner: openembedded-core+owner@lists.openembedded.org
> Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [tgamblin@baylibre.com]
> -=-=-=-=-=-=-=-=-=-=-=-
>

Hi Dixit,

On 6/5/25 3:34 PM, Dixit Parmar via lists.openembedded.org wrote:
> This variable controls the kernel module spliting.
> 
> Signed-off-by: Dixit Parmar <dixitparmar19@gmail.com>
> ---
>   documentation/ref-manual/variables.rst | 9 +++++++++

This is for the yocto-docs mailing list.

How to know?

https://git.openembedded.org/openembedded-core/tree/ clearly doesn't 
have the file you're modifying, so not OE-Core.

Now... poky does have it, but the documentation/README says 
(https://git.yoctoproject.org/poky/tree/documentation/README#n406)
"""
Please see the top level README file in this repository for details of where
to send patches.
"""

but in poky that file doesn't exist, though README.md specifies:
https://git.yoctoproject.org/poky/tree/meta-poky/README.poky.md#n57

I'll work on making this easier to find out. (Namely adding the 
contribution information in documentation/README instead of making the 
latter point at README, and making README a symlink to 
documentation/README).

Will review once on the proper ML :)

Thanks!
Quentin

I had sent out this patch on docs@lists.yoctoproject.org ML with a different file earlier, they suggested to send it to OE-Core so I sent it here.
I again sent this same patch to docs@lists.yoctoproject.org
Looking forward to reviews.

Hi Dixit,

On 6/5/25 3:58 PM, Dixit Parmar via lists.openembedded.org wrote:
> I had sent out this patch on docs@lists.yoctoproject.org ML with a different file earlier, they suggested to send it to OE-Core so I sent it here.
> I again sent this same patch to docs@lists.yoctoproject.org
> Looking forward to reviews.
> 

The original patch sent to yocto-docs mailing list was modifying a file 
from OE-Core so it should have been sent to OE-Core mailing list, even 
if it is "documentation".

As feedback to the original patch it was said it may have limited 
usefulness to have VAR[doc] and we should rather have the variable 
described in the variables glossary of the yocto documentation (or in 
both places). This now modifies a file that is part of the Yocto 
documentation and not OE-Core, so it shouldn't be sent to the OE-Core 
mailing list but the yocto-docs one.

Note that BitBake also has its own documentation, c.f. 
bitbake/documentation if you're looking from poky git repo.

Reading BitBake's README file you will see that patches for the BitBake 
documentation needs to be sent to both the BitBake and yocto-docs 
mailing list. The reason is simple for that: BitBake documentation gets 
reviewed by the documentation community (typically looking at yocto-docs 
mailing list only) but merged by the BitBake maintainer(s).

I know this isn't necessarily the clearest or easiest information to 
find so I hope this helps. Please let us know if you have suggestions on 
how to improve this.

Cheers,
Quentin