Docs: Add note about global distutils.cfg (#3689)

pypa · Nov 23, 2022 · 917b761 · 917b761
2 parents a79f347 + 0e24a27
commit 917b761
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/changelog.d/3689.doc.rst 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
@@ -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
 -----------------