diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2014-09-25 07:18:40 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2014-09-25 07:18:40 -0400 |
| commit | db32bc9ab87fccf85515f87d3714de12ccabc585 (patch) | |
| tree | 5451cfbf0af0e28826473df426d6525710d2545e /doc/config.rst | |
| parent | fe9ea16b667d2a89d94f09b52c58b54e209874c2 (diff) | |
| download | python-coveragepy-db32bc9ab87fccf85515f87d3714de12ccabc585.tar.gz | |
Add docs for --concurrency
Diffstat (limited to 'doc/config.rst')
| -rw-r--r-- | doc/config.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst index 882fc77..792ed45 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -10,6 +10,7 @@ Configuration files :history: 20110604T184400, updated for 3.5. :history: 20110827T212700, updated for 3.5.1 :history: 20130926T222300, updated for 3.6.1 +:history: 20140925T064700, updated for 4.0a1 Coverage.py options can be specified in a configuration file. This makes it @@ -90,6 +91,15 @@ to more than one command. ``cover_pylib`` (boolean, default False): whether to measure the Python standard library. +``concurrency`` (string, default "thread"): the name of the concurrency +library in use by the product code. If your program uses `gevent`_, +`greenlet`_, or `eventlet`_, you must name that library in this option, or +coverage will produce very wrong results. + +.. _greenlet: http://greenlet.readthedocs.org/en/latest/ +.. _gevent: http://www.gevent.org/ +.. _eventlet: http://eventlet.net/ + ``data_file`` (string, default ".coverage"): the name of the data file to use for storing or reporting coverage. |