diff options
| author | Ned Batchelder <nedbat@gmail.com> | 2016-02-28 16:11:10 -0500 |
|---|---|---|
| committer | Ned Batchelder <nedbat@gmail.com> | 2016-02-28 16:11:10 -0500 |
| commit | f3e7c3e8def481afb6ef4c12a1c517beb514f6aa (patch) | |
| tree | e135db8b1cf3ceb99901dcb036ae35c99970da72 /doc | |
| parent | 4afd9f8452270572a7a580775255b44178d61451 (diff) | |
| parent | 8feda9baf012b2407ddfe691fd43d2d5878ad3e9 (diff) | |
| download | python-coveragepy-f3e7c3e8def481afb6ef4c12a1c517beb514f6aa.tar.gz | |
Merged in Nagasaki45/coverage.py (pull request #78)
State that --source value should be a comma separated list in the docs.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cmd.rst | 4 | ||||
| -rw-r--r-- | doc/install.rst | 21 |
2 files changed, 14 insertions, 11 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index a66df82..5f3cc53 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -113,7 +113,7 @@ Give it a value of ``greenlet``, ``eventlet``, or ``gevent``. By default, coverage.py does not measure code installed with the Python interpreter, for example, the standard library. If you want to measure that -code as well as your own, add the ``-L`` flag. +code as well as your own, add the ``-L`` (or ``--pylib``) flag. If your coverage results seem to be overlooking code that you know has been executed, try running coverage.py again with the ``--timid`` flag. This uses a @@ -168,7 +168,7 @@ Coverage.py collects execution data in a file called ".coverage". If need be, you can set a new file name with the COVERAGE_FILE environment variable. This can include a path to another directory. -By default,each run of your program starts with an empty data set. If you need +By default, each run of your program starts with an empty data set. If you need to run your program multiple times to get complete data (for example, because you need to supply disjoint options), you can accumulate data across runs with the ``-a`` flag on the **run** command. diff --git a/doc/install.rst b/doc/install.rst index 16d4447..55273e6 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -57,18 +57,21 @@ The alternate old-school technique is: .. __: coverage_pypi_ -Installing from source ----------------------- +Installing dependencies +----------------------- -Coverage.py includes a C extension for speed. If you are installing from -source, you may need to install the python-dev support files, for example -with:: +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 on the names of the packages for your distribution. For example:: - $ sudo apt-get install python-dev + $ sudo apt-get install python-dev gcc + $ sudo yum install python-devel gcc -or for Python 3.x:: - - $ sudo apt-get install python3-dev + $ sudo apt-get install python3-dev gcc + $ sudo yum install python3-devel gcc Installing on Windows |