[PATCH 1/1] documentation: add doc for KERNEL_SPLIT_MODULES

[PATCH 1/1] documentation: add doc for KERNEL_SPLIT_MODULES

[Dixit Parmar]

Add the missing documentation for the KERNEL_SPLIT_MODULES variable.

[ YOCTO #15771 ]

Signed-off-by: Dixit Parmar <dixitparmar19@gmail.com>
---
 meta/conf/documentation.conf | 1 +
 1 file changed, 1 insertion(+)

diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
index 3dd7bce515..4c8becbdc2 100644
--- a/meta/conf/documentation.conf
+++ b/meta/conf/documentation.conf
@@ -252,6 +252,7 @@ KERNEL_MODULE_AUTOLOAD[doc] = "Lists kernel modules that need to be auto-loaded
 KERNEL_MODULE_PROBECONF[doc] = "Lists kernel modules for which the build system expects to find module_conf_* values that specify configuration for each of the modules"
 KERNEL_PACKAGE_NAME[doc] = "Name prefix for kernel packages. Defaults to 'kernel'."
 KERNEL_PATH[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)."
+KERNEL_SPLIT_MODULES[doc] = "Allow opt-out of split kernel modules. 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."
 KERNEL_SRC[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)."
 KERNEL_LOCALVERSION[doc] = "Appends a string to the name of the local version of the kernel image."
 KFEATURE_DESCRIPTION[doc] = "Provides a short description of a configuration fragment. You use this variable in the .scc file that describes a configuration fragment file."
-- 
2.43.0

Re: [docs] [PATCH 1/1] documentation: add doc for KERNEL_SPLIT_MODULES

[Quentin Schulz]

Hi Dixit,

On 5/29/25 5:22 AM, Dixit Parmar via lists.yoctoproject.org wrote:
> Add the missing documentation for the KERNEL_SPLIT_MODULES variable.
> 
> [ YOCTO #15771 ]
> 
> Signed-off-by: Dixit Parmar <dixitparmar19@gmail.com>
> ---
>   meta/conf/documentation.conf | 1 +

This file is not handled by the yocto-docs community as far as I know, 
so you won't really have review from us.

>   1 file changed, 1 insertion(+)
> 
> diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
> index 3dd7bce515..4c8becbdc2 100644
> --- a/meta/conf/documentation.conf
> +++ b/meta/conf/documentation.conf
> @@ -252,6 +252,7 @@ KERNEL_MODULE_AUTOLOAD[doc] = "Lists kernel modules that need to be auto-loaded
>   KERNEL_MODULE_PROBECONF[doc] = "Lists kernel modules for which the build system expects to find module_conf_* values that specify configuration for each of the modules"
>   KERNEL_PACKAGE_NAME[doc] = "Name prefix for kernel packages. Defaults to 'kernel'."
>   KERNEL_PATH[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)."
> +KERNEL_SPLIT_MODULES[doc] = "Allow opt-out of split kernel modules. 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."

I'm not sure where this [doc] varflag is used actually... I would 
recommend to add an entry in the yocto-docs variable glossary instead, 
so it eventually appears on docs.yoctoproject.org.

https://git.yoctoproject.org/yocto-docs would be the git repo to do your 
modifications on. The variable glossary is stored in 
documentation/ref-manual/variables.rst.

Let us know if you need help with something.

Looking forward to seeing your patch on the ML :)

Cheers,
Quentin

Re: [docs] [PATCH 1/1] documentation: add doc for KERNEL_SPLIT_MODULES

[Antonin Godard]

On Thu May 29, 2025 at 5:22 AM CEST, Dixit Parmar via lists.yoctoproject.org wrote:
> Add the missing documentation for the KERNEL_SPLIT_MODULES variable.
>
> [ YOCTO #15771 ]
>
> Signed-off-by: Dixit Parmar <dixitparmar19@gmail.com>
> ---
>  meta/conf/documentation.conf | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
> index 3dd7bce515..4c8becbdc2 100644
> --- a/meta/conf/documentation.conf
> +++ b/meta/conf/documentation.conf
> @@ -252,6 +252,7 @@ KERNEL_MODULE_AUTOLOAD[doc] = "Lists kernel modules that need to be auto-loaded
>  KERNEL_MODULE_PROBECONF[doc] = "Lists kernel modules for which the build system expects to find module_conf_* values that specify configuration for each of the modules"
>  KERNEL_PACKAGE_NAME[doc] = "Name prefix for kernel packages. Defaults to 'kernel'."
>  KERNEL_PATH[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)."
> +KERNEL_SPLIT_MODULES[doc] = "Allow opt-out of split kernel modules. 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."
>  KERNEL_SRC[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)."
>  KERNEL_LOCALVERSION[doc] = "Appends a string to the name of the local version of the kernel image."
>  KFEATURE_DESCRIPTION[doc] = "Provides a short description of a configuration fragment. You use this variable in the .scc file that describes a configuration fragment file."

Hi,

This should be sent to the openembedded-core mailing list, as it modifies the
openembedded-core layer, not the yocto-docs repository. As Quentin suggested, a
patch modifying yocto-docs/documentation/ref-manual/variables.rst would be
appreciated!

Thanks,
Antonin

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

Re: [PATCH 1/1] documentation: add doc for KERNEL_SPLIT_MODULES

[Dixit Parmar]

[-- Attachment #1: Type: text/plain, Size: 509 bytes --]

Thank you for guidance.
My idea was to have documentation for KERNEL_SPLIT_MODULES in the meta/conf/documentation.conf similar to KERNEL_MODULE_AUTOLOAD, KERNEL_MODULE_PROBECONF etc is there in this file. Not sure if that is correct understanding. Can you please suggest if we need KERNEL_SPLIT_MODULES in the meta/conf/documentation.conf or not apart from having it in the variable-glossary.

I'd really appreciate if you could point me to correct mailing list & prefix(if needed) for variable glossary.

[-- Attachment #2: Type: text/html, Size: 563 bytes --]

Re: [PATCH 1/1] documentation: add doc for KERNEL_SPLIT_MODULES

[Dixit Parmar]

[-- Attachment #1: Type: text/plain, Size: 124 bytes --]

Sent out patch for documentation/ref-manual/variable.rst https://lists.openembedded.org/g/openembedded-core/message/218019

[-- Attachment #2: Type: text/html, Size: 135 bytes --]

Re: [docs] [PATCH 1/1] documentation: add doc for KERNEL_SPLIT_MODULES

[Antonin Godard]

On Thu Jun 5, 2025 at 2:18 PM CEST, Dixit Parmar via lists.yoctoproject.org wrote:
> Thank you for guidance.
> My idea was to have documentation for KERNEL_SPLIT_MODULES in the
> meta/conf/documentation.conf similar to KERNEL_MODULE_AUTOLOAD,
> KERNEL_MODULE_PROBECONF etc is there in this file. Not sure if that is correct
> understanding. Can you please suggest if we need KERNEL_SPLIT_MODULES in the
> meta/conf/documentation.conf or not apart from having it in the
> variable-glossary.
>
> I'd really appreciate if you could point me to correct mailing list &
> prefix(if needed) for variable glossary.

If you modify meta/conf/documentation.conf, the patch needs to be sent to
openembedded-core@lists.openembedded.org, because that file is part of
openembedded-core.

If you modify the yocto-docs repository, the patch needs to be sent to
docs@lists.yoctoproject.org.

Thanks for contributing!
Antonin

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