Skip to content

gh-85454: Remove links from historical mentions of distutils (GH-95192) #95192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions Doc/distributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,21 +41,21 @@ Key terms
file format standards. They maintain a variety of tools, documentation
and issue trackers on both `GitHub <https://github.com/pypa>`__ and
`Bitbucket <https://bitbucket.org/pypa/>`__.
* :mod:`distutils` is the original build and distribution system first added
to the Python standard library in 1998. While direct use of :mod:`distutils`
* ``distutils`` is the original build and distribution system first added
to the Python standard library in 1998. While direct use of ``distutils``
is being phased out, it still laid the foundation for the current packaging
and distribution infrastructure, and it not only remains part of the
standard library, but its name lives on in other ways (such as the name
of the mailing list used to coordinate Python packaging standards
development).
* `setuptools`_ is a (largely) drop-in replacement for :mod:`distutils` first
* `setuptools`_ is a (largely) drop-in replacement for ``distutils`` first
published in 2004. Its most notable addition over the unmodified
:mod:`distutils` tools was the ability to declare dependencies on other
``distutils`` tools was the ability to declare dependencies on other
packages. It is currently recommended as a more regularly updated
alternative to :mod:`distutils` that offers consistent support for more
alternative to ``distutils`` that offers consistent support for more
recent packaging standards across a wide range of Python versions.
* `wheel`_ (in this context) is a project that adds the ``bdist_wheel``
command to :mod:`distutils`/`setuptools`_. This produces a cross platform
command to ``distutils``/`setuptools`_. This produces a cross platform
binary packaging format (called "wheels" or "wheel files" and defined in
:pep:`427`) that allows Python libraries, even those including binary
extensions, to be installed on a system without needing to be built
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/2.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -820,7 +820,7 @@ packages, which made administering a Python installation something of a chore.

The SIG for distribution utilities, shepherded by Greg Ward, has created the
Distutils, a system to make package installation much easier. They form the
:mod:`distutils` package, a new part of Python's standard library. In the best
``distutils`` package, a new part of Python's standard library. In the best
case, installing a Python module from source will require the same steps: first
you simply mean unpack the tarball or zip archive, and the run "``python
setup.py install``". The platform will be automatically detected, the compiler
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2056,7 +2056,7 @@ information:
such as "3.2".

It also provides access to the paths and variables corresponding to one of
seven named schemes used by :mod:`distutils`. Those include *posix_prefix*,
seven named schemes used by ``distutils``. Those include *posix_prefix*,
*posix_home*, *posix_user*, *nt*, *nt_user*, *os2*, *os2_home*:

* :func:`~sysconfig.get_paths` makes a dictionary containing installation paths
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1079,7 +1079,7 @@ Both the ``build`` and ``build_ext`` commands now accept a ``-j`` option to
enable parallel building of extension modules.
(Contributed by Antoine Pitrou in :issue:`5309`.)

The :mod:`distutils` module now supports ``xz`` compression, and can be
The ``distutils`` module now supports ``xz`` compression, and can be
enabled by passing ``xztar`` as an argument to ``bdist --format``.
(Contributed by Serhiy Storchaka in :issue:`16314`.)

Expand Down
6 changes: 3 additions & 3 deletions Doc/whatsnew/3.6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1012,7 +1012,7 @@ distutils
---------

The ``default_format`` attribute has been removed from
:class:`distutils.command.sdist.sdist` and the ``formats``
``distutils.command.sdist.sdist`` and the ``formats``
attribute defaults to ``['gztar']``. Although not anticipated,
any code relying on the presence of ``default_format`` may
need to be adapted. See :issue:`27819` for more details.
Expand Down Expand Up @@ -1986,7 +1986,7 @@ distutils
~~~~~~~~~

The undocumented ``extra_path`` argument to the
:class:`~distutils.Distribution` constructor is now considered deprecated
``distutils.Distribution`` constructor is now considered deprecated
and will raise a warning if set. Support for this parameter will be
removed in a future Python release. See :issue:`27919` for details.

Expand Down Expand Up @@ -2243,7 +2243,7 @@ Changes in the Python API
accepting additional keyword arguments will need to adjust their calls to
:meth:`type.__new__` (whether direct or via :class:`super`) accordingly.

* In :class:`distutils.command.sdist.sdist`, the ``default_format``
* In ``distutils.command.sdist.sdist``, the ``default_format``
attribute has been removed and is no longer honored. Instead, the
gzipped tarfile format is the default on all platforms and no
platform-specific selection is made.
Expand Down
4 changes: 2 additions & 2 deletions Doc/whatsnew/3.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1906,7 +1906,7 @@ Other CPython Implementation Changes
variables were defined. Previously, the order was undefined.
(Contributed by Raymond Hettinger in :issue:`32690`.)

* The :mod:`distutils` ``upload`` command no longer tries to change CR
* The ``distutils`` ``upload`` command no longer tries to change CR
end-of-line characters to CRLF. This fixes a corruption issue with sdists
that ended with a byte equivalent to CR.
(Contributed by Bo Bayles in :issue:`32304`.)
Expand Down Expand Up @@ -2181,7 +2181,7 @@ The following features and APIs have been removed from Python 3.7:
:func:`ssl.wrap_socket` or :class:`ssl.SSLContext`.
(Contributed by Christian Heimes in :issue:`32951`.)

