summaryrefslogtreecommitdiff
path: root/doc/cmd.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2014-09-25 07:39:28 -0400
committerNed Batchelder <ned@nedbatchelder.com>2014-09-25 07:39:28 -0400
commit3a205cb7ad3d177369316818b2b2d77569ba1f18 (patch)
tree27cc558931ac2c6504fda26a85d8ecaa2a434e2e /doc/cmd.rst
parentb8f43e662ccdc11d5314d34a87c0dbdc0fba2403 (diff)
downloadpython-coveragepy-git-3a205cb7ad3d177369316818b2b2d77569ba1f18.tar.gz
Document stuff for 4.0a1
Diffstat (limited to 'doc/cmd.rst')
-rw-r--r--doc/cmd.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index cb401597..96c27634 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -277,6 +277,19 @@ The ``-m`` flag also shows the line numbers of missing statements::
-------------------------------------------------------
TOTAL 91 12 87%
+If you are using branch coverage, then branch statistics will be reported in
+the Branch and BrMiss columns, the Missing column will detail the missed
+branches::
+
+ $ coverage report -m
+ Name Stmts Miss Branch BrMiss Cover Missing
+ ---------------------------------------------------------------------
+ my_program 20 4 10 2 80% 33-35, 36->38, 39
+ my_module 15 2 3 0 86% 8, 12
+ my_other_module 56 6 5 1 89% 17-23, 40->45
+ ---------------------------------------------------------------------
+ TOTAL 91 12 18 3 87%
+
You can restrict the report to only certain files by naming them on the
command line::