summaryrefslogtreecommitdiff
path: root/doc/install.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2016-03-29 21:06:22 -0400
committerNed Batchelder <ned@nedbatchelder.com>2016-03-29 21:06:22 -0400
commit8040de27dc7e5a3a1b7b0873a84faa068bf805cb (patch)
tree27a2cd9adcbe92a1d6898b50a4d4b20b5c8d6bd2 /doc/install.rst
parentec67a11057d9742181d81261e57a536da3fc7093 (diff)
downloadpython-coveragepy-git-8040de27dc7e5a3a1b7b0873a84faa068bf805cb.tar.gz
Add mentions to the docs about the need for the C extension
Diffstat (limited to 'doc/install.rst')
-rw-r--r--doc/install.rst20
1 files changed, 14 insertions, 6 deletions
diff --git a/doc/install.rst b/doc/install.rst
index 1ccbed87..d362d6e5 100644
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -57,15 +57,20 @@ The alternate old-school technique is:
.. __: coverage_pypi_
-Installing dependencies
------------------------
+.. _install_extension:
+
+C Extension
+-----------
Coverage.py includes a C extension for speed. It is strongly recommended to use
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 the names of the packages for your distribution. For example::
+coverage.py features. Most of the time, the C extension will be installed
+without any special action on your part.
+
+If you are installing on Linux, 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, which Python version you are 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
@@ -82,6 +87,9 @@ You can determine if you are using the extension by looking at the output of
The first line will either say "with C extension," or "without C extension."
+A few features of coverage.py aren't supported without the C extension, such
+as concurrency and plugins.
+
Installing on Windows
---------------------