summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-12-06 19:09:35 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-12-18 10:41:21 +0000
commitf417d3274c427908c43f8cd20e797609450a3724 (patch)
treeb09dd3addc6a43f1711573ee66db7c5445bc2d72 /documentation/ref-manual
parentf3adc7a899b85101238b24989ebf824a6066f9fa (diff)
downloadpoky-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')
-rw-r--r--documentation/ref-manual/classes.rst18
-rw-r--r--documentation/ref-manual/images.rst2
-rw-r--r--documentation/ref-manual/qa-checks.rst2
-rw-r--r--documentation/ref-manual/variables.rst14
4 files changed, 18 insertions, 18 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
1397The :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class provides support to pack a kernel image, 1397The :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class provides support to pack a kernel image,
1398device trees, a U-boot script, a Initramfs bundle and a RAM disk 1398device trees, a U-boot script, a :term:`Initramfs` bundle and a RAM disk
1399into a single FIT image. In theory, a FIT image can support any number 1399into a single FIT image. In theory, a FIT image can support any number
1400of kernels, U-boot scripts, Initramfs bundles, RAM disks and device-trees. 1400of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees.
1401However, :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` currently only supports 1401However, :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` currently only supports
1402limited usecases: just one kernel image, an optional U-boot script, 1402limited usecases: just one kernel image, an optional U-boot script,
1403an optional Initramfs bundle, an optional RAM disk, and any number of 1403an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of
1404device tree. 1404device tree.
1405 1405
1406To create a FIT image, it is required that :term:`KERNEL_CLASSES` 1406To 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`
1432is set to 0. 1432is set to 0.
1433 1433
1434Only a single Initramfs bundle can be added to the FIT image created by 1434Only 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.
1436In case of Initramfs, the kernel is configured to be bundled with the root filesystem 1436In case of :term:`Initramfs`, the kernel is configured to be bundled with the root filesystem
1437in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin). 1437in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin).
1438When the kernel is copied to RAM and executed, it unpacks the Initramfs root filesystem. 1438When the kernel is copied to RAM and executed, it unpacks the :term:`Initramfs` root filesystem.
1439The Initramfs bundle can be enabled when :term:`INITRAMFS_IMAGE` 1439The :term:`Initramfs` bundle can be enabled when :term:`INITRAMFS_IMAGE`
1440is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1. 1440is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1.
1441The address where the Initramfs bundle is to be loaded by U-boot is specified 1441The address where the :term:`Initramfs` bundle is to be loaded by U-boot is specified
1442by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`. 1442by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`.
1443 1443
1444Only a single U-boot boot script can be added to the FIT image created by 1444Only a single U-boot boot script can be added to the FIT image created by
diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst
index d52b39f3cf..9358acc953 100644
--- a/documentation/ref-manual/images.rst
+++ b/documentation/ref-manual/images.rst
@@ -20,7 +20,7 @@ image you want.
20 file before using the BitBake command to build the minimal or base 20 file before using the BitBake command to build the minimal or base
21 image:: 21 image::
22 22
23 1. Comment out the EXTRA_IMAGE_FEATURES line 23 1. Comment out the :term:`EXTRA_IMAGE_FEATURES` line
24 2. Set INCOMPATIBLE_LICENSE = "GPL-3.0* LGPL-3.0* AGPL-3.0*" 24 2. Set INCOMPATIBLE_LICENSE = "GPL-3.0* LGPL-3.0* AGPL-3.0*"
25 25
26 26
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 1a768aac93..798d4be4cf 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -602,7 +602,7 @@ Errors and Warnings
602 602
603 GitHub provides "archive" tarballs, however these can be re-generated 603 GitHub provides "archive" tarballs, however these can be re-generated
604 on the fly and thus the file's signature will not necessarily match that 604 on the fly and thus the file's signature will not necessarily match that
605 in the SRC_URI checksums in future leading to build failures. It is 605 in the :term:`SRC_URI` checksums in future leading to build failures. It is
606 recommended that you use an official release tarball or switch to 606 recommended that you use an official release tarball or switch to
607 pulling the corresponding revision in the actual git repository instead. 607 pulling the corresponding revision in the actual git repository instead.
608 608
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0435f88347..99100498b7 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3922,7 +3922,7 @@ system and gives an overview of their function and contents.
3922 This kind of mechanism is typically used for two reasons: 3922 This kind of mechanism is typically used for two reasons:
3923 3923
3924 - For booting the same kernel binary on multiple systems requiring 3924 - For booting the same kernel binary on multiple systems requiring
3925 different device drivers. The Initramfs image is then customized 3925 different device drivers. The :term:`Initramfs` image is then customized
3926 for each type of system, to include the specific kernel modules 3926 for each type of system, to include the specific kernel modules
3927 necessary to access the final root filesystem. This technique 3927 necessary to access the final root filesystem. This technique
3928 is used on all GNU / Linux distributions for desktops and servers. 3928 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.
6456 .. note:: 6456 .. note::
6457 6457
6458 A recipe's own recipe name (:term:`PN`) is always implicitly prepended 6458 A recipe's own recipe name (:term:`PN`) is always implicitly prepended
6459 to `PROVIDES`, so while using "+=" in the above example may not be 6459 to :term:`PROVIDES`, so while using "+=" in the above example may not be
6460 strictly necessary it is recommended to avoid confusion. 6460 strictly necessary it is recommended to avoid confusion.
6461 6461
6462 In addition to providing recipes under alternate names, the 6462 In addition to providing recipes under alternate names, the
@@ -7772,7 +7772,7 @@ system and gives an overview of their function and contents.
7772 prevented the reuse of prebuilt artifacts stored in the Shared 7772 prevented the reuse of prebuilt artifacts stored in the Shared
7773 State Cache. 7773 State Cache.
7774 7774
7775 ``SSTATE_EXCLUDEDEPS_SYSROOT`` is evaluated as two regular 7775 :term:`SSTATE_EXCLUDEDEPS_SYSROOT` is evaluated as two regular
7776 expressions of recipe and dependency to ignore. An example 7776 expressions of recipe and dependency to ignore. An example
7777 is the rule in :oe_git:`meta/conf/layer.conf </meta/conf/layer.conf>`:: 7777 is the rule in :oe_git:`meta/conf/layer.conf </meta/conf/layer.conf>`::
7778 7778
@@ -8254,7 +8254,7 @@ system and gives an overview of their function and contents.
8254 SYSTEMD_SERVICE:${PN} = "connman.service" 8254 SYSTEMD_SERVICE:${PN} = "connman.service"
8255 8255
8256 The package overrides that can be specified are directly related to the value of 8256 The package overrides that can be specified are directly related to the value of
8257 term:`SYSTEMD_PACKAGES`. Overrides not included in term:`SYSTEMD_PACKAGES` 8257 :term:`SYSTEMD_PACKAGES`. Overrides not included in :term:`SYSTEMD_PACKAGES`
8258 will be silently ignored. 8258 will be silently ignored.
8259 8259
8260 :term:`SYSVINIT_ENABLED_GETTYS` 8260 :term:`SYSVINIT_ENABLED_GETTYS`
@@ -8765,7 +8765,7 @@ system and gives an overview of their function and contents.
8765 :doc:`/sdk-manual/index` manual. 8765 :doc:`/sdk-manual/index` manual.
8766 8766
8767 Note that this variable applies to building an SDK, not an eSDK, 8767 Note that this variable applies to building an SDK, not an eSDK,
8768 in which case the term:`TOOLCHAIN_HOST_TASK_ESDK` setting should be 8768 in which case the :term:`TOOLCHAIN_HOST_TASK_ESDK` setting should be
8769 used instead. 8769 used instead.
8770 8770
8771 :term:`TOOLCHAIN_HOST_TASK_ESDK` 8771 :term:`TOOLCHAIN_HOST_TASK_ESDK`
@@ -9417,7 +9417,7 @@ system and gives an overview of their function and contents.
9417 - :term:`MULTIMACH_TARGET_SYS`: The target system identifier 9417 - :term:`MULTIMACH_TARGET_SYS`: The target system identifier
9418 - :term:`PN`: The recipe name 9418 - :term:`PN`: The recipe name
9419 - :term:`EXTENDPE`: The epoch --- if :term:`PE` is not specified, which 9419 - :term:`EXTENDPE`: The epoch --- if :term:`PE` is not specified, which
9420 is usually the case for most recipes, then `EXTENDPE` is blank. 9420 is usually the case for most recipes, then :term:`EXTENDPE` is blank.
9421 - :term:`PV`: The recipe version 9421 - :term:`PV`: The recipe version
9422 - :term:`PR`: The recipe revision 9422 - :term:`PR`: The recipe revision
9423 9423
@@ -9453,7 +9453,7 @@ system and gives an overview of their function and contents.
9453 On systems where many tasks run in parallel, setting a limit to this 9453 On systems where many tasks run in parallel, setting a limit to this
9454 can be helpful in controlling system resource usage. 9454 can be helpful in controlling system resource usage.
9455 9455
9456 :term:`XZ_MEMLIMIT` 9456 :term:`XZ_MEMLIMIT`
9457 Specifies the maximum memory the xz compression should use as a percentage 9457 Specifies the maximum memory the xz compression should use as a percentage
9458 of system memory. If unconstrained the xz compressor can use large amounts of 9458 of system memory. If unconstrained the xz compressor can use large amounts of
9459 memory and become problematic with parallelism elsewhere in the build. 9459 memory and become problematic with parallelism elsewhere in the build.