mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-07-16 03:47:03 +00:00
Code Issues Projects Releases Wiki Activity

ref-manual: expand on kernel "do_sizecheck" task

Browse Source 
Expand on the description of do_sizecheck() to mention that it will
size-check on *all* kernel images listed in KERNEL_IMAGETYPES.

(From yocto-docs rev: 0a7d6b399d6354985527ed5fa7c2a0b132e0b640)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
[AG: kilobytes -> kibibytes
 See https://lore.kernel.org/r/DJUQAEXAC03Q.2T7IDXHKVIX95@bootlin.com]
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b01fb11a4909fe2d3afa6cb01bd7b179429e382c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
This commit is contained in:
Robert P. J. Day
2026-07-09 04:31:10 -04:00
committed by Paul Barker
parent 84ecefc9f2
commit 9ba4cbc08e
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/tasks.rst
+4 -5
View File
@@ -774,11 +774,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:
documentation/ref-manual/variables.rst
+7 -6
View File
@@ -5110,17 +5110,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 kibibytes.
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