[PATCH] ref-manual: expand on kernel "do_sizecheck" task
"Robert P. J. Day" <[email protected]> Thu, 9 Jul 2026 04:31:10 -0400 (EDT)
| Newsgroups | org.yoctoproject.lists.docs |
|---|---|
| Message-ID | <[email protected]> |
Expand on the description of do_sizecheck() to mention that it will size-check on *all* kernel images listed in KERNEL_IMAGETYPES. Signed-off-by: Robert P. J. Day <[email protected]> --- diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index e1db2d5ed..db0abad00 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -837,11 +837,10 @@ can successfully build the kernel modules in the next step of the build. ``do_sizecheck`` ---------------- -After the kernel has been built, this task checks the size of the -stripped kernel image against -:term:`KERNEL_IMAGE_MAXSIZE`. If that -variable was set and the size of the stripped kernel exceeds that size, -the kernel build produces a warning to that effect. +If the variable :term:`KERNEL_IMAGE_MAXSIZE` is set, this task compares +the size of all stripped kernel images listed in :term:`KERNEL_IMAGETYPES` +against that value. If more than one image type is listed there, warn on +any that exceed that value, but fail only if none of them fit. .. _ref-tasks-strip: diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c92b195ff..ba83b6e6f 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -5603,17 +5603,18 @@ system and gives an overview of their function and contents. information. :term:`KERNEL_IMAGE_MAXSIZE` - Specifies the maximum size of the kernel image file in kilobytes. If - :term:`KERNEL_IMAGE_MAXSIZE` is set, the size of the kernel image file is - checked against the set value during the - :ref:`ref-tasks-sizecheck` task. The task fails if - the kernel image file is larger than the setting. + Specifies the maximum allowable size of the kernel image file in kilobytes. + If this variable is set, the sizes of all of the kernel image files listed + in :term:`KERNEL_IMAGETYPES` are checked against this value during the + :ref:`ref-tasks-sizecheck` task. That task will warn about any of the + kernel images that exceed the maximum, and will fail only if all images + are too large. :term:`KERNEL_IMAGE_MAXSIZE` is useful for target devices that have a limited amount of space in which the kernel image must be stored. By default, this variable is not set, which means the size of the - kernel image is not checked. + kernel images are not checked. :term:`KERNEL_IMAGE_NAME` The base name of the kernel image. This variable is set in the