# HG changeset patch
# User osimons
# Date 1266066608 0
# Node ID 1f03b23e38ffbaf63731f66d2568e75cacd7343b
# Parent 440b48bba3e9b53f2ccda4af72ed3c9b851e3b90
Merged [811] from trunk.
diff --git a/doc/commands.txt b/doc/commands.txt
--- a/doc/commands.txt
+++ b/doc/commands.txt
@@ -707,12 +707,15 @@
+ --coverage-dir build/coverage
+ --coverage-method trace"/>
Instructs `distutils` to run the ``unittest`` command (which is provided by
Bitten), and passes the options needed to determine the output paths for test
results and code coverage reports.
+Option ``--coverage-method`` is one of ``trace``, ``coverage`` or ``figleaf``.
+
Configuration
-------------
@@ -768,7 +771,7 @@
| Name | Description |
+==============+=============================================================+
| ``summary`` | Path to the summary file written by ``trace.py``, |
-| | relative to the project source directory. |
+| | relative to the project source directory. |
+--------------+-------------------------------------------------------------+
| ``coverdir`` | Path to the directory containing the coverage files written |
| | by ``trace.py``, relative to the project source directory. |
@@ -789,6 +792,52 @@
+---------------------
+````
+---------------------
+
+Extract data from a coverage.py_ run.
+
+.. _coverage.py: http://nedbatchelder.com/code/coverage/
+
+Parameters
+----------
+
++--------------+-------------------------------------------------------------+
+| Name | Description |
++==============+=============================================================+
+| ``summary`` | Path to the summary file with ``coverage.py`` information, |
+| | relative to the project source directory. |
++--------------+-------------------------------------------------------------+
+| ``coverdir`` | Path to the directory containing per-module coverage |
+| | details, relative to the project source directory. |
++--------------+-------------------------------------------------------------+
+| ``include`` | List of glob patterns (separated by space) that specify |
+| | which Python file should be included in the coverage report |
++--------------+-------------------------------------------------------------+
+| ``exclude`` | List of glob patterns (separated by space) that specify |
+| | which Python file should be excluded from the coverage |
+| | report |
++--------------+-------------------------------------------------------------+
+
+Examples
+--------
+
+.. code-block:: xml
+
+
+
+
+
+
+
+
--------------------
````
--------------------
@@ -804,7 +853,7 @@
| Name | Description |
+==============+=============================================================+
| ``summary`` | Path to the summary file written by ``figleaf``, |
-| | relative to the project source directory. |
+| | relative to the project source directory. |
+--------------+-------------------------------------------------------------+
| ``include`` | List of glob patterns (separated by space) that specify |
| | which Python file should be included in the coverage report |