mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-09-16 09:49:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH

Browse Source 
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]

(From yocto-docs rev: 6a314a9217206f572289b484e59076483391868c)

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>
This commit is contained in:
Tim Orling
2022-01-13 07:38:41 -08:00
committed by Richard Purdie
parent fc30301d4c
commit 7018f99223
1 changed files with 20 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
documentation/ref-manual/variables.rst
View File

@@ -1984,8 +1984,7 @@ system and gives an overview of their function and contents.
:term:`DISTUTILS_SETUP_PATH` :term:`DISTUTILS_SETUP_PATH`
When used by recipes that inherit the When used by recipes that inherit the
:ref:`distutils3 <ref-classes-distutils3>` or :ref:`distutils3 <ref-classes-distutils3>` class, this variable should
:ref:`setuptools3 <ref-classes-setuptools3>` class, this variable should
be used to specify the directory in which the ``setup.py`` file is 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 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 :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" S = "${WORKDIR}/git"
DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule" 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` :term:`DL_DIR`
The central download directory used by the build process to store The central download directory used by the build process to store
downloads. By default, :term:`DL_DIR` gets files suitable for mirroring downloads. By default, :term:`DL_DIR` gets files suitable for mirroring
@@ -6840,6 +6846,18 @@ system and gives an overview of their function and contents.
EXTRA_IMAGE_FEATURES += "read-only-rootfs" 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` :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS`
A list of recipe dependencies that should not be used to determine A list of recipe dependencies that should not be used to determine
signatures of tasks from one recipe when they depend on tasks from signatures of tasks from one recipe when they depend on tasks from