Document envvar COCOTB_LIBRARY_COVERAGE.
Closes
@@ -127,17 +127,6 @@ Cocotb
This needs the :mod:`cherrypy` and :mod:`dowser` Python modules installed.
-.. envvar:: COCOTB_PY_DIR
-
- Path to the directory containing the cocotb Python package in the :file:`cocotb` subdirectory;
- for cocotb-internal use.
-
-.. envvar:: COCOTB_SHARE_DIR
-
- Path to the directory containing the cocotb Makefiles and simulator libraries in the subdirectories
- :file:`lib`, :file:`include`, and :file:`makefiles`;
- for cocotb-internal use.
-
Regression Manager
~~~~~~~~~~~~~~~~~~
@@ -326,6 +315,27 @@ and
`CXXFLAGS`, `LDLIBS` are not supported by distutils/pip
+Internal Variables
+------------------
+
+The following variables are used for cocotb internals.
+They may change at any time, and users should not rely on them.
+
+.. envvar:: COCOTB_PY_DIR
+
+ Path to the directory containing the cocotb Python package in the :file:`cocotb` subdirectory.
+
+.. envvar:: COCOTB_SHARE_DIR
+
+ Path to the directory containing the cocotb Makefiles and simulator libraries in the subdirectories
+ :file:`lib`, :file:`include`, and :file:`makefiles`.
+
+.. envvar:: COCOTB_LIBRARY_COVERAGE
+
+ Enable code coverage collection for cocotb internals.
+ When set, a file :file:`.coverage.cocotb` will be written which contains statistics about the code coverage.
+ This is mainly useful for cocotb's own Continuous Integration setup.
+
..
TODO
