Mercurial > bitten > bitten-test
diff doc/commands.txt @ 662:b00da52e942f
0.6dev: Adding docs for `<python:figleaf>` command. Closes #438.
author | osimons |
---|---|
date | Wed, 02 Sep 2009 23:50:11 +0000 |
parents | 900b09af6b38 |
children | 9f5e9e0f6ac9 |
line wrap: on
line diff
--- a/doc/commands.txt +++ b/doc/commands.txt @@ -796,6 +796,43 @@ <python:trace summary="build/trace.out" coverdir="build/coverage" /> + +-------------------- +``<python:figleaf>`` +-------------------- + +Extracts coverage information recorded by Figleaf_. + +.. _figleaf: http://darcs.idyll.org/~t/projects/figleaf/doc/ + +Parameters +---------- + ++--------------+-------------------------------------------------------------+ +| Name | Description | ++==============+=============================================================+ +| ``summary`` | Path to the summary file written by ``figleaf``, | +| | 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 + + <step id="figleaf" description="Figleaf coverage"> + <sh:exec executable="figleaf" args="setup.py test"/> + <python:figleaf summary=".figleaf" exclude="build/* setup* */tests/*"/> + </step> + + ------------------- ``<python:pylint>`` -------------------