diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2024-03-30 17:52:37 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2024-04-08 14:36:38 +0100 |
commit | fed404fca0ae6eb313aeac7c029d22c06b5486a7 (patch) | |
tree | 3c44e751d9d3f676ae2d56f05f212cdc022f2ad4 /documentation | |
parent | ae1b8c607909d108d994386ad6e78f1f0422e174 (diff) | |
download | poky-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')
-rw-r--r-- | documentation/dev-manual/init-manager.rst | 2 | ||||
-rw-r--r-- | documentation/dev-manual/start.rst | 2 | ||||
-rw-r--r-- | documentation/dev-manual/wic.rst | 4 | ||||
-rw-r--r-- | documentation/migration-guides/migration-4.0.rst | 20 | ||||
-rw-r--r-- | documentation/migration-guides/release-notes-4.0.5.rst | 2 | ||||
-rw-r--r-- | documentation/migration-guides/release-notes-4.0.rst | 16 | ||||
-rw-r--r-- | documentation/migration-guides/release-notes-4.2.rst | 4 | ||||
-rw-r--r-- | documentation/overview-manual/intro.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/classes.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/tasks.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 32 |
11 files changed, 45 insertions, 45 deletions
diff --git a/documentation/dev-manual/init-manager.rst b/documentation/dev-manual/init-manager.rst index 20d61ea830..ddce82b81f 100644 --- a/documentation/dev-manual/init-manager.rst +++ b/documentation/dev-manual/init-manager.rst | |||
@@ -121,7 +121,7 @@ increasing levels of complexity and functionality: | |||
121 | :widths: 40 20 20 20 | 121 | :widths: 40 20 20 20 |
122 | :header-rows: 1 | 122 | :header-rows: 1 |
123 | 123 | ||
124 | * - | 124 | * - |
125 | - BusyBox init | 125 | - BusyBox init |
126 | - SysVinit | 126 | - SysVinit |
127 | - systemd | 127 | - systemd |
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 8539bc0889..386e5f5d29 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst | |||
@@ -619,7 +619,7 @@ containing the release you wish to use, for example | |||
619 | 619 | ||
620 | You will find there source archives of individual components (if you wish | 620 | You will find there source archives of individual components (if you wish |
621 | to use them individually), and of the corresponding Poky release bundling | 621 | to use them individually), and of the corresponding Poky release bundling |
622 | a selection of these components. | 622 | a selection of these components. |
623 | 623 | ||
624 | .. note:: | 624 | .. note:: |
625 | 625 | ||
diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst index 05e9cb381b..aeecd0dd3e 100644 --- a/documentation/dev-manual/wic.rst +++ b/documentation/dev-manual/wic.rst | |||
@@ -146,7 +146,7 @@ command to return the available Wic images as follows:: | |||
146 | qemuloongarch Create qcow2 image for LoongArch QEMU machines | 146 | qemuloongarch Create qcow2 image for LoongArch QEMU machines |
147 | directdisk-multi-rootfs Create multi rootfs image using rootfs plugin | 147 | directdisk-multi-rootfs Create multi rootfs image using rootfs plugin |
148 | directdisk Create a 'pcbios' direct disk image | 148 | directdisk Create a 'pcbios' direct disk image |
149 | efi-bootdisk | 149 | efi-bootdisk |
150 | mkhybridiso Create a hybrid ISO image | 150 | mkhybridiso Create a hybrid ISO image |
151 | directdisk-gpt Create a 'pcbios' direct disk image | 151 | directdisk-gpt Create a 'pcbios' direct disk image |
152 | systemd-bootdisk Create an EFI disk image with systemd-boot | 152 | systemd-bootdisk Create an EFI disk image with systemd-boot |
@@ -289,7 +289,7 @@ Use the following command to list the available kickstart files:: | |||
289 | qemuloongarch Create qcow2 image for LoongArch QEMU machines | 289 | qemuloongarch Create qcow2 image for LoongArch QEMU machines |
290 | directdisk-multi-rootfs Create multi rootfs image using rootfs plugin | 290 | directdisk-multi-rootfs Create multi rootfs image using rootfs plugin |
291 | directdisk Create a 'pcbios' direct disk image | 291 | directdisk Create a 'pcbios' direct disk image |
292 | efi-bootdisk | 292 | efi-bootdisk |
293 | mkhybridiso Create a hybrid ISO image | 293 | mkhybridiso Create a hybrid ISO image |
294 | directdisk-gpt Create a 'pcbios' direct disk image | 294 | directdisk-gpt Create a 'pcbios' direct disk image |
295 | systemd-bootdisk Create an EFI disk image with systemd-boot | 295 | systemd-bootdisk Create an EFI disk image with systemd-boot |
diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst index b5bd57c312..0e9e741458 100644 --- a/documentation/migration-guides/migration-4.0.rst +++ b/documentation/migration-guides/migration-4.0.rst | |||
@@ -68,7 +68,7 @@ changes and you need to review them before committing. An example warning | |||
68 | looks like:: | 68 | looks like:: |
69 | 69 | ||
70 | poky/scripts/lib/devtool/upgrade.py needs further work at line 275 since it contains abort | 70 | poky/scripts/lib/devtool/upgrade.py needs further work at line 275 since it contains abort |
71 | 71 | ||
72 | Fetching changes | 72 | Fetching changes |
73 | ~~~~~~~~~~~~~~~~ | 73 | ~~~~~~~~~~~~~~~~ |
74 | 74 | ||
@@ -111,7 +111,7 @@ License changes | |||
111 | If they do not, by default a warning will be shown. A | 111 | If they do not, by default a warning will be shown. A |
112 | :oe_git:`convert-spdx-licenses.py </openembedded-core/tree/scripts/contrib/convert-spdx-licenses.py>` | 112 | :oe_git:`convert-spdx-licenses.py </openembedded-core/tree/scripts/contrib/convert-spdx-licenses.py>` |
113 | script can be used to update your recipes. | 113 | script can be used to update your recipes. |
114 | 114 | ||
115 | - :term:`INCOMPATIBLE_LICENSE` should now use `SPDX identifiers <https://spdx.org/licenses/>`__. | 115 | - :term:`INCOMPATIBLE_LICENSE` should now use `SPDX identifiers <https://spdx.org/licenses/>`__. |
116 | Additionally, wildcarding is now limited to specifically supported values - | 116 | Additionally, wildcarding is now limited to specifically supported values - |
117 | see the :term:`INCOMPATIBLE_LICENSE` documentation for further information. | 117 | see the :term:`INCOMPATIBLE_LICENSE` documentation for further information. |
@@ -121,7 +121,7 @@ License changes | |||
121 | which can cause signature issues for users. In addition the ``available_licenses()`` | 121 | which can cause signature issues for users. In addition the ``available_licenses()`` |
122 | function has been removed from the :ref:`ref-classes-license` class as | 122 | function has been removed from the :ref:`ref-classes-license` class as |
123 | it is no longer needed. | 123 | it is no longer needed. |
124 | 124 | ||
125 | Removed recipes | 125 | Removed recipes |
126 | ~~~~~~~~~~~~~~~ | 126 | ~~~~~~~~~~~~~~~ |
127 | 127 | ||
@@ -136,11 +136,11 @@ The following recipes have been removed in this release: | |||
136 | 136 | ||
137 | Python changes | 137 | Python changes |
138 | ~~~~~~~~~~~~~~ | 138 | ~~~~~~~~~~~~~~ |
139 | 139 | ||
140 | - ``distutils`` has been deprecated upstream in Python 3.10 and thus the ``distutils*`` | 140 | - ``distutils`` has been deprecated upstream in Python 3.10 and thus the ``distutils*`` |
141 | classes have been moved to ``meta-python``. Recipes that inherit the ``distutils*`` | 141 | classes have been moved to ``meta-python``. Recipes that inherit the ``distutils*`` |
142 | classes should be updated to inherit ``setuptools*`` equivalents instead. | 142 | classes should be updated to inherit ``setuptools*`` equivalents instead. |
143 | 143 | ||
144 | - The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. | 144 | - The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. |
145 | The new Python packaging classes that should be used are | 145 | The new Python packaging classes that should be used are |
146 | :ref:`ref-classes-python_flit_core`, :ref:`ref-classes-python_setuptools_build_meta` | 146 | :ref:`ref-classes-python_flit_core`, :ref:`ref-classes-python_setuptools_build_meta` |
@@ -159,7 +159,7 @@ Prelink removed | |||
159 | Prelink has been dropped by ``glibc`` upstream in 2.36. It already caused issues with | 159 | Prelink has been dropped by ``glibc`` upstream in 2.36. It already caused issues with |
160 | binary corruption, has a number of open bugs and is of questionable benefit | 160 | binary corruption, has a number of open bugs and is of questionable benefit |
161 | without disabling load address randomization and PIE executables. | 161 | without disabling load address randomization and PIE executables. |
162 | 162 | ||
163 | We disabled prelinking by default in the honister (3.4) release, but left it able | 163 | We disabled prelinking by default in the honister (3.4) release, but left it able |
164 | to be enabled if desired. However, without glibc support it cannot be maintained | 164 | to be enabled if desired. However, without glibc support it cannot be maintained |
165 | any further, so all of the prelinking functionality has been removed in this release. | 165 | any further, so all of the prelinking functionality has been removed in this release. |
@@ -170,7 +170,7 @@ reference(s). | |||
170 | Reproducible as standard | 170 | Reproducible as standard |
171 | ~~~~~~~~~~~~~~~~~~~~~~~~ | 171 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
172 | 172 | ||
173 | Reproducibility is now considered as standard functionality, thus the | 173 | Reproducibility is now considered as standard functionality, thus the |
174 | ``reproducible`` class has been removed and its previous contents merged into the | 174 | ``reproducible`` class has been removed and its previous contents merged into the |
175 | :ref:`ref-classes-base` class. If you have references in your configuration to | 175 | :ref:`ref-classes-base` class. If you have references in your configuration to |
176 | ``reproducible`` in :term:`INHERIT`, :term:`USER_CLASSES` etc. then they should be | 176 | ``reproducible`` in :term:`INHERIT`, :term:`USER_CLASSES` etc. then they should be |
@@ -212,7 +212,7 @@ and :ref:`bitbake-user-manual/bitbake-user-manual-metadata:removal (override sty | |||
212 | 212 | ||
213 | Miscellaneous changes | 213 | Miscellaneous changes |
214 | ~~~~~~~~~~~~~~~~~~~~~ | 214 | ~~~~~~~~~~~~~~~~~~~~~ |
215 | 215 | ||
216 | - ``blacklist.bbclass`` is removed and the functionality moved to the | 216 | - ``blacklist.bbclass`` is removed and the functionality moved to the |
217 | :ref:`ref-classes-base` class with a more descriptive | 217 | :ref:`ref-classes-base` class with a more descriptive |
218 | ``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()` | 218 | ``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()` |
@@ -252,7 +252,7 @@ Miscellaneous changes | |||
252 | - The ``cortexa72-crc`` and ``cortexa72-crc-crypto`` tunes have been removed since | 252 | - The ``cortexa72-crc`` and ``cortexa72-crc-crypto`` tunes have been removed since |
253 | the crc extension is now enabled by default for cortexa72. Replace any references to | 253 | the crc extension is now enabled by default for cortexa72. Replace any references to |
254 | these with ``cortexa72`` and ``cortexa72-crypto`` respectively. | 254 | these with ``cortexa72`` and ``cortexa72-crypto`` respectively. |
255 | 255 | ||
256 | - The Python development shell (previously known as ``devpyshell``) feature has been | 256 | - The Python development shell (previously known as ``devpyshell``) feature has been |
257 | renamed to ``pydevshell``. To start it you should now run:: | 257 | renamed to ``pydevshell``. To start it you should now run:: |
258 | 258 | ||
@@ -261,7 +261,7 @@ Miscellaneous changes | |||
261 | - The ``packagegroups-core-full-cmdline-libs`` packagegroup is no longer produced, as | 261 | - The ``packagegroups-core-full-cmdline-libs`` packagegroup is no longer produced, as |
262 | libraries should normally be brought in via dependencies. If you have any references | 262 | libraries should normally be brought in via dependencies. If you have any references |
263 | to this then remove them. | 263 | to this then remove them. |
264 | 264 | ||
265 | - The :term:`TOPDIR` variable and the current working directory are no longer modified | 265 | - The :term:`TOPDIR` variable and the current working directory are no longer modified |
266 | when parsing recipes. Any code depending on the previous behaviour will no longer | 266 | when parsing recipes. Any code depending on the previous behaviour will no longer |
267 | work - change any such code to explicitly use appropriate path variables instead. | 267 | work - change any such code to explicitly use appropriate path variables instead. |
diff --git a/documentation/migration-guides/release-notes-4.0.5.rst b/documentation/migration-guides/release-notes-4.0.5.rst index 172b8b800d..cdfe85b750 100644 --- a/documentation/migration-guides/release-notes-4.0.5.rst +++ b/documentation/migration-guides/release-notes-4.0.5.rst | |||
@@ -83,7 +83,7 @@ Fixes in Yocto-4.0.5 | |||
83 | Known Issues in Yocto-4.0.5 | 83 | Known Issues in Yocto-4.0.5 |
84 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 84 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
85 | 85 | ||
86 | - There are recent CVEs in key components such as openssl. They are not included in this release as it was built before the issues were known and fixes were available but these are now available on the kirkstone branch. | 86 | - There are recent CVEs in key components such as openssl. They are not included in this release as it was built before the issues were known and fixes were available but these are now available on the kirkstone branch. |
87 | 87 | ||
88 | 88 | ||
89 | Contributors to Yocto-4.0.5 | 89 | Contributors to Yocto-4.0.5 |
diff --git a/documentation/migration-guides/release-notes-4.0.rst b/documentation/migration-guides/release-notes-4.0.rst index 6eb5f807de..a5d66c0410 100644 --- a/documentation/migration-guides/release-notes-4.0.rst +++ b/documentation/migration-guides/release-notes-4.0.rst | |||
@@ -38,7 +38,7 @@ New Features / Enhancements in 4.0 | |||
38 | 38 | ||
39 | - Inclusive language adjustments to some variable names - see the | 39 | - Inclusive language adjustments to some variable names - see the |
40 | :ref:`4.0 migration guide <migration-4.0-inclusive-language>` for details. | 40 | :ref:`4.0 migration guide <migration-4.0-inclusive-language>` for details. |
41 | 41 | ||
42 | - New recipes: | 42 | - New recipes: |
43 | 43 | ||
44 | - ``buildtools-docs-tarball`` | 44 | - ``buildtools-docs-tarball`` |
@@ -114,7 +114,7 @@ New Features / Enhancements in 4.0 | |||
114 | - BitBake enhancements: | 114 | - BitBake enhancements: |
115 | 115 | ||
116 | - Fetcher enhancements: | 116 | - Fetcher enhancements: |
117 | 117 | ||
118 | - New :ref:`bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` for Rust packages | 118 | - New :ref:`bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` for Rust packages |
119 | - Added striplevel support to unpack | 119 | - Added striplevel support to unpack |
120 | - git: Add a warning asking users to set a branch in git urls | 120 | - git: Add a warning asking users to set a branch in git urls |
@@ -127,7 +127,7 @@ New Features / Enhancements in 4.0 | |||
127 | - ssh: now supports checkstatus, allows : in URLs (both required for use with sstate) and no longer requires username | 127 | - ssh: now supports checkstatus, allows : in URLs (both required for use with sstate) and no longer requires username |
128 | - wget: add redirectauth parameter | 128 | - wget: add redirectauth parameter |
129 | - wget: add 30s timeout for checkstatus calls | 129 | - wget: add 30s timeout for checkstatus calls |
130 | 130 | ||
131 | - Show warnings for append/prepend/remove operators combined with +=/.= | 131 | - Show warnings for append/prepend/remove operators combined with +=/.= |
132 | - Add bb.warnonce() and bb.erroronce() log methods | 132 | - Add bb.warnonce() and bb.erroronce() log methods |
133 | - Improved setscene task display | 133 | - Improved setscene task display |
@@ -140,7 +140,7 @@ New Features / Enhancements in 4.0 | |||
140 | - Architecture-specific enhancements: | 140 | - Architecture-specific enhancements: |
141 | 141 | ||
142 | - ARM: | 142 | - ARM: |
143 | 143 | ||
144 | - tune-cortexa72: Enable the crc extension by default for cortexa72 | 144 | - tune-cortexa72: Enable the crc extension by default for cortexa72 |
145 | - qemuarm64: Add tiny ktype to qemuarm64 bsp | 145 | - qemuarm64: Add tiny ktype to qemuarm64 bsp |
146 | - armv9a/tune: Add the support for the Neoverse N2 core | 146 | - armv9a/tune: Add the support for the Neoverse N2 core |
@@ -163,7 +163,7 @@ New Features / Enhancements in 4.0 | |||
163 | - linux-yocto-dev: add qemuriscv32 | 163 | - linux-yocto-dev: add qemuriscv32 |
164 | - packagegroup-core-tools-profile: Enable systemtap for riscv64 | 164 | - packagegroup-core-tools-profile: Enable systemtap for riscv64 |
165 | - qemuriscv: Use virtio-tablet-pci for mouse | 165 | - qemuriscv: Use virtio-tablet-pci for mouse |
166 | 166 | ||
167 | - x86: | 167 | - x86: |
168 | 168 | ||
169 | - kernel-yocto: conditionally enable stack protection checking on x86-64 | 169 | - kernel-yocto: conditionally enable stack protection checking on x86-64 |
@@ -199,7 +199,7 @@ New Features / Enhancements in 4.0 | |||
199 | - yocto-check-layer: improved README checks | 199 | - yocto-check-layer: improved README checks |
200 | - cve-check: add json output format | 200 | - cve-check: add json output format |
201 | - cve-check: add coverage statistics on recipes with/without CVEs | 201 | - cve-check: add coverage statistics on recipes with/without CVEs |
202 | - Added mirrors for kernel sources and uninative binaries on kernel.org | 202 | - Added mirrors for kernel sources and uninative binaries on kernel.org |
203 | - glibc and binutils recipes now use shallow mirror tarballs for faster fetching | 203 | - glibc and binutils recipes now use shallow mirror tarballs for faster fetching |
204 | - When patching fails, show more information on the fatal error | 204 | - When patching fails, show more information on the fatal error |
205 | 205 | ||
@@ -234,7 +234,7 @@ New Features / Enhancements in 4.0 | |||
234 | - Detect more known licenses in Python code | 234 | - Detect more known licenses in Python code |
235 | - Move license md5sums data into CSV files | 235 | - Move license md5sums data into CSV files |
236 | - npm: Use README as license fallback | 236 | - npm: Use README as license fallback |
237 | 237 | ||
238 | - SDK-related enhancements: | 238 | - SDK-related enhancements: |
239 | 239 | ||
240 | - Extended recipes to :ref:`ref-classes-nativesdk`: ``cargo``, | 240 | - Extended recipes to :ref:`ref-classes-nativesdk`: ``cargo``, |
@@ -244,7 +244,7 @@ New Features / Enhancements in 4.0 | |||
244 | - Support creating per-toolchain cmake file in SDK | 244 | - Support creating per-toolchain cmake file in SDK |
245 | 245 | ||
246 | - Rust enhancements: | 246 | - Rust enhancements: |
247 | 247 | ||
248 | - New python_setuptools3_rust class to enable building python extensions in Rust | 248 | - New python_setuptools3_rust class to enable building python extensions in Rust |
249 | - classes/meson: Add optional rust definitions | 249 | - classes/meson: Add optional rust definitions |
250 | 250 | ||
diff --git a/documentation/migration-guides/release-notes-4.2.rst b/documentation/migration-guides/release-notes-4.2.rst index 653602f152..30049b89f6 100644 --- a/documentation/migration-guides/release-notes-4.2.rst +++ b/documentation/migration-guides/release-notes-4.2.rst | |||
@@ -35,7 +35,7 @@ New Features / Enhancements in 4.2 | |||
35 | 35 | ||
36 | - BitBake's UI will now ping the server regularly to ensure | 36 | - BitBake's UI will now ping the server regularly to ensure |
37 | it is still alive. | 37 | it is still alive. |
38 | 38 | ||
39 | - New variables: | 39 | - New variables: |
40 | 40 | ||
41 | - :term:`VOLATILE_TMP_DIR` allows to specify | 41 | - :term:`VOLATILE_TMP_DIR` allows to specify |
@@ -288,7 +288,7 @@ New Features / Enhancements in 4.2 | |||
288 | BitBake manual. All variables should be easy to access through the Yocto | 288 | BitBake manual. All variables should be easy to access through the Yocto |
289 | Manual variable index. | 289 | Manual variable index. |
290 | - Expanded the description of the :term:`BB_NUMBER_THREADS` variable. | 290 | - Expanded the description of the :term:`BB_NUMBER_THREADS` variable. |
291 | 291 | ||
292 | - Miscellaneous changes: | 292 | - Miscellaneous changes: |
293 | 293 | ||
294 | - Supporting 64 bit dates on 32 bit platforms: several packages have been | 294 | - Supporting 64 bit dates on 32 bit platforms: several packages have been |
diff --git a/documentation/overview-manual/intro.rst b/documentation/overview-manual/intro.rst index a8091771f4..80446b3810 100644 --- a/documentation/overview-manual/intro.rst +++ b/documentation/overview-manual/intro.rst | |||
@@ -38,7 +38,7 @@ This manual does not give you the following: | |||
38 | procedures reside in other manuals within the Yocto Project | 38 | procedures reside in other manuals within the Yocto Project |
39 | documentation set. For example, the :doc:`/dev-manual/index` | 39 | documentation set. For example, the :doc:`/dev-manual/index` |
40 | provides examples on how to perform | 40 | provides examples on how to perform |
41 | various development tasks. As another example, the | 41 | various development tasks. As another example, the |
42 | :doc:`/sdk-manual/index` manual contains detailed | 42 | :doc:`/sdk-manual/index` manual contains detailed |
43 | instructions on how to install an SDK, which is used to develop | 43 | instructions on how to install an SDK, which is used to develop |
44 | applications for target hardware. | 44 | applications for target hardware. |
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` | |||
665 | to the desired size, in bytes. | 665 | to the desired size, in bytes. |
666 | 666 | ||
667 | See :oe_git:`devicetree.bbclass sources | 667 | See :oe_git:`devicetree.bbclass sources |
668 | </openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>` | 668 | </openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>` |
669 | for further variables controlling this class. | 669 | for further variables controlling this class. |
670 | 670 | ||
671 | Here is an excerpt of an example ``recipes-kernel/linux/devicetree-acme.bb`` | 671 | Here 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 | ||
361 | Creates the file and directory structure for an installable extensible | 361 | Creates the file and directory structure for an installable extensible |
362 | SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`" | 362 | SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`" |
363 | section in the Yocto Project Overview and Concepts Manual for more | 363 | section in the Yocto Project Overview and Concepts Manual for more |
364 | information. | 364 | information. |
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 |