diff options
| -rw-r--r-- | changelog.d/3689.doc.rst | 2 | ||||
| -rw-r--r-- | docs/deprecated/distutils-legacy.rst | 9 |
2 files changed, 11 insertions, 0 deletions
diff --git a/changelog.d/3689.doc.rst b/changelog.d/3689.doc.rst new file mode 100644 index 00000000..eb0fa05e --- /dev/null +++ b/changelog.d/3689.doc.rst @@ -0,0 +1,2 @@ +Document that ``distutils.cfg`` might be ignored unless +``SETUPTOOLS_USE_DISTUTILS=stdlib``. diff --git a/docs/deprecated/distutils-legacy.rst b/docs/deprecated/distutils-legacy.rst index e106ce97..63c8ff07 100644 --- a/docs/deprecated/distutils-legacy.rst +++ b/docs/deprecated/distutils-legacy.rst @@ -7,6 +7,15 @@ Since the 60.0.0 release, Setuptools includes a local, vendored copy of distutil SETUPTOOLS_USE_DISTUTILS=stdlib +.. warning:: + Please note that this also affects how ``distutils.cfg`` files inside stdlib's ``distutils`` + package directory are processed. + Unless ``SETUPTOOLS_USE_DISTUTILS=stdlib``, they will have no effect on the build process. + + You can still use a global user config file, ``~/.pydistutils.cfg`` (POSIX) or ``%USERPROFILE%/pydistutils.cfg`` (Windows), + or use the environment variable :doc:`DIST_EXTRA_CONFIG <deprecated/distutils/configfile>` to point to another + supplementary configuration file. + Prefer Setuptools ----------------- |