summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/ref-manual/variables.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c6ae3fb8bc..10d363a389 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5350,6 +5350,27 @@ system and gives an overview of their function and contents.
5350 the :term:`KERNEL_PATH` variable. Both variables are common variables 5350 the :term:`KERNEL_PATH` variable. Both variables are common variables
5351 used by external Makefiles to point to the kernel source directory. 5351 used by external Makefiles to point to the kernel source directory.
5352 5352
5353 :term:`KERNEL_SPLIT_MODULES`
5354 When inheriting the :ref:`ref-classes-kernel-module-split` class, this
5355 variable controls whether kernel modules are split into separate packages
5356 or bundled into a single package.
5357
5358 For some use cases, a monolithic kernel module package
5359 :term:`KERNEL_PACKAGE_NAME` that contains all modules built from the
5360 kernel sources may be preferred to speed up the installation.
5361
5362 By default, this variable is set to ``1``, resulting in one package per
5363 module. Setting it to any other value will generate a single monolithic
5364 package containing all kernel modules.
5365
5366 .. note::
5367
5368 If :term:`KERNEL_SPLIT_MODULES` is set to 0, it is still possible to
5369 install all kernel modules at once by adding ``kernel-modules`` (assuming
5370 :term:`KERNEL_PACKAGE_NAME` is ``kernel-modules``) to :term:`IMAGE_INSTALL`.
5371 The way it works is that a placeholder "kernel-modules" package will be
5372 created and will depend on every other individual kernel module packages.
5373
5353 :term:`KERNEL_SRC` 5374 :term:`KERNEL_SRC`
5354 The location of the kernel sources. This variable is set to the value 5375 The location of the kernel sources. This variable is set to the value
5355 of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module` 5376 of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module`