diff options
Diffstat (limited to 'doc/config.rst')
| -rw-r--r-- | doc/config.rst | 56 |
1 files changed, 52 insertions, 4 deletions
diff --git a/doc/config.rst b/doc/config.rst index 1f4a82e3..159a42f5 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -7,6 +7,8 @@ Configuration files :history: 20100223T201600, new for 3.3 :history: 20100725T211700, updated for 3.4. :history: 20100824T092900, added ``precision``. +:history: 20110604T184400, updated for 3.5. +:history: 20110827T212700, updated for 3.5.1 Coverage.py options can be specified in a configuration file. This makes it @@ -31,8 +33,8 @@ 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. -Strings don't need quotes. Multi-strings can be created by indenting values on -multiple lines. +Strings don't need quotes. Multi-valued strings can be created by indenting +values on multiple lines. Boolean values can be specified as ``on``, ``off``, ``true``, ``false``, ``1``, or ``0`` and are case-insensitive. @@ -102,6 +104,33 @@ measure during execution. See :ref:`source` for details. Try this if you get seemingly impossible results. +.. _config_paths: + +[paths] +------- + +The entries in this section are lists of file paths that should be +considered equivalent when combining data from different machines:: + + [paths] + source = + src/ + /jenkins/build/*/src + c:\myproj\src + +The names of the entries are ignored, you may choose any name that +you like. The value is a lists of strings. When combining data +with the ``combine`` command, two file paths will be combined +if they start with paths from the same list. + +The first value must be an actual file path on the machine where +the reporting will happen, so that source code can be found. +The other values can be file patterns to match against the paths +of collected data. + +See :ref:`cmd_combining` for more information. + + [report] -------- @@ -122,24 +151,43 @@ in reporting. See :ref:`source` for details. ``omit`` (multi-string): a list of filename patterns, the files to leave out of reporting. See :ref:`source` for details. +``partial_branches`` (multi-string): a list of regular expressions. Any line +of code that matches one of these regexes is excused from being reported as +a partial branch. More details are in :ref:`branch`. If you use this option, +you are replacing all the partial branch regexes so you'll need to also +supply the "pragma: no branch" regex if you still want to use it. + ``precision`` (integer): the number of digits after the decimal point to display for reported coverage percentages. The default is 0, displaying for example "87%". A value of 2 will display percentages like "87.32%". +``show_missing`` (boolean, default False): when running a summary report, +show missing lines. See :ref:`cmd_summary` for more information. + + +.. _config_html: [html] ------ Values particular to HTML reporting. The values in the ``[report]`` section -also apply to HTML output. +also apply to HTML output, where appropriate. ``directory`` (string, default "htmlcov"): where to write the HTML report files. +``extra_css`` (string): the path to a file of CSS to apply to the HTML report. +The file will be copied into the HTML output directory. Don't name it +"style.css". This CSS is in addition to the CSS normally used, though you can +overwrite as many of the rules as you like. + +``title`` (string, default "Coverage report"): the title to use for the report. +Note this is text, not HTML. + [xml] ----- Values particular to XML reporting. The values in the ``[report]`` section -also apply to XML output. +also apply to XML output, where appropriate. ``output`` (string, default "coverage.xml"): where to write the XML report. |