summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2024-03-30 17:52:37 +0100
committerSteve Sakoman <steve@sakoman.com>2024-04-19 04:50:39 -0700
commitfac2a5eff5d149e7850b69bc2480292fa3a3f5e9 (patch)
treed3b919085adf820b4b9505370793a1e42cd4c82f
parenta6fdddf8c44367a5bd82ba9d979e708bd710db79 (diff)
downloadpoky-fac2a5eff5d149e7850b69bc2480292fa3a3f5e9.tar.gz
manuals: fix trailing spaces
Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: 45b04c281a567e06fd2904166bcc26603e73e684) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r--documentation/dev-manual/init-manager.rst2
-rw-r--r--documentation/dev-manual/start.rst12
-rw-r--r--documentation/dev-manual/wic.rst4
-rw-r--r--documentation/migration-guides/migration-4.0.rst20
-rw-r--r--documentation/migration-guides/release-notes-4.0.5.rst2
-rw-r--r--documentation/migration-guides/release-notes-4.0.rst17
-rw-r--r--documentation/overview-manual/intro.rst2
-rw-r--r--documentation/ref-manual/classes.rst2
-rw-r--r--documentation/ref-manual/tasks.rst2
-rw-r--r--documentation/ref-manual/variables.rst2
10 files changed, 34 insertions, 31 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 7b6026cf42..aec39b02a9 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -612,10 +612,14 @@ Use the following procedure to locate the latest upstream copy of the
612Accessing Index of Releases 612Accessing Index of Releases
613--------------------------- 613---------------------------
614 614
615Yocto Project maintains an Index of Releases area that contains related 615The Yocto Project also provides source archives of its releases, which
616files that contribute to the Yocto Project. Rather than Git 616are available on :yocto_dl:`/releases/yocto/`. Then, choose the subdirectory
617repositories, these files are tarballs that represent snapshots in time 617containing the release you wish to use, for example
618of a given component. 618:yocto_dl:`yocto-&DISTRO; </releases/yocto/yocto-&DISTRO;/>`.
619
620You will find there source archives of individual components (if you wish
621to use them individually), and of the corresponding Poky release bundling
622a selection of these components.
619 623
620.. note:: 624.. note::
621 625
diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst
index f794693c50..687c9e6580 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 mkefidisk Create an EFI disk image 146 mkefidisk Create an EFI disk image
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
@@ -290,7 +290,7 @@ Use the following command to list the available kickstart files::
290 mkefidisk Create an EFI disk image 290 mkefidisk Create an EFI disk image
291 directdisk-multi-rootfs Create multi rootfs image using rootfs plugin 291 directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
292 directdisk Create a 'pcbios' direct disk image 292 directdisk Create a 'pcbios' direct disk image
293 efi-bootdisk 293 efi-bootdisk
294 mkhybridiso Create a hybrid ISO image 294 mkhybridiso Create a hybrid ISO image
295 directdisk-gpt Create a 'pcbios' direct disk image 295 directdisk-gpt Create a 'pcbios' direct disk image
296 systemd-bootdisk Create an EFI disk image with systemd-boot 296 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 93576d4538..5e240457c0 100644
--- a/documentation/migration-guides/migration-4.0.rst
+++ b/documentation/migration-guides/migration-4.0.rst
@@ -66,7 +66,7 @@ changes and you need to review them before committing. An example warning
66looks like:: 66looks like::
67 67
68 poky/scripts/lib/devtool/upgrade.py needs further work at line 275 since it contains abort 68 poky/scripts/lib/devtool/upgrade.py needs further work at line 275 since it contains abort
69 69
70Fetching changes 70Fetching changes
71~~~~~~~~~~~~~~~~ 71~~~~~~~~~~~~~~~~
72 72
@@ -109,7 +109,7 @@ License changes
109 If they do not, by default a warning will be shown. A 109 If they do not, by default a warning will be shown. A
110 :oe_git:`convert-spdx-licenses.py </openembedded-core/tree/scripts/contrib/convert-spdx-licenses.py>` 110 :oe_git:`convert-spdx-licenses.py </openembedded-core/tree/scripts/contrib/convert-spdx-licenses.py>`
111 script can be used to update your recipes. 111 script can be used to update your recipes.
112 112
113- :term:`INCOMPATIBLE_LICENSE` should now use `SPDX identifiers <https://spdx.org/licenses/>`__. 113- :term:`INCOMPATIBLE_LICENSE` should now use `SPDX identifiers <https://spdx.org/licenses/>`__.
114 Additionally, wildcarding is now limited to specifically supported values - 114 Additionally, wildcarding is now limited to specifically supported values -
115 see the :term:`INCOMPATIBLE_LICENSE` documentation for further information. 115 see the :term:`INCOMPATIBLE_LICENSE` documentation for further information.
@@ -119,7 +119,7 @@ License changes
119 which can cause signature issues for users. In addition the ``available_licenses()`` 119 which can cause signature issues for users. In addition the ``available_licenses()``
120 function has been removed from the :ref:`license <ref-classes-license>` class as 120 function has been removed from the :ref:`license <ref-classes-license>` class as
121 it is no longer needed. 121 it is no longer needed.
122 122
123Removed recipes 123Removed recipes
124~~~~~~~~~~~~~~~ 124~~~~~~~~~~~~~~~
125 125
@@ -134,11 +134,11 @@ The following recipes have been removed in this release:
134 134
135Python changes 135Python changes
136~~~~~~~~~~~~~~ 136~~~~~~~~~~~~~~
137 137
138- ``distutils`` has been deprecated upstream in Python 3.10 and thus the ``distutils*`` 138- ``distutils`` has been deprecated upstream in Python 3.10 and thus the ``distutils*``
139 classes have been moved to ``meta-python``. Recipes that inherit the ``distutils*`` 139 classes have been moved to ``meta-python``. Recipes that inherit the ``distutils*``
140 classes should be updated to inherit ``setuptools*`` equivalents instead. 140 classes should be updated to inherit ``setuptools*`` equivalents instead.
141 141
142- The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. 142- The Python package build process is now based on `wheels <https://pythonwheels.com/>`__.
143 The new Python packaging classes that should be used are 143 The new Python packaging classes that should be used are
144 :ref:`python_flit_core <ref-classes-python_flit_core>`, 144 :ref:`python_flit_core <ref-classes-python_flit_core>`,
@@ -158,7 +158,7 @@ Prelink removed
158Prelink has been dropped by ``glibc`` upstream in 2.36. It already caused issues with 158Prelink has been dropped by ``glibc`` upstream in 2.36. It already caused issues with
159binary corruption, has a number of open bugs and is of questionable benefit 159binary corruption, has a number of open bugs and is of questionable benefit
160without disabling load address randomization and PIE executables. 160without disabling load address randomization and PIE executables.
161 161
162We disabled prelinking by default in the honister (3.4) release, but left it able 162We disabled prelinking by default in the honister (3.4) release, but left it able
163to be enabled if desired. However, without glibc support it cannot be maintained 163to be enabled if desired. However, without glibc support it cannot be maintained
164any further, so all of the prelinking functionality has been removed in this release. 164any further, so all of the prelinking functionality has been removed in this release.
@@ -169,7 +169,7 @@ reference(s).
169Reproducible as standard 169Reproducible as standard
170~~~~~~~~~~~~~~~~~~~~~~~~ 170~~~~~~~~~~~~~~~~~~~~~~~~
171 171
172Reproducibility is now considered as standard functionality, thus the 172Reproducibility is now considered as standard functionality, thus the
173``reproducible`` class has been removed and its previous contents merged into the 173``reproducible`` class has been removed and its previous contents merged into the
174:ref:`base <ref-classes-base>` class. If you have references in your configuration to 174:ref:`base <ref-classes-base>` class. If you have references in your configuration to
175``reproducible`` in :term:`INHERIT`, :term:`USER_CLASSES` etc. then they should be 175``reproducible`` in :term:`INHERIT`, :term:`USER_CLASSES` etc. then they should be
@@ -211,7 +211,7 @@ and :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (over
211 211
212Miscellaneous changes 212Miscellaneous changes
213~~~~~~~~~~~~~~~~~~~~~ 213~~~~~~~~~~~~~~~~~~~~~
214 214
215- ``blacklist.bbclass`` is removed and the functionality moved to the 215- ``blacklist.bbclass`` is removed and the functionality moved to the
216 :ref:`base <ref-classes-base>` class with a more descriptive 216 :ref:`base <ref-classes-base>` class with a more descriptive
217 ``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()` 217 ``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()`
@@ -251,7 +251,7 @@ Miscellaneous changes
251- The ``cortexa72-crc`` and ``cortexa72-crc-crypto`` tunes have been removed since 251- The ``cortexa72-crc`` and ``cortexa72-crc-crypto`` tunes have been removed since
252 the crc extension is now enabled by default for cortexa72. Replace any references to 252 the crc extension is now enabled by default for cortexa72. Replace any references to
253 these with ``cortexa72`` and ``cortexa72-crypto`` respectively. 253 these with ``cortexa72`` and ``cortexa72-crypto`` respectively.
254 254
255- The Python development shell (previously known as ``devpyshell``) feature has been 255- The Python development shell (previously known as ``devpyshell``) feature has been
256 renamed to ``pydevshell``. To start it you should now run:: 256 renamed to ``pydevshell``. To start it you should now run::
257 257
@@ -260,7 +260,7 @@ Miscellaneous changes
260- The ``packagegroups-core-full-cmdline-libs`` packagegroup is no longer produced, as 260- The ``packagegroups-core-full-cmdline-libs`` packagegroup is no longer produced, as
261 libraries should normally be brought in via dependencies. If you have any references 261 libraries should normally be brought in via dependencies. If you have any references
262 to this then remove them. 262 to this then remove them.
263 263
264- The :term:`TOPDIR` variable and the current working directory are no longer modified 264- The :term:`TOPDIR` variable and the current working directory are no longer modified
265 when parsing recipes. Any code depending on the previous behaviour will no longer 265 when parsing recipes. Any code depending on the previous behaviour will no longer
266 work - change any such code to explicitly use appropriate path variables instead. 266 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 ea0280b03c..95cc6f6d30 100644
--- a/documentation/migration-guides/release-notes-4.0.5.rst
+++ b/documentation/migration-guides/release-notes-4.0.5.rst
@@ -81,7 +81,7 @@ Fixes in Yocto-4.0.5
81Known Issues in Yocto-4.0.5 81Known Issues in Yocto-4.0.5
82~~~~~~~~~~~~~~~~~~~~~~~~~~~ 82~~~~~~~~~~~~~~~~~~~~~~~~~~~
83 83
84- 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. 84- 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.
85 85
86 86
87Contributors to Yocto-4.0.5 87Contributors 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 b675cae217..11206072a0 100644
--- a/documentation/migration-guides/release-notes-4.0.rst
+++ b/documentation/migration-guides/release-notes-4.0.rst
@@ -36,7 +36,7 @@ New Features / Enhancements in 4.0
36 36
37- Inclusive language adjustments to some variable names - see the 37- Inclusive language adjustments to some variable names - see the
38 :ref:`4.0 migration guide <migration-4.0-inclusive-language>` for details. 38 :ref:`4.0 migration guide <migration-4.0-inclusive-language>` for details.
39 39
40- New recipes: 40- New recipes:
41 41
42 - ``buildtools-docs-tarball`` 42 - ``buildtools-docs-tarball``
@@ -112,8 +112,7 @@ New Features / Enhancements in 4.0
112- BitBake enhancements: 112- BitBake enhancements:
113 113
114 - Fetcher enhancements: 114 - Fetcher enhancements:
115 115 - New :ref:`bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` for Rust packages
116 - New :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` for Rust packages
117 - Added striplevel support to unpack 116 - Added striplevel support to unpack
118 - git: Add a warning asking users to set a branch in git urls 117 - git: Add a warning asking users to set a branch in git urls
119 - git: Allow git fetcher to support subdir param 118 - git: Allow git fetcher to support subdir param
@@ -125,7 +124,7 @@ New Features / Enhancements in 4.0
125 - ssh: now supports checkstatus, allows : in URLs (both required for use with sstate) and no longer requires username 124 - ssh: now supports checkstatus, allows : in URLs (both required for use with sstate) and no longer requires username
126 - wget: add redirectauth parameter 125 - wget: add redirectauth parameter
127 - wget: add 30s timeout for checkstatus calls 126 - wget: add 30s timeout for checkstatus calls
128 127
129 - Show warnings for append/prepend/remove operators combined with +=/.= 128 - Show warnings for append/prepend/remove operators combined with +=/.=
130 - Add bb.warnonce() and bb.erroronce() log methods 129 - Add bb.warnonce() and bb.erroronce() log methods
131 - Improved setscene task display 130 - Improved setscene task display
@@ -138,7 +137,7 @@ New Features / Enhancements in 4.0
138- Architecture-specific enhancements: 137- Architecture-specific enhancements:
139 138
140 - ARM: 139 - ARM:
141 140
142 - tune-cortexa72: Enable the crc extension by default for cortexa72 141 - tune-cortexa72: Enable the crc extension by default for cortexa72
143 - qemuarm64: Add tiny ktype to qemuarm64 bsp 142 - qemuarm64: Add tiny ktype to qemuarm64 bsp
144 - armv9a/tune: Add the support for the Neoverse N2 core 143 - armv9a/tune: Add the support for the Neoverse N2 core
@@ -161,7 +160,7 @@ New Features / Enhancements in 4.0
161 - linux-yocto-dev: add qemuriscv32 160 - linux-yocto-dev: add qemuriscv32
162 - packagegroup-core-tools-profile: Enable systemtap for riscv64 161 - packagegroup-core-tools-profile: Enable systemtap for riscv64
163 - qemuriscv: Use virtio-tablet-pci for mouse 162 - qemuriscv: Use virtio-tablet-pci for mouse
164 163
165 - x86: 164 - x86:
166 165
167 - kernel-yocto: conditionally enable stack protection checking on x86-64 166 - kernel-yocto: conditionally enable stack protection checking on x86-64
@@ -197,7 +196,7 @@ New Features / Enhancements in 4.0
197- yocto-check-layer: improved README checks 196- yocto-check-layer: improved README checks
198- cve-check: add json output format 197- cve-check: add json output format
199- cve-check: add coverage statistics on recipes with/without CVEs 198- cve-check: add coverage statistics on recipes with/without CVEs
200- Added mirrors for kernel sources and uninative binaries on kernel.org 199- Added mirrors for kernel sources and uninative binaries on kernel.org
201- glibc and binutils recipes now use shallow mirror tarballs for faster fetching 200- glibc and binutils recipes now use shallow mirror tarballs for faster fetching
202- When patching fails, show more information on the fatal error 201- When patching fails, show more information on the fatal error
203 202
@@ -232,7 +231,7 @@ New Features / Enhancements in 4.0
232 - Detect more known licenses in Python code 231 - Detect more known licenses in Python code
233 - Move license md5sums data into CSV files 232 - Move license md5sums data into CSV files
234 - npm: Use README as license fallback 233 - npm: Use README as license fallback
235 234
236- SDK-related enhancements: 235- SDK-related enhancements:
237 236
238 - Extended recipes to ``nativesdk``: ``cargo``, ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` 237 - Extended recipes to ``nativesdk``: ``cargo``, ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging``
@@ -240,7 +239,7 @@ New Features / Enhancements in 4.0
240 - Support creating per-toolchain cmake file in SDK 239 - Support creating per-toolchain cmake file in SDK
241 240
242- Rust enhancements: 241- Rust enhancements:
243 242
244 - New python_setuptools3_rust class to enable building python extensions in Rust 243 - New python_setuptools3_rust class to enable building python extensions in Rust
245 - classes/meson: Add optional rust definitions 244 - classes/meson: Add optional rust definitions
246 245
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 e7bf5e9a6e..43bdc8bd25 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -588,7 +588,7 @@ The padding size can be modified by setting :term:`DT_PADDING_SIZE`
588to the desired size, in bytes. 588to the desired size, in bytes.
589 589
590See :oe_git:`devicetree.bbclass sources 590See :oe_git:`devicetree.bbclass sources
591</openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>` 591</openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>`
592for further variables controlling this class. 592for further variables controlling this class.
593 593
594Here is an excerpt of an example ``recipes-kernel/linux/devicetree-acme.bb`` 594Here is an excerpt of an example ``recipes-kernel/linux/devicetree-acme.bb``
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 0f1f95b9ff..346e9491f3 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -369,7 +369,7 @@ information.
369``do_populate_sdk_ext`` 369``do_populate_sdk_ext``
370----------------------- 370-----------------------
371 371
372Creates the file and directory structure for an installable extensible 372Creates the file and directory structure for an installable extensible
373SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`" 373SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`"
374section in the Yocto Project Overview and Concepts Manual for more 374section in the Yocto Project Overview and Concepts Manual for more
375information. 375information.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 5e5b688878..c2a6566341 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7601,7 +7601,7 @@ system and gives an overview of their function and contents.
7601 The name of keys used by the :ref:`ref-classes-kernel-fitimage` class 7601 The name of keys used by the :ref:`ref-classes-kernel-fitimage` class
7602 for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR` 7602 for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR`
7603 directory. If we have for example a ``dev.key`` key and a ``dev.crt`` 7603 directory. If we have for example a ``dev.key`` key and a ``dev.crt``
7604 certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will 7604 certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will
7605 have to set :term:`SPL_SIGN_KEYNAME` to ``dev``. 7605 have to set :term:`SPL_SIGN_KEYNAME` to ``dev``.
7606 7606
7607 :term:`SPLASH` 7607 :term:`SPLASH`