Skip to content

Commit e5babcf

Browse files
committed
docs: explain the COVERAGE_*_CORE testing variables
1 parent ebdc277 commit e5babcf

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

doc/contributing.rst

+10-8
Original file line numberDiff line numberDiff line change
@@ -175,17 +175,19 @@ can combine tox and pytest options::
175175

176176
TODO: Update this for CORE instead of TRACER
177177

178-
You can also affect the test runs with environment variables. Define any of
179-
these as 1 to use them:
178+
You can also affect the test runs with environment variables:
180179

181-
- ``COVERAGE_NO_PYTRACER=1`` disables the Python tracer if you only want to
182-
run the CTracer tests.
180+
- ``COVERAGE_ONE_CORE=1`` will use only one tracing core for each Python
181+
version. This isn't about CPU cores, it's about the central code that tracks
182+
execution. This will use the preferred core for the Python version and
183+
implementation being tested.
183184

184-
- ``COVERAGE_NO_CTRACER=1`` disables the C tracer if you only want to run the
185-
PyTracer tests.
185+
- ``COVERAGE_TEST_CORES=...`` defines the cores to run tests on. Three cores
186+
are available, specify them as a comma-separated string:
186187

187-
- ``COVERAGE_ONE_TRACER=1`` will use only one tracer for each Python version.
188-
This will use the C tracer if it is available, or the Python tracer if not.
188+
- ``ctrace`` is a sys.settrace function implemented in C.
189+
- ``pytrace`` is a sys.settrace function implemented in Python.
190+
- ``sysmon`` is a sys.monitoring implementation.
189191

190192
- ``COVERAGE_AST_DUMP=1`` will dump the AST tree as it is being used during
191193
code parsing.

0 commit comments

Comments
 (0)