diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-12-06 19:09:35 +0100 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-18 10:41:21 +0000 |
| commit | f417d3274c427908c43f8cd20e797609450a3724 (patch) | |
| tree | b09dd3addc6a43f1711573ee66db7c5445bc2d72 /documentation/ref-manual/classes.rst | |
| parent | f3adc7a899b85101238b24989ebf824a6066f9fa (diff) | |
| download | poky-f417d3274c427908c43f8cd20e797609450a3724.tar.gz | |
manuals: add missing references to variables
[YOCTO #14508]
(From yocto-docs rev: 7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.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.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 9f8593831f..de5f108fb1 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
| @@ -1395,12 +1395,12 @@ generation. | |||
| 1395 | =========================== | 1395 | =========================== |
| 1396 | 1396 | ||
| 1397 | The :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class provides support to pack a kernel image, | 1397 | The :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class provides support to pack a kernel image, |
| 1398 | device trees, a U-boot script, a Initramfs bundle and a RAM disk | 1398 | device trees, a U-boot script, a :term:`Initramfs` bundle and a RAM disk |
| 1399 | into a single FIT image. In theory, a FIT image can support any number | 1399 | into a single FIT image. In theory, a FIT image can support any number |
| 1400 | of kernels, U-boot scripts, Initramfs bundles, RAM disks and device-trees. | 1400 | of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees. |
| 1401 | However, :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` currently only supports | 1401 | However, :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` currently only supports |
| 1402 | limited usecases: just one kernel image, an optional U-boot script, | 1402 | limited usecases: just one kernel image, an optional U-boot script, |
| 1403 | an optional Initramfs bundle, an optional RAM disk, and any number of | 1403 | an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of |
| 1404 | device tree. | 1404 | device tree. |
| 1405 | 1405 | ||
| 1406 | To create a FIT image, it is required that :term:`KERNEL_CLASSES` | 1406 | To create a FIT image, it is required that :term:`KERNEL_CLASSES` |
| @@ -1431,14 +1431,14 @@ is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by | |||
| 1431 | :term:`INITRAMFS_IMAGE` is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` | 1431 | :term:`INITRAMFS_IMAGE` is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` |
| 1432 | is set to 0. | 1432 | is set to 0. |
| 1433 | 1433 | ||
| 1434 | Only a single Initramfs bundle can be added to the FIT image created by | 1434 | Only a single :term:`Initramfs` bundle can be added to the FIT image created by |
| 1435 | :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` and the Initramfs bundle in FIT is optional. | 1435 | :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` and the :term:`Initramfs` bundle in FIT is optional. |
| 1436 | In case of Initramfs, the kernel is configured to be bundled with the root filesystem | 1436 | In case of :term:`Initramfs`, the kernel is configured to be bundled with the root filesystem |
| 1437 | in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin). | 1437 | in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin). |
| 1438 | When the kernel is copied to RAM and executed, it unpacks the Initramfs root filesystem. | 1438 | When the kernel is copied to RAM and executed, it unpacks the :term:`Initramfs` root filesystem. |
| 1439 | The Initramfs bundle can be enabled when :term:`INITRAMFS_IMAGE` | 1439 | The :term:`Initramfs` bundle can be enabled when :term:`INITRAMFS_IMAGE` |
| 1440 | is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1. | 1440 | is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1. |
| 1441 | The address where the Initramfs bundle is to be loaded by U-boot is specified | 1441 | The address where the :term:`Initramfs` bundle is to be loaded by U-boot is specified |
| 1442 | by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`. | 1442 | by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`. |
| 1443 | 1443 | ||
| 1444 | Only a single U-boot boot script can be added to the FIT image created by | 1444 | Only a single U-boot boot script can be added to the FIT image created by |
