Skip to content

Commit

Permalink
Move timeout config options into correct section
Browse files Browse the repository at this point in the history
The interrupt_timeout and terminate_timeout options are set on the
environment, not globally.
  • Loading branch information
jhesketh committed May 21, 2020
1 parent dd0bb80 commit 58fec20
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,22 +160,6 @@ Global settings are defined under the ``tox`` section as:
Name of the virtual environment used to create a source distribution from the
source tree.

.. conf:: interrupt_timeout ^ float ^ 0.3

.. versionadded:: 3.15.0

When tox is interrupted, it propagates the signal to the child process,
waits :conf:``interrupt_timeout`` seconds, and sends it a SIGTERM if it hasn't
exited.

.. conf:: terminate_timeout ^ float ^ 0.2

.. versionadded:: 3.15.0

When tox is interrupted, it propagates the signal to the child process,
waits :conf:``interrupt_timeout`` seconds, sends it a SIGTERM, waits
:conf:``terminate_timeout`` seconds, and sends it a SIGKILL if it hasn't exited.

Jenkins override
++++++++++++++++

Expand Down Expand Up @@ -597,6 +581,22 @@ Complete list of settings that you can put into ``testenv*`` sections:
via the ``-e`` tox will only run those three (even if ``coverage`` may specify as ``depends`` other targets too -
such as ``py27, py35, py36, py37``).

.. conf:: interrupt_timeout ^ float ^ 0.3

.. versionadded:: 3.15.0

When tox is interrupted, it propagates the signal to the child process,
waits :conf:``interrupt_timeout`` seconds, and sends it a SIGTERM if it hasn't
exited.

.. conf:: terminate_timeout ^ float ^ 0.2

.. versionadded:: 3.15.0

When tox is interrupted, it propagates the signal to the child process,
waits :conf:``interrupt_timeout`` seconds, sends it a SIGTERM, waits
:conf:``terminate_timeout`` seconds, and sends it a SIGKILL if it hasn't exited.

Substitutions
-------------

Expand Down

0 comments on commit 58fec20

Please sign in to comment.