summaryrefslogtreecommitdiff
path: root/doc/config.rst
diff options
context:
space:
mode:
authorloic@dachary.org <loic@dachary.org>2017-01-07 14:39:44 +0100
committerloic@dachary.org <loic@dachary.org>2017-01-07 14:39:44 +0100
commit6cee6103a399dfb00f95962033624855642fd722 (patch)
tree517218fb7deb814b75b8c91b9936f664df4b3744 /doc/config.rst
parent9242d96f2be40ecc556f8cf3cb9fb6fea7d4ea02 (diff)
downloadpython-coveragepy-git-6cee6103a399dfb00f95962033624855642fd722.tar.gz
* --source and --include are mutually exclusive (take 2) #265
close #265 close #101
Diffstat (limited to 'doc/config.rst')
-rw-r--r--doc/config.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/config.rst b/doc/config.rst
index a8005a4f..75803bd5 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