Skip to content

Commit

Permalink
Table with list of default env vars per OS (#3291)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>
  • Loading branch information
3 people authored Jul 14, 2024
1 parent 33f6c23 commit e6b9803
Show file tree
Hide file tree
Showing 2 changed files with 150 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/changelog/2753.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add table with default environment variables per OS
149 changes: 149 additions & 0 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down

0 comments on commit e6b9803

Please sign in to comment.