summaryrefslogtreecommitdiff
path: root/doc/config.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2010-02-24 00:02:56 -0500
committerNed Batchelder <ned@nedbatchelder.com>2010-02-24 00:02:56 -0500
commit06d52b0f165650b4530ef85d4179e6ae3b35d407 (patch)
treedec25129aed8b35aafc542af665263848b11bf8b /doc/config.rst
parentb007d17e5e2da220c57920b84c7f337bc8b378d0 (diff)
downloadpython-coveragepy-06d52b0f165650b4530ef85d4179e6ae3b35d407.tar.gz
Updating docs
Diffstat (limited to 'doc/config.rst')
-rw-r--r--doc/config.rst79
1 files changed, 79 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst
new file mode 100644
index 0000000..355cf44
--- /dev/null
+++ b/doc/config.rst
@@ -0,0 +1,79 @@
+.. _config:
+
+===================
+Configuration files
+===================
+
+:history: 20100223T201600, new for 3.3
+
+Coverage.py options can be specified in a configuration file. This makes it
+easier to re-run coverage with consistent settings, and also allows for
+specification of options that are otherwise only available in the
+:ref:`API <api>`.
+
+Configuration files also make it easier to get coverage testing of spawned
+sub-processes. See :ref:`Subprocess measurement <subprocess>` for more details.
+
+
+
+Syntax
+------
+
+A coverage.py configuration file is in classic .ini file format: sections are
+introduced by a ``[section]`` header, and contain ``name = value`` entries.
+Lines beginning with ``#`` or ``;`` are ignored as comments.
+
+Multi-line entries can be created by indenting values on multiple lines.
+
+Boolean values can be specified as ``on``, ``off``, ``true``, ``false``, ``1``,
+or ``0``.
+
+Many sections and values correspond roughly to commands and options in the
+command-line interface.
+
+
+[run]
+-----
+
+These values are generally used when running product code, though some apply
+to more than one command.
+
+``branch`` (boolean): whether to measure :ref:`branch coverage <branch>`.
+
+``cover_pylib`` (boolean): whether to measure the Python standard library.
+
+``data_file`` (string): the name of the data file to use for storing or
+reporting coverage.
+
+``parallel`` (boolean):
+
+``timid`` (boolean):
+
+
+[report]
+--------
+
+Values common to many kinds of reporting.
+
+``exclude_lines`` (multi-string):
+
+``ignore_errors`` (boolean):
+
+``omit`` (multi-string):
+
+
+[html]
+------
+
+Values particular to HTML reporting.
+
+``directory`` (string):
+
+
+[xml]
+-----
+
+Values particular to XML reporting.
+
+``output`` (string):
+