mirror of
https://git.yoctoproject.org/poky
synced 2026-05-30 12:29:55 +00:00
manuals: replace hyphens with em dashes
Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. (From yocto-docs rev: a0d93ea1ddfdfbcde8dac3aa328307be778f9e3c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Steve Sakoman <steve@sakoman.com>
This commit is contained in:
Michael Opdenacker
committed by
Steve Sakoman
Steve Sakoman
parent
3b7e326704
commit
5b75b5cbcf
@@ -341,39 +341,39 @@ Removed and Renamed Recipes
|
||||
|
||||
The following recipes have been removed:
|
||||
|
||||
- ``packagegroup-toolset-native`` - This recipe is largely unused.
|
||||
- ``packagegroup-toolset-native`` --- this recipe is largely unused.
|
||||
|
||||
- ``linux-yocto-3.8`` - Support for the Linux yocto 3.8 kernel has been
|
||||
- ``linux-yocto-3.8`` --- support for the Linux yocto 3.8 kernel has been
|
||||
dropped. Support for the 3.10 and 3.14 kernels have been added with
|
||||
the ``linux-yocto-3.10`` and ``linux-yocto-3.14`` recipes.
|
||||
|
||||
- ``ocf-linux`` - This recipe has been functionally replaced using
|
||||
- ``ocf-linux`` --- this recipe has been functionally replaced using
|
||||
``cryptodev-linux``.
|
||||
|
||||
- ``genext2fs`` - ``genext2fs`` is no longer used by the build system
|
||||
- ``genext2fs`` --- ``genext2fs`` is no longer used by the build system
|
||||
and is unmaintained upstream.
|
||||
|
||||
- ``js`` - This provided an ancient version of Mozilla's javascript
|
||||
- ``js`` --- this provided an ancient version of Mozilla's javascript
|
||||
engine that is no longer needed.
|
||||
|
||||
- ``zaurusd`` - The recipe has been moved to the ``meta-handheld``
|
||||
- ``zaurusd`` --- the recipe has been moved to the ``meta-handheld``
|
||||
layer.
|
||||
|
||||
- ``eglibc 2.17`` - Replaced by the ``eglibc 2.19`` recipe.
|
||||
- ``eglibc 2.17`` --- replaced by the ``eglibc 2.19`` recipe.
|
||||
|
||||
- ``gcc 4.7.2`` - Replaced by the now stable ``gcc 4.8.2``.
|
||||
- ``gcc 4.7.2`` --- replaced by the now stable ``gcc 4.8.2``.
|
||||
|
||||
- ``external-sourcery-toolchain`` - this recipe is now maintained in
|
||||
- ``external-sourcery-toolchain`` --- this recipe is now maintained in
|
||||
the ``meta-sourcery`` layer.
|
||||
|
||||
- ``linux-libc-headers-yocto 3.4+git`` - Now using version 3.10 of the
|
||||
- ``linux-libc-headers-yocto 3.4+git`` --- now using version 3.10 of the
|
||||
``linux-libc-headers`` by default.
|
||||
|
||||
- ``meta-toolchain-gmae`` - This recipe is obsolete.
|
||||
- ``meta-toolchain-gmae`` --- this recipe is obsolete.
|
||||
|
||||
- ``packagegroup-core-sdk-gmae`` - This recipe is obsolete.
|
||||
- ``packagegroup-core-sdk-gmae`` --- this recipe is obsolete.
|
||||
|
||||
- ``packagegroup-core-standalone-gmae-sdk-target`` - This recipe is
|
||||
- ``packagegroup-core-standalone-gmae-sdk-target`` --- this recipe is
|
||||
obsolete.
|
||||
|
||||
.. _migration-1.6-removed-classes:
|
||||
|
||||
@@ -216,11 +216,11 @@ The following sanity check changes occurred.
|
||||
- :term:`SRC_URI` is now checked for usage of two
|
||||
problematic items:
|
||||
|
||||
- "${PN}" prefix/suffix use - Warnings always appear if ${PN} is
|
||||
- "${PN}" prefix/suffix use --- warnings always appear if ${PN} is
|
||||
used. You must fix the issue regardless of whether multiconfig or
|
||||
anything else that would cause prefixing/suffixing to happen.
|
||||
|
||||
- Github archive tarballs - these are not guaranteed to be stable.
|
||||
- Github archive tarballs --- these are not guaranteed to be stable.
|
||||
Consequently, it is likely that the tarballs will be refreshed and
|
||||
thus the SRC_URI checksums will fail to apply. It is recommended
|
||||
that you fetch either an official release tarball or a specific
|
||||
|
||||
@@ -200,7 +200,7 @@ Packaging changes
|
||||
-----------------
|
||||
|
||||
- ``intltool`` has been removed from ``packagegroup-core-sdk`` as it is
|
||||
rarely needed to build modern software - gettext can do most of the
|
||||
rarely needed to build modern software --- gettext can do most of the
|
||||
things it used to be needed for. ``intltool`` has also been removed
|
||||
from ``packagegroup-core-self-hosted`` as it is not needed to for
|
||||
standard builds.
|
||||
|
||||
@@ -23,7 +23,7 @@ Removed recipes
|
||||
The following recipes have been removed:
|
||||
|
||||
- ``bjam-native``: replaced by ``boost-build-native``
|
||||
- ``avahi-ui``: folded into the main ``avahi`` recipe - the GTK UI can be disabled using :term:`PACKAGECONFIG` for ``avahi``.
|
||||
- ``avahi-ui``: folded into the main ``avahi`` recipe --- the GTK UI can be disabled using :term:`PACKAGECONFIG` for ``avahi``.
|
||||
- ``build-compare``: no longer needed with the removal of the ``packagefeed-stability`` class
|
||||
- ``dhcp``: obsolete, functionally replaced by ``dhcpcd`` and ``kea``
|
||||
- ``libmodulemd-v1``: replaced by ``libmodulemd``
|
||||
@@ -37,7 +37,7 @@ Removed classes
|
||||
|
||||
The following classes (.bbclass files) have been removed:
|
||||
|
||||
- ``spdx``: obsolete - the Yocto Project is a strong supporter of SPDX, but this class was old code using a dated approach and had the potential to be misleading. The ``meta-sdpxscanner`` layer is a much more modern and active approach to handling this and is recommended as a replacement.
|
||||
- ``spdx``: obsolete --- the Yocto Project is a strong supporter of SPDX, but this class was old code using a dated approach and had the potential to be misleading. The ``meta-sdpxscanner`` layer is a much more modern and active approach to handling this and is recommended as a replacement.
|
||||
|
||||
- ``packagefeed-stability``: this class had become obsolete with the advent of hash equivalence and reproducible builds.
|
||||
|
||||
@@ -46,7 +46,7 @@ pseudo path filtering and mismatch behaviour
|
||||
--------------------------------------------
|
||||
|
||||
pseudo now operates on a filtered subset of files. This is a significant change
|
||||
to the way pseudo operates within OpenEmbedded - by default, pseudo monitors and
|
||||
to the way pseudo operates within OpenEmbedded --- by default, pseudo monitors and
|
||||
logs (adds to its database) any file created or modified whilst in a ``fakeroot``
|
||||
environment. However, there are large numbers of files that we simply don't care
|
||||
about the permissions of whilst in that ``fakeroot`` context, for example ${:term:`S`}, ${:term:`B`}, ${:term:`T`},
|
||||
@@ -68,7 +68,7 @@ structure above that subdirectory. For these types of cases in your own recipes,
|
||||
extend :term:`PSEUDO_IGNORE_PATHS` to cover additional paths that pseudo should not
|
||||
be monitoring.
|
||||
|
||||
In addition, pseudo's behaviour on mismatches has now been changed - rather
|
||||
In addition, pseudo's behaviour on mismatches has now been changed --- rather
|
||||
than doing what turns out to be a rather dangerous "fixup" if it sees a file
|
||||
with a different path but the same inode as another file it has previously seen,
|
||||
pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>`
|
||||
@@ -137,10 +137,10 @@ DHCP server/client replaced
|
||||
|
||||
The ``dhcp`` software package has become unmaintained and thus has been
|
||||
functionally replaced by ``dhcpcd`` (client) and ``kea`` (server). You will
|
||||
need to replace references to the recipe/package names as appropriate - most
|
||||
need to replace references to the recipe/package names as appropriate --- most
|
||||
commonly, at the package level ``dhcp-client`` should be replaced by
|
||||
``dhcpcd`` and ``dhcp-server`` should be replaced by ``kea``. If you have any
|
||||
custom configuration files for these they will need to be adapted - refer to
|
||||
custom configuration files for these they will need to be adapted --- refer to
|
||||
the upstream documentation for ``dhcpcd`` and ``kea`` for further details.
|
||||
|
||||
|
||||
@@ -181,7 +181,7 @@ In addition, the following new checks were added and default to triggering an er
|
||||
|
||||
- :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its packages, and does not inherit the :ref:`update-alternatives <ref-classes-update-alternatives>` class.
|
||||
|
||||
- A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` will now trigger a warning so that they can be removed and path comparisons can be more reliable - remove any instances of these in your recipes if the warning is displayed.
|
||||
- A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` will now trigger a warning so that they can be removed and path comparisons can be more reliable --- remove any instances of these in your recipes if the warning is displayed.
|
||||
|
||||
|
||||
.. _migration-3.2-src-uri-file-globbing:
|
||||
@@ -209,7 +209,7 @@ deploy class now cleans ``DEPLOYDIR`` before ``do_deploy``
|
||||
|
||||
``do_deploy`` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as ``do_install`` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds.
|
||||
|
||||
Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` - these should be refactored to use ``do_deploy_prepend`` instead.
|
||||
Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` --- these should be refactored to use ``do_deploy_prepend`` instead.
|
||||
|
||||
|
||||
.. _migration-3.2-nativesdk-sdk-provides-dummy:
|
||||
@@ -303,7 +303,7 @@ now need to be changed to ``inherit image-artifact-names``.
|
||||
Miscellaneous changes
|
||||
---------------------
|
||||
|
||||
- Support for the long-deprecated ``PACKAGE_GROUP`` variable has now been removed - replace any remaining instances with :term:`FEATURE_PACKAGES`.
|
||||
- Support for the long-deprecated ``PACKAGE_GROUP`` variable has now been removed --- replace any remaining instances with :term:`FEATURE_PACKAGES`.
|
||||
- The ``FILESPATHPKG`` variable, having been previously deprecated, has now been removed. Replace any remaining references with appropriate use of :term:`FILESEXTRAPATHS`.
|
||||
- Erroneous use of ``inherit +=`` (instead of ``INHERIT +=``) in a configuration file now triggers an error instead of silently being ignored.
|
||||
- ptest support has been removed from the ``kbd`` recipe, as upstream has moved to autotest which is difficult to work with in a cross-compilation environment.
|
||||
|
||||
@@ -17,7 +17,6 @@ using ``scripts/install-buildtools``) --- see
|
||||
:ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions`
|
||||
for details.
|
||||
|
||||
|
||||
.. _migration-3.3-removed-recipes:
|
||||
|
||||
Removed recipes
|
||||
|
||||
@@ -146,7 +146,7 @@ Virtual runtime provides
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Recipes shouldn't use the ``virtual/`` string in :term:`RPROVIDES` and
|
||||
:term:`RDEPENDS` - it is confusing because ``virtual/`` has no special
|
||||
:term:`RDEPENDS` --- it is confusing because ``virtual/`` has no special
|
||||
meaning in :term:`RPROVIDES` and :term:`RDEPENDS` (unlike in the
|
||||
corresponding build-time :term:`PROVIDES` and :term:`DEPENDS`).
|
||||
|
||||
@@ -171,7 +171,7 @@ Extensible SDK host extension
|
||||
For a normal SDK, some layers append to :term:`TOOLCHAIN_HOST_TASK`
|
||||
unconditionally which is fine, until the eSDK tries to override the
|
||||
variable to its own values. Instead of installing packages specified
|
||||
in this variable it uses native recipes instead - a very different
|
||||
in this variable it uses native recipes instead --- a very different
|
||||
approach. This has led to confusing errors when binaries are added
|
||||
to the SDK but not relocated.
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ New Features / Enhancements in 3.4
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
- Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades
|
||||
- Switched override character to ':' (replacing '_') for more robust parsing and improved performance - see the above migration guide for help
|
||||
- Switched override character to ':' (replacing '_') for more robust parsing and improved performance --- see the above migration guide for help
|
||||
- Rust integrated into core, providing rust support for cross-compilation and SDK
|
||||
- New create-spdx class for creating SPDX SBoM documents
|
||||
- New recipes: cargo, core-image-ptest-all, core-image-ptest-fast, core-image-weston-sdk, erofs-utils, gcompat, gi-docgen, libmicrohttpd, libseccomp, libstd-rs, perlcross, python3-markdown, python3-pyyaml, python3-smartypants, python3-typogrify, rust, rust-cross, rust-cross-canadian, rust-hello-world, rust-llvm, rust-tools-cross-canadian, rustfmt, xwayland
|
||||
|
||||
Reference in New Issue
Block a user