test_ok1/doc/test/plugin/figleaf.txt


report test coverage using the 'figleaf' package.
=================================================


.. contents::
  :local:

Usage
---------------

after pip or easy_install mediated installation of ``pytest-figleaf`` you can type::

    py.test --figleaf [...]

to enable figleaf coverage in your test run.  A default ".figleaf" data file
and "html" directory will be created.  You can use ``--fig-data`` 
and ``fig-html`` to modify the paths.

command line options
--------------------


``--figleaf``
    trace python coverage with figleaf and write HTML for files below the current working dir
``--fig-data=dir``
    set tracing file, default: ".figleaf".
``--fig-html=dir``
    set html reporting dir, default "html".

.. include:: links.txt
new cleaner layout, many improvements to docs --HG-- branch : 1.0.x 2009-07-21 00:54:08 +08:00
remove dist-testing and looponfail code from core. there remain some (pytest_runner particularly) tests that test both plain and dist modes which cannot be easily dis-entangled. food for thought. --HG-- branch : trunk 2010-01-13 23:00:33 +08:00			`report test coverage using the 'figleaf' package.`
			`=================================================`
new cleaner layout, many improvements to docs --HG-- branch : 1.0.x 2009-07-21 00:54:08 +08:00

remove dist-testing and looponfail code from core. there remain some (pytest_runner particularly) tests that test both plain and dist modes which cannot be easily dis-entangled. food for thought. --HG-- branch : trunk 2010-01-13 23:00:33 +08:00			`.. contents::`
			`:local:`
new cleaner layout, many improvements to docs --HG-- branch : 1.0.x 2009-07-21 00:54:08 +08:00
remove dist-testing and looponfail code from core. there remain some (pytest_runner particularly) tests that test both plain and dist modes which cannot be easily dis-entangled. food for thought. --HG-- branch : trunk 2010-01-13 23:00:33 +08:00			`Usage`
			`---------------`
new cleaner layout, many improvements to docs --HG-- branch : 1.0.x 2009-07-21 00:54:08 +08:00
progressing towards 1.3.2, adding announcement, regen docs --HG-- branch : trunk 2010-07-07 21:41:28 +08:00			after pip or easy_install mediated installation of ``pytest-figleaf`` you can type::
new cleaner layout, many improvements to docs --HG-- branch : 1.0.x 2009-07-21 00:54:08 +08:00
remove dist-testing and looponfail code from core. there remain some (pytest_runner particularly) tests that test both plain and dist modes which cannot be easily dis-entangled. food for thought. --HG-- branch : trunk 2010-01-13 23:00:33 +08:00			`py.test --figleaf [...]`
new cleaner layout, many improvements to docs --HG-- branch : 1.0.x 2009-07-21 00:54:08 +08:00
remove dist-testing and looponfail code from core. there remain some (pytest_runner particularly) tests that test both plain and dist modes which cannot be easily dis-entangled. food for thought. --HG-- branch : trunk 2010-01-13 23:00:33 +08:00			`to enable figleaf coverage in your test run. A default ".figleaf" data file`
progressing towards 1.3.2, adding announcement, regen docs --HG-- branch : trunk 2010-07-07 21:41:28 +08:00			and "html" directory will be created. You can use ``--fig-data``
			and ``fig-html`` to modify the paths.
remove dist-testing and looponfail code from core. there remain some (pytest_runner particularly) tests that test both plain and dist modes which cannot be easily dis-entangled. food for thought. --HG-- branch : trunk 2010-01-13 23:00:33 +08:00
			`command line options`
			`--------------------`


			``--figleaf``
			`trace python coverage with figleaf and write HTML for files below the current working dir`
			``--fig-data=dir``
			`set tracing file, default: ".figleaf".`
			``--fig-html=dir``
			`set html reporting dir, default "html".`

			`.. include:: links.txt`