* [PATCH v2 1/3] ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH
@ 2022-01-13 15:38 Tim Orling
2022-01-13 15:38 ` [PATCH v2 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS Tim Orling
2022-01-13 15:38 ` [PATCH v2 3/3] ref-manual/classes.rst: add setuptools3-base Tim Orling
0 siblings, 2 replies; 5+ messages in thread
From: Tim Orling @ 2022-01-13 15:38 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>
---
Changes in v2:
- fix whitespace error
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..7c2f74a39 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
@@ -1996,6 +1995,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
downloads. By default, :term:`DL_DIR` gets files suitable for mirroring
@@ -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] 5+ messages in thread
* [PATCH v2 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS
2022-01-13 15:38 [PATCH v2 1/3] ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH Tim Orling
@ 2022-01-13 15:38 ` Tim Orling
2022-01-13 15:38 ` [PATCH v2 3/3] ref-manual/classes.rst: add setuptools3-base Tim Orling
1 sibling, 0 replies; 5+ messages in thread
From: Tim Orling @ 2022-01-13 15:38 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>
---
Changes in v2:
- drop "default" variable examples, as this is brittle and perhaps not
providing that much value.
documentation/ref-manual/variables.rst | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 7c2f74a39..37231a3cd 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6847,6 +6847,18 @@ 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.
+
+ :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.
+
: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] 5+ messages in thread
* [PATCH v2 3/3] ref-manual/classes.rst: add setuptools3-base
2022-01-13 15:38 [PATCH v2 1/3] ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH Tim Orling
2022-01-13 15:38 ` [PATCH v2 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS Tim Orling
@ 2022-01-13 15:38 ` Tim Orling
2022-01-14 17:20 ` [docs] " Michael Opdenacker
1 sibling, 1 reply; 5+ messages in thread
From: Tim Orling @ 2022-01-13 15:38 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>
---
Changes in v2:
- fix whitespace errors
- add ref-classes-setuptools3 links
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..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``
--
2.30.2
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [docs] [PATCH v2 3/3] ref-manual/classes.rst: add setuptools3-base
2022-01-13 15:38 ` [PATCH v2 3/3] ref-manual/classes.rst: add setuptools3-base Tim Orling
@ 2022-01-14 17:20 ` Michael Opdenacker
2022-01-14 18:09 ` Tim Orling
0 siblings, 1 reply; 5+ messages in thread
From: Michael Opdenacker @ 2022-01-14 17:20 UTC (permalink / raw)
To: Tim Orling, docs; +Cc: Tim Orling
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.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [docs] [PATCH v2 3/3] ref-manual/classes.rst: add setuptools3-base
2022-01-14 17:20 ` [docs] " Michael Opdenacker
@ 2022-01-14 18:09 ` Tim Orling
0 siblings, 0 replies; 5+ messages in thread
From: Tim Orling @ 2022-01-14 18:09 UTC (permalink / raw)
To: Michael Opdenacker; +Cc: Tim Orling, docs
[-- Attachment #1: Type: text/plain, Size: 993 bytes --]
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
>
>
[-- Attachment #2: Type: text/html, Size: 1800 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2022-01-14 18:09 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-01-13 15:38 [PATCH v2 1/3] ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH Tim Orling
2022-01-13 15:38 ` [PATCH v2 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS Tim Orling
2022-01-13 15:38 ` [PATCH v2 3/3] ref-manual/classes.rst: add setuptools3-base Tim Orling
2022-01-14 17:20 ` [docs] " Michael Opdenacker
2022-01-14 18:09 ` 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.