summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChris Jerdonek <chris.jerdonek@gmail.com>2013-11-14 01:51:26 -0800
committerChris Jerdonek <chris.jerdonek@gmail.com>2013-11-14 01:51:26 -0800
commit85c7a80c4024780f9d091b98d0a65ac08936ac04 (patch)
tree7926d0e2bd700598fc80dace4896acaa2a05a7bc /doc
parent12c229a216b3fb51e990613d88104b607b39f0cb (diff)
downloadtox-85c7a80c4024780f9d091b98d0a65ac08936ac04.tar.gz
Address issue #125 by adding a --hashseed command-line option.
This commit also causes Tox to set PYTHONHASHSEED for test commands to a random integer generated when tox is invoked. See the issue here: https://bitbucket.org/hpk42/tox/issue/125
Diffstat (limited to 'doc')
-rw-r--r--doc/example/basic.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/example/basic.txt b/doc/example/basic.txt
index 55b0848..19a15d4 100644
--- a/doc/example/basic.txt
+++ b/doc/example/basic.txt
@@ -175,6 +175,27 @@ a PYTHONPATH setting that will lead Python to also import
from the ``subdir`` below the directory where your ``tox.ini``
file resides.
+special handling of PYTHONHASHSEED
+-------------------------------------------
+
+.. versionadded:: 1.6.2
+
+By default, Tox sets PYTHONHASHSEED_ for test commands to a random integer
+generated when ``tox`` is invoked. This mimics Python's hash randomization
+enabled by default starting `in Python 3.3`_. To aid in reproducing test
+failures, Tox displays the value of ``PYTHONHASHSEED`` in the test output.
+
+You can tell Tox to use an explicit hash seed value via the ``--hashseed``
+command-line option to ``tox``. You can also override the hash seed value
+per test environment in ``tox.ini`` as follows::
+
+ [testenv:hash]
+ setenv =
+ PYTHONHASHSEED = 100
+
+.. _`in Python 3.3`: http://docs.python.org/3/whatsnew/3.3.html#builtin-functions-and-types
+.. _PYTHONHASHSEED: http://docs.python.org/using/cmdline.html#envvar-PYTHONHASHSEED
+
Integration with setuptools/distribute test commands
----------------------------------------------------