* The unused :mod:`distutils` ``install_misc`` command has been removed.
* The unused ``distutils`` ``install_misc`` command has been removed.
(Contributed by Eric N. Vander Weele in :issue:`29218`.)


Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.10.0a1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2204,7 +2204,7 @@ Handle cases where the ``end_lineno`` is ``None`` on
.. nonce: zwl5Hc
.. section: Library

:mod:`distutils` upload creates SHA2-256 and Blake2b-256 digests. MD5
``distutils`` upload creates SHA2-256 and Blake2b-256 digests. MD5
digests is skipped if platform blocks MD5.

..
Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.10.0b1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1142,7 +1142,7 @@ name>`` instead of ``SQL logic error``. Patch by Erlend E. Aasland.
.. nonce: GK9a0l
.. section: Library

Install schemes in :mod:`distutils.command.install` are now loaded from
Install schemes in ``distutils.command.install`` are now loaded from
:mod:`sysconfig`.

..
Expand All @@ -1152,7 +1152,7 @@ Install schemes in :mod:`distutils.command.install` are now loaded from
.. nonce: SenEje
.. section: Library

:mod:`distutils.sysconfig` has been merged to :mod:`sysconfig`.
``distutils.sysconfig`` has been merged to :mod:`sysconfig`.

..

Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.11.0a1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1445,7 +1445,7 @@ asynchronous.
.. nonce: NOwcDJ
.. section: Library

Fix clang rpath issue in :mod:`distutils`. The UnixCCompiler now uses
Fix clang rpath issue in ``distutils``. The UnixCCompiler now uses
correct clang option to add a runtime library directory (rpath) to a shared
library.

Expand Down Expand Up @@ -2798,7 +2798,7 @@ documentation for deprecations.
.. nonce: rvyf2v
.. section: Library

Restore back :func:`parse_makefile` in :mod:`distutils.sysconfig` because it
Restore back :func:`parse_makefile` in ``distutils.sysconfig`` because it
behaves differently than the similar implementation in :mod:`sysconfig`.

..
Expand Down
8 changes: 4 additions & 4 deletions Misc/NEWS.d/3.8.0a1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ malicious or buggy certificate can result into segfault. Vulnerability
.. section: Security

The :option:`-I` command line option (run Python in isolated mode) is now
also copied by the :mod:`multiprocessing` and :mod:`distutils` modules when
also copied by the :mod:`multiprocessing` and ``distutils`` modules when
spawning child processes. Previously, only :option:`-E` and :option:`-s`
options (enabled by :option:`-I`) were copied.

Expand Down Expand Up @@ -2270,7 +2270,7 @@ last release was in 2000. Mac OS 9 last release was in 2001.
.. nonce: laV_IE
.. section: Library

:func:`~distutils.utils.check_environ` of :mod:`distutils.utils` now catches
:func:`~distutils.utils.check_environ` of ``distutils.utils`` now catches
:exc:`KeyError` on calling :func:`pwd.getpwuid`: don't create the ``HOME``
environment variable in this case.

Expand Down Expand Up @@ -3070,7 +3070,7 @@ Add deprecation warning when `loop` is used in methods: `asyncio.sleep`,
.. nonce: Pr3-iG
.. section: Library

ZIP files created by :mod:`distutils` will now include entries for
ZIP files created by ``distutils`` will now include entries for
directories.

..
Expand Down Expand Up @@ -3720,7 +3720,7 @@ Deprecate passing non-ThreadPoolExecutor instances to
.. section: Library

Restore ``msilib.Win64`` to preserve backwards compatibility since it's
already used by :mod:`distutils`' ``bdist_msi`` command.
already used by ``distutils``' ``bdist_msi`` command.

..

Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.8.0a4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ unexpected cache miss.
.. nonce: MW1TLt
.. section: Library

Fix :mod:`distutils.sysconfig` if :data:`sys.executable` is ``None`` or an
Fix ``distutils.sysconfig`` if :data:`sys.executable` is ``None`` or an
empty string: use :func:`os.getcwd` to initialize ``project_base``. Fix
also the distutils build command: don't use :data:`sys.executable` if it is
``None`` or an empty string.
Expand All @@ -350,7 +350,7 @@ also the distutils build command: don't use :data:`sys.executable` if it is
.. nonce: Fg4EXb
.. section: Library

:func:`shutil.which` and :func:`distutils.spawn.find_executable` now use
:func:`shutil.which` and ``distutils.spawn.find_executable`` now use
``os.confstr("CS_PATH")`` if available instead of :data:`os.defpath`, if the
``PATH`` environment variable is not set. Moreover, don't use
``os.confstr("CS_PATH")`` nor :data:`os.defpath` if the ``PATH`` environment
Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.9.0a5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -623,7 +623,7 @@ connections.
.. nonce: 5a822c
.. section: Library

Reimplement :func:`distutils.spawn.spawn` function with the
Reimplement ``distutils.spawn.spawn`` function with the
:mod:`subprocess` module.

..
Expand Down Expand Up @@ -1022,7 +1022,7 @@ lock-related objects from :mod:`threading`) around 49-day uptime.
.. nonce: MnHdYl
.. section: Windows

:mod:`distutils` will no longer statically link :file:`vcruntime140.dll`
``distutils`` will no longer statically link :file:`vcruntime140.dll`
when a redistributable version is unavailable. All future releases of
CPython will include a copy of this DLL to ensure distributed extensions can
continue to load.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
C extension modules are now built by ``configure`` and ``make``
instead of :mod:`distutils` and ``setup.py``.
instead of ``distutils`` and ``setup.py``.