diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-11-23 14:01:46 +0000 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-11-23 14:01:46 +0000 |
| commit | 917b7613d5a1917035389c30516677bab2d81ba4 (patch) | |
| tree | 06de98f809c340821e113c4a01d86cc10eb2760e | |
| parent | a79f3473bb84ee1cc5af6996d1aee81c99d21175 (diff) | |
| parent | 0e24a27d322e52082167cc2ac01859b4d885a4e6 (diff) | |
| download | python-setuptools-git-917b7613d5a1917035389c30516677bab2d81ba4.tar.gz | |
Docs: Add note about global `distutils.cfg` (#3689)
| -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 ----------------- |