diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 9721b4ebd..e794efc5d 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -101,6 +101,7 @@ Pierre-Luc Tessier Gagné Prakhar Gurunani Ronald Evers Ronny Pfannschmidt +Ryuichi Ohori Selim Belhaouane Sorin Sbarnea Sridhar Ratnakumar diff --git a/docs/changelog.rst b/docs/changelog.rst index ff61b0189..3003080ad 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -12,6 +12,8 @@ with advance notice in the **Deprecations** section of releases. .. towncrier release notes start v3.23.1 (2021-05-05) +-------------------- + Bugfixes ^^^^^^^^ diff --git a/docs/changelog/2036.doc.rst b/docs/changelog/2036.doc.rst new file mode 100644 index 000000000..12bb5a5d2 --- /dev/null +++ b/docs/changelog/2036.doc.rst @@ -0,0 +1 @@ +Extended environment variables section - by :user:`majiang` diff --git a/docs/config.rst b/docs/config.rst index b1056516d..c0158c27b 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -1093,8 +1093,22 @@ user can bypass the system's interpreter parser by defining the When the workaround is enabled, all tox-invoked text file executables will have their interpreter directive parsed by and explicitly executed by ``tox``. +Environment variables +--------------------- +tox will treat the following environment variables: + +- ``TOX_DISCOVER`` for python discovery first try the python executables under these paths +- ``TOXENV`` see :conf:`envlist`. +- ``TOX_LIMITED_SHEBANG`` see :ref:`long interpreter directives`. +- ``TOX_PARALLEL_NO_SPINNER`` see :ref:`parallel_mode`. +- ``_TOX_PARALLEL_ENV`` lets tox know that it is invoked in the parallel mode. +- ``TOX_PROVISION`` is only intended to be used internally. +- ``TOX_REPORTER_TIMESTAMP`` enables showing for each output line its delta since the tox startup when set to ``1``. +- ``TOX_SKIP_ENV`` see :conf:`envlist`. +- ``TOX_TESTENV_PASSENV`` see :conf:`passenv`. + Injected environment variables ------------------------------- +++++++++++++++++++++++++++++++ tox will inject the following environment variables that you can use to test that your command is running within tox: .. versionadded:: 3.4