summaryrefslogtreecommitdiff
path: root/docs/deprecated
diff options
context:
space:
mode:
Diffstat (limited to 'docs/deprecated')
-rw-r--r--docs/deprecated/distutils-legacy.rst12
-rw-r--r--docs/deprecated/easy_install.rst7
-rw-r--r--docs/deprecated/functionalities.rst2
-rw-r--r--docs/deprecated/index.rst1
4 files changed, 10 insertions, 12 deletions
diff --git a/docs/deprecated/distutils-legacy.rst b/docs/deprecated/distutils-legacy.rst
index 94104fe8..e73cdff5 100644
--- a/docs/deprecated/distutils-legacy.rst
+++ b/docs/deprecated/distutils-legacy.rst
@@ -3,11 +3,10 @@ Porting from Distutils
Setuptools and the PyPA have a `stated goal <https://github.com/pypa/packaging-problems/issues/127>`_ to make Setuptools the reference API for distutils.
-Since the 49.1.2 release, Setuptools includes a local, vendored copy of distutils (from late copies of CPython) that is disabled by default. To enable the use of this copy of distutils when invoking setuptools, set the enviroment variable:
+Since the 60.0.0 release, Setuptools includes a local, vendored copy of distutils (from late copies of CPython) that is enabled by default. To disable the use of this copy of distutils when invoking setuptools, set the enviroment variable:
- SETUPTOOLS_USE_DISTUTILS=local
+ SETUPTOOLS_USE_DISTUTILS=stdlib
-This behavior is planned to become the default.
Prefer Setuptools
-----------------
@@ -20,12 +19,15 @@ As Distutils is deprecated, any usage of functions or objects from distutils is
``distutils.command.{build_clib,build_ext,build_py,sdist}`` → ``setuptools.command.*``
-``distutils.log`` → (no replacement yet)
+``distutils.log`` → :mod:`logging` (standard library)
-``distutils.version.*`` → ``packaging.version.*``
+``distutils.version.*`` → :doc:`packaging.version.* <packaging:version>`
``distutils.errors.*`` → ``setuptools.errors.*`` [#errors]_
+
+Migration advice is also provided by :pep:`PEP 632 <632#migration-advice>`.
+
If a project relies on uses of ``distutils`` that do not have a suitable replacement above, please search the `Setuptools issue tracker <https://github.com/pypa/setuptools/issues/>`_ and file a request, describing the use-case so that Setuptools' maintainers can investigate. Please provide enough detail to help the maintainers understand how distutils is used, what value it provides, and why that behavior should be supported.
diff --git a/docs/deprecated/easy_install.rst b/docs/deprecated/easy_install.rst
index 76c3f608..3cf3bea9 100644
--- a/docs/deprecated/easy_install.rst
+++ b/docs/deprecated/easy_install.rst
@@ -34,7 +34,7 @@ Using "Easy Install"
Installing "Easy Install"
-------------------------
-Please see the `setuptools PyPI page <https://pypi.org/project/setuptools/>`_
+Please see the :pypi:`setuptools` on the package index
for download links and basic installation instructions for each of the
supported platforms.
@@ -1020,10 +1020,7 @@ of the User installation scheme. "virtualenv" provides a version of ``easy_inst
scoped to the cloned python install and is used in the normal way. "virtualenv" does offer various features
that the User installation scheme alone does not provide, e.g. the ability to hide the main python site-packages.
-Please refer to the `virtualenv`_ documentation for more details.
-
-.. _virtualenv: https://pypi.org/project/virtualenv/
-
+Please refer to the :pypi:`virtualenv` documentation for more details.
Package Index "API"
diff --git a/docs/deprecated/functionalities.rst b/docs/deprecated/functionalities.rst
index c6ea83b3..7213c5d6 100644
--- a/docs/deprecated/functionalities.rst
+++ b/docs/deprecated/functionalities.rst
@@ -30,4 +30,4 @@ invoked via symlinks. They *must* be invoked using their original filename, in
order to ensure that, once running, ``pkg_resources`` will know what project
and version is in use. The header script will check this and exit with an
error if the ``.egg`` file has been renamed or is invoked via a symlink that
-changes its base name. \ No newline at end of file
+changes its base name.
diff --git a/docs/deprecated/index.rst b/docs/deprecated/index.rst
index ce2ac006..59fc7bef 100644
--- a/docs/deprecated/index.rst
+++ b/docs/deprecated/index.rst
@@ -13,7 +13,6 @@ objectives.
.. toctree::
:maxdepth: 1
- python3
python_eggs
easy_install
distutils/index