From 8b1909aa6f7a51a878dc3d4a9223403ad3e164a9 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Thu, 5 Jan 2023 08:34:26 +0100 Subject: 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 `. 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 Suggested-by: Quentin Schulz Signed-off-by: Richard Purdie --- documentation/migration-guides/migration-4.0.rst | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) (limited to 'documentation/migration-guides/migration-4.0.rst') 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 - The ``AVAILABLE_LICENSES`` variable has been removed. This variable was a performance liability and is highly dependent on which layers are added to the configuration, which can cause signature issues for users. In addition the ``available_licenses()`` - function has been removed from the :ref:`license ` class as + function has been removed from the :ref:`ref-classes-license` class as it is no longer needed. Removed recipes @@ -143,15 +143,14 @@ Python changes - The Python package build process is now based on `wheels `__. Here are the new Python packaging classes that should be used: - :ref:`python_flit_core `, - :ref:`python_setuptools_build_meta ` - and :ref:`python_poetry_core `. + :ref:`ref-classes-python_flit_core`, :ref:`ref-classes-python_setuptools_build_meta` + and :ref:`ref-classes-python_poetry_core`. -- The :ref:`setuptools3 ` class :ref:`ref-tasks-install` task now +- The :ref:`ref-classes-setuptools3` class :ref:`ref-tasks-install` task now installs the ``wheel`` binary archive. In current versions of ``setuptools`` the legacy ``setup.py install`` method is deprecated. If the ``setup.py`` cannot be used with wheels, for example it creates files outside of the Python module or standard - entry points, then :ref:`setuptools3_legacy ` should + entry points, then :ref:`ref-classes-setuptools3_legacy` should be used instead. Prelink removed @@ -173,7 +172,7 @@ Reproducible as standard Reproducibility is now considered as standard functionality, thus the ``reproducible`` class has been removed and its previous contents merged into the -:ref:`base ` class. If you have references in your configuration to +:ref:`ref-classes-base` class. If you have references in your configuration to ``reproducible`` in :term:`INHERIT`, :term:`USER_CLASSES` etc. then they should be removed. @@ -215,15 +214,15 @@ Miscellaneous changes ~~~~~~~~~~~~~~~~~~~~~ - ``blacklist.bbclass`` is removed and the functionality moved to the - :ref:`base ` class with a more descriptive + :ref:`ref-classes-base` class with a more descriptive ``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()` function. The usage remains the same, for example:: SKIP_RECIPE[my-recipe] = "Reason for skipping recipe" -- :ref:`allarch ` packagegroups can no longer depend on packages +- :ref:`ref-classes-allarch` packagegroups can no longer depend on packages which use :term:`PKG` renaming such as :ref:`ref-classes-debian`. Such packagegroups - recipes should be changed to avoid inheriting :ref:`allarch `. + recipes should be changed to avoid inheriting :ref:`ref-classes-allarch`. - The ``lnr`` script has been removed. ``lnr`` implemented the same behaviour as `ln --relative --symbolic`, since at the time of creation `--relative` was only available in coreutils 8.16 @@ -232,7 +231,7 @@ Miscellaneous changes any calls to ``lnr`` in your recipes or classes, they should be replaced with `ln --relative --symbolic` or `ln -rs` if you prefer the short version. -- The ``package_qa_handle_error()`` function formerly in the :ref:`insane ` +- The ``package_qa_handle_error()`` function formerly in the :ref:`ref-classes-insane` class has been moved and renamed - if you have any references in your own custom classes they should be changed to ``oe.qa.handle_error()``. -- cgit v1.2.3-54-g00ecf