mirror of
https://git.yoctoproject.org/poky
synced 2026-09-13 00:49:33 +02:00
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>
This commit is contained in:
Michael Opdenacker
committed by
Richard Purdie
Richard Purdie
parent
f3adc7a899
commit
f417d3274c
@@ -1395,12 +1395,12 @@ generation.
|
||||
===========================
|
||||
|
||||
The :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class provides support to pack a kernel image,
|
||||
device trees, a U-boot script, a Initramfs bundle and a RAM disk
|
||||
device trees, a U-boot script, a :term:`Initramfs` bundle and a RAM disk
|
||||
into a single FIT image. In theory, a FIT image can support any number
|
||||
of kernels, U-boot scripts, Initramfs bundles, RAM disks and device-trees.
|
||||
of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees.
|
||||
However, :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` currently only supports
|
||||
limited usecases: just one kernel image, an optional U-boot script,
|
||||
an optional Initramfs bundle, an optional RAM disk, and any number of
|
||||
an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of
|
||||
device tree.
|
||||
|
||||
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
|
||||
:term:`INITRAMFS_IMAGE` is specified and that :term:`INITRAMFS_IMAGE_BUNDLE`
|
||||
is set to 0.
|
||||
|
||||
Only a single Initramfs bundle can be added to the FIT image created by
|
||||
:ref:`kernel-fitimage <ref-classes-kernel-fitimage>` and the Initramfs bundle in FIT is optional.
|
||||
In case of Initramfs, the kernel is configured to be bundled with the root filesystem
|
||||
Only a single :term:`Initramfs` bundle can be added to the FIT image created by
|
||||
:ref:`kernel-fitimage <ref-classes-kernel-fitimage>` and the :term:`Initramfs` bundle in FIT is optional.
|
||||
In case of :term:`Initramfs`, the kernel is configured to be bundled with the root filesystem
|
||||
in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin).
|
||||
When the kernel is copied to RAM and executed, it unpacks the Initramfs root filesystem.
|
||||
The Initramfs bundle can be enabled when :term:`INITRAMFS_IMAGE`
|
||||
When the kernel is copied to RAM and executed, it unpacks the :term:`Initramfs` root filesystem.
|
||||
The :term:`Initramfs` bundle can be enabled when :term:`INITRAMFS_IMAGE`
|
||||
is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1.
|
||||
The address where the Initramfs bundle is to be loaded by U-boot is specified
|
||||
The address where the :term:`Initramfs` bundle is to be loaded by U-boot is specified
|
||||
by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`.
|
||||
|
||||
Only a single U-boot boot script can be added to the FIT image created by
|
||||
|
||||
@@ -20,7 +20,7 @@ image you want.
|
||||
file before using the BitBake command to build the minimal or base
|
||||
image::
|
||||
|
||||
1. Comment out the EXTRA_IMAGE_FEATURES line
|
||||
1. Comment out the :term:`EXTRA_IMAGE_FEATURES` line
|
||||
2. Set INCOMPATIBLE_LICENSE = "GPL-3.0* LGPL-3.0* AGPL-3.0*"
|
||||
|
||||
|
||||
|
||||
@@ -602,7 +602,7 @@ Errors and Warnings
|
||||
|
||||
GitHub provides "archive" tarballs, however these can be re-generated
|
||||
on the fly and thus the file's signature will not necessarily match that
|
||||
in the SRC_URI checksums in future leading to build failures. It is
|
||||
in the :term:`SRC_URI` checksums in future leading to build failures. It is
|
||||
recommended that you use an official release tarball or switch to
|
||||
pulling the corresponding revision in the actual git repository instead.
|
||||
|
||||
|
||||
@@ -3922,7 +3922,7 @@ system and gives an overview of their function and contents.
|
||||
This kind of mechanism is typically used for two reasons:
|
||||
|
||||
- For booting the same kernel binary on multiple systems requiring
|
||||
different device drivers. The Initramfs image is then customized
|
||||
different device drivers. The :term:`Initramfs` image is then customized
|
||||
for each type of system, to include the specific kernel modules
|
||||
necessary to access the final root filesystem. This technique
|
||||
is used on all GNU / Linux distributions for desktops and servers.
|
||||
@@ -6456,7 +6456,7 @@ system and gives an overview of their function and contents.
|
||||
.. note::
|
||||
|
||||
A recipe's own recipe name (:term:`PN`) is always implicitly prepended
|
||||
to `PROVIDES`, so while using "+=" in the above example may not be
|
||||
to :term:`PROVIDES`, so while using "+=" in the above example may not be
|
||||
strictly necessary it is recommended to avoid confusion.
|
||||
|
||||
In addition to providing recipes under alternate names, the
|
||||
@@ -7772,7 +7772,7 @@ system and gives an overview of their function and contents.
|
||||
prevented the reuse of prebuilt artifacts stored in the Shared
|
||||
State Cache.
|
||||
|
||||
``SSTATE_EXCLUDEDEPS_SYSROOT`` is evaluated as two regular
|
||||
:term:`SSTATE_EXCLUDEDEPS_SYSROOT` is evaluated as two regular
|
||||
expressions of recipe and dependency to ignore. An example
|
||||
is the rule in :oe_git:`meta/conf/layer.conf </meta/conf/layer.conf>`::
|
||||
|
||||
@@ -8254,7 +8254,7 @@ system and gives an overview of their function and contents.
|
||||
SYSTEMD_SERVICE:${PN} = "connman.service"
|
||||
|
||||
The package overrides that can be specified are directly related to the value of
|
||||
term:`SYSTEMD_PACKAGES`. Overrides not included in term:`SYSTEMD_PACKAGES`
|
||||
:term:`SYSTEMD_PACKAGES`. Overrides not included in :term:`SYSTEMD_PACKAGES`
|
||||
will be silently ignored.
|
||||
|
||||
:term:`SYSVINIT_ENABLED_GETTYS`
|
||||
@@ -8765,7 +8765,7 @@ system and gives an overview of their function and contents.
|
||||
:doc:`/sdk-manual/index` manual.
|
||||
|
||||
Note that this variable applies to building an SDK, not an eSDK,
|
||||
in which case the term:`TOOLCHAIN_HOST_TASK_ESDK` setting should be
|
||||
in which case the :term:`TOOLCHAIN_HOST_TASK_ESDK` setting should be
|
||||
used instead.
|
||||
|
||||
:term:`TOOLCHAIN_HOST_TASK_ESDK`
|
||||
@@ -9417,7 +9417,7 @@ system and gives an overview of their function and contents.
|
||||
- :term:`MULTIMACH_TARGET_SYS`: The target system identifier
|
||||
- :term:`PN`: The recipe name
|
||||
- :term:`EXTENDPE`: The epoch --- if :term:`PE` is not specified, which
|
||||
is usually the case for most recipes, then `EXTENDPE` is blank.
|
||||
is usually the case for most recipes, then :term:`EXTENDPE` is blank.
|
||||
- :term:`PV`: The recipe version
|
||||
- :term:`PR`: The recipe revision
|
||||
|
||||
@@ -9453,7 +9453,7 @@ system and gives an overview of their function and contents.
|
||||
On systems where many tasks run in parallel, setting a limit to this
|
||||
can be helpful in controlling system resource usage.
|
||||
|
||||
:term:`XZ_MEMLIMIT`
|
||||
:term:`XZ_MEMLIMIT`
|
||||
Specifies the maximum memory the xz compression should use as a percentage
|
||||
of system memory. If unconstrained the xz compressor can use large amounts of
|
||||
memory and become problematic with parallelism elsewhere in the build.
|
||||
|
||||
Reference in New Issue
Block a user