diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cmd.rst | 7 | ||||
| -rw-r--r-- | doc/conf.py | 4 | ||||
| -rw-r--r-- | doc/config.rst | 5 | ||||
| -rw-r--r-- | doc/contributing.rst | 2 | ||||
| -rw-r--r-- | doc/faq.rst | 6 | ||||
| -rw-r--r-- | doc/index.rst | 12 | ||||
| -rw-r--r-- | doc/install.rst | 4 | ||||
| -rw-r--r-- | doc/plugins.rst | 2 | ||||
| -rw-r--r-- | doc/python-coverage.1.txt | 6 | ||||
| -rw-r--r-- | doc/requirements.pip | 6 | ||||
| -rw-r--r-- | doc/trouble.rst | 2 |
11 files changed, 34 insertions, 22 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index ef4c1135..baf1ca08 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -171,6 +171,13 @@ could affect the measurement process. The possible warnings include: when coverage started. This meant coverage.py couldn't monitor its execution. +* "Already imported a file that will be measured: XXX (already-imported)" + + File XXX had already been imported when coverage.py started measurement. Your + setting for ``--source`` or ``--include`` indicates that you wanted to + measure that file. Lines will be missing from the coverage report since the + execution during import hadn't been measured. + * "--include is ignored because --source is set (include-ignored)" Both ``--include`` and ``--source`` were specified while running code. Both diff --git a/doc/conf.py b/doc/conf.py index 08c88537..503387b5 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -56,9 +56,9 @@ copyright = u'2009\N{EN DASH}2018, Ned Batchelder' # CHANGEME # built documents. # # The short X.Y version. -version = '4.5' # CHANGEME +version = '5.0' # CHANGEME # The full version, including alpha/beta/rc tags. -release = '4.5.1' # CHANGEME +release = '5.0a1' # CHANGEME # 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 c1fb4b1b..062aa740 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -33,8 +33,9 @@ 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. +A different location for the configuration file can be specified with the +``--rcfile=FILE`` command line option or with the ``COVERAGE_RCFILE`` +environment variable. Coverage.py will read settings from other usual configuration files if no other configuration file is used. It will automatically read from "setup.cfg" or diff --git a/doc/contributing.rst b/doc/contributing.rst index 3f628109..1b06bed7 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -117,7 +117,7 @@ the second uses the C implementation. To limit tox to just a few versions of Python, use the ``-e`` switch:: - $ tox -e py27,py33 + $ tox -e py27,py37 To run just a few tests, you can use `pytest test selectors`_:: diff --git a/doc/faq.rst b/doc/faq.rst index a0145362..fb9dbeb2 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -109,15 +109,15 @@ __ https://nedbatchelder.com/blog/200710/flaws_in_coverage_measurement.html - `trialcoverage`_ is a plug-in for Twisted trial. - .. _trialcoverage: https://pypi.python.org/pypi/trialcoverage + .. _trialcoverage: https://pypi.org/project/trialcoverage/ - `pytest-coverage`_ - .. _pytest-coverage: https://pypi.python.org/pypi/pytest-coverage + .. _pytest-coverage: https://pypi.org/project/pytest-coverage/ - `django-coverage`_ for use with Django. - .. _django-coverage: https://pypi.python.org/pypi/django-coverage + .. _django-coverage: https://pypi.org/project/django-coverage/ **Q: Where can I get more help with coverage.py?** diff --git a/doc/index.rst b/doc/index.rst index 44e53946..c6ddf5de 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -77,21 +77,21 @@ not. .. ifconfig:: prerelease - The latest version is coverage.py 4.4b1, released April 4th 2017. It is + The latest version is coverage.py 5.0a1, released June 5th 2018. It is supported on: - * Python versions 2.6, 2.7, 3.3, 3.4, 3.5, and 3.6. + * Python versions 2.7, 3.4, 3.5, 3.6, and 3.7. - * PyPy2 5.6 and PyPy3 5.5. + * PyPy2 6.0 and PyPy3 6.0. * Jython 2.7.1, though only for running code, not reporting. * IronPython 2.7.7, though only for running code, not reporting. **This is a pre-release build. The usual warnings about possible bugs - apply.** The latest stable version is coverage.py 4.3.4, `described here`_. + apply.** The latest stable version is coverage.py 4.5.1, `described here`_. -.. _described here: https://nedbatchelder.com/code/coverage +.. _described here: http://coverage.readthedocs.io/ Quick start @@ -145,7 +145,7 @@ Getting started is easy: Then visit htmlcov/index.html in your browser, to see a `report like this one`_. -.. _coverage.py page on the Python Package Index: https://pypi.python.org/pypi/coverage +.. _coverage.py page on the Python Package Index: https://pypi.org/project/coverage/ .. _report like this: https://nedbatchelder.com/files/sample_coverage_html/index.html .. _report like this one: https://nedbatchelder.com/files/sample_coverage_html_beta/index.html diff --git a/doc/install.rst b/doc/install.rst index 29bc833e..4f3717b4 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -29,8 +29,8 @@ Installation .. highlight:: console -.. _coverage_pypi: https://pypi.python.org/pypi/coverage -.. _setuptools: https://pypi.python.org/pypi/setuptools +.. _coverage_pypi: https://pypi.org/project/coverage/ +.. _setuptools: https://pypi.org/project/setuptools/ You can install coverage.py in the usual ways. The simplest way is with pip:: diff --git a/doc/plugins.rst b/doc/plugins.rst index f2bad6d4..e4967b4b 100644 --- a/doc/plugins.rst +++ b/doc/plugins.rst @@ -66,7 +66,7 @@ Some coverage.py plug-ins you might find useful: * `Django template coverage.py plug-in`__: for measuring coverage in Django templates. - .. __: https://pypi.python.org/pypi/django_coverage_plugin + .. __: https://pypi.org/project/django_coverage_plugin/ * `Mako template coverage plug-in`__: for measuring coverage in Mako templates. Doesn't work yet, probably needs some changes in Mako itself. diff --git a/doc/python-coverage.1.txt b/doc/python-coverage.1.txt index 94402b84..a415f080 100644 --- a/doc/python-coverage.1.txt +++ b/doc/python-coverage.1.txt @@ -8,7 +8,7 @@ measure code coverage of Python program execution :Author: Ned Batchelder <ned@nedbatchelder.com> :Author: |author| -:Date: 2015-09-20 +:Date: 2018-05-28 :Copyright: Apache 2.0 license, attribution and disclaimer required. :Manual section: 1 :Manual group: Coverage.py @@ -219,6 +219,10 @@ COVERAGE_FILE Path to the file where coverage measurements are collected to and reported from. Default: ``.coverage`` in the current working directory. +COVERAGE_RCFILE + + Path to the configuration file, often named ``.coveragerc``. + HISTORY ======= diff --git a/doc/requirements.pip b/doc/requirements.pip index 73467c94..dbd6c8fa 100644 --- a/doc/requirements.pip +++ b/doc/requirements.pip @@ -3,9 +3,9 @@ # https://requires.io/github/nedbat/coveragepy/requirements/ pyenchant==2.0.0 -sphinx==1.6.6 -sphinxcontrib-spelling==4.0.1 -sphinx_rtd_theme==0.2.4 +sphinx==1.7.5 +sphinxcontrib-spelling==4.1.0 +sphinx_rtd_theme==0.3.1 # A version of doc8 with a -q flag. git+https://github.com/nedbat/doc8.git#egg=doc8==0.0 diff --git a/doc/trouble.rst b/doc/trouble.rst index e3951218..d152599a 100644 --- a/doc/trouble.rst +++ b/doc/trouble.rst @@ -64,7 +64,7 @@ timid=True`` configuration option. DecoratorTools fiddles with the trace function. You will need to use ``--timid``. -.. _DecoratorTools: https://pypi.python.org/pypi/DecoratorTools +.. _DecoratorTools: https://pypi.org/project/DecoratorTools/ .. _TurboGears: http://turbogears.org/ |