diff options
author | Tim Orling <ticotimo@gmail.com> | 2022-02-27 20:04:06 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-03-04 09:39:37 +0000 |
commit | 99a5b42d5cef91b4238e641a2c53c0c44f1e9ca9 (patch) | |
tree | 4e9f9697cee4191d677c032883db856c35c91aab /documentation | |
parent | 0447aace57d46c4de4d120b430384e99fc3a5e0c (diff) | |
download | poky-99a5b42d5cef91b4238e641a2c53c0c44f1e9ca9.tar.gz |
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 <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/classes.rst | 22 |
1 files changed, 20 insertions, 2 deletions
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. | |||
2386 | ======================= | 2386 | ======================= |
2387 | 2387 | ||
2388 | The ``setuptools3`` class supports Python version 3.x extensions that | 2388 | The ``setuptools3`` class supports Python version 3.x extensions that |
2389 | use build systems based on ``setuptools``. If your recipe uses these | 2389 | use build systems based on ``setuptools`` (e.g. only have a ``setup.py`` and |
2390 | build systems, the recipe needs to inherit the ``setuptools3`` class. | 2390 | have not migrated to the official ``pyproject.toml`` format). If your recipe |
2391 | uses these build systems, the recipe needs to inherit the ``setuptools3`` class. | ||
2392 | |||
2393 | .. note:: | ||
2394 | |||
2395 | The ``setuptools3`` class ``do_compile()`` task now calls | ||
2396 | ``setup.py bdist_wheel`` to build the ``wheel`` binary archive format | ||
2397 | (See `PEP-427 <https://www.python.org/dev/peps/pep-0427/>`__). | ||
2398 | |||
2399 | A consequence of this is that legacy software still using deprecated | ||
2400 | ``distutils`` from the Python standard library cannot be packaged as | ||
2401 | ``wheels``. A common solution is the replace | ||
2402 | ``from distutils.core import setup`` with ``from setuptools import setup``. | ||
2403 | |||
2404 | .. note:: | ||
2405 | |||
2406 | The ``setuptools3`` class ``do_install()`` task now calls ``pip install`` | ||
2407 | to install the ``wheel`` binary archive. In current versions of | ||
2408 | ``setuptools`` the legacy ``setup.py install`` method is deprecated. | ||
2391 | 2409 | ||
2392 | .. _ref-classes-setuptools3-base: | 2410 | .. _ref-classes-setuptools3-base: |
2393 | 2411 | ||