| Message ID | 20250529032252.340015-1-dixitparmar19@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | [1/1] documentation: add doc for KERNEL_SPLIT_MODULES | expand |
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
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."
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(+)