Commits

Anonymous committed c012957

Update doc with new section on coverage config file.

Comments (0)

Files changed (3)

+syntax: glob
+
+*~
+*.pyo
+*.pyc
+*egg-info
+build
+dist
+env*
 examine it.
 
 
+Coverage Config File
+--------------------
+
+This plugin provides a clean minimal set of command line options that are added to nosetests.  For
+further control of coverage use a coverage config file.
+
+For example if tests are contained within the directory tree being measured the tests may be
+excluded if desired by using a .coveragerc file with the omit option set::
+
+    nosetests --cov-config .coveragerc
+              --cov myproj
+              myproj/tests/
+
+Where the .coveragerc file contains file globs::
+
+    [run]
+    omit = tests/*
+
+For full details refer to the `coverage config file`_ documentation.
+
+.. _`coverage config file`: http://nedbatchelder.com/code/coverage/config.html
+
+Note that this plugin controls some options and setting the option in the config file will have no
+effect.  These include specifying source to be measured (source option) and all data file handling
+(data_file and parallel options).
+
+
 Limitations
 -----------
 
 
 log = logging.getLogger(__name__)
 
+
 class Cov(Plugin):
     """Activate cov plugin to generate coverage reports"""