diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2016-03-29 12:39:31 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2016-03-29 12:39:31 -0400 |
| commit | ec67a11057d9742181d81261e57a536da3fc7093 (patch) | |
| tree | a6d2a3afd04332dc664c0314da16e849d5313206 /doc/install.rst | |
| parent | f30b4a59cd4da3d328683db81189eaf0a2d09da2 (diff) | |
| download | python-coveragepy-git-ec67a11057d9742181d81261e57a536da3fc7093.tar.gz | |
A better way to indicate the presence of the C extension
Diffstat (limited to 'doc/install.rst')
| -rw-r--r-- | doc/install.rst | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/doc/install.rst b/doc/install.rst index 133ecd02..1ccbed87 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -65,7 +65,7 @@ this extension: it is much faster, and is needed to support a number of coverage.py features. You may need to install the python-dev and gcc support files before installing coverage via pip. The exact commands depend on which package manager you use on your operating system, which Python version you are -using, and on the names of the packages for your distribution. For example:: +using, and the names of the packages for your distribution. For example:: $ sudo apt-get install python-dev gcc $ sudo yum install python-devel gcc @@ -73,6 +73,15 @@ using, and on the names of the packages for your distribution. For example:: $ sudo apt-get install python3-dev gcc $ sudo yum install python3-devel gcc +You can determine if you are using the extension by looking at the output of +``coverage --version``:: + + $ coverage --version + Coverage.py, version |release| with C extension + Documentation at https://coverage.readthedocs.org + +The first line will either say "with C extension," or "without C extension." + Installing on Windows --------------------- @@ -96,7 +105,7 @@ coverage.py installed properly: .. parsed-literal:: $ coverage --version - Coverage.py, version |release| with CTracer + Coverage.py, version |release| with C extension Documentation at https://coverage.readthedocs.org .. ifconfig:: prerelease @@ -104,7 +113,7 @@ coverage.py installed properly: .. parsed-literal:: $ coverage --version - Coverage.py, version |release| with CTracer + Coverage.py, version |release| with C extension Documentation at https://coverage.readthedocs.org/en/coverage-|release| You can also invoke coverage.py as a module: @@ -114,7 +123,7 @@ You can also invoke coverage.py as a module: .. parsed-literal:: $ python -m coverage --version - Coverage.py, version |release| with CTracer + Coverage.py, version |release| with C extension Documentation at https://coverage.readthedocs.org .. ifconfig:: prerelease @@ -122,5 +131,5 @@ You can also invoke coverage.py as a module: .. parsed-literal:: $ python -m coverage --version - Coverage.py, version |release| with CTracer + Coverage.py, version |release| with C extension Documentation at https://coverage.readthedocs.org/en/coverage-|release| |