diff mbox series

[v2] ref-manual: document KERNEL_SPLIT_MODULES variable

Message ID 20250608104459.1888510-1-dixitparmar19@gmail.com
State New
Headers show
Series [v2] ref-manual: document KERNEL_SPLIT_MODULES variable | expand

Commit Message

Dixit Parmar June 8, 2025, 10:44 a.m. UTC 
This variable controls the kernel module spliting.

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

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 9768d8f5b..b7dde2604 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5359,6 +5359,20 @@  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`
+      When inheriting the :ref:`ref-classes-kernel-module-split` class, this
+      variable controls whether kernel modules are split into separate packages
+      or bundled into a single package.
+
+      For some use cases, a monolithic kernel module package
+      :ref:`KERNEL_PACKAGE_NAME` (by default named ``kernel``) that contains
+      all modules built from the kernel sources may be preferred. Because a
+      monolithic package can reduce download time and speed up installation.
+
+      By default, this variable is set to ``1``, resulting in one package per
+      module. Setting it to any other value will generate a single monolithic
+      package containing all kernel modules.
+
    :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`