All of lore.kernel.org
 help / color / mirror / Atom feed
* Add setuptools*.bbclass changes and distutils deprecation
@ 2022-01-11 19:57 Tim Orling
  2022-01-11 19:57 ` [PATCH 1/3] ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH Tim Orling
                   ` (2 more replies)
  0 siblings, 3 replies; 8+ messages in thread
From: Tim Orling @ 2022-01-11 19:57 UTC (permalink / raw)
  To: docs

This series deprecates the 'distutils' bbclasses and variables and
documents the replacements based on 'setuptools'.

We intend to move the 'distutils' bbclasses to meta-python, probably
during 3.5-M3. An updated series for the docs will be sent at that
time.

This series depends on the 'deprecation of distutils' patches for
oe-core [1]


[1] https://lore.kernel.org/openembedded-core/cover.1641920605.git.tim.orling@konsulko.com/T/#m8d122be68f9b03d35a1187dd462e71de2542837c




^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH 1/3] ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH
  2022-01-11 19:57 Add setuptools*.bbclass changes and distutils deprecation Tim Orling
@ 2022-01-11 19:57 ` Tim Orling
  2022-01-11 19:57 ` [PATCH 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS Tim Orling
  2022-01-11 19:57 ` [PATCH 3/3] ref-manual/classes.rst: add setuptools3-base Tim Orling
  2 siblings, 0 replies; 8+ messages in thread
From: Tim Orling @ 2022-01-11 19:57 UTC (permalink / raw)
  To: docs; +Cc: Tim Orling

Add SETUPTOOLS_SETUP_PATH for setuptools3 class.

Deprecate DISTUTILS_SETUP_PATH and drop mention of ref-classes-setuptools3 as
that class has moved to new variable.

[YOCTO #14610]

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
---
 documentation/ref-manual/variables.rst | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index be496161b..83ccda830 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1985,8 +1985,7 @@ system and gives an overview of their function and contents.
 
    :term:`DISTUTILS_SETUP_PATH`
       When used by recipes that inherit the
-      :ref:`distutils3 <ref-classes-distutils3>` or
-      :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable should
+      :ref:`distutils3 <ref-classes-distutils3>` class, this variable should
       be used to specify the directory in which the ``setup.py`` file is
       located if it is not at the root of the source tree (as specified by
       :term:`S`). For example, in a recipe where the sources are fetched from
@@ -1995,6 +1994,13 @@ system and gives an overview of their function and contents.
 
          S = "${WORKDIR}/git"
          DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule"
+      
+      .. note::
+
+         ``distutils`` has been deprecated in Python 3.10 and will be removed
+         in Python 3.12. For this reason, the use of :ref:`distutils3 <ref-classes-distutils3>`
+         is deprecated. Instead use :ref:`setuptools3 <ref-classes-setuptools3>` and the
+         :term:`SETUPTOOLS_SETUP_PATH` variable.
 
    :term:`DL_DIR`
       The central download directory used by the build process to store
@@ -6841,6 +6847,18 @@ system and gives an overview of their function and contents.
 
          EXTRA_IMAGE_FEATURES += "read-only-rootfs"
 
+   :term:`SETUPTOOLS_SETUP_PATH`
+      When used by recipes that inherit the
+      :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable should
+      be used to specify the directory in which the ``setup.py`` file is
+      located if it is not at the root of the source tree (as specified by
+      :term:`S`). For example, in a recipe where the sources are fetched from
+      a Git repository and ``setup.py`` is in a ``python/pythonmodule``
+      subdirectory, you would have this::
+
+         S = "${WORKDIR}/git"
+         SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule"
+
    :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS`
       A list of recipe dependencies that should not be used to determine
       signatures of tasks from one recipe when they depend on tasks from
-- 
2.30.2



^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS
  2022-01-11 19:57 Add setuptools*.bbclass changes and distutils deprecation Tim Orling
  2022-01-11 19:57 ` [PATCH 1/3] ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH Tim Orling
@ 2022-01-11 19:57 ` Tim Orling
  2022-01-12 14:26   ` [docs] " Quentin Schulz
  2022-01-11 19:57 ` [PATCH 3/3] ref-manual/classes.rst: add setuptools3-base Tim Orling
  2 siblings, 1 reply; 8+ messages in thread
From: Tim Orling @ 2022-01-11 19:57 UTC (permalink / raw)
  To: docs; +Cc: Tim Orling

Add SETUPTOOLS_BUILD_ARGS variable which can be used to pass additional
arguments to `setup.py build`.

Add SETUPTOOLS_INSTALL_ARGS variable which can be used to pass
additional arguments to `setup.py install`.

[YOCTO #14610]

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
---
 documentation/ref-manual/variables.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 83ccda830..3011c1c83 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6847,6 +6847,25 @@ system and gives an overview of their function and contents.
 
          EXTRA_IMAGE_FEATURES += "read-only-rootfs"
 
+   :term:`SETUPTOOLS_BUILD_ARGS`
+      When used by recipes that inherit the
+      :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable can
+      be used to specify additional arguments to be passed to ``setup.py build``
+      in the ``setuptools3_do_compile()`` task. By default, this variable is unset::
+      
+         SETUPTOOLS_BUILD_ARGS ?= ""
+
+   :term:`SETUPTOOLS_INSTALL_ARGS`
+      When used by recipes that inherit the
+      :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable can
+      be used to specify additional arguments to be passed to ``setup.py install``
+      in the ``setuptools3_do_install()`` task. By default, this variable is::
+
+         SETUPTOOLS_INSTALL_ARGS ?= "--root=${D} \
+             --prefix=${prefix} \
+             --install-lib=${PYTHON_SITEPACKAGES_DIR} \
+             --install-data=${datadir}"
+
    :term:`SETUPTOOLS_SETUP_PATH`
       When used by recipes that inherit the
       :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable should
-- 
2.30.2



^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 3/3] ref-manual/classes.rst: add setuptools3-base
  2022-01-11 19:57 Add setuptools*.bbclass changes and distutils deprecation Tim Orling
  2022-01-11 19:57 ` [PATCH 1/3] ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH Tim Orling
  2022-01-11 19:57 ` [PATCH 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS Tim Orling
@ 2022-01-11 19:57 ` Tim Orling
  2022-01-12 14:31   ` [docs] " Quentin Schulz
  2 siblings, 1 reply; 8+ messages in thread
From: Tim Orling @ 2022-01-11 19:57 UTC (permalink / raw)
  To: docs; +Cc: Tim Orling

Add setuptools3-base class

Deprecate distutils3* classes.

[YOCTO #14610]

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
---
 documentation/ref-manual/classes.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 99d9a7a3e..41360c965 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 Python3 version 3.x extensions. If you need
+functionality that is not provided by the ``setuptools3`` class, you may
+want to ``inherit setuptools3-base``. Some recipes do not need the tasks
+in the ``setuptools3`` class and inherit this class instead.
+
 .. _ref-classes-sign_rpm:
 
 ``sign_rpm.bbclass``
-- 
2.30.2



^ permalink raw reply related	[flat|nested] 8+ messages in thread

* Re: [docs] [PATCH 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS
  2022-01-11 19:57 ` [PATCH 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS Tim Orling
@ 2022-01-12 14:26   ` Quentin Schulz
  2022-01-12 16:26     ` Tim Orling
  0 siblings, 1 reply; 8+ messages in thread
From: Quentin Schulz @ 2022-01-12 14:26 UTC (permalink / raw)
  To: Tim Orling, docs; +Cc: Tim Orling

Hi Tim,

On 1/11/22 20:57, Tim Orling wrote:
> Add SETUPTOOLS_BUILD_ARGS variable which can be used to pass additional
> arguments to `setup.py build`.
> 
> Add SETUPTOOLS_INSTALL_ARGS variable which can be used to pass
> additional arguments to `setup.py install`.
> 
> [YOCTO #14610]
> 
> Signed-off-by: Tim Orling <tim.orling@konsulko.com>
> ---
>   documentation/ref-manual/variables.rst | 19 +++++++++++++++++++
>   1 file changed, 19 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 83ccda830..3011c1c83 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -6847,6 +6847,25 @@ system and gives an overview of their function and contents.
>   
>            EXTRA_IMAGE_FEATURES += "read-only-rootfs"
>   
> +   :term:`SETUPTOOLS_BUILD_ARGS`
> +      When used by recipes that inherit the
> +      :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable can
> +      be used to specify additional arguments to be passed to ``setup.py build``
> +      in the ``setuptools3_do_compile()`` task. By default, this variable is unset::
> +
> +         SETUPTOOLS_BUILD_ARGS ?= ""
> +
> +   :term:`SETUPTOOLS_INSTALL_ARGS`
> +      When used by recipes that inherit the
> +      :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable can
> +      be used to specify additional arguments to be passed to ``setup.py install``
> +      in the ``setuptools3_do_install()`` task. By default, this variable is::
> +
> +         SETUPTOOLS_INSTALL_ARGS ?= "--root=${D} \
> +             --prefix=${prefix} \
> +             --install-lib=${PYTHON_SITEPACKAGES_DIR} \
> +             --install-data=${datadir}"
> +

I don't really like specifying the default values of variables in the 
docs. The default value can change and the docs will most likely not be 
kept in sync (as a few recent patches from Michael has shown :) ).

I think the paragraph can stop at "be passed to ``setup.py install``. Or 
maybe we can add a few words on what someone would typically set this 
variable to in their recipe if they have to modify it?

Cheers,
Quentin

>      :term:`SETUPTOOLS_SETUP_PATH`
>         When used by recipes that inherit the
>         :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable should
> 
> 
> 
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#2384): https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_2384&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=8wGMTT7Mjy9XFEK8rx13kzdh8PSQEe7L1DRuSkGS_zIIejVqWrVUWNVNxtQDiQjR&s=Hrn-7ZEdMEgRnmJGvVy19eX7zCYGwQY2oq4Hr0XGhz0&e=
> Mute This Topic: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_mt_88357645_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=8wGMTT7Mjy9XFEK8rx13kzdh8PSQEe7L1DRuSkGS_zIIejVqWrVUWNVNxtQDiQjR&s=KVFe8_QAMfcjQibqPvJqj14YPqUGtIHNOSHR0hmZEZI&e=
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_unsub&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=8wGMTT7Mjy9XFEK8rx13kzdh8PSQEe7L1DRuSkGS_zIIejVqWrVUWNVNxtQDiQjR&s=a2EqtjY70frDTNQjHZiWadqWOQo6eyBrV7c4oFuIVUI&e=  [quentin.schulz@theobroma-systems.com]
> -=-=-=-=-=-=-=-=-=-=-=-
> 


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [docs] [PATCH 3/3] ref-manual/classes.rst: add setuptools3-base
  2022-01-11 19:57 ` [PATCH 3/3] ref-manual/classes.rst: add setuptools3-base Tim Orling
@ 2022-01-12 14:31   ` Quentin Schulz
  2022-01-12 16:27     ` Tim Orling
  0 siblings, 1 reply; 8+ messages in thread
From: Quentin Schulz @ 2022-01-12 14:31 UTC (permalink / raw)
  To: Tim Orling, docs; +Cc: Tim Orling

Hi Tim,

On 1/11/22 20:57, Tim Orling wrote:
> Add setuptools3-base class
> 
> Deprecate distutils3* classes.
> 
> [YOCTO #14610]
> 
> Signed-off-by: Tim Orling <tim.orling@konsulko.com>
> ---
>   documentation/ref-manual/classes.rst | 19 +++++++++++++++++++
>   1 file changed, 19 insertions(+)
> 
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 99d9a7a3e..41360c965 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 Python3 version 3.x extensions. If you need

"Python3 extensions" or "Python 3.x extensions" but I guess not both at 
the same time? FWIW, setuptools3 uses the latter.

> +functionality that is not provided by the ``setuptools3`` class, you may

:ref:`setuptools3 <ref-classes-setuptools3>`

> +want to ``inherit setuptools3-base``. Some recipes do not need the tasks
> +in the ``setuptools3`` class and inherit this class instead.
> +

:ref:`setuptools3 <ref-classes-setuptools3>`

Looks good otherwise,
Thanks!

Quentin

>   .. _ref-classes-sign_rpm:
>   
>   ``sign_rpm.bbclass``
> 
> 
> 
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#2385): https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_2385&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=h2Sz3gZJqoPsLKIfwNlfXAYFeX7mpQdP2oEhvb2aGweey-2-dybLOh-TQ4wdUyAn&s=M_b1du7dlXE8qFoFbIMq2Rl5WKpnDzSYPdMNNHYarmk&e=
> Mute This Topic: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_mt_88357646_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=h2Sz3gZJqoPsLKIfwNlfXAYFeX7mpQdP2oEhvb2aGweey-2-dybLOh-TQ4wdUyAn&s=-Zmwc8AjGeJ5swQXxOjJeeJ_PhR3Yr1UOFftrABLXys&e=
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_unsub&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=h2Sz3gZJqoPsLKIfwNlfXAYFeX7mpQdP2oEhvb2aGweey-2-dybLOh-TQ4wdUyAn&s=rOYWLxd9CDFOLemM4UKT_oz3hU5amnFuC7rGylfmQno&e=  [quentin.schulz@theobroma-systems.com]
> -=-=-=-=-=-=-=-=-=-=-=-
> 


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [docs] [PATCH 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS
  2022-01-12 14:26   ` [docs] " Quentin Schulz
@ 2022-01-12 16:26     ` Tim Orling
  0 siblings, 0 replies; 8+ messages in thread
From: Tim Orling @ 2022-01-12 16:26 UTC (permalink / raw)
  To: Quentin Schulz; +Cc: YP docs mailing list, Tim Orling

[-- Attachment #1: Type: text/plain, Size: 4002 bytes --]

On Wed, Jan 12, 2022 at 6:26 AM Quentin Schulz <
quentin.schulz@theobroma-systems.com> wrote:

> Hi Tim,
>
> On 1/11/22 20:57, Tim Orling wrote:
> > Add SETUPTOOLS_BUILD_ARGS variable which can be used to pass additional
> > arguments to `setup.py build`.
> >
> > Add SETUPTOOLS_INSTALL_ARGS variable which can be used to pass
> > additional arguments to `setup.py install`.
> >
> > [YOCTO #14610]
> >
> > Signed-off-by: Tim Orling <tim.orling@konsulko.com>
> > ---
> >   documentation/ref-manual/variables.rst | 19 +++++++++++++++++++
> >   1 file changed, 19 insertions(+)
> >
> > diff --git a/documentation/ref-manual/variables.rst
> b/documentation/ref-manual/variables.rst
> > index 83ccda830..3011c1c83 100644
> > --- a/documentation/ref-manual/variables.rst
> > +++ b/documentation/ref-manual/variables.rst
> > @@ -6847,6 +6847,25 @@ system and gives an overview of their function
> and contents.
> >
> >            EXTRA_IMAGE_FEATURES += "read-only-rootfs"
> >
> > +   :term:`SETUPTOOLS_BUILD_ARGS`
> > +      When used by recipes that inherit the
> > +      :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable
> can
> > +      be used to specify additional arguments to be passed to
> ``setup.py build``
> > +      in the ``setuptools3_do_compile()`` task. By default, this
> variable is unset::
> > +
> > +         SETUPTOOLS_BUILD_ARGS ?= ""
> > +
> > +   :term:`SETUPTOOLS_INSTALL_ARGS`
> > +      When used by recipes that inherit the
> > +      :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable
> can
> > +      be used to specify additional arguments to be passed to
> ``setup.py install``
> > +      in the ``setuptools3_do_install()`` task. By default, this
> variable is::
> > +
> > +         SETUPTOOLS_INSTALL_ARGS ?= "--root=${D} \
> > +             --prefix=${prefix} \
> > +             --install-lib=${PYTHON_SITEPACKAGES_DIR} \
> > +             --install-data=${datadir}"
> > +
>
> I don't really like specifying the default values of variables in the
> docs. The default value can change and the docs will most likely not be
> kept in sync (as a few recent patches from Michael has shown :) ).
>
> Agreed. I didn't like it either ;)


> I think the paragraph can stop at "be passed to ``setup.py install``. Or
> maybe we can add a few words on what someone would typically set this
> variable to in their recipe if they have to modify it?
>
>
Of course the problem is I didn't have any examples other than the
default...


> Cheers,
> Quentin
>
> >      :term:`SETUPTOOLS_SETUP_PATH`
> >         When used by recipes that inherit the
> >         :ref:`setuptools3 <ref-classes-setuptools3>` class, this
> variable should
> >
> >
> >
> > -=-=-=-=-=-=-=-=-=-=-=-
> > Links: You receive all messages sent to this group.
> > View/Reply Online (#2384):
> https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_2384&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=8wGMTT7Mjy9XFEK8rx13kzdh8PSQEe7L1DRuSkGS_zIIejVqWrVUWNVNxtQDiQjR&s=Hrn-7ZEdMEgRnmJGvVy19eX7zCYGwQY2oq4Hr0XGhz0&e=
> > Mute This Topic:
> https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_mt_88357645_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=8wGMTT7Mjy9XFEK8rx13kzdh8PSQEe7L1DRuSkGS_zIIejVqWrVUWNVNxtQDiQjR&s=KVFe8_QAMfcjQibqPvJqj14YPqUGtIHNOSHR0hmZEZI&e=
> > Group Owner: docs+owner@lists.yoctoproject.org
> > Unsubscribe:
> https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_unsub&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=8wGMTT7Mjy9XFEK8rx13kzdh8PSQEe7L1DRuSkGS_zIIejVqWrVUWNVNxtQDiQjR&s=a2EqtjY70frDTNQjHZiWadqWOQo6eyBrV7c4oFuIVUI&e=
> [quentin.schulz@theobroma-systems.com]
> > -=-=-=-=-=-=-=-=-=-=-=-
> >
>

[-- Attachment #2: Type: text/html, Size: 6499 bytes --]

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [docs] [PATCH 3/3] ref-manual/classes.rst: add setuptools3-base
  2022-01-12 14:31   ` [docs] " Quentin Schulz
@ 2022-01-12 16:27     ` Tim Orling
  0 siblings, 0 replies; 8+ messages in thread
From: Tim Orling @ 2022-01-12 16:27 UTC (permalink / raw)
  To: Quentin Schulz; +Cc: YP docs mailing list, Tim Orling

[-- Attachment #1: Type: text/plain, Size: 3777 bytes --]

On Wed, Jan 12, 2022 at 6:31 AM Quentin Schulz <
quentin.schulz@theobroma-systems.com> wrote:

> Hi Tim,
>
> On 1/11/22 20:57, Tim Orling wrote:
> > Add setuptools3-base class
> >
> > Deprecate distutils3* classes.
> >
> > [YOCTO #14610]
> >
> > Signed-off-by: Tim Orling <tim.orling@konsulko.com>
> > ---
> >   documentation/ref-manual/classes.rst | 19 +++++++++++++++++++
> >   1 file changed, 19 insertions(+)
> >
> > diff --git a/documentation/ref-manual/classes.rst
> b/documentation/ref-manual/classes.rst
> > index 99d9a7a3e..41360c965 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 Python3 version 3.x extensions. If you need
>
> "Python3 extensions" or "Python 3.x extensions" but I guess not both at
> the same time? FWIW, setuptools3 uses the latter.
>
> > +functionality that is not provided by the ``setuptools3`` class, you may
>
> :ref:`setuptools3 <ref-classes-setuptools3>`
>
> > +want to ``inherit setuptools3-base``. Some recipes do not need the tasks
> > +in the ``setuptools3`` class and inherit this class instead.
> > +
>
> :ref:`setuptools3 <ref-classes-setuptools3>`
>
>
Good catch. Thank you for the second set of eyes on this.


> Looks good otherwise,
> Thanks!
>
> Quentin
>
> >   .. _ref-classes-sign_rpm:
> >
> >   ``sign_rpm.bbclass``
> >
> >
> >
> > -=-=-=-=-=-=-=-=-=-=-=-
> > Links: You receive all messages sent to this group.
> > View/Reply Online (#2385):
> https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_2385&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=h2Sz3gZJqoPsLKIfwNlfXAYFeX7mpQdP2oEhvb2aGweey-2-dybLOh-TQ4wdUyAn&s=M_b1du7dlXE8qFoFbIMq2Rl5WKpnDzSYPdMNNHYarmk&e=
> > Mute This Topic:
> https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_mt_88357646_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=h2Sz3gZJqoPsLKIfwNlfXAYFeX7mpQdP2oEhvb2aGweey-2-dybLOh-TQ4wdUyAn&s=-Zmwc8AjGeJ5swQXxOjJeeJ_PhR3Yr1UOFftrABLXys&e=
> > Group Owner: docs+owner@lists.yoctoproject.org
> > Unsubscribe:
> https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_unsub&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=h2Sz3gZJqoPsLKIfwNlfXAYFeX7mpQdP2oEhvb2aGweey-2-dybLOh-TQ4wdUyAn&s=rOYWLxd9CDFOLemM4UKT_oz3hU5amnFuC7rGylfmQno&e=
> [quentin.schulz@theobroma-systems.com]
> > -=-=-=-=-=-=-=-=-=-=-=-
> >
>

[-- Attachment #2: Type: text/html, Size: 6103 bytes --]

^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2022-01-12 16:27 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-01-11 19:57 Add setuptools*.bbclass changes and distutils deprecation Tim Orling
2022-01-11 19:57 ` [PATCH 1/3] ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH Tim Orling
2022-01-11 19:57 ` [PATCH 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS Tim Orling
2022-01-12 14:26   ` [docs] " Quentin Schulz
2022-01-12 16:26     ` Tim Orling
2022-01-11 19:57 ` [PATCH 3/3] ref-manual/classes.rst: add setuptools3-base Tim Orling
2022-01-12 14:31   ` [docs] " Quentin Schulz
2022-01-12 16:27     ` Tim Orling

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.