From e6b9803d77c352aaf38e9d69c6d99d5d773b0617 Mon Sep 17 00:00:00 2001 From: seyidaniels Date: Sun, 14 Jul 2024 08:16:54 +0100 Subject: [PATCH] Table with list of default env vars per OS (#3291) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Table with list of default env vars per OS * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update env variables list * ADD windir env variable --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Bernát Gábor --- docs/changelog/2753.bugfix.rst | 1 + docs/config.rst | 149 +++++++++++++++++++++++++++++++++ 2 files changed, 150 insertions(+) create mode 100644 docs/changelog/2753.bugfix.rst diff --git a/docs/changelog/2753.bugfix.rst b/docs/changelog/2753.bugfix.rst new file mode 100644 index 000000000..0372ba42d --- /dev/null +++ b/docs/changelog/2753.bugfix.rst @@ -0,0 +1 @@ +Add table with default environment variables per OS diff --git a/docs/config.rst b/docs/config.rst index 9d8f8acbb..49d7b9b09 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -289,6 +289,155 @@ Base options tox invocation environment it is ignored. The list of environment variable names is not case sensitive, for example: passing ``A`` or ``a`` will pass through both ``A`` and ``a``. + Some variables are always passed through to ensure the basic functionality of standard library functions or tooling like + pip. This is also not case sensitive on all platforms except Windows. + + .. list-table:: Environment Variables per Operating System + :widths: 25 25 25 25 + :header-rows: 1 + + * - Environment Variable + - Linux + - MacOS + - Windows + * - https_proxy + - ✅ + - ✅ + - ✅ + * - http_proxy + - ✅ + - ✅ + - ✅ + * - no_proxy + - ✅ + - ✅ + - ✅ + * - LANG + - ✅ + - ✅ + - ✅ + * - LANGUAGE + - ✅ + - ✅ + - ✅ + * - CURL_CA_BUNDLE + - ✅ + - ✅ + - ✅ + * - SSL_CERT_FILE + - ✅ + - ✅ + - ✅ + * - CC + - ✅ + - ✅ + - ✅ + * - CFLAGS + - ✅ + - ✅ + - ✅ + * - CCSHARED + - ✅ + - ✅ + - ✅ + * - CXX + - ✅ + - ✅ + - ✅ + * - CPPFLAGS + - ✅ + - ✅ + - ✅ + * - LD_LIBRARY_PATH + - ✅ + - ✅ + - ✅ + * - LDFLAGS + - ✅ + - ✅ + - ✅ + * - HOME + - ✅ + - ✅ + - ✅ + * - FORCE_COLOR + - ✅ + - ✅ + - ✅ + * - NO_COLOR + - ✅ + - ✅ + - ✅ + * - TMPDIR + - ✅ + - ✅ + - ❌ + * - TEMP + - ❌ + - ❌ + - ✅ + * - TMP + - ❌ + - ❌ + - ✅ + * - USERPROFILE + - ❌ + - ❌ + - ✅ + * - PATHEXT + - ❌ + - ❌ + - ✅ + * - MSYSTEM + - ❌ + - ❌ + - ✅ + * - WINDIR + - ❌ + - ❌ + - ✅ + * - APPDATA + - ❌ + - ❌ + - ✅ + * - PROGRAMDATA + - ❌ + - ❌ + - ✅ + * - PROGRAMFILES(x86) + - ❌ + - ❌ + - ✅ + * - SYSTEMDRIVE + - ❌ + - ❌ + - ✅ + * - SYSTEMROOT + - ❌ + - ❌ + - ✅ + * - COMSPEC + - ❌ + - ❌ + - ✅ + * - PROCESSOR_ARCHITECTURE + - ❌ + - ❌ + - ✅ + * - NUMBER_OF_PROCESSORS + - ❌ + - ❌ + - ✅ + * - PIP_* + - ✅ + - ✅ + - ✅ + * - VIRTUALENV_* + - ✅ + - ✅ + - ✅ + + More environment variable-related information can be found in :ref:`environment variable substitutions`.