diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2010-07-25 19:28:51 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2010-07-25 19:28:51 -0400 |
commit | 169656a3b2b8f4b74c5f45a02c487922c6f321be (patch) | |
tree | a982b4c06f90cba644a1c1a32733bf01bbce7d25 /doc/config.rst | |
parent | 5612dabf04499110288df3f589b7b5d6449f489a (diff) | |
download | python-coveragepy-169656a3b2b8f4b74c5f45a02c487922c6f321be.tar.gz |
Lots of doc updates, more to come.
Diffstat (limited to 'doc/config.rst')
-rw-r--r-- | doc/config.rst | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/config.rst b/doc/config.rst index ada6d08..d3c3876 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -29,8 +29,8 @@ multiple lines. Boolean values can be specified as ``on``, ``off``, ``true``, ``false``, ``1``, or ``0`` and are case-insensitive. -Many sections and values correspond roughly to commands and options in the -command-line interface. +Many sections and values correspond roughly to commands and options in +the :ref:`command-line interface <cmd>`. Here's a sample configuration file:: @@ -84,6 +84,7 @@ many processes. ``timid`` (boolean, default False): use a simpler but slower trace method. Try this if you get seemingly impossible results. +.. TODO missing: source, include, omit. [report] -------- @@ -102,11 +103,14 @@ found. ``omit`` (multi-string): a list of file prefixes. If a source file begins with one of these prefixes, it will be omitted from the report. +.. TODO: omit is file patterns now +.. TODO missing: include [html] ------ -Values particular to HTML reporting. +Values particular to HTML reporting. The values in the ``[report]`` section +also apply to HTML output. ``directory`` (string, default "htmlcov"): where to write the HTML report files. @@ -114,6 +118,7 @@ Values particular to HTML reporting. [xml] ----- -Values particular to XML reporting. +Values particular to XML reporting. The values in the ``[report]`` section +also apply to XML output. ``output`` (string, default "coverage.xml"): where to write the XML report. |