diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-01-05 08:34:26 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-01-06 17:39:09 +0000 |
commit | 8b1909aa6f7a51a878dc3d4a9223403ad3e164a9 (patch) | |
tree | e1418f545ad6640afb5fde004696eef2a9e6e67b /documentation/migration-guides/migration-4.0.rst | |
parent | ae280972ffba62d7ed839b692957f61b0955cbca (diff) | |
download | poky-8b1909aa6f7a51a878dc3d4a9223403ad3e164a9.tar.gz |
manuals: simplify references to classes
Now that .bbclass is removed from class section titles.
We can now have, for example, :ref:`ref-classes-insane`
instead of :ref:`insane <ref-classes-insane>`.
Then, when necessary, rework paragraphs so that they
have lines of even length, not exceeding 80 characters.
(From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/migration-guides/migration-4.0.rst')
-rw-r--r-- | documentation/migration-guides/migration-4.0.rst | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst index dd840f2bb3..3106498404 100644 --- a/documentation/migration-guides/migration-4.0.rst +++ b/documentation/migration-guides/migration-4.0.rst | |||
@@ -119,7 +119,7 @@ License changes | |||
119 | - The ``AVAILABLE_LICENSES`` variable has been removed. This variable was a performance | 119 | - The ``AVAILABLE_LICENSES`` variable has been removed. This variable was a performance |
120 | liability and is highly dependent on which layers are added to the configuration, | 120 | liability and is highly dependent on which layers are added to the configuration, |
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:`license <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 |
@@ -143,15 +143,14 @@ Python changes | |||
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 | Here are the new Python packaging classes that should be used: | 145 | Here are the new Python packaging classes that should be used: |
146 | :ref:`python_flit_core <ref-classes-python_flit_core>`, | 146 | :ref:`ref-classes-python_flit_core`, :ref:`ref-classes-python_setuptools_build_meta` |
147 | :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>` | 147 | and :ref:`ref-classes-python_poetry_core`. |
148 | and :ref:`python_poetry_core <ref-classes-python_poetry_core>`. | ||
149 | 148 | ||
150 | - The :ref:`setuptools3 <ref-classes-setuptools3>` class :ref:`ref-tasks-install` task now | 149 | - The :ref:`ref-classes-setuptools3` class :ref:`ref-tasks-install` task now |
151 | installs the ``wheel`` binary archive. In current versions of ``setuptools`` the | 150 | installs the ``wheel`` binary archive. In current versions of ``setuptools`` the |
152 | legacy ``setup.py install`` method is deprecated. If the ``setup.py`` cannot be used | 151 | legacy ``setup.py install`` method is deprecated. If the ``setup.py`` cannot be used |
153 | with wheels, for example it creates files outside of the Python module or standard | 152 | with wheels, for example it creates files outside of the Python module or standard |
154 | entry points, then :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` should | 153 | entry points, then :ref:`ref-classes-setuptools3_legacy` should |
155 | be used instead. | 154 | be used instead. |
156 | 155 | ||
157 | Prelink removed | 156 | Prelink removed |
@@ -173,7 +172,7 @@ Reproducible as standard | |||
173 | 172 | ||
174 | Reproducibility is now considered as standard functionality, thus the | 173 | Reproducibility is now considered as standard functionality, thus the |
175 | ``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 |
176 | :ref:`base <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 |
177 | ``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 |
178 | removed. | 177 | removed. |
179 | 178 | ||
@@ -215,15 +214,15 @@ Miscellaneous changes | |||
215 | ~~~~~~~~~~~~~~~~~~~~~ | 214 | ~~~~~~~~~~~~~~~~~~~~~ |
216 | 215 | ||
217 | - ``blacklist.bbclass`` is removed and the functionality moved to the | 216 | - ``blacklist.bbclass`` is removed and the functionality moved to the |
218 | :ref:`base <ref-classes-base>` class with a more descriptive | 217 | :ref:`ref-classes-base` class with a more descriptive |
219 | ``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()` |
220 | function. The usage remains the same, for example:: | 219 | function. The usage remains the same, for example:: |
221 | 220 | ||
222 | SKIP_RECIPE[my-recipe] = "Reason for skipping recipe" | 221 | SKIP_RECIPE[my-recipe] = "Reason for skipping recipe" |
223 | 222 | ||
224 | - :ref:`allarch <ref-classes-allarch>` packagegroups can no longer depend on packages | 223 | - :ref:`ref-classes-allarch` packagegroups can no longer depend on packages |
225 | which use :term:`PKG` renaming such as :ref:`ref-classes-debian`. Such packagegroups | 224 | which use :term:`PKG` renaming such as :ref:`ref-classes-debian`. Such packagegroups |
226 | recipes should be changed to avoid inheriting :ref:`allarch <ref-classes-allarch>`. | 225 | recipes should be changed to avoid inheriting :ref:`ref-classes-allarch`. |
227 | 226 | ||
228 | - The ``lnr`` script has been removed. ``lnr`` implemented the same behaviour as `ln --relative --symbolic`, | 227 | - The ``lnr`` script has been removed. ``lnr`` implemented the same behaviour as `ln --relative --symbolic`, |
229 | since at the time of creation `--relative` was only available in coreutils 8.16 | 228 | since at the time of creation `--relative` was only available in coreutils 8.16 |
@@ -232,7 +231,7 @@ Miscellaneous changes | |||
232 | any calls to ``lnr`` in your recipes or classes, they should be replaced with | 231 | any calls to ``lnr`` in your recipes or classes, they should be replaced with |
233 | `ln --relative --symbolic` or `ln -rs` if you prefer the short version. | 232 | `ln --relative --symbolic` or `ln -rs` if you prefer the short version. |
234 | 233 | ||
235 | - The ``package_qa_handle_error()`` function formerly in the :ref:`insane <ref-classes-insane>` | 234 | - The ``package_qa_handle_error()`` function formerly in the :ref:`ref-classes-insane` |
236 | class has been moved and renamed - if you have any references in your own custom | 235 | class has been moved and renamed - if you have any references in your own custom |
237 | classes they should be changed to ``oe.qa.handle_error()``. | 236 | classes they should be changed to ``oe.qa.handle_error()``. |
238 | 237 | ||