summaryrefslogtreecommitdiff
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
commitfd1ae23848b18ea9f991fc1b669a5a82aed637aa (patch)
tree0b97b0265f06b4936203e613bb5d5e35c89a48bb
parentdb32bc9ab87fccf85515f87d3714de12ccabc585 (diff)
downloadpython-coveragepy-fd1ae23848b18ea9f991fc1b669a5a82aed637aa.tar.gz
Document stuff for 4.0a1
-rw-r--r--CHANGES.txt2
-rw-r--r--doc/changes.rst24
-rw-r--r--doc/cmd.rst13
-rw-r--r--doc/conf.py4
-rw-r--r--doc/config.rst8
5 files changed, 48 insertions, 3 deletions
diff --git a/CHANGES.txt b/CHANGES.txt
index b034744..1c7881e 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -17,7 +17,7 @@ Change history for Coverage.py
``[coverage:run]`` section of setup.cfg. Finishes `issue 304`_.
- The ``report`` command can now show missing branches when reporting on branch
- coverage. Thanks, Steve Leonard. Closes `issue 230`.
+ coverage. Thanks, Steve Leonard. Closes `issue 230`_.
- The XML report now contains a <source> element, fixing `issue 94`_. Thanks
Stan Hu.
diff --git a/doc/changes.rst b/doc/changes.rst
index 3ddf889..cc95837 100644
--- a/doc/changes.rst
+++ b/doc/changes.rst
@@ -35,6 +35,30 @@ history, see the `CHANGES.txt`_ file in the source tree.
.. _CHANGES.txt: http://bitbucket.org/ned/coveragepy/src/tip/CHANGES.txt
+.. _changes_40:
+
+Version 4.0 --- pre-release
+---------------------------
+
+- Python versions supported are now CPython 2.6, 2.7, 3.2, 3.3, and 3.4, and
+ PyPy 2.2.
+
+- Gevent, eventlet, and greenlet are now supported, closing `issue 149`_. Huge
+ thanks to Peter Portante for initial implementation, and to Joe Jevnik for
+ the final insight that completed the work.
+
+- Options are now also read from a setup.cfg file, if any. Sections are
+ prefixed with "coverage:", so the ``[run]`` options will be read from the
+ ``[coverage:run]`` section of setup.cfg. Finishes `issue 304`_.
+
+- The ``report`` command can now show missing branches when reporting on branch
+ coverage. Thanks, Steve Leonard. Closes `issue 230`_.
+
+.. _issue 149: https://bitbucket.org/ned/coveragepy/issue/149/coverage-gevent-looks-broken
+.. _issue 230: https://bitbucket.org/ned/coveragepy/issue/230/show-line-no-for-missing-branches-in
+.. _issue 304: https://bitbucket.org/ned/coveragepy/issue/304/attempt-to-get-configuration-from-setupcfg
+
+
.. _changes_371:
Version 3.7.1 --- 13 December 2013
diff --git a/doc/cmd.rst b/doc/cmd.rst
index cb40159..96c2763 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::
diff --git a/doc/conf.py b/doc/conf.py
index 41a00e3..0091cb3 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -47,9 +47,9 @@ copyright = u'2009\N{EN DASH}2013, Ned Batchelder'
# built documents.
#
# The short X.Y version.
-version = '3.7.1'
+version = '4.0'
# The full version, including alpha/beta/rc tags.
-release = '3.7.1'
+release = '4.0a1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/doc/config.rst b/doc/config.rst
index 792ed45..cec14e0 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -27,6 +27,14 @@ configuration file are tied to your source code and how it should be measured,
so it should be stored with your source, and checked into source control,
rather than put in your home directory.
+A different name for the configuration file can be specified with the
+``--rcfile=FILE`` command line option.
+
+Coverage.py will read settings from a ``setup.cfg`` file if no other
+configuration file is used. In this case, the section names have "coverage:"
+prefixed, so the ``[run]`` options described below will be found in the
+``[coverage:run]`` section of ``setup.cfg``.
+
Syntax
------