mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 05:29:32 +00:00
Code Issues Projects Releases Wiki Activity

manuals: fix trailing spaces

Browse Source 
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>
This commit is contained in:
Michael Opdenacker
2024-03-30 17:52:37 +01:00
committed by Steve Sakoman
parent a6fdddf8c4
commit fac2a5eff5
10 changed files with 34 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/dev-manual/init-manager.rst
+1 -1
View File
@@ -121,7 +121,7 @@ increasing levels of complexity and functionality:
:widths: 40 20 20 20 :widths: 40 20 20 20
:header-rows: 1 :header-rows: 1
* - * -
- BusyBox init - BusyBox init
- SysVinit - SysVinit
- systemd - systemd
documentation/dev-manual/start.rst
+8 -4
View File
@@ -612,10 +612,14 @@ Use the following procedure to locate the latest upstream copy of the
Accessing Index of Releases Accessing Index of Releases
--------------------------- ---------------------------
Yocto Project maintains an Index of Releases area that contains related The Yocto Project also provides source archives of its releases, which
files that contribute to the Yocto Project. Rather than Git are available on :yocto_dl:`/releases/yocto/`. Then, choose the subdirectory
repositories, these files are tarballs that represent snapshots in time containing the release you wish to use, for example
of a given component. :yocto_dl:`yocto-&DISTRO; </releases/yocto/yocto-&DISTRO;/>`.
You will find there source archives of individual components (if you wish
to use them individually), and of the corresponding Poky release bundling
a selection of these components.
.. note:: .. note::
documentation/dev-manual/wic.rst
+2 -2
View File
@@ -146,7 +146,7 @@ command to return the available Wic images as follows::
mkefidisk Create an EFI disk image mkefidisk Create an EFI disk image
directdisk-multi-rootfs Create multi rootfs image using rootfs plugin directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
directdisk Create a 'pcbios' direct disk image directdisk Create a 'pcbios' direct disk image
efi-bootdisk efi-bootdisk
mkhybridiso Create a hybrid ISO image mkhybridiso Create a hybrid ISO image
directdisk-gpt Create a 'pcbios' direct disk image directdisk-gpt Create a 'pcbios' direct disk image
systemd-bootdisk Create an EFI disk image with systemd-boot systemd-bootdisk Create an EFI disk image with systemd-boot
@@ -290,7 +290,7 @@ Use the following command to list the available kickstart files::
mkefidisk Create an EFI disk image mkefidisk Create an EFI disk image
directdisk-multi-rootfs Create multi rootfs image using rootfs plugin directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
directdisk Create a 'pcbios' direct disk image directdisk Create a 'pcbios' direct disk image
efi-bootdisk efi-bootdisk
mkhybridiso Create a hybrid ISO image mkhybridiso Create a hybrid ISO image
directdisk-gpt Create a 'pcbios' direct disk image directdisk-gpt Create a 'pcbios' direct disk image
systemd-bootdisk Create an EFI disk image with systemd-boot systemd-bootdisk Create an EFI disk image with systemd-boot
documentation/migration-guides/migration-4.0.rst
+10 -10
View File
@@ -66,7 +66,7 @@ changes and you need to review them before committing. An example warning
looks like:: looks like::
poky/scripts/lib/devtool/upgrade.py needs further work at line 275 since it contains abort poky/scripts/lib/devtool/upgrade.py needs further work at line 275 since it contains abort
Fetching changes Fetching changes
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@@ -109,7 +109,7 @@ License changes
If they do not, by default a warning will be shown. A If they do not, by default a warning will be shown. A
:oe_git:`convert-spdx-licenses.py </openembedded-core/tree/scripts/contrib/convert-spdx-licenses.py>` :oe_git:`convert-spdx-licenses.py </openembedded-core/tree/scripts/contrib/convert-spdx-licenses.py>`
script can be used to update your recipes. script can be used to update your recipes.
- :term:`INCOMPATIBLE_LICENSE` should now use `SPDX identifiers <https://spdx.org/licenses/>`__. - :term:`INCOMPATIBLE_LICENSE` should now use `SPDX identifiers <https://spdx.org/licenses/>`__.
Additionally, wildcarding is now limited to specifically supported values - Additionally, wildcarding is now limited to specifically supported values -
see the :term:`INCOMPATIBLE_LICENSE` documentation for further information. see the :term:`INCOMPATIBLE_LICENSE` documentation for further information.
@@ -119,7 +119,7 @@ License changes
which can cause signature issues for users. In addition the ``available_licenses()`` which can cause signature issues for users. In addition the ``available_licenses()``
function has been removed from the :ref:`license <ref-classes-license>` class as function has been removed from the :ref:`license <ref-classes-license>` class as
it is no longer needed. it is no longer needed.
Removed recipes Removed recipes
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
@@ -134,11 +134,11 @@ The following recipes have been removed in this release:
Python changes Python changes
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
- ``distutils`` has been deprecated upstream in Python 3.10 and thus the ``distutils*`` - ``distutils`` has been deprecated upstream in Python 3.10 and thus the ``distutils*``
classes have been moved to ``meta-python``. Recipes that inherit the ``distutils*`` classes have been moved to ``meta-python``. Recipes that inherit the ``distutils*``
classes should be updated to inherit ``setuptools*`` equivalents instead. classes should be updated to inherit ``setuptools*`` equivalents instead.
- The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. - The Python package build process is now based on `wheels <https://pythonwheels.com/>`__.
The new Python packaging classes that should be used are The new Python packaging classes that should be used are
:ref:`python_flit_core <ref-classes-python_flit_core>`, :ref:`python_flit_core <ref-classes-python_flit_core>`,
@@ -158,7 +158,7 @@ Prelink removed
Prelink has been dropped by ``glibc`` upstream in 2.36. It already caused issues with Prelink has been dropped by ``glibc`` upstream in 2.36. It already caused issues with
binary corruption, has a number of open bugs and is of questionable benefit binary corruption, has a number of open bugs and is of questionable benefit
without disabling load address randomization and PIE executables. without disabling load address randomization and PIE executables.
We disabled prelinking by default in the honister (3.4) release, but left it able We disabled prelinking by default in the honister (3.4) release, but left it able
to be enabled if desired. However, without glibc support it cannot be maintained to be enabled if desired. However, without glibc support it cannot be maintained
any further, so all of the prelinking functionality has been removed in this release. any further, so all of the prelinking functionality has been removed in this release.
@@ -169,7 +169,7 @@ reference(s).
Reproducible as standard Reproducible as standard
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
Reproducibility is now considered as standard functionality, thus the Reproducibility is now considered as standard functionality, thus the
``reproducible`` class has been removed and its previous contents merged into the ``reproducible`` class has been removed and its previous contents merged into the
:ref:`base <ref-classes-base>` class. If you have references in your configuration to :ref:`base <ref-classes-base>` class. If you have references in your configuration to
``reproducible`` in :term:`INHERIT`, :term:`USER_CLASSES` etc. then they should be ``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
Miscellaneous changes Miscellaneous changes
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
- ``blacklist.bbclass`` is removed and the functionality moved to the - ``blacklist.bbclass`` is removed and the functionality moved to the
:ref:`base <ref-classes-base>` class with a more descriptive :ref:`base <ref-classes-base>` class with a more descriptive
``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()` ``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()`
@@ -251,7 +251,7 @@ Miscellaneous changes
- The ``cortexa72-crc`` and ``cortexa72-crc-crypto`` tunes have been removed since - The ``cortexa72-crc`` and ``cortexa72-crc-crypto`` tunes have been removed since
the crc extension is now enabled by default for cortexa72. Replace any references to the crc extension is now enabled by default for cortexa72. Replace any references to
these with ``cortexa72`` and ``cortexa72-crypto`` respectively. these with ``cortexa72`` and ``cortexa72-crypto`` respectively.
- The Python development shell (previously known as ``devpyshell``) feature has been - The Python development shell (previously known as ``devpyshell``) feature has been
renamed to ``pydevshell``. To start it you should now run:: renamed to ``pydevshell``. To start it you should now run::
@@ -260,7 +260,7 @@ Miscellaneous changes
- The ``packagegroups-core-full-cmdline-libs`` packagegroup is no longer produced, as - The ``packagegroups-core-full-cmdline-libs`` packagegroup is no longer produced, as
libraries should normally be brought in via dependencies. If you have any references libraries should normally be brought in via dependencies. If you have any references
to this then remove them. to this then remove them.
- The :term:`TOPDIR` variable and the current working directory are no longer modified - The :term:`TOPDIR` variable and the current working directory are no longer modified
when parsing recipes. Any code depending on the previous behaviour will no longer when parsing recipes. Any code depending on the previous behaviour will no longer
work - change any such code to explicitly use appropriate path variables instead. work - change any such code to explicitly use appropriate path variables instead.
documentation/migration-guides/release-notes-4.0.5.rst
+1 -1
View File
@@ -81,7 +81,7 @@ Fixes in Yocto-4.0.5
Known Issues in Yocto-4.0.5 Known Issues in Yocto-4.0.5
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
- 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. - 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.
Contributors to Yocto-4.0.5 Contributors to Yocto-4.0.5
documentation/migration-guides/release-notes-4.0.rst
+8 -9
View File
@@ -36,7 +36,7 @@ New Features / Enhancements in 4.0
- Inclusive language adjustments to some variable names - see the - Inclusive language adjustments to some variable names - see the
:ref:`4.0 migration guide <migration-4.0-inclusive-language>` for details. :ref:`4.0 migration guide <migration-4.0-inclusive-language>` for details.
- New recipes: - New recipes:
- ``buildtools-docs-tarball`` - ``buildtools-docs-tarball``
@@ -112,8 +112,7 @@ New Features / Enhancements in 4.0
- BitBake enhancements: - BitBake enhancements:
- Fetcher enhancements: - Fetcher enhancements:
- New :ref:`bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` for Rust packages
- New :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` for Rust packages
- Added striplevel support to unpack - Added striplevel support to unpack
- git: Add a warning asking users to set a branch in git urls - git: Add a warning asking users to set a branch in git urls
- git: Allow git fetcher to support subdir param - git: Allow git fetcher to support subdir param
@@ -125,7 +124,7 @@ New Features / Enhancements in 4.0
- ssh: now supports checkstatus, allows : in URLs (both required for use with sstate) and no longer requires username - ssh: now supports checkstatus, allows : in URLs (both required for use with sstate) and no longer requires username
- wget: add redirectauth parameter - wget: add redirectauth parameter
- wget: add 30s timeout for checkstatus calls - wget: add 30s timeout for checkstatus calls
- Show warnings for append/prepend/remove operators combined with +=/.= - Show warnings for append/prepend/remove operators combined with +=/.=
- Add bb.warnonce() and bb.erroronce() log methods - Add bb.warnonce() and bb.erroronce() log methods
- Improved setscene task display - Improved setscene task display
@@ -138,7 +137,7 @@ New Features / Enhancements in 4.0
- Architecture-specific enhancements: - Architecture-specific enhancements:
- ARM: - ARM:
- tune-cortexa72: Enable the crc extension by default for cortexa72 - tune-cortexa72: Enable the crc extension by default for cortexa72
- qemuarm64: Add tiny ktype to qemuarm64 bsp - qemuarm64: Add tiny ktype to qemuarm64 bsp
- armv9a/tune: Add the support for the Neoverse N2 core - armv9a/tune: Add the support for the Neoverse N2 core
@@ -161,7 +160,7 @@ New Features / Enhancements in 4.0
- linux-yocto-dev: add qemuriscv32 - linux-yocto-dev: add qemuriscv32
- packagegroup-core-tools-profile: Enable systemtap for riscv64 - packagegroup-core-tools-profile: Enable systemtap for riscv64
- qemuriscv: Use virtio-tablet-pci for mouse - qemuriscv: Use virtio-tablet-pci for mouse
- x86: - x86:
- kernel-yocto: conditionally enable stack protection checking on x86-64 - kernel-yocto: conditionally enable stack protection checking on x86-64
@@ -197,7 +196,7 @@ New Features / Enhancements in 4.0
- yocto-check-layer: improved README checks - yocto-check-layer: improved README checks
- cve-check: add json output format - cve-check: add json output format
- cve-check: add coverage statistics on recipes with/without CVEs - cve-check: add coverage statistics on recipes with/without CVEs
- Added mirrors for kernel sources and uninative binaries on kernel.org - Added mirrors for kernel sources and uninative binaries on kernel.org
- glibc and binutils recipes now use shallow mirror tarballs for faster fetching - glibc and binutils recipes now use shallow mirror tarballs for faster fetching
- When patching fails, show more information on the fatal error - When patching fails, show more information on the fatal error
@@ -232,7 +231,7 @@ New Features / Enhancements in 4.0
- Detect more known licenses in Python code - Detect more known licenses in Python code
- Move license md5sums data into CSV files - Move license md5sums data into CSV files
- npm: Use README as license fallback - npm: Use README as license fallback
- SDK-related enhancements: - SDK-related enhancements:
- Extended recipes to ``nativesdk``: ``cargo``, ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` - Extended recipes to ``nativesdk``: ``cargo``, ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging``
@@ -240,7 +239,7 @@ New Features / Enhancements in 4.0
- Support creating per-toolchain cmake file in SDK - Support creating per-toolchain cmake file in SDK
- Rust enhancements: - Rust enhancements:
- New python_setuptools3_rust class to enable building python extensions in Rust - New python_setuptools3_rust class to enable building python extensions in Rust
- classes/meson: Add optional rust definitions - classes/meson: Add optional rust definitions
documentation/overview-manual/intro.rst
+1 -1
View File
@@ -38,7 +38,7 @@ This manual does not give you the following:
procedures reside in other manuals within the Yocto Project procedures reside in other manuals within the Yocto Project
documentation set. For example, the :doc:`/dev-manual/index` documentation set. For example, the :doc:`/dev-manual/index`
provides examples on how to perform provides examples on how to perform
various development tasks. As another example, the various development tasks. As another example, the
:doc:`/sdk-manual/index` manual contains detailed :doc:`/sdk-manual/index` manual contains detailed
instructions on how to install an SDK, which is used to develop instructions on how to install an SDK, which is used to develop
applications for target hardware. applications for target hardware.
documentation/ref-manual/classes.rst
+1 -1
View File
@@ -588,7 +588,7 @@ The padding size can be modified by setting :term:`DT_PADDING_SIZE`
to the desired size, in bytes. to the desired size, in bytes.
See :oe_git:`devicetree.bbclass sources See :oe_git:`devicetree.bbclass sources
</openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>` </openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>`
for further variables controlling this class. for further variables controlling this class.
Here is an excerpt of an example ``recipes-kernel/linux/devicetree-acme.bb`` Here is an excerpt of an example ``recipes-kernel/linux/devicetree-acme.bb``
documentation/ref-manual/tasks.rst
+1 -1
View File
@@ -369,7 +369,7 @@ information.
``do_populate_sdk_ext`` ``do_populate_sdk_ext``
----------------------- -----------------------
Creates the file and directory structure for an installable extensible Creates the file and directory structure for an installable extensible
SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`" SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`"
section in the Yocto Project Overview and Concepts Manual for more section in the Yocto Project Overview and Concepts Manual for more
information. information.
documentation/ref-manual/variables.rst
+1 -1
View File
@@ -7601,7 +7601,7 @@ system and gives an overview of their function and contents.
The name of keys used by the :ref:`ref-classes-kernel-fitimage` class The name of keys used by the :ref:`ref-classes-kernel-fitimage` class
for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR` for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR`
directory. If we have for example a ``dev.key`` key and a ``dev.crt`` directory. If we have for example a ``dev.key`` key and a ``dev.crt``
certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will
have to set :term:`SPL_SIGN_KEYNAME` to ``dev``. have to set :term:`SPL_SIGN_KEYNAME` to ``dev``.
:term:`SPLASH` :term:`SPLASH`