From 99a5b42d5cef91b4238e641a2c53c0c44f1e9ca9 Mon Sep 17 00:00:00 2001 From: Tim Orling Date: Sun, 27 Feb 2022 20:04:06 -0800 Subject: docs: update setuptools3 class Add notes to inform about the new `wheel` behavior of the setuptools3.bbclass. (From yocto-docs rev: 4f19c8218f7c960d1ad0288d76d5394b6595c3f1) Signed-off-by: Tim Orling Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/ref-manual/classes.rst | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) (limited to 'documentation') diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 949217bf42..56d2d4538a 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -2386,8 +2386,26 @@ the Simple DirectMedia Layer (SDL) library. ======================= The ``setuptools3`` class supports Python version 3.x extensions that -use build systems based on ``setuptools``. If your recipe uses these -build systems, the recipe needs to inherit the ``setuptools3`` class. +use build systems based on ``setuptools`` (e.g. only have a ``setup.py`` and +have not migrated to the official ``pyproject.toml`` format). If your recipe +uses these build systems, the recipe needs to inherit the ``setuptools3`` class. + + .. note:: + + The ``setuptools3`` class ``do_compile()`` task now calls + ``setup.py bdist_wheel`` to build the ``wheel`` binary archive format + (See `PEP-427 `__). + + A consequence of this is that legacy software still using deprecated + ``distutils`` from the Python standard library cannot be packaged as + ``wheels``. A common solution is the replace + ``from distutils.core import setup`` with ``from setuptools import setup``. + + .. note:: + + The ``setuptools3`` class ``do_install()`` task now calls ``pip install`` + to install the ``wheel`` binary archive. In current versions of + ``setuptools`` the legacy ``setup.py install`` method is deprecated. .. _ref-classes-setuptools3-base: -- cgit v1.2.3-54-g00ecf