summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/classes.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-05-10 17:31:29 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-05-26 17:32:50 +0100
commita95cbed77fd2fa2ec263dbdf59bb2aed359d7ce1 (patch)
treef74d1b27dfe302df26f86c9e983019bcb101f12b /documentation/ref-manual/classes.rst
parent4417a30196b0cac1d9dc83b23e7fd5719b8ebc2d (diff)
downloadpoky-a95cbed77fd2fa2ec263dbdf59bb2aed359d7ce1.tar.gz
ref-manual: improve description of kernel-fitimage variables
- Mentioning that they are related to this class (for further information about their usage) - Replace "fitImage" by "FIT image" - Minor formating and style fixes (From yocto-docs rev: 07214a4ff2646efb143a02fc9381a029870e9b56) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Jamin Lin <jamin_lin@aspeedtech.com> Reviewed-by: Sean Anderson <sean.anderson@seco.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/classes.rst')
-rw-r--r--documentation/ref-manual/classes.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 94b6a3ebd7..2f96ffb82f 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1582,13 +1582,13 @@ The :ref:`ref-classes-kernel-devicetree` class, which is inherited by the
1582=================== 1582===================
1583 1583
1584The :ref:`ref-classes-kernel-fitimage` class provides support to pack a kernel image, 1584The :ref:`ref-classes-kernel-fitimage` class provides support to pack a kernel image,
1585device trees, a U-boot script, a :term:`Initramfs` bundle and a RAM disk 1585device trees, a U-boot script, an :term:`Initramfs` bundle and a RAM disk
1586into a single FIT image. In theory, a FIT image can support any number 1586into a single FIT image. In theory, a FIT image can support any number
1587of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees. 1587of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees.
1588However, :ref:`ref-classes-kernel-fitimage` currently only supports 1588However, :ref:`ref-classes-kernel-fitimage` currently only supports
1589limited usecases: just one kernel image, an optional U-boot script, 1589limited usecases: just one kernel image, an optional U-boot script,
1590an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of 1590an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of
1591device tree. 1591device trees.
1592 1592
1593To create a FIT image, it is required that :term:`KERNEL_CLASSES` 1593To create a FIT image, it is required that :term:`KERNEL_CLASSES`
1594is set to include ":ref:`ref-classes-kernel-fitimage`" and :term:`KERNEL_IMAGETYPE` 1594is set to include ":ref:`ref-classes-kernel-fitimage`" and :term:`KERNEL_IMAGETYPE`