[v2,3/3] ref-manual/classes.rst: add setuptools3-base

Message ID 20220113153843.2544066-3-tim.orling@konsulko.com
State New
Headers show
Series [v2,1/3] ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH | expand

Commit Message

Tim Orling Jan. 13, 2022, 3:38 p.m. UTC
Add setuptools3-base class

Deprecate distutils3* classes.

[YOCTO #14610]

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
---
Changes in v2:
  - fix whitespace errors
  - add ref-classes-setuptools3 links

 documentation/ref-manual/classes.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

Comments

Michael Opdenacker Jan. 14, 2022, 5:20 p.m. UTC | #1
Hi Tim

Thanks for the patches!

On 1/13/22 4:38 PM, Tim Orling wrote:
> Add setuptools3-base class
>
> +
> +The ``setuptools3-base`` class provides a reusable base for other classes
> +that support building Python version 3.x extensions. If you need
> +functionality that is not provided by the :ref:`setuptools3<ref-classes-setuptools3` class, you may
> +want to ``inherit setuptools3-base``. Some recipes do not need the tasks
> +in the :ref:`setuptools3<ref-classes-setuptools3` class and inherit this class instead.


There were syntax issues in the above references but no problem, I fixed
them.
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Merged into "master-next".

Thanks again!
Michael.
Tim Orling Jan. 14, 2022, 6:09 p.m. UTC | #2
On Fri, Jan 14, 2022 at 9:20 AM Michael Opdenacker <
michael.opdenacker@bootlin.com> wrote:

> Hi Tim
>
> Thanks for the patches!
>
> On 1/13/22 4:38 PM, Tim Orling wrote:
> > Add setuptools3-base class
> >
> > +
> > +The ``setuptools3-base`` class provides a reusable base for other
> classes
> > +that support building Python version 3.x extensions. If you need
> > +functionality that is not provided by the
> :ref:`setuptools3<ref-classes-setuptools3` class, you may
> > +want to ``inherit setuptools3-base``. Some recipes do not need the tasks
> > +in the :ref:`setuptools3<ref-classes-setuptools3` class and inherit
> this class instead.
>
>
> There were syntax issues in the above references but no problem, I fixed
> them.

thank you.I was being lazy :/

>
> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> Merged into "master-next".
>
> Thanks again!
> Michael.
>
> --
> Michael Opdenacker, Bootlin
> Embedded Linux and Kernel engineering
> https://bootlin.com
>
>

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 99d9a7a3e..12a9fd83a 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -515,6 +515,14 @@  used.
 -  Extensions that use ``distutils``-based build systems require the
    ``distutils`` class in their recipes.
 
+   .. note::
+
+      ``distutils`` has been deprecated in Python 3.10 and will be removed
+      in Python 3.12. For this reason the ``distutils3*`` classes are now
+      deprecated and will be removed from core in the near future. Instead,
+      use the ``setuptools3*`` classes.
+
+
 -  Extensions that use build systems based on ``setuptools3`` require
    the :ref:`setuptools3 <ref-classes-setuptools3>` class in their
    recipes.
@@ -2376,6 +2384,17 @@  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.
 
+.. _ref-classes-setuptools3-base:
+
+``setuptools3-base.bbclass``
+============================
+
+The ``setuptools3-base`` class provides a reusable base for other classes
+that support building Python version 3.x extensions. If you need
+functionality that is not provided by the :ref:`setuptools3<ref-classes-setuptools3` class, you may
+want to ``inherit setuptools3-base``. Some recipes do not need the tasks
+in the :ref:`setuptools3<ref-classes-setuptools3` class and inherit this class instead.
+
 .. _ref-classes-sign_rpm:
 
 ``sign_rpm.bbclass``