Mercurial > bitten > bitten-test
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 661:8931a5ebdc7a | 662:b00da52e942f |
|---|---|
| 793 -------- | 793 -------- |
| 794 | 794 |
| 795 .. code-block:: xml | 795 .. code-block:: xml |
| 796 | 796 |
| 797 <python:trace summary="build/trace.out" coverdir="build/coverage" /> | 797 <python:trace summary="build/trace.out" coverdir="build/coverage" /> |
| 798 | |
| 799 | |
| 800 -------------------- | |
| 801 ``<python:figleaf>`` | |
| 802 -------------------- | |
| 803 | |
| 804 Extracts coverage information recorded by Figleaf_. | |
| 805 | |
| 806 .. _figleaf: http://darcs.idyll.org/~t/projects/figleaf/doc/ | |
| 807 | |
| 808 Parameters | |
| 809 ---------- | |
| 810 | |
| 811 +--------------+-------------------------------------------------------------+ | |
| 812 | Name | Description | | |
| 813 +==============+=============================================================+ | |
| 814 | ``summary`` | Path to the summary file written by ``figleaf``, | | |
| 815 | | relative to the project source directory. | | |
| 816 +--------------+-------------------------------------------------------------+ | |
| 817 | ``include`` | List of glob patterns (separated by space) that specify | | |
| 818 | | which Python file should be included in the coverage report | | |
| 819 +--------------+-------------------------------------------------------------+ | |
| 820 | ``exclude`` | List of glob patterns (separated by space) that specify | | |
| 821 | | which Python file should be excluded from the coverage | | |
| 822 | | report | | |
| 823 +--------------+-------------------------------------------------------------+ | |
| 824 | |
| 825 Examples | |
| 826 -------- | |
| 827 | |
| 828 .. code-block:: xml | |
| 829 | |
| 830 <step id="figleaf" description="Figleaf coverage"> | |
| 831 <sh:exec executable="figleaf" args="setup.py test"/> | |
| 832 <python:figleaf summary=".figleaf" exclude="build/* setup* */tests/*"/> | |
| 833 </step> | |
| 834 | |
| 798 | 835 |
| 799 ------------------- | 836 ------------------- |
| 800 ``<python:pylint>`` | 837 ``<python:pylint>`` |
| 801 ------------------- | 838 ------------------- |
| 802 | 839 |