summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2024-03-30 17:52:37 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-04-08 14:36:38 +0100
commitfed404fca0ae6eb313aeac7c029d22c06b5486a7 (patch)
tree3c44e751d9d3f676ae2d56f05f212cdc022f2ad4 /documentation/ref-manual
parentae1b8c607909d108d994386ad6e78f1f0422e174 (diff)
downloadpoky-fed404fca0ae6eb313aeac7c029d22c06b5486a7.tar.gz
manuals: fix trailing spaces
Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: ef6b650c31c4320314564bb85a45eebde3fd98c1) 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.rst4
-rw-r--r--documentation/ref-manual/tasks.rst2
-rw-r--r--documentation/ref-manual/variables.rst32
3 files changed, 19 insertions, 19 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index a1e160bb44..1d01456ece 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -665,7 +665,7 @@ The padding size can be modified by setting :term:`DT_PADDING_SIZE`
665to the desired size, in bytes. 665to the desired size, in bytes.
666 666
667See :oe_git:`devicetree.bbclass sources 667See :oe_git:`devicetree.bbclass sources
668</openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>` 668</openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>`
669for further variables controlling this class. 669for further variables controlling this class.
670 670
671Here is an excerpt of an example ``recipes-kernel/linux/devicetree-acme.bb`` 671Here is an excerpt of an example ``recipes-kernel/linux/devicetree-acme.bb``
@@ -3284,7 +3284,7 @@ The variables used by this class are:
3284- :term:`UBOOT_FIT_KEY_REQ_ARGS`: ``openssl req`` arguments. 3284- :term:`UBOOT_FIT_KEY_REQ_ARGS`: ``openssl req`` arguments.
3285- :term:`UBOOT_FIT_SIGN_ALG`: signature algorithm for the FIT image. 3285- :term:`UBOOT_FIT_SIGN_ALG`: signature algorithm for the FIT image.
3286- :term:`UBOOT_FIT_SIGN_NUMBITS`: size of the private key for FIT image 3286- :term:`UBOOT_FIT_SIGN_NUMBITS`: size of the private key for FIT image
3287 signing. 3287 signing.
3288- :term:`UBOOT_FIT_KEY_SIGN_PKCS`: algorithm for the public key certificate 3288- :term:`UBOOT_FIT_KEY_SIGN_PKCS`: algorithm for the public key certificate
3289 for FIT image signing. 3289 for FIT image signing.
3290- :term:`UBOOT_FITIMAGE_ENABLE`: enable the generation of a U-Boot FIT image. 3290- :term:`UBOOT_FITIMAGE_ENABLE`: enable the generation of a U-Boot FIT image.
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index c28cd7a94a..2e4b23408d 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -358,7 +358,7 @@ information.
358``do_populate_sdk_ext`` 358``do_populate_sdk_ext``
359----------------------- 359-----------------------
360 360
361Creates the file and directory structure for an installable extensible 361Creates the file and directory structure for an installable extensible
362SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`" 362SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`"
363section in the Yocto Project Overview and Concepts Manual for more 363section in the Yocto Project Overview and Concepts Manual for more
364information. 364information.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 435481c9aa..52062b63fa 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2983,18 +2983,18 @@ system and gives an overview of their function and contents.
2983 2983
2984 :term:`FIT_ADDRESS_CELLS` 2984 :term:`FIT_ADDRESS_CELLS`
2985 Specifies the value of the ``#address-cells`` value for the 2985 Specifies the value of the ``#address-cells`` value for the
2986 description of the FIT image. 2986 description of the FIT image.
2987 2987
2988 The default value is set to "1" by the :ref:`ref-classes-kernel-fitimage` 2988 The default value is set to "1" by the :ref:`ref-classes-kernel-fitimage`
2989 class, which corresponds to 32 bit addresses. 2989 class, which corresponds to 32 bit addresses.
2990 2990
2991 For platforms that need to set 64 bit addresses, for example in 2991 For platforms that need to set 64 bit addresses, for example in
2992 :term:`UBOOT_LOADADDRESS` and :term:`UBOOT_ENTRYPOINT`, you need to 2992 :term:`UBOOT_LOADADDRESS` and :term:`UBOOT_ENTRYPOINT`, you need to
2993 set this value to "2", as two 32 bit values (cells) will be needed 2993 set this value to "2", as two 32 bit values (cells) will be needed
2994 to represent such addresses. 2994 to represent such addresses.
2995 2995
2996 Here is an example setting "0x400000000" as a load address:: 2996 Here is an example setting "0x400000000" as a load address::
2997 2997
2998 FIT_ADDRESS_CELLS = "2" 2998 FIT_ADDRESS_CELLS = "2"
2999 UBOOT_LOADADDRESS= "0x04 0x00000000" 2999 UBOOT_LOADADDRESS= "0x04 0x00000000"
3000 3000
@@ -3971,15 +3971,15 @@ system and gives an overview of their function and contents.
3971 Specifies a space-separated list of license names (as they would 3971 Specifies a space-separated list of license names (as they would
3972 appear in :term:`LICENSE`) that should be excluded 3972 appear in :term:`LICENSE`) that should be excluded
3973 from the build (if set globally), or from an image (if set locally 3973 from the build (if set globally), or from an image (if set locally
3974 in an image recipe). 3974 in an image recipe).
3975 3975
3976 When the variable is set globally, recipes that provide no alternatives to listed 3976 When the variable is set globally, recipes that provide no alternatives to listed
3977 incompatible licenses are not built. Packages that are individually 3977 incompatible licenses are not built. Packages that are individually
3978 licensed with the specified incompatible licenses will be deleted. 3978 licensed with the specified incompatible licenses will be deleted.
3979 Most of the time this does not allow a feasible build (because it becomes impossible 3979 Most of the time this does not allow a feasible build (because it becomes impossible
3980 to satisfy build time dependencies), so the recommended way to 3980 to satisfy build time dependencies), so the recommended way to
3981 implement license restrictions is to set the variable in specific 3981 implement license restrictions is to set the variable in specific
3982 image recipes where the restrictions must apply. That way there 3982 image recipes where the restrictions must apply. That way there
3983 are no build time restrictions, but the license check is still 3983 are no build time restrictions, but the license check is still
3984 performed when the image's filesystem is assembled from packages. 3984 performed when the image's filesystem is assembled from packages.
3985 3985
@@ -4495,12 +4495,12 @@ system and gives an overview of their function and contents.
4495 When kernel configuration fragments are missing for some 4495 When kernel configuration fragments are missing for some
4496 :term:`KERNEL_FEATURES` specified by layers or BSPs, 4496 :term:`KERNEL_FEATURES` specified by layers or BSPs,
4497 building and configuring the kernel stops with an error. 4497 building and configuring the kernel stops with an error.
4498 4498
4499 You can turn these errors into warnings by setting the 4499 You can turn these errors into warnings by setting the
4500 following in ``conf/local.conf``:: 4500 following in ``conf/local.conf``::
4501 4501
4502 KERNEL_DANGLING_FEATURES_WARN_ONLY = "1" 4502 KERNEL_DANGLING_FEATURES_WARN_ONLY = "1"
4503 4503
4504 You will still be warned that runtime issues may occur, 4504 You will still be warned that runtime issues may occur,
4505 but at least the kernel configuration and build process will 4505 but at least the kernel configuration and build process will
4506 be allowed to continue. 4506 be allowed to continue.
@@ -7868,7 +7868,7 @@ system and gives an overview of their function and contents.
7868 This option allows to associate `SPDX annotations 7868 This option allows to associate `SPDX annotations
7869 <https://spdx.github.io/spdx-spec/v2.3/annotations/>`__ to a recipe, 7869 <https://spdx.github.io/spdx-spec/v2.3/annotations/>`__ to a recipe,
7870 using the values of variables in the recipe:: 7870 using the values of variables in the recipe::
7871 7871
7872 ANNOTATION1 = "First annotation for recipe" 7872 ANNOTATION1 = "First annotation for recipe"
7873 ANNOTATION2 = "Second annotation for recipe" 7873 ANNOTATION2 = "Second annotation for recipe"
7874 SPDX_CUSTOM_ANNOTATION_VARS = "ANNOTATION1 ANNOTATION2" 7874 SPDX_CUSTOM_ANNOTATION_VARS = "ANNOTATION1 ANNOTATION2"
@@ -7991,7 +7991,7 @@ system and gives an overview of their function and contents.
7991 The name of keys used by the :ref:`ref-classes-kernel-fitimage` class 7991 The name of keys used by the :ref:`ref-classes-kernel-fitimage` class
7992 for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR` 7992 for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR`
7993 directory. If we have for example a ``dev.key`` key and a ``dev.crt`` 7993 directory. If we have for example a ``dev.key`` key and a ``dev.crt``
7994 certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will 7994 certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will
7995 have to set :term:`SPL_SIGN_KEYNAME` to ``dev``. 7995 have to set :term:`SPL_SIGN_KEYNAME` to ``dev``.
7996 7996
7997 :term:`SPLASH` 7997 :term:`SPLASH`
@@ -8028,7 +8028,7 @@ system and gives an overview of their function and contents.
8028 8028
8029 EXTRA_OECONF += "--disable-startup-msg --enable-img-fullscreen" 8029 EXTRA_OECONF += "--disable-startup-msg --enable-img-fullscreen"
8030 8030
8031 For information on append files, see the 8031 For information on append files, see the
8032 ":ref:`dev-manual/layers:appending other layers metadata with your layer`" 8032 ":ref:`dev-manual/layers:appending other layers metadata with your layer`"
8033 section. 8033 section.
8034 8034
@@ -9442,10 +9442,10 @@ system and gives an overview of their function and contents.
9442 9442
9443 :term:`UBOOT_FIT_ADDRESS_CELLS` 9443 :term:`UBOOT_FIT_ADDRESS_CELLS`
9444 Specifies the value of the ``#address-cells`` value for the 9444 Specifies the value of the ``#address-cells`` value for the
9445 description of the U-Boot FIT image. 9445 description of the U-Boot FIT image.
9446 9446
9447 The default value is set to "1" by the :ref:`ref-classes-uboot-sign` 9447 The default value is set to "1" by the :ref:`ref-classes-uboot-sign`
9448 class, which corresponds to 32 bit addresses. 9448 class, which corresponds to 32 bit addresses.
9449 9449
9450 For platforms that need to set 64 bit addresses in 9450 For platforms that need to set 64 bit addresses in
9451 :term:`UBOOT_LOADADDRESS` and :term:`UBOOT_ENTRYPOINT`, you need to 9451 :term:`UBOOT_LOADADDRESS` and :term:`UBOOT_ENTRYPOINT`, you need to
@@ -9453,7 +9453,7 @@ system and gives an overview of their function and contents.
9453 to represent such addresses. 9453 to represent such addresses.
9454 9454
9455 Here is an example setting "0x400000000" as a load address:: 9455 Here is an example setting "0x400000000" as a load address::
9456 9456
9457 UBOOT_FIT_ADDRESS_CELLS = "2" 9457 UBOOT_FIT_ADDRESS_CELLS = "2"
9458 UBOOT_LOADADDRESS= "0x04 0x00000000" 9458 UBOOT_LOADADDRESS= "0x04 0x00000000"
9459 9459
@@ -9516,7 +9516,7 @@ system and gives an overview of their function and contents.
9516 UBOOT_FITIMAGE_ENABLE = "1" 9516 UBOOT_FITIMAGE_ENABLE = "1"
9517 9517
9518 See the :ref:`ref-classes-uboot-sign` class for details. 9518 See the :ref:`ref-classes-uboot-sign` class for details.
9519 9519
9520 :term:`UBOOT_LOADADDRESS` 9520 :term:`UBOOT_LOADADDRESS`
9521 Specifies the load address for the U-Boot image. During U-Boot image 9521 Specifies the load address for the U-Boot image. During U-Boot image
9522 creation, the :term:`UBOOT_LOADADDRESS` variable is passed as a 9522 creation, the :term:`UBOOT_LOADADDRESS` variable is passed as a