diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2012-11-03 22:17:35 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2012-11-03 22:17:35 -0400 |
| commit | 2ed120a530c3563056dba02562fbf9df642d13a6 (patch) | |
| tree | 46177baa64968af6a3ce10320e1054a1e5e1cbd0 /doc/cmd.rst | |
| parent | 82f9dd6e35c811eb53051f70ebf51bea2740f9dd (diff) | |
| download | python-coveragepy-2ed120a530c3563056dba02562fbf9df642d13a6.tar.gz | |
Issue #139: Now the report, html, and xml commands take a --fail-under=MIN switch, and exit with 2 if the coverage is less than MIN.
Diffstat (limited to 'doc/cmd.rst')
| -rw-r--r-- | doc/cmd.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index 4555208..c15857c 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -204,6 +204,11 @@ encountered trying to find source files to report on. This can be useful if some files are missing, or if your Python execution is tricky enough that file names are synthesized without real source files. +If you provide a ``--fail-under`` value, the total percentage covered will be +compared to that value. If it is less, the command will exit with a status +code of 2, indicating that the total coverage was less than your target. This +can be used as part of a pass/fail condition, for example in a continuous +integration server. This option isn't available for **annotate**. .. _cmd_summary: |