summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorloic <loic@dachary.org>2017-01-07 14:39:44 +0100
committerloic <loic@dachary.org>2017-01-07 14:39:44 +0100
commitc80eedd40b8650066928a94c7ae3680b38a10e67 (patch)
tree8604448885a2ec9c06f53509e75224e4a157b41e /doc
parentf5587814d1aa983ad995b2c1acc391f6251ceda0 (diff)
downloadpython-coveragepy-c80eedd40b8650066928a94c7ae3680b38a10e67.tar.gz
* --source and --include are mutually exclusive (take 2) #265
close #265 close #101
Diffstat (limited to 'doc')
-rw-r--r--doc/config.rst6
-rw-r--r--doc/source.rst3
2 files changed, 7 insertions, 2 deletions
diff --git a/doc/config.rst b/doc/config.rst
index a8005a4..75803bd 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -136,7 +136,8 @@ warning. See :ref:`cmd_warnings` for specific warnings.
--debug option <cmd_run_debug>` for details.
``include`` (multi-string): a list of file name patterns, the files to include
-in measurement or reporting. See :ref:`source` for details.
+in measurement or reporting. Ignored if ``source`` is set. See :ref:`source`
+for details.
``note`` (string): an arbitrary string that will be written to the data file.
You can use the :meth:`CoverageData.run_infos` method to retrieve this string
@@ -153,7 +154,8 @@ many processes. See :ref:`cmd_combining` for more information.
for more information.
``source`` (multi-string): a list of packages or directories, the source to
-measure during execution. See :ref:`source` for details.
+measure during execution. If set, ``include`` is ignored. See :ref:`source`
+for details.
``timid`` (boolean, default False): use a simpler but slower trace method.
This uses PyTracer instead of CTracer, and is only needed in very unusual
diff --git a/doc/source.rst b/doc/source.rst
index 8d831c4..640fc43 100644
--- a/doc/source.rst
+++ b/doc/source.rst
@@ -66,6 +66,9 @@ are interpreted relative to the current directory::
The ``source``, ``include``, and ``omit`` values all work together to determine
the source that will be measured.
+If both ``source`` and ``include`` are set, the ``include`` value is ignored
+and a warning is printed on the standard output.
+
.. _source_reporting